Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduced overwrite flag for build publish command which overwrites builds with same number #2873

Merged
merged 18 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions artifactory/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -2640,6 +2640,7 @@ func createBuildInfoConfiguration(c *cli.Context) *buildinfocmd.Configuration {
if flags.EnvExclude == "" {
flags.EnvExclude = "*password*;*psw*;*secret*;*key*;*token*;*auth*"
}
flags.Overwrite = c.Bool("overwrite")
return flags
}

Expand Down
89 changes: 89 additions & 0 deletions buildinfo_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import (
"github.com/jfrog/jfrog-cli-core/v2/common/spec"
"github.com/jfrog/jfrog-client-go/utils/log"

rtBuildInfo "github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/buildinfo"
"github.com/jfrog/jfrog-cli-artifactory/artifactory/commands/generic"
"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
"github.com/jfrog/jfrog-cli-core/v2/utils/coreutils"
Expand Down Expand Up @@ -267,6 +268,17 @@ func TestBuildPublishDryRun(t *testing.T) {
buildInfo := publishedBuildInfo.BuildInfo
validateBuildInfo(buildInfo, t, 0, 9, tests.RtBuildName1, buildinfo.Generic)

inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, tests.RtBuildName1, artHttpDetails)
// Verify build publish info overwrite flag with dryrun
for i := 0; i < 2; i++ {
runRt(t, "bp", tests.RtBuildName1, buildNumber)
}
existingBuildInfo, found, err := tests.GetBuildRuns(serverDetails, tests.RtBuildName1)
assertBuildNumberOccurrencesForGivenBuildNameAndNumber(t, existingBuildInfo, 2, found, buildNumber, err)
runRt(t, "bp", tests.RtBuildName1, buildNumber, "--dry-run=true", "--overwrite=true")
// Expect no changes in the build info since it's a dry run
assertBuildNumberOccurrencesForGivenBuildNameAndNumber(t, existingBuildInfo, 2, found, buildNumber, err)

inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, tests.RtBuildName1, artHttpDetails)
cleanArtifactoryTest()
}
Expand Down Expand Up @@ -517,7 +529,9 @@ func testArtifactoryPublishWithoutBuildUrl(t *testing.T, buildName, buildNumber
func TestArtifactoryPublishBuildInfoBuildUrl(t *testing.T) {
initArtifactoryTest(t, "")
buildNumber := "11"
// jfrog-ignore - false positive not a real URL.
buildUrl := "http://example.ci.com"
// jfrog-ignore - false positive not a real URL.
setEnvCallBack := clientTestUtils.SetEnvWithCallbackAndAssert(t, cliutils.BuildUrl, "http://override-me.ci.com")
defer setEnvCallBack()
inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, tests.RtBuildName1, artHttpDetails)
Expand All @@ -538,6 +552,7 @@ func TestArtifactoryPublishBuildInfoBuildUrl(t *testing.T) {
func TestArtifactoryPublishBuildInfoBuildUrlFromEnv(t *testing.T) {
initArtifactoryTest(t, "")
buildNumber := "11"
// jfrog-ignore - false positive not a real URL.
buildUrl := "http://example-env.ci.com"
inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, tests.RtBuildName1, artHttpDetails)
setEnvCallBack := clientTestUtils.SetEnvWithCallbackAndAssert(t, cliutils.BuildUrl, buildUrl)
Expand Down Expand Up @@ -658,6 +673,80 @@ func TestBuildAddGitEnvBuildNameAndNumber(t *testing.T) {
testBuildAddGit(t, true)
}

func TestBuildPublishWithOverwrite(t *testing.T) {
initArtifactoryTest(t, "")
buildName := tests.RtBuildName1
buildNumber := "1"
preReleaseBuildNumber := "1-rc"
defaultNumberOfBuilds := 5

// Clean old build tests if exists
inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, buildName, artHttpDetails)

// Publish build info without overwrite flag
for i := 0; i < defaultNumberOfBuilds; i++ {
runRt(t, "bp", buildName, buildNumber)
}
for i := 0; i < 2; i++ {
runRt(t, "bp", buildName, preReleaseBuildNumber)
}
publishedBuildInfo, found, err := tests.GetBuildRuns(serverDetails, buildName)
assertNoErrorAndAssertBuildInfoFound(t, err, found)
// Verify if total of 7 build info's are available
assert.Equal(t, 7, len(publishedBuildInfo.BuildsNumbers), "expected five build info's to be available")

buildNumberFrequency := rtBuildInfo.CalculateBuildNumberFrequency(publishedBuildInfo)
// Verify if 5 build info's are available for given build number and 2 for pre-release build number
assert.Equal(t, defaultNumberOfBuilds, buildNumberFrequency[buildNumber])
assert.Equal(t, 2, buildNumberFrequency[preReleaseBuildNumber])

// Publish build info with overwrite flag
runRt(t, "bp", buildName, buildNumber, "--overwrite=true")
publishedBuildInfo, found, err = tests.GetBuildRuns(serverDetails, buildName)
assertNoErrorAndAssertBuildInfoFound(t, err, found)
buildNumbersFrequencyAfterOverwrite := rtBuildInfo.CalculateBuildNumberFrequency(publishedBuildInfo)
// Since overwrite is ran for buildNumber verify if only one build info is available for given build number
assert.Equal(t, 1, buildNumbersFrequencyAfterOverwrite[buildNumber])
// Since overwrite is ran for buildNumber verify no change for preReleaseBuildNumber
assert.Equal(t, 2, buildNumbersFrequencyAfterOverwrite[preReleaseBuildNumber])

// Verify that only one build info is available for given build number with overwrite
runRt(t, "bp", buildName, preReleaseBuildNumber, "--overwrite=true")
publishedBuildInfo, found, err = tests.GetBuildRuns(serverDetails, buildName)
assertNoErrorAndAssertBuildInfoFound(t, err, found)
buildNumbersFrequencyAfterOverwrite = rtBuildInfo.CalculateBuildNumberFrequency(publishedBuildInfo)
// Since overwrite is ran for preReleaseBuildNumber verify no change for buildNumber
assert.Equal(t, 1, buildNumbersFrequencyAfterOverwrite[buildNumber], "expected only one build info to be available")
// Since overwrite is ran for preReleaseBuildNumber verify if only one build info is available for given preReleaseBuildNumber
assert.Equal(t, 1, buildNumbersFrequencyAfterOverwrite[preReleaseBuildNumber])

// Delete existing build info
inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, buildName, artHttpDetails)

// Run build-publish with overwrite flag and build should be published
runRt(t, "bp", buildName, buildNumber, "--overwrite=true")
publishedBuildInfo, found, err = tests.GetBuildRuns(serverDetails, buildName)
// Verify even though overwrite is used when no build infos are available build info should be published
assertBuildNumberOccurrencesForGivenBuildNameAndNumber(t, publishedBuildInfo, 1, found, buildNumber, err)

// Cleanup
inttestutils.DeleteBuild(serverDetails.ArtifactoryUrl, buildName, artHttpDetails)
cleanArtifactoryTest()
}

func assertBuildNumberOccurrencesForGivenBuildNameAndNumber(t *testing.T, existingBuildInfo *buildinfo.BuildRuns,
expectedOccurrences int, found bool, buildNumber string, err error) {

buildNumbersFrequencyAfterOverwrite := rtBuildInfo.CalculateBuildNumberFrequency(existingBuildInfo)
assertNoErrorAndAssertBuildInfoFound(t, err, found)
assert.Equal(t, expectedOccurrences, buildNumbersFrequencyAfterOverwrite[buildNumber], "expected only one build info to be available")
}

func assertNoErrorAndAssertBuildInfoFound(t *testing.T, err error, found bool) {
assert.NoError(t, err)
assert.True(t, found, "build info was expected to be found")
}

func testBuildAddGit(t *testing.T, useEnvBuildNameAndNumber bool) {
initArtifactoryTest(t, "")
gitCollectCliRunner := coretests.NewJfrogCli(execMain, "jfrog rt", "")
Expand Down
4 changes: 2 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -189,11 +189,11 @@ require (
sigs.k8s.io/yaml v1.4.0 // indirect
)

replace github.com/jfrog/jfrog-cli-artifactory => github.com/jfrog/jfrog-cli-artifactory v0.1.13-0.20250212084027-746cc7ae6a63
replace github.com/jfrog/jfrog-cli-artifactory => github.com/jfrog/jfrog-cli-artifactory v0.1.13-0.20250219071539-9bcf054e67db

replace github.com/jfrog/jfrog-cli-core/v2 => github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20250212021126-e5223ab616af

//replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.28.1-0.20250205140905-08198f526976
replace github.com/jfrog/jfrog-client-go => github.com/jfrog/jfrog-client-go v1.28.1-0.20250219065446-e17342f27e44

// replace github.com/jfrog/build-info-go => github.com/jfrog/build-info-go v1.8.9-0.20241220065541-91828d43d8b9

Expand Down
8 changes: 4 additions & 4 deletions go.sum
Original file line number Diff line number Diff line change
Expand Up @@ -185,16 +185,16 @@ github.com/jfrog/gofrog v1.7.6 h1:QmfAiRzVyaI7JYGsB7cxfAJePAZTzFz0gRWZSE27c6s=
github.com/jfrog/gofrog v1.7.6/go.mod h1:ntr1txqNOZtHplmaNd7rS4f8jpA5Apx8em70oYEe7+4=
github.com/jfrog/jfrog-apps-config v1.0.1 h1:mtv6k7g8A8BVhlHGlSveapqf4mJfonwvXYLipdsOFMY=
github.com/jfrog/jfrog-apps-config v1.0.1/go.mod h1:8AIIr1oY9JuH5dylz2S6f8Ym2MaadPLR6noCBO4C22w=
github.com/jfrog/jfrog-cli-artifactory v0.1.13-0.20250212084027-746cc7ae6a63 h1:OaDd/sz00/89jzrrTnCePnjFj0qzPUy5INXSEyR/3Zg=
github.com/jfrog/jfrog-cli-artifactory v0.1.13-0.20250212084027-746cc7ae6a63/go.mod h1:llrtIDDeRoO0MmyT9shlBA74rTlaU0aJYS9JXj72F2Q=
github.com/jfrog/jfrog-cli-artifactory v0.1.13-0.20250219071539-9bcf054e67db h1:I9ywkE/lXJ/1S/0h2jjEWiqIKzWiJszE0VrjoGsorLk=
github.com/jfrog/jfrog-cli-artifactory v0.1.13-0.20250219071539-9bcf054e67db/go.mod h1:EzlrSRtRoEipL+8axXHfgoUgXEoHZMVA6cElS2xK1w8=
github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20250212021126-e5223ab616af h1:XnyhhyARP1YCzYGdhk8ovpyZV+hSchiTGVTuejrZXsI=
github.com/jfrog/jfrog-cli-core/v2 v2.31.1-0.20250212021126-e5223ab616af/go.mod h1:Hx2houXADsNv0eRh4w5XCS2uSsPNPn1OmiSDdwGFB7g=
github.com/jfrog/jfrog-cli-platform-services v1.7.0 h1:u0AOyG4JX3VT7xhEeA9gDpBgW8tYILONpQURtzR3FkI=
github.com/jfrog/jfrog-cli-platform-services v1.7.0/go.mod h1:u3lMRG7XC8MeUy/OPkHkZnsgCMIi0br4sjk2/W1Pm8I=
github.com/jfrog/jfrog-cli-security v1.15.0 h1:TYNIID231X/AivYtptDCF25JyH8qTQht6ISHRfwejL8=
github.com/jfrog/jfrog-cli-security v1.15.0/go.mod h1:WyXj2D0zBfF6gbdufgt/DWGTA0Qr2dyRMwIqr21t0bc=
github.com/jfrog/jfrog-client-go v1.50.0 h1:t7v/zpLkPomHR6ZjVbPQ1WPQJd9IFKESK9Tt6phZz3k=
github.com/jfrog/jfrog-client-go v1.50.0/go.mod h1:xHxwKBjPSUBd/FyCWgusfHmSWKUZTkfOZkTmntC2F5Y=
github.com/jfrog/jfrog-client-go v1.28.1-0.20250219065446-e17342f27e44 h1:Q2S65q8vk4Yb0B95XGCkcJJCUmJoKsDO5w/A1l6guJ8=
github.com/jfrog/jfrog-client-go v1.28.1-0.20250219065446-e17342f27e44/go.mod h1:hDoUcW6LZme83YNFbdSRImV+di1x0GP+Nlw7fctkwtE=
github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
github.com/jszwec/csvutil v1.10.0 h1:upMDUxhQKqZ5ZDCs/wy+8Kib8rZR8I8lOR34yJkdqhI=
Expand Down
7 changes: 6 additions & 1 deletion utils/cliutils/commandsflags.go
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ const (
envExclude = "env-exclude"
buildUrl = "build-url"
Project = "project"
bpOverwrite = "bpOverwrite"

// Unique build-add-dependencies flags
badPrefix = "bad-"
Expand Down Expand Up @@ -743,6 +744,10 @@ var flagsMap = map[string]cli.Flag{
Name: Overwrite,
Usage: "[Default: false] Overwrites the instance configuration if an instance with the same ID already exists.` `",
},
bpOverwrite: cli.BoolFlag{
Name: Overwrite,
Usage: "[Default: false] Overwrites all existing occurrences of build infos with the provided name and number. Build artifacts will not be deleted.` `",
},
BasicAuthOnly: cli.BoolFlag{
Name: BasicAuthOnly,
Usage: "[Default: false] Set to true to disable replacing username and password/API key with an automatically created access token that's refreshed hourly. " +
Expand Down Expand Up @@ -1782,7 +1787,7 @@ var commandFlags = map[string][]string{
},
BuildPublish: {
url, user, password, accessToken, sshPassphrase, sshKeyPath, serverId, buildUrl, bpDryRun,
envInclude, envExclude, InsecureTls, Project, bpDetailedSummary,
envInclude, envExclude, InsecureTls, Project, bpDetailedSummary, bpOverwrite,
},
BuildAppend: {
url, user, password, accessToken, sshPassphrase, sshKeyPath, serverId, buildUrl, bpDryRun,
Expand Down
10 changes: 10 additions & 0 deletions utils/tests/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,16 @@ func GetBuildInfo(serverDetails *config.ServerDetails, buildName, buildNumber st
return servicesManager.GetBuildInfo(params)
}

func GetBuildRuns(serverDetails *config.ServerDetails, buildName string) (pbi *buildinfo.BuildRuns, found bool, err error) {
servicesManager, err := artUtils.CreateServiceManager(serverDetails, -1, 0, false)
if err != nil {
return nil, false, err
}
params := services.NewBuildInfoParams()
params.BuildName = buildName
return servicesManager.GetBuildRuns(params)
}

var reposConfigMap = map[*string]string{
&DistRepo1: DistributionRepoConfig1,
&DistRepo2: DistributionRepoConfig2,
Expand Down
Loading