From 9117cec064cdc199369558605af34de95d9b0857 Mon Sep 17 00:00:00 2001 From: Dimitris Sotirakis Date: Wed, 14 Jun 2023 12:42:05 +0300 Subject: [PATCH] [v9.4.x] NPM packages: Fail `build-frontend-packages` step if `package.json` and input tag differ (#70011) (#70041) * NPM packages: Fail `build-frontend-packages` step if `package.json` and input tag differ (#70011) * Fail if package.json version is different than the tag * Add tests * Update message * Small refactoring * Fix lint (cherry picked from commit a6b524fd56ed6f11b17d1850bb5e868eec241743) * Bump urfave/cli/v2 * go mod tidy --- go.mod | 5 +- go.sum | 6 ++ pkg/build/frontend/config.go | 23 +++++-- pkg/build/frontend/config_test.go | 102 ++++++++++++++++++++++++++++++ 4 files changed, 127 insertions(+), 9 deletions(-) create mode 100644 pkg/build/frontend/config_test.go diff --git a/go.mod b/go.mod index 1e6d7dd7f20..5014ae234c6 100644 --- a/go.mod +++ b/go.mod @@ -29,7 +29,7 @@ require ( cuelang.org/go v0.5.0-beta.2 github.com/Azure/azure-sdk-for-go v65.0.0+incompatible github.com/Azure/go-autorest/autorest v0.11.28 - github.com/BurntSushi/toml v1.1.0 + github.com/BurntSushi/toml v1.2.1 github.com/Masterminds/semver v1.5.0 github.com/VividCortex/mysqlerr v0.0.0-20170204212430-6c6b55f8796f github.com/aws/aws-sdk-go v1.44.171 @@ -96,7 +96,7 @@ require ( github.com/teris-io/shortid v0.0.0-20171029131806-771a37caa5cf github.com/ua-parser/uap-go v0.0.0-20211112212520-00c877edfe0f github.com/uber/jaeger-client-go v2.29.1+incompatible - github.com/urfave/cli/v2 v2.3.0 + github.com/urfave/cli/v2 v2.25.0 github.com/vectordotdev/go-datemath v0.1.1-0.20220323213446-f3954d0b18ae github.com/weaveworks/common v0.0.0-20210913144402-035033b78a78 github.com/xorcare/pointer v1.1.0 @@ -338,6 +338,7 @@ require ( github.com/unknwon/bra v0.0.0-20200517080246-1e3013ecaff8 // indirect github.com/unknwon/com v1.0.1 // indirect github.com/unknwon/log v0.0.0-20150304194804-e617c87089d3 // indirect + github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect go.opentelemetry.io/otel/metric v0.34.0 // indirect go.starlark.net v0.0.0-20221020143700-22309ac47eac // indirect golang.org/x/term v0.5.0 // indirect diff --git a/go.sum b/go.sum index 3951b3ec6f1..9d83497c88b 100644 --- a/go.sum +++ b/go.sum @@ -229,6 +229,8 @@ github.com/AzureAD/microsoft-authentication-library-for-go v0.7.0/go.mod h1:BDJ5 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/toml v1.1.0 h1:ksErzDEI1khOiGPgpwuI7x2ebx/uXQNw7xJpn9Eq1+I= github.com/BurntSushi/toml v1.1.0/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= +github.com/BurntSushi/toml v1.2.1 h1:9F2/+DoOYIOksmaJFPw1tGFy1eDnIJXg+UHjuD8lTak= +github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/DATA-DOG/go-sqlmock v1.3.3/go.mod h1:f/Ixk793poVmq4qj/V1dPUg2JEAKC73Q5eFN3EC/SaM= github.com/DATA-DOG/go-sqlmock v1.4.1/go.mod h1:f/Ixk793poVmq4qj/V1dPUg2JEAKC73Q5eFN3EC/SaM= @@ -2538,6 +2540,8 @@ github.com/urfave/cli v1.22.9 h1:cv3/KhXGBGjEXLC4bH0sLuJ9BewaAbpk5oyMOveu4pw= github.com/urfave/cli v1.22.9/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0= github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M= github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI= +github.com/urfave/cli/v2 v2.25.0 h1:ykdZKuQey2zq0yin/l7JOm9Mh+pg72ngYMeB0ABn6q8= +github.com/urfave/cli/v2 v2.25.0/go.mod h1:GHupkWPMM0M/sj1a2b4wUrWBPzazNrIjouW6fmdJLxc= github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= github.com/valyala/fasttemplate v1.0.1/go.mod h1:UQGH1tvbgY+Nz5t2n7tXsz52dQxojPUpymEIMZ47gx8= @@ -2597,6 +2601,8 @@ github.com/xlab/treeprint v1.1.0/go.mod h1:gj5Gd3gPdKtR1ikdDK6fnFLdmIS0X30kTTuNd github.com/xorcare/pointer v1.1.0 h1:sFwXOhRF8QZ0tyVZrtxWGIoVZNEmRzBCaFWdONPQIUM= github.com/xorcare/pointer v1.1.0/go.mod h1:6KLhkOh6YbuvZkT4YbxIbR/wzLBjyMxOiNzZhJTor2Y= github.com/xordataexchange/crypt v0.0.3-0.20170626215501-b2862e3d0a77/go.mod h1:aYKd//L2LvnjZzWKhF00oedf4jCCReLcmhLdhm1A27Q= +github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU= +github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8= github.com/yalue/merged_fs v1.2.2 h1:vXHTpJBluJryju7BBpytr3PDIkzsPMpiEknxVGPhN/I= github.com/yalue/merged_fs v1.2.2/go.mod h1:WqqchfVYQyclV2tnR7wtRhBddzBvLVR83Cjw9BKQw0M= github.com/youmark/pkcs8 v0.0.0-20181117223130-1be2e3e5546d/go.mod h1:rHwXgn7JulP+udvsHwJoVG1YGAP6VLg4y9I5dyZdqmA= diff --git a/pkg/build/frontend/config.go b/pkg/build/frontend/config.go index 3bb66238961..3d244faa248 100644 --- a/pkg/build/frontend/config.go +++ b/pkg/build/frontend/config.go @@ -1,30 +1,39 @@ package frontend import ( + "fmt" + "github.com/grafana/grafana/pkg/build/config" "github.com/urfave/cli/v2" ) const GrafanaDir = "." -func GetConfig(c *cli.Context, version string) (config.Config, config.Edition, error) { +func GetConfig(c *cli.Context, inputTagVersion string) (config.Config, config.Edition, error) { cfg := config.Config{ NumWorkers: c.Int("jobs"), GitHubToken: c.String("github-token"), - PackageVersion: version, + PackageVersion: inputTagVersion, } mode := config.Edition(c.String("edition")) + buildID := c.String("build-id") + packageVersion, err := config.GetGrafanaVersion(buildID, GrafanaDir) + if err != nil { + return config.Config{}, "", cli.Exit(err.Error(), 1) + } - if version == "" { - buildID := c.String("build-id") - var err error - version, err = config.GetGrafanaVersion(buildID, GrafanaDir) - cfg.PackageVersion = version + if inputTagVersion == "" { + cfg.PackageVersion = packageVersion if err != nil { return config.Config{}, config.EditionOSS, cli.Exit(err.Error(), 1) } + return cfg, mode, err + } + if inputTagVersion != packageVersion { + return config.Config{}, "", cli.Exit(fmt.Errorf("package.json version and input tag version differ %s != %s.\nPlease update package.json", packageVersion, inputTagVersion), 1) } + cfg.PackageVersion = inputTagVersion return cfg, mode, nil } diff --git a/pkg/build/frontend/config_test.go b/pkg/build/frontend/config_test.go new file mode 100644 index 00000000000..a456887dbcb --- /dev/null +++ b/pkg/build/frontend/config_test.go @@ -0,0 +1,102 @@ +package frontend + +import ( + "encoding/json" + "flag" + "os" + "testing" + + "github.com/stretchr/testify/require" + "github.com/urfave/cli/v2" +) + +const ( + jobs = "jobs" + githubToken = "github-token" +) + +type packageJson struct { + Version string `json:"version"` +} + +var app = cli.NewApp() + +func TestGetConfig(t *testing.T) { + tests := []struct { + ctx *cli.Context + name string + packageJsonVersion string + tagVersion string + wantErr bool + }{ + { + ctx: cli.NewContext(app, setFlags(t, jobs, githubToken, flag.NewFlagSet("flagSet", flag.ContinueOnError)), nil), + name: "package.json matches tag", + packageJsonVersion: "10.0.0", + tagVersion: "10.0.0", + wantErr: false, + }, + { + ctx: cli.NewContext(app, setFlags(t, jobs, githubToken, flag.NewFlagSet("flagSet", flag.ContinueOnError)), nil), + name: "package.json doesn't match tag", + packageJsonVersion: "10.1.0", + tagVersion: "10.0.0", + wantErr: true, + }, + { + ctx: cli.NewContext(app, setFlags(t, jobs, githubToken, flag.NewFlagSet("flagSet", flag.ContinueOnError)), nil), + name: "non-tag event", + packageJsonVersion: "10.1.0", + tagVersion: "", + wantErr: false, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + var context cli.Context + err := createTempPackageJson(t, tt.packageJsonVersion) + require.NoError(t, err) + defer deleteTempPackageJson(t) + + got, _, err := GetConfig(&context, tt.tagVersion) + if !tt.wantErr { + require.Equal(t, got.PackageVersion, tt.packageJsonVersion) + } + + if tt.wantErr { + require.Equal(t, got.PackageVersion, "") + require.Error(t, err) + } + }) + } +} + +func setFlags(t *testing.T, flag1, flag2 string, flagSet *flag.FlagSet) *flag.FlagSet { + t.Helper() + if flag1 != "" { + flagSet.StringVar(&flag1, jobs, "2", "") + } + if flag2 != "" { + flagSet.StringVar(&flag2, githubToken, "token", "") + } + return flagSet +} + +func createTempPackageJson(t *testing.T, version string) error { + t.Helper() + + data := packageJson{Version: version} + file, _ := json.MarshalIndent(data, "", " ") + + err := os.WriteFile("package.json", file, 0644) + require.NoError(t, err) + + return nil +} + +func deleteTempPackageJson(t *testing.T) { + t.Helper() + + err := os.RemoveAll("package.json") + require.NoError(t, err) +}