generated from wayfair-incubator/oss-template
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add new command to bump version using yaml selector
- Loading branch information
Showing
7 changed files
with
298 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| package telefonistka | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| lru "github.com/hashicorp/golang-lru/v2" | ||
| "github.com/hexops/gotextdiff" | ||
| "github.com/hexops/gotextdiff/myers" | ||
| "github.com/hexops/gotextdiff/span" | ||
| "github.com/mikefarah/yq/v4/pkg/yqlib" | ||
| log "github.com/sirupsen/logrus" | ||
| "github.com/spf13/cobra" | ||
| "github.com/wayfair-incubator/telefonistka/internal/pkg/githubapi" | ||
| ) | ||
|
|
||
| // This is still(https://github.com/spf13/cobra/issues/1862) the documented way to use cobra | ||
| func init() { //nolint:gochecknoinits | ||
| var targetRepo string | ||
| var targetFile string | ||
| var address string | ||
| var replacement string | ||
| var githubHost string | ||
| var triggeringRepo string | ||
| var triggeringRepoSHA string | ||
| var triggeringActor string | ||
| var autoMerge bool | ||
| eventCmd := &cobra.Command{ | ||
| Use: "bump-yaml", | ||
| Short: "Bump artifact version in a file using yaml selector", | ||
| Long: `Bump artifact version in a file using yaml selector. | ||
| This will open a pull request in the target repo. | ||
| This command uses yq selector to find the yaml value to replace. | ||
| `, | ||
| Args: cobra.ExactArgs(0), | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| bumpVersionYaml(targetRepo, targetFile, address, replacement, githubHost, triggeringRepo, triggeringRepoSHA, triggeringActor, autoMerge) | ||
| }, | ||
| } | ||
| eventCmd.Flags().StringVarP(&targetRepo, "target-repo", "t", getEnv("TARGET_REPO", ""), "Target Git repository slug(e.g. org-name/repo-name), defaults to TARGET_REPO env var.") | ||
| eventCmd.Flags().StringVarP(&targetFile, "target-file", "f", getEnv("TARGET_FILE", ""), "Target file path(from repo root), defaults to TARGET_FILE env var.") | ||
| eventCmd.Flags().StringVar(&address, "address", "", "Yaml value address described as a yq selector, e.g. '.db.[] | select(.name == \"postgres\").image.tag'.") | ||
| eventCmd.Flags().StringVarP(&replacement, "replacement-string", "n", "", "Replacement string that includes the version value of new artifact, e.g. 'v2.7.1'.") | ||
| eventCmd.Flags().StringVarP(&githubHost, "github-host", "g", "", "GitHub instance HOSTNAME, defaults to \"github.com\". This is used for GitHub Enterprise Server instances.") | ||
| eventCmd.Flags().StringVarP(&triggeringRepo, "triggering-repo", "p", getEnv("GITHUB_REPOSITORY", ""), "Github repo triggering the version bump(e.g. `octocat/Hello-World`) defaults to GITHUB_REPOSITORY env var.") | ||
| eventCmd.Flags().StringVarP(&triggeringRepoSHA, "triggering-repo-sha", "s", getEnv("GITHUB_SHA", ""), "Git SHA of triggering repo, defaults to GITHUB_SHA env var.") | ||
| eventCmd.Flags().StringVarP(&triggeringActor, "triggering-actor", "a", getEnv("GITHUB_ACTOR", ""), "GitHub user of the person/bot who triggered the bump, defaults to GITHUB_ACTOR env var.") | ||
| eventCmd.Flags().BoolVar(&autoMerge, "auto-merge", false, "Automatically merges the created PR, defaults to false.") | ||
| rootCmd.AddCommand(eventCmd) | ||
| } | ||
|
|
||
| func bumpVersionYaml(targetRepo string, targetFile string, address string, value string, githubHost string, triggeringRepo string, triggeringRepoSHA string, triggeringActor string, autoMerge bool) { | ||
| ctx := context.Background() | ||
| var githubRestAltURL string | ||
|
|
||
| if githubHost != "" { | ||
| githubRestAltURL = "https://" + githubHost + "/api/v3" | ||
| log.Infof("Github REST API endpoint is configured to %s", githubRestAltURL) | ||
| } | ||
| var mainGithubClientPair githubapi.GhClientPair | ||
| mainGhClientCache, _ := lru.New[string, githubapi.GhClientPair](128) | ||
|
|
||
| mainGithubClientPair.GetAndCache(mainGhClientCache, "GITHUB_APP_ID", "GITHUB_APP_PRIVATE_KEY_PATH", "GITHUB_OAUTH_TOKEN", strings.Split(targetRepo, "/")[0], ctx) | ||
|
|
||
| var ghPrClientDetails githubapi.GhPrClientDetails | ||
|
|
||
| ghPrClientDetails.GhClientPair = &mainGithubClientPair | ||
| ghPrClientDetails.Ctx = ctx | ||
| ghPrClientDetails.Owner = strings.Split(targetRepo, "/")[0] | ||
| ghPrClientDetails.Repo = strings.Split(targetRepo, "/")[1] | ||
| ghPrClientDetails.PrLogger = log.WithFields(log.Fields{}) // TODO what fields should be here? | ||
|
|
||
| defaultBranch, _ := ghPrClientDetails.GetDefaultBranch() | ||
|
|
||
| initialFileContent, err, _ := githubapi.GetFileContent(ghPrClientDetails, defaultBranch, targetFile) | ||
| if err != nil { | ||
| ghPrClientDetails.PrLogger.Errorf("Fail to fetch file content:%s\n", err) | ||
| os.Exit(1) | ||
| } | ||
| newFileContent, err := updateYaml(initialFileContent, address, value) | ||
| if err != nil { | ||
| ghPrClientDetails.PrLogger.Errorf("Fail to update yaml:%s\n", err) | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| edits := myers.ComputeEdits(span.URIFromPath(""), initialFileContent, newFileContent) | ||
| ghPrClientDetails.PrLogger.Infof("Diff:\n%s", gotextdiff.ToUnified("Before", "After", initialFileContent, edits)) | ||
|
|
||
| err = githubapi.BumpVersion(ghPrClientDetails, "main", targetFile, newFileContent, triggeringRepo, triggeringRepoSHA, triggeringActor, autoMerge) | ||
| if err != nil { | ||
| log.Errorf("Failed to bump version: %v", err) | ||
| os.Exit(1) | ||
| } | ||
| } | ||
|
|
||
| func updateYaml(yamlContent string, address string, value string) (string, error) { | ||
| yqExpression := fmt.Sprintf("(%s)=\"%s\"", address, value) | ||
|
|
||
| preferences := yqlib.NewDefaultYamlPreferences() | ||
| evaluate, err := yqlib.NewStringEvaluator().Evaluate(yqExpression, yamlContent, yqlib.NewYamlEncoder(preferences), yqlib.NewYamlDecoder(preferences)) | ||
| if err != nil { | ||
| return "", err | ||
| } | ||
| return evaluate, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| package telefonistka | ||
|
|
||
| import ( | ||
| "testing" | ||
| ) | ||
|
|
||
| func TestUpdateYaml(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| tests := []struct { | ||
| name string | ||
| yamlContent string | ||
| address string | ||
| value string | ||
| want string | ||
| }{ | ||
| { | ||
| name: "Test simple", | ||
| yamlContent: ` | ||
| tag: "16.1" | ||
| `, | ||
| address: `.tag`, | ||
| value: "16.2", | ||
| want: ` | ||
| tag: "16.2" | ||
| `, | ||
| }, | ||
| { | ||
| name: "Test nested", | ||
| yamlContent: ` | ||
| image: | ||
| repository: "postgres" | ||
| tag: "16.1" | ||
| `, | ||
| address: `.image.tag`, | ||
| value: "16.2", | ||
| want: ` | ||
| image: | ||
| repository: "postgres" | ||
| tag: "16.2" | ||
| `, | ||
| }, | ||
| { | ||
| name: "Test nested select", | ||
| yamlContent: ` | ||
| db: | ||
| - name: "postgres" | ||
| image: | ||
| repository: "postgres" | ||
| tag: "16.1" | ||
| `, | ||
| address: `.db.[] | select(.name == "postgres").image.tag`, | ||
| value: "16.2", | ||
| want: ` | ||
| db: | ||
| - name: "postgres" | ||
| image: | ||
| repository: "postgres" | ||
| tag: "16.2" | ||
| `, | ||
| }, | ||
| { | ||
| name: "Test add missing", | ||
| yamlContent: ` | ||
| image: | ||
| repository: "postgres" | ||
| `, | ||
| address: `.image.tag`, | ||
| value: "16.2", | ||
| want: ` | ||
| image: | ||
| repository: "postgres" | ||
| tag: "16.2" | ||
| `, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| got, err := updateYaml(tt.yamlContent, tt.address, tt.value) | ||
| if err != nil { | ||
| t.Errorf("updateYaml() error = %v", err) | ||
| return | ||
| } | ||
| if got != tt.want { | ||
| t.Errorf("updateYaml() got = %v, want %v", got, tt.want) | ||
| } | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.