func auditStepModelBeforeSharePullRequest(step models.StepModel, stepID, version string) error {
if err := step.Audit(); err != nil {
return fmt.Errorf("Failed to audit step infos, error: %s", err)
}
pth, err := pathutil.NormalizedOSTempDirPath(stepID + version)
if err != nil {
return fmt.Errorf("Failed to create a temporary directory for the step's audit, error: %s", err)
}
if step.Source == nil {
return fmt.Errorf("Missing Source porperty")
}
err = retry.Times(2).Wait(3 * time.Second).Try(func(attempt uint) error {
return cmdex.GitCloneTag(step.Source.Git, pth, version)
})
if err != nil {
return fmt.Errorf("Failed to git-clone the step (url: %s) version (%s), error: %s",
step.Source.Git, version, err)
}
latestCommit, err := cmdex.GitGetLatestCommitHashOnHead(pth)
if err != nil {
return fmt.Errorf("Failed to get git-latest-commit-hash, error: %s", err)
}
if latestCommit != step.Source.Commit {
return fmt.Errorf("Step commit hash (%s) should be the latest commit hash (%s) on git tag", step.Source.Commit, latestCommit)
}
return nil
}
// ParseStepYml ...
func ParseStepYml(pth string, validate bool) (models.StepModel, error) {
bytes, err := fileutil.ReadBytesFromFile(pth)
if err != nil {
return models.StepModel{}, err
}
var stepModel models.StepModel
if err := yaml.Unmarshal(bytes, &stepModel); err != nil {
return models.StepModel{}, err
}
if err := stepModel.Normalize(); err != nil {
return models.StepModel{}, err
}
if validate {
if err := stepModel.Audit(); err != nil {
return models.StepModel{}, err
}
}
if err := stepModel.FillMissingDefaults(); err != nil {
return models.StepModel{}, err
}
return stepModel, nil
}
// ReadSpecStep ...
func ReadSpecStep(pth string) (stepmanModels.StepModel, error) {
if isExists, err := pathutil.IsPathExists(pth); err != nil {
return stepmanModels.StepModel{}, err
} else if !isExists {
return stepmanModels.StepModel{}, errors.New(fmt.Sprint("No file found at path", pth))
}
bytes, err := fileutil.ReadBytesFromFile(pth)
if err != nil {
return stepmanModels.StepModel{}, err
}
var stepModel stepmanModels.StepModel
if err := yaml.Unmarshal(bytes, &stepModel); err != nil {
return stepmanModels.StepModel{}, err
}
if err := stepModel.Normalize(); err != nil {
return stepmanModels.StepModel{}, err
}
if err := stepModel.Validate(false); err != nil {
return stepmanModels.StepModel{}, err
}
if err := stepModel.FillMissingDefaults(); err != nil {
return stepmanModels.StepModel{}, err
}
return stepModel, nil
}
func auditStepModelBeforeSharePullRequest(step models.StepModel, stepID, version string) error {
if err := step.Audit(); err != nil {
return err
}
pth, err := pathutil.NormalizedOSTempDirPath(stepID + version)
if err != nil {
return err
}
if err := cmdex.GitCloneTag(step.Source.Git, pth, version); err != nil {
return err
}
latestCommit, err := cmdex.GitGetLatestCommitHashOnHead(pth)
if err != nil {
return err
}
if latestCommit != step.Source.Commit {
return fmt.Errorf("Step commit hash (%s) should be the latest commit hash (%s) on git tag", step.Source.Commit, latestCommit)
}
return nil
}
// MergeStepWith ...
func MergeStepWith(step, otherStep stepmanModels.StepModel) (stepmanModels.StepModel, error) {
if otherStep.Title != nil {
step.Title = pointers.NewStringPtr(*otherStep.Title)
}
if otherStep.Description != nil {
step.Description = pointers.NewStringPtr(*otherStep.Description)
}
if otherStep.Summary != nil {
step.Summary = pointers.NewStringPtr(*otherStep.Summary)
}
if otherStep.Website != nil {
step.Website = pointers.NewStringPtr(*otherStep.Website)
}
if otherStep.SourceCodeURL != nil {
step.SourceCodeURL = pointers.NewStringPtr(*otherStep.SourceCodeURL)
}
if otherStep.SupportURL != nil {
step.SupportURL = pointers.NewStringPtr(*otherStep.SupportURL)
}
if otherStep.PublishedAt != nil {
step.PublishedAt = pointers.NewTimePtr(*otherStep.PublishedAt)
}
if otherStep.Source.Git != "" {
step.Source.Git = otherStep.Source.Git
}
if otherStep.Source.Commit != "" {
step.Source.Commit = otherStep.Source.Commit
}
if len(otherStep.Dependencies) > 0 {
step.Dependencies = otherStep.Dependencies
}
if len(otherStep.Deps.Brew) > 0 || len(otherStep.Deps.AptGet) > 0 || len(otherStep.Deps.CheckOnly) > 0 {
step.Deps = otherStep.Deps
}
if len(otherStep.HostOsTags) > 0 {
step.HostOsTags = otherStep.HostOsTags
}
if len(otherStep.ProjectTypeTags) > 0 {
step.ProjectTypeTags = otherStep.ProjectTypeTags
}
if len(otherStep.TypeTags) > 0 {
step.TypeTags = otherStep.TypeTags
}
if otherStep.IsRequiresAdminUser != nil {
step.IsRequiresAdminUser = pointers.NewBoolPtr(*otherStep.IsRequiresAdminUser)
}
if otherStep.IsAlwaysRun != nil {
step.IsAlwaysRun = pointers.NewBoolPtr(*otherStep.IsAlwaysRun)
}
if otherStep.IsSkippable != nil {
step.IsSkippable = pointers.NewBoolPtr(*otherStep.IsSkippable)
}
if otherStep.RunIf != nil {
step.RunIf = pointers.NewStringPtr(*otherStep.RunIf)
}
for _, input := range step.Inputs {
key, _, err := input.GetKeyValuePair()
if err != nil {
return stepmanModels.StepModel{}, err
}
otherInput, found := getInputByKey(otherStep, key)
if found {
err := MergeEnvironmentWith(&input, otherInput)
if err != nil {
return stepmanModels.StepModel{}, err
}
}
}
for _, output := range step.Outputs {
key, _, err := output.GetKeyValuePair()
if err != nil {
return stepmanModels.StepModel{}, err
}
otherOutput, found := getOutputByKey(otherStep, key)
if found {
err := MergeEnvironmentWith(&output, otherOutput)
if err != nil {
return stepmanModels.StepModel{}, err
}
}
}
return step, nil
}
func create(c *cli.Context) error {
toolMode := c.Bool(ToolMode)
share, err := ReadShareSteplibFromFile()
if err != nil {
log.Error(err)
log.Fatalln("You have to start sharing with `stepman share start`, or you can read instructions with `stepman share`")
}
// Input validation
tag := c.String(TagKey)
if tag == "" {
log.Fatalln("No Step tag specified")
}
gitURI := c.String(GitKey)
if gitURI == "" {
log.Fatalln("No Step url specified")
}
stepID := c.String(StepIDKEy)
if stepID == "" {
stepID = getStepIDFromGit(gitURI)
}
if stepID == "" {
log.Fatalln("No Step id specified")
}
r := regexp.MustCompile(`[a-z0-9-]+`)
if find := r.FindString(stepID); find != stepID {
log.Fatalln("StepID doesn't conforms to: [a-z0-9-]")
}
route, found := stepman.ReadRoute(share.Collection)
if !found {
log.Fatalf("No route found for collectionURI (%s)", share.Collection)
}
stepDirInSteplib := stepman.GetStepCollectionDirPath(route, stepID, tag)
stepYMLPathInSteplib := path.Join(stepDirInSteplib, "step.yml")
if exist, err := pathutil.IsPathExists(stepYMLPathInSteplib); err != nil {
log.Fatalf("Failed to check step.yml path in steplib, err: %s", err)
} else if exist {
log.Warnf("Step already exist in path: %s.", stepDirInSteplib)
if val, err := goinp.AskForBool("Would you like to overwrite local version of Step?"); err != nil {
log.Fatalf("Failed to get bool, err: %s", err)
} else {
if !val {
log.Errorln("Unfortunately we can't continue with sharing without an overwrite exist step.yml.")
log.Fatalln("Please finish your changes, run this command again and allow it to overwrite the exist step.yml!")
}
}
}
// Clone Step to tmp dir
tmp, err := pathutil.NormalizedOSTempDirPath("")
if err != nil {
log.Fatalf("Failed to get temp directory, err: %s", err)
}
log.Infof("Cloning Step from (%s) with tag (%s) to temporary path (%s)", gitURI, tag, tmp)
if err := cmdex.GitCloneTag(gitURI, tmp, tag); err != nil {
log.Fatalf("Git clone failed, err: %s", err)
}
// Update step.yml
tmpStepYMLPath := path.Join(tmp, "step.yml")
bytes, err := fileutil.ReadBytesFromFile(tmpStepYMLPath)
if err != nil {
log.Fatalf("Failed to read Step from file, err: %s", err)
}
var stepModel models.StepModel
if err := yaml.Unmarshal(bytes, &stepModel); err != nil {
log.Fatalf("Failed to unmarchal Step, err: %s", err)
}
commit, err := cmdex.GitGetCommitHashOfHEAD(tmp)
if err != nil {
log.Fatalf("Failed to get commit hash, err: %s", err)
}
stepModel.Source = &models.StepSourceModel{
Git: gitURI,
Commit: commit,
}
stepModel.PublishedAt = pointers.NewTimePtr(time.Now())
// Validate step-yml
if err := stepModel.Audit(); err != nil {
log.Fatalf("Failed to validate Step, err: %s", err)
}
for _, input := range stepModel.Inputs {
key, value, err := input.GetKeyValuePair()
if err != nil {
log.Fatalf("Failed to get Step input key-value pair, err: %s", err)
}
options, err := input.GetOptions()
if err != nil {
log.Fatalf("Failed to get Step input (%s) options, err: %s", key, err)
}
if len(options.ValueOptions) > 0 && value == "" {
log.Warn("Step input with 'value_options', should contain default value!")
log.Fatalf("Missing default value for Step input (%s).", key)
}
}
if strings.Contains(*stepModel.Summary, "\n") {
log.Warningln("Step summary should be one line!")
}
if utf8.RuneCountInString(*stepModel.Summary) > maxSummaryLength {
log.Warningf("Step summary should contains maximum (%d) characters, actual: (%d)!", maxSummaryLength, utf8.RuneCountInString(*stepModel.Summary))
}
// Copy step.yml to steplib
share.StepID = stepID
share.StepTag = tag
if err := WriteShareSteplibToFile(share); err != nil {
log.Fatalf("Failed to save share steplib to file, err: %s", err)
}
log.Info("Step dir in collection:", stepDirInSteplib)
if exist, err := pathutil.IsPathExists(stepDirInSteplib); err != nil {
log.Fatalf("Failed to check path (%s), err: %s", stepDirInSteplib, err)
} else if !exist {
if err := os.MkdirAll(stepDirInSteplib, 0777); err != nil {
log.Fatalf("Failed to create path (%s), err: %s", stepDirInSteplib, err)
}
}
log.Infof("Checkout branch: %s", share.ShareBranchName())
collectionDir := stepman.GetCollectionBaseDirPath(route)
if err := cmdex.GitCheckout(collectionDir, share.ShareBranchName()); err != nil {
if err := cmdex.GitCreateAndCheckoutBranch(collectionDir, share.ShareBranchName()); err != nil {
log.Fatalf("Git failed to create and checkout branch, err: %s", err)
}
}
stepBytes, err := yaml.Marshal(stepModel)
if err != nil {
log.Fatalf("Failed to marcshal Step model, err: %s", err)
}
if err := fileutil.WriteBytesToFile(stepYMLPathInSteplib, stepBytes); err != nil {
log.Fatalf("Failed to write Step to file, err: %s", err)
}
// Update spec.json
if err := stepman.ReGenerateStepSpec(route); err != nil {
log.Fatalf("Failed to re-create steplib, err: %s", err)
}
printFinishCreate(share, stepDirInSteplib, toolMode)
return nil
}
// MergeStepWith ...
func MergeStepWith(step, otherStep stepmanModels.StepModel) (stepmanModels.StepModel, error) {
if err := step.FillMissingDeafults(); err != nil {
return stepmanModels.StepModel{}, err
}
if otherStep.Title != nil {
*step.Title = *otherStep.Title
}
if otherStep.Description != nil {
*step.Description = *otherStep.Description
}
if otherStep.Summary != nil {
*step.Summary = *otherStep.Summary
}
if otherStep.Website != nil {
*step.Website = *otherStep.Website
}
if otherStep.SourceCodeURL != nil {
*step.SourceCodeURL = *otherStep.SourceCodeURL
}
if otherStep.SupportURL != nil {
*step.SupportURL = *otherStep.SupportURL
}
if otherStep.Source.Git != nil {
*step.Source.Git = *otherStep.Source.Git
}
if len(otherStep.HostOsTags) > 0 {
step.HostOsTags = otherStep.HostOsTags
}
if len(otherStep.ProjectTypeTags) > 0 {
step.ProjectTypeTags = otherStep.ProjectTypeTags
}
if len(otherStep.TypeTags) > 0 {
step.TypeTags = otherStep.TypeTags
}
if otherStep.IsRequiresAdminUser != nil {
*step.IsRequiresAdminUser = *otherStep.IsRequiresAdminUser
}
if otherStep.IsAlwaysRun != nil {
*step.IsAlwaysRun = *otherStep.IsAlwaysRun
}
if otherStep.IsSkippable != nil {
*step.IsSkippable = *otherStep.IsSkippable
}
if otherStep.RunIf != nil {
*step.RunIf = *otherStep.RunIf
}
for _, input := range step.Inputs {
key, _, err := input.GetKeyValuePair()
if err != nil {
return stepmanModels.StepModel{}, err
}
otherInput, found := getInputByKey(otherStep, key)
if found {
err := MergeEnvironmentWith(&input, otherInput)
if err != nil {
return stepmanModels.StepModel{}, err
}
}
}
for _, output := range step.Outputs {
key, _, err := output.GetKeyValuePair()
if err != nil {
return stepmanModels.StepModel{}, err
}
otherOutput, found := getOutputByKey(otherStep, key)
if found {
err := MergeEnvironmentWith(&output, otherOutput)
if err != nil {
return stepmanModels.StepModel{}, err
}
}
}
return step, nil
}
func removeStepRedundantFields(step *stepmanModels.StepModel) error {
if step.Title != nil && *step.Title == "" {
step.Title = nil
}
if step.Description != nil && *step.Description == "" {
step.Description = nil
}
if step.Summary != nil && *step.Summary == "" {
step.Summary = nil
}
if step.Website != nil && *step.Website == "" {
step.Website = nil
}
if step.SourceCodeURL != nil && *step.SourceCodeURL == "" {
step.SourceCodeURL = nil
}
if step.SupportURL != nil && *step.SupportURL == "" {
step.SupportURL = nil
}
if step.PublishedAt != nil && (*step.PublishedAt).Equal(time.Time{}) {
step.PublishedAt = nil
}
if step.IsRequiresAdminUser != nil && *step.IsRequiresAdminUser == stepmanModels.DefaultIsRequiresAdminUser {
step.IsRequiresAdminUser = nil
}
if step.IsAlwaysRun != nil && *step.IsAlwaysRun == stepmanModels.DefaultIsAlwaysRun {
step.IsAlwaysRun = nil
}
if step.IsSkippable != nil && *step.IsSkippable == stepmanModels.DefaultIsSkippable {
step.IsSkippable = nil
}
if step.RunIf != nil && *step.RunIf == "" {
step.RunIf = nil
}
for _, env := range step.Inputs {
if err := removeEnvironmentRedundantFields(&env); err != nil {
return err
}
}
for _, env := range step.Outputs {
if err := removeEnvironmentRedundantFields(&env); err != nil {
return err
}
}
return nil
}