Update the version-promote command to align with the new API

asafgabai · asafgabai · commit 0dc80f19bccc · 2025-06-11T18:19:32.000+03:00
diff --git a/apptrust/commands/flags.go b/apptrust/commands/flags.go
@@ -42,6 +42,11 @@ const (
 	UserOwnersFlag          = "user-owners"
 	GroupOwnersFlag         = "group-owners"
 	SigningKeyFlag          = "signing-key"
+	SyncFlag                = "sync"
+	PromotionTypeFlag       = "promotion-type"
+	DryRunFlag              = "dry-run"
+	ExcludeReposFlag        = "exclude-repos"
+	IncludeReposFlag        = "include-repos"
 )
 
 // Flag keys mapped to their corresponding components.Flag definition.
@@ -69,6 +74,11 @@ var flagsMap = map[string]components.Flag{
 	UserOwnersFlag:          components.NewStringFlag(UserOwnersFlag, "Comma-separated list of user owners.", func(f *components.StringFlag) { f.Mandatory = false }),
 	GroupOwnersFlag:         components.NewStringFlag(GroupOwnersFlag, "Comma-separated list of group owners.", func(f *components.StringFlag) { f.Mandatory = false }),
 	SigningKeyFlag:          components.NewStringFlag(SigningKeyFlag, "The GPG/RSA key-pair name given in Artifactory.", func(f *components.StringFlag) { f.Mandatory = false }),
+	SyncFlag:                components.NewBoolFlag(SyncFlag, "Whether to synchronize the operation.", components.WithBoolDefaultValueTrue()),
+	PromotionTypeFlag:       components.NewStringFlag(PromotionTypeFlag, "The promotion type. The following values are supported: "+coreutils.ListToText(model.PromotionTypeValues), func(f *components.StringFlag) { f.Mandatory = false; f.DefaultValue = model.PromotionTypeCopy }),
+	DryRunFlag:              components.NewBoolFlag(DryRunFlag, "Perform a simulation of the operation.", components.WithBoolDefaultValueFalse()),
+	ExcludeReposFlag:        components.NewStringFlag(ExcludeReposFlag, "Semicolon-separated list of repositories to exclude.", func(f *components.StringFlag) { f.Mandatory = false }),
+	IncludeReposFlag:        components.NewStringFlag(IncludeReposFlag, "Semicolon-separated list of repositories to include.", func(f *components.StringFlag) { f.Mandatory = false }),
 }
 
 var commandFlags = map[string][]string{
@@ -90,8 +100,11 @@ var commandFlags = map[string][]string{
 		user,
 		accessToken,
 		serverId,
-		ApplicationKeyFlag,
-		StageVarsFlag,
+		SyncFlag,
+		PromotionTypeFlag,
+		DryRunFlag,
+		ExcludeReposFlag,
+		IncludeReposFlag,
 	},
 	DeleteAppVersion: {
 		url,
diff --git a/apptrust/commands/version/promote_app_version_cmd.go b/apptrust/commands/version/promote_app_version_cmd.go
@@ -20,7 +20,10 @@ import (
 type promoteAppVersionCommand struct {
 	versionService versions.VersionService
 	serverDetails  *coreConfig.ServerDetails
+	applicationKey string
+	version        string
 	requestPayload *model.PromoteAppVersionRequest
+	sync           bool
 }
 
 func (pv *promoteAppVersionCommand) Run() error {
@@ -29,7 +32,7 @@ func (pv *promoteAppVersionCommand) Run() error {
 		return err
 	}
 
-	return pv.versionService.PromoteAppVersion(ctx, pv.requestPayload)
+	return pv.versionService.PromoteAppVersion(ctx, pv.applicationKey, pv.version, pv.requestPayload, pv.sync)
 }
 
 func (pv *promoteAppVersionCommand) ServerDetails() (*coreConfig.ServerDetails, error) {
@@ -41,9 +44,17 @@ func (pv *promoteAppVersionCommand) CommandName() string {
 }
 
 func (pv *promoteAppVersionCommand) prepareAndRunCommand(ctx *components.Context) error {
-	if len(ctx.Arguments) != 1 {
+	if len(ctx.Arguments) != 3 {
 		return pluginsCommon.WrongNumberOfArgumentsHandler(ctx)
 	}
+
+	// Extract from arguments
+	pv.applicationKey = ctx.Arguments[0]
+	pv.version = ctx.Arguments[1]
+
+	// Extract sync flag value
+	pv.sync = ctx.GetBoolTFlagValue(commands.SyncFlag)
+
 	serverDetails, err := utils.ServerDetailsByFlags(ctx)
 	if err != nil {
 		return err
@@ -57,10 +68,37 @@ func (pv *promoteAppVersionCommand) prepareAndRunCommand(ctx *components.Context
 }
 
 func (pv *promoteAppVersionCommand) buildRequestPayload(ctx *components.Context) (*model.PromoteAppVersionRequest, error) {
+	stage := ctx.Arguments[2]
+
+	var includedRepos []string
+	var excludedRepos []string
+
+	if includeReposStr := ctx.GetStringFlagValue(commands.IncludeReposFlag); includeReposStr != "" {
+		includedRepos = utils.ParseSliceFlag(includeReposStr)
+	}
+
+	if excludeReposStr := ctx.GetStringFlagValue(commands.ExcludeReposFlag); excludeReposStr != "" {
+		excludedRepos = utils.ParseSliceFlag(excludeReposStr)
+	}
+
+	// Validate promotion type flag
+	promotionType := ctx.GetStringFlagValue(commands.PromotionTypeFlag)
+	validatedPromotionType, err := utils.ValidateEnumFlag(commands.PromotionTypeFlag, promotionType, model.PromotionTypeCopy, model.PromotionTypeValues)
+	if err != nil {
+		return nil, err
+	}
+
+	// If dry-run is true, override with dry_run
+	dryRun := ctx.GetBoolFlagValue(commands.DryRunFlag)
+	if dryRun {
+		validatedPromotionType = model.PromotionTypeDryRun
+	}
+
 	return &model.PromoteAppVersionRequest{
-		ApplicationKey: ctx.GetStringFlagValue(commands.ApplicationKeyFlag),
-		Version:        ctx.Arguments[0],
-		Environment:    ctx.GetStringFlagValue(commands.StageVarsFlag),
+		Stage:                  stage,
+		PromotionType:          validatedPromotionType,
+		IncludedRepositoryKeys: includedRepos,
+		ExcludedRepositoryKeys: excludedRepos,
 	}, nil
 }
 
@@ -73,8 +111,18 @@ func GetPromoteAppVersionCommand(appContext app.Context) components.Command {
 		Aliases:     []string{"vp"},
 		Arguments: []components.Argument{
 			{
-				Name:        "version-name",
-				Description: "The name of the version",
+				Name:        "application-key",
+				Description: "The application key",
+				Optional:    false,
+			},
+			{
+				Name:        "version",
+				Description: "The version to promote",
+				Optional:    false,
+			},
+			{
+				Name:        "target-stage",
+				Description: "The target stage to which the application version should be promoted",
 				Optional:    false,
 			},
 		},
diff --git a/apptrust/commands/version/promote_app_version_cmd_test.go b/apptrust/commands/version/promote_app_version_cmd_test.go
@@ -1,47 +1,100 @@
 package version
 
 import (
+	"errors"
 	"testing"
 
 	"github.com/jfrog/jfrog-cli-application/apptrust/commands"
 	mockversions "github.com/jfrog/jfrog-cli-application/apptrust/service/versions/mocks"
 	"go.uber.org/mock/gomock"
 
 	"github.com/jfrog/jfrog-cli-application/apptrust/model"
-	coreconfig "github.com/jfrog/jfrog-cli-core/v2/utils/config"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
 	"github.com/stretchr/testify/assert"
 )
 
-func TestRun(t *testing.T) {
+func TestPromoteAppVersionCommand_Run(t *testing.T) {
+	tests := []struct {
+		name string
+		sync bool
+	}{
+		{
+			name: "sync flag true",
+			sync: true,
+		},
+		{
+			name: "sync flag false",
+			sync: false,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+
+			serverDetails := &config.ServerDetails{Url: "https://example.com"}
+			applicationKey := "app-key"
+			version := "1.0.0"
+			requestPayload := &model.PromoteAppVersionRequest{
+				Stage: "prod",
+			}
+
+			mockVersionService := mockversions.NewMockVersionService(ctrl)
+			mockVersionService.EXPECT().PromoteAppVersion(gomock.Any(), applicationKey, version, requestPayload, tt.sync).
+				Return(nil).Times(1)
+
+			cmd := &promoteAppVersionCommand{
+				versionService: mockVersionService,
+				serverDetails:  serverDetails,
+				applicationKey: applicationKey,
+				version:        version,
+				requestPayload: requestPayload,
+				sync:           tt.sync,
+			}
+
+			err := cmd.Run()
+			assert.NoError(t, err)
+		})
+	}
+}
+
+func TestPromoteAppVersionCommand_Run_Error(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	defer ctrl.Finish()
 
-	serverDetails := &coreconfig.ServerDetails{}
+	serverDetails := &config.ServerDetails{Url: "https://example.com"}
+	applicationKey := "app-key"
+	version := "1.0.0"
 	requestPayload := &model.PromoteAppVersionRequest{
-		ApplicationKey: "app",
-		Version:        "1.0.0",
-		Environment:    "env",
+		Stage: "prod",
 	}
+	sync := true
+	expectedError := errors.New("service error occurred")
 
 	mockVersionService := mockversions.NewMockVersionService(ctrl)
-	mockVersionService.EXPECT().PromoteAppVersion(gomock.Any(), requestPayload).
-		Return(nil).Times(1)
+	mockVersionService.EXPECT().PromoteAppVersion(gomock.Any(), applicationKey, version, requestPayload, sync).
+		Return(expectedError).Times(1)
 
 	cmd := &promoteAppVersionCommand{
 		versionService: mockVersionService,
 		serverDetails:  serverDetails,
+		applicationKey: applicationKey,
+		version:        version,
 		requestPayload: requestPayload,
+		sync:           sync,
 	}
 
 	err := cmd.Run()
-	assert.NoError(t, err)
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "service error occurred")
 }
 
-func TestServerDetails(t *testing.T) {
+func TestPromoteAppVersionCommand_ServerDetails(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	defer ctrl.Finish()
 
-	serverDetails := &coreconfig.ServerDetails{}
+	serverDetails := &config.ServerDetails{}
 	cmd := &promoteAppVersionCommand{
 		serverDetails: serverDetails,
 	}
@@ -51,7 +104,7 @@ func TestServerDetails(t *testing.T) {
 	assert.Equal(t, serverDetails, details)
 }
 
-func TestCommandName(t *testing.T) {
+func TestPromoteAppVersionCommand_CommandName(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	defer ctrl.Finish()
 
diff --git a/apptrust/model/promote_app_version_request.go b/apptrust/model/promote_app_version_request.go
@@ -1,7 +1,23 @@
 package model
 
+const (
+	PromotionTypeCopy = "copy"
+	PromotionTypeMove = "move"
+
+	// This is not a valid value for the --promotion-type flag, but is passed to the API if the --dry-run flag is set.
+	PromotionTypeDryRun = "dry_run"
+)
+
+var (
+	PromotionTypeValues = []string{
+		PromotionTypeCopy,
+		PromotionTypeMove,
+	}
+)
+
 type PromoteAppVersionRequest struct {
-	ApplicationKey string `json:"application_key"`
-	Version        string `json:"version"`
-	Environment    string `json:"environment"`
+	Stage                  string   `json:"stage"`
+	PromotionType          string   `json:"promotion_type,omitempty"`
+	IncludedRepositoryKeys []string `json:"included_repository_keys,omitempty"`
+	ExcludedRepositoryKeys []string `json:"excluded_repository_keys,omitempty"`
 }
diff --git a/apptrust/service/versions/version_service.go b/apptrust/service/versions/version_service.go
@@ -4,15 +4,15 @@ package versions
 
 import (
 	"fmt"
-
 	"github.com/jfrog/jfrog-cli-application/apptrust/service"
+	"strconv"
 
 	"github.com/jfrog/jfrog-cli-application/apptrust/model"
 )
 
 type VersionService interface {
 	CreateAppVersion(ctx service.Context, request *model.CreateAppVersionRequest) error
-	PromoteAppVersion(ctx service.Context, payload *model.PromoteAppVersionRequest) error
+	PromoteAppVersion(ctx service.Context, applicationKey string, version string, payload *model.PromoteAppVersionRequest, sync bool) error
 	DeleteAppVersion(ctx service.Context, applicationKey string, version string) error
 }
 
@@ -36,8 +36,9 @@ func (vs *versionService) CreateAppVersion(ctx service.Context, request *model.C
 	return nil
 }
 
-func (vs *versionService) PromoteAppVersion(ctx service.Context, payload *model.PromoteAppVersionRequest) error {
-	response, responseBody, err := ctx.GetHttpClient().Post("/v1/applications/version/promote", payload)
+func (vs *versionService) PromoteAppVersion(ctx service.Context, applicationKey, version string, request *model.PromoteAppVersionRequest, sync bool) error {
+	endpoint := fmt.Sprintf("/v1/applications/%s/versions/%s/promote?async=%s", applicationKey, version, strconv.FormatBool(!sync))
+	response, responseBody, err := ctx.GetHttpClient().Post(endpoint, request)
 	if err != nil {
 		return err
 	}
@@ -50,7 +51,7 @@ func (vs *versionService) PromoteAppVersion(ctx service.Context, payload *model.
 	return nil
 }
 
-func (vs *versionService) DeleteAppVersion(ctx service.Context, applicationKey string, version string) error {
+func (vs *versionService) DeleteAppVersion(ctx service.Context, applicationKey, version string) error {
 	url := fmt.Sprintf("/v1/applications/%s/versions/%s", applicationKey, version)
 	response, responseBody, err := ctx.GetHttpClient().Delete(url, nil)
 	if err != nil {
diff --git a/apptrust/service/versions/version_service_test.go b/apptrust/service/versions/version_service_test.go
