Refactor PromoteAppVersionRequest to use CommonPromoteAppVersion for improved structure and readability

Author: EyalDelarea

apptrust/commands/version/promote_app_version_cmd.go

@@ -81,11 +81,13 @@ func (pv *promoteAppVersionCommand) buildRequestPayload(ctx *components.Context)
 	}
 
 	return &model.PromoteAppVersionRequest{
-		Stage:                        stage,
-		PromotionType:                promotionType,
-		IncludedRepositoryKeys:       includedRepos,
-		ExcludedRepositoryKeys:       excludedRepos,
-		ArtifactAdditionalProperties: artifactProps,
+		Stage: stage,
+		CommonPromoteAppVersion: model.CommonPromoteAppVersion{
+			PromotionType:                promotionType,
+			IncludedRepositoryKeys:       includedRepos,
+			ExcludedRepositoryKeys:       excludedRepos,
+			ArtifactAdditionalProperties: artifactProps,
+		},
 	}, nil
 }
 

apptrust/commands/version/promote_app_version_cmd_test.go

@@ -68,10 +68,11 @@ func TestPromoteAppVersionCommand_Run_Error(t *testing.T) {
 	requestPayload := &model.PromoteAppVersionRequest{
 		Stage: "prod",
 	}
+	sync := true
 	expectedError := errors.New("service error occurred")
 
 	mockVersionService := mockversions.NewMockVersionService(ctrl)
-	mockVersionService.EXPECT().PromoteAppVersion(gomock.Any(), applicationKey, version, requestPayload, false).
+	mockVersionService.EXPECT().PromoteAppVersion(gomock.Any(), applicationKey, version, requestPayload, sync).
 		Return(expectedError).Times(1)
 
 	cmd := &promoteAppVersionCommand{
@@ -80,7 +81,7 @@ func TestPromoteAppVersionCommand_Run_Error(t *testing.T) {
 		applicationKey: applicationKey,
 		version:        version,
 		requestPayload: requestPayload,
-		sync:           false,
+		sync:           sync,
 	}
 
 	err := cmd.Run()

apptrust/model/promote_app_version_request.go

@@ -14,10 +14,14 @@ var PromotionTypeValues = []string{
 	PromotionTypeMove,
 }
 
-type PromoteAppVersionRequest struct {
-	Stage                        string            `json:"stage"`
+type CommonPromoteAppVersion struct {
 	PromotionType                string            `json:"promotion_type,omitempty"`
 	IncludedRepositoryKeys       []string          `json:"included_repository_keys,omitempty"`
 	ExcludedRepositoryKeys       []string          `json:"excluded_repository_keys,omitempty"`
 	ArtifactAdditionalProperties map[string]string `json:"artifact_additional_properties,omitempty"`
 }
+
+type PromoteAppVersionRequest struct {
+	CommonPromoteAppVersion
+	Stage string `json:"stage"`
+}

apptrust/model/release_app_version_request.go

@@ -1,22 +1,24 @@
 package model
 
-const (
-	ReleaseStage = "PROD"
-)
-
+// ReleaseAppVersionRequest represents a request to release an application version to production.
+// This struct reuses CommonPromoteAppVersion for consistency with PromoteAppVersionRequest.
+// A release is functionally promoted with a hardcoded stage ("prod") set by the backend,
+// so the stage is not included here.
+// This separation improves readability and intent in the codebase.
 type ReleaseAppVersionRequest struct {
-	PromoteAppVersionRequest
+	CommonPromoteAppVersion
 }
 
+// NewReleaseAppVersionRequest constructs a ReleaseAppVersionRequest.
+// The provided parameters are identical to those used for promotion, but the stage is always production.
 func NewReleaseAppVersionRequest(
 	promotionType string,
 	includedRepositoryKeys []string,
 	excludedRepositoryKeys []string,
 	artifactProperties map[string]string,
 ) *ReleaseAppVersionRequest {
 	return &ReleaseAppVersionRequest{
-		PromoteAppVersionRequest: PromoteAppVersionRequest{
-			Stage:                        ReleaseStage,
+		CommonPromoteAppVersion: CommonPromoteAppVersion{
 			PromotionType:                promotionType,
 			IncludedRepositoryKeys:       includedRepositoryKeys,
 			ExcludedRepositoryKeys:       excludedRepositoryKeys,

apptrust/service/versions/version_service_test.go

@@ -97,10 +97,12 @@ func TestPromoteAppVersion(t *testing.T) {
 			applicationKey: "test-app",
 			version:        "1.0.0",
 			payload: &model.PromoteAppVersionRequest{
-				Stage:                  "prod",
-				PromotionType:          model.PromotionTypeCopy,
-				IncludedRepositoryKeys: []string{"repo1", "repo2"},
-				ExcludedRepositoryKeys: []string{"repo3"},
+				Stage: "prod",
+				CommonPromoteAppVersion: model.CommonPromoteAppVersion{
+					PromotionType:          model.PromotionTypeCopy,
+					IncludedRepositoryKeys: []string{"repo1", "repo2"},
+					ExcludedRepositoryKeys: []string{"repo3"},
+				},
 			},
 			sync:             true,
 			expectedEndpoint: "/v1/applications/test-app/versions/1.0.0/promote",
@@ -114,10 +116,12 @@ func TestPromoteAppVersion(t *testing.T) {
 			applicationKey: "test-app",
 			version:        "1.0.0",
 			payload: &model.PromoteAppVersionRequest{
-				Stage:                  "prod",
-				PromotionType:          model.PromotionTypeCopy,
-				IncludedRepositoryKeys: []string{"repo1", "repo2"},
-				ExcludedRepositoryKeys: []string{"repo3"},
+				Stage: "prod",
+				CommonPromoteAppVersion: model.CommonPromoteAppVersion{
+					PromotionType:          model.PromotionTypeCopy,
+					IncludedRepositoryKeys: []string{"repo1", "repo2"},
+					ExcludedRepositoryKeys: []string{"repo3"},
+				},
 			},
 			sync:             false,
 			expectedEndpoint: "/v1/applications/test-app/versions/1.0.0/promote",
@@ -131,8 +135,10 @@ func TestPromoteAppVersion(t *testing.T) {
 			applicationKey: "test-app",
 			version:        "1.0.0",
 			payload: &model.PromoteAppVersionRequest{
-				Stage:         "prod",
-				PromotionType: model.PromotionTypeCopy,
+				Stage: "prod",
+				CommonPromoteAppVersion: model.CommonPromoteAppVersion{
+					PromotionType: model.PromotionTypeCopy,
+				},
 			},
 			sync:             true,
 			expectedEndpoint: "/v1/applications/test-app/versions/1.0.0/promote",
@@ -146,8 +152,10 @@ func TestPromoteAppVersion(t *testing.T) {
 			applicationKey: "test-app",
 			version:        "1.0.0",
 			payload: &model.PromoteAppVersionRequest{
-				Stage:         "prod",
-				PromotionType: model.PromotionTypeCopy,
+				Stage: "prod",
+				CommonPromoteAppVersion: model.CommonPromoteAppVersion{
+					PromotionType: model.PromotionTypeCopy,
+				},
 			},
 			sync:             false,
 			expectedEndpoint: "/v1/applications/test-app/versions/1.0.0/promote",