UseAppDockerConfigForPrivateRegistries in workflow request

prakash100198 · prakash100198 · commit c88eca83a66f · 2024-08-30T16:55:04.000+05:30
diff --git a/pkg/pipeline/CiService.go b/pkg/pipeline/CiService.go
@@ -158,21 +158,31 @@ func (impl *CiServiceImpl) GetCiMaterials(pipelineId int, ciMaterials []*pipelin
 	}
 }
 
-func (impl *CiServiceImpl) handleRuntimeParamsValidations(trigger types.Trigger, ciMaterials []*pipelineConfig.CiPipelineMaterial) error {
+func (impl *CiServiceImpl) handleRuntimeParamsValidations(trigger types.Trigger, ciMaterials []*pipelineConfig.CiPipelineMaterial) (bool, error) {
+	var useAppDockerConfigForPrivateRegistries bool
+	var err error
 	// checking if user has given run time parameters for externalCiArtifact, if given then sending git material to Ci-Runner
 	externalCiArtifact, exists := trigger.ExtraEnvironmentVariables[CiPipeline.ExtraEnvVarExternalCiArtifactKey]
 	// validate externalCiArtifact as docker image
 	if exists {
 		if !strings.Contains(externalCiArtifact, ":") {
 			impl.Logger.Errorw("validation error", "externalCiArtifact", externalCiArtifact)
-			return fmt.Errorf("invalid image name given in externalCiArtifact")
+			return useAppDockerConfigForPrivateRegistries, fmt.Errorf("invalid image name given in externalCiArtifact")
+		}
+		useAppBuildConfig, ok := trigger.ExtraEnvironmentVariables[CiPipeline.ExtraEnvVarUseAppDockerConfig]
+		if ok && len(useAppBuildConfig) > 0 {
+			useAppDockerConfigForPrivateRegistries, err = strconv.ParseBool(useAppBuildConfig)
+			if err != nil {
+				impl.Logger.Errorw("error in parsing useAppBuildConfig string data to bool", "err", err)
+				return useAppDockerConfigForPrivateRegistries, fmt.Errorf("error in parsing useAppBuildConfig string data to bool, err:- %v", err)
+			}
 		}
 	}
 	if trigger.PipelineType == string(CiPipeline.CI_JOB) && len(ciMaterials) != 0 && !exists && externalCiArtifact == "" {
 		ciMaterials[0].GitMaterial = nil
 		ciMaterials[0].GitMaterialId = 0
 	}
-	return nil
+	return useAppDockerConfigForPrivateRegistries, nil
 }
 
 func (impl *CiServiceImpl) TriggerCiPipeline(trigger types.Trigger) (int, error) {
@@ -181,7 +191,7 @@ func (impl *CiServiceImpl) TriggerCiPipeline(trigger types.Trigger) (int, error)
 	if err != nil {
 		return 0, err
 	}
-	err = impl.handleRuntimeParamsValidations(trigger, ciMaterials)
+	useAppDockerConfigForPrivateRegistries, err := impl.handleRuntimeParamsValidations(trigger, ciMaterials)
 	if err != nil {
 		return 0, err
 	}
@@ -265,6 +275,7 @@ func (impl *CiServiceImpl) TriggerCiPipeline(trigger types.Trigger) (int, error)
 		impl.Logger.Errorw("make workflow req", "err", err)
 		return 0, err
 	}
+	workflowRequest.UseAppDockerConfigForPrivateRegistries = useAppDockerConfigForPrivateRegistries
 	workflowRequest.Scope = scope
 	workflowRequest.BuildxCacheModeMin = impl.buildxCacheFlags.BuildxCacheModeMin
 	workflowRequest.AsyncBuildxCacheExport = impl.buildxCacheFlags.AsyncBuildxCacheExport
diff --git a/pkg/pipeline/bean/CiPipeline/CiBuildConfig.go b/pkg/pipeline/bean/CiPipeline/CiBuildConfig.go
@@ -89,4 +89,5 @@ func (pType PipelineType) IsValidPipelineType() bool {
 const (
 	ExtraEnvVarExternalCiArtifactKey = "externalCiArtifact"
 	ExtraEnvVarImageDigestKey        = "imageDigest"
+	ExtraEnvVarUseAppDockerConfig    = "useAppDockerConfig"
 )
diff --git a/pkg/pipeline/types/Workflow.go b/pkg/pipeline/types/Workflow.go
@@ -113,38 +113,39 @@ type WorkflowRequest struct {
 	ImageRetryCount            int                               `json:"imageRetryCount"`
 	ImageRetryInterval         int                               `json:"imageRetryInterval"`
 	// Data from CD Workflow service
-	WorkflowRunnerId            int                                  `json:"workflowRunnerId"`
-	CdPipelineId                int                                  `json:"cdPipelineId"`
-	StageYaml                   string                               `json:"stageYaml"`
-	ArtifactLocation            string                               `json:"artifactLocation"`
-	CiArtifactDTO               CiArtifactDTO                        `json:"ciArtifactDTO"`
-	CdImage                     string                               `json:"cdImage"`
-	StageType                   string                               `json:"stageType"`
-	CdCacheLocation             string                               `json:"cdCacheLocation"`
-	CdCacheRegion               string                               `json:"cdCacheRegion"`
-	WorkflowPrefixForLog        string                               `json:"workflowPrefixForLog"`
-	DeploymentTriggeredBy       string                               `json:"deploymentTriggeredBy,omitempty"`
-	DeploymentTriggerTime       time.Time                            `json:"deploymentTriggerTime,omitempty"`
-	DeploymentReleaseCounter    int                                  `json:"deploymentReleaseCounter,omitempty"`
-	WorkflowExecutor            pipelineConfig.WorkflowExecutorType  `json:"workflowExecutor"`
-	PrePostDeploySteps          []*bean.StepObject                   `json:"prePostDeploySteps"`
-	CiArtifactLastFetch         time.Time                            `json:"ciArtifactLastFetch"`
-	CiPipelineType              string                               `json:"ciPipelineType"`
-	UseExternalClusterBlob      bool                                 `json:"useExternalClusterBlob"`
-	RegistryDestinationImageMap map[string][]string                  `json:"registryDestinationImageMap"`
-	RegistryCredentialMap       map[string]bean4.RegistryCredentials `json:"registryCredentialMap"`
-	PluginArtifactStage         string                               `json:"pluginArtifactStage"`
-	PushImageBeforePostCI       bool                                 `json:"pushImageBeforePostCI"`
-	ImageScanMaxRetries         int                                  `json:"imageScanMaxRetries,omitempty"`
-	ImageScanRetryDelay         int                                  `json:"imageScanRetryDelay,omitempty"`
-	Type                        bean.WorkflowPipelineType
-	Pipeline                    *pipelineConfig.Pipeline
-	Env                         *repository.Environment
-	AppLabels                   map[string]string
-	Scope                       resourceQualifiers.Scope
-	BuildxCacheModeMin          bool `json:"buildxCacheModeMin"`
-	AsyncBuildxCacheExport      bool `json:"asyncBuildxCacheExport"`
-	UseDockerApiToGetDigest     bool `json:"useDockerApiToGetDigest"`
+	WorkflowRunnerId                       int                                  `json:"workflowRunnerId"`
+	CdPipelineId                           int                                  `json:"cdPipelineId"`
+	StageYaml                              string                               `json:"stageYaml"`
+	ArtifactLocation                       string                               `json:"artifactLocation"`
+	CiArtifactDTO                          CiArtifactDTO                        `json:"ciArtifactDTO"`
+	CdImage                                string                               `json:"cdImage"`
+	StageType                              string                               `json:"stageType"`
+	CdCacheLocation                        string                               `json:"cdCacheLocation"`
+	CdCacheRegion                          string                               `json:"cdCacheRegion"`
+	WorkflowPrefixForLog                   string                               `json:"workflowPrefixForLog"`
+	DeploymentTriggeredBy                  string                               `json:"deploymentTriggeredBy,omitempty"`
+	DeploymentTriggerTime                  time.Time                            `json:"deploymentTriggerTime,omitempty"`
+	DeploymentReleaseCounter               int                                  `json:"deploymentReleaseCounter,omitempty"`
+	WorkflowExecutor                       pipelineConfig.WorkflowExecutorType  `json:"workflowExecutor"`
+	PrePostDeploySteps                     []*bean.StepObject                   `json:"prePostDeploySteps"`
+	CiArtifactLastFetch                    time.Time                            `json:"ciArtifactLastFetch"`
+	CiPipelineType                         string                               `json:"ciPipelineType"`
+	UseExternalClusterBlob                 bool                                 `json:"useExternalClusterBlob"`
+	RegistryDestinationImageMap            map[string][]string                  `json:"registryDestinationImageMap"`
+	RegistryCredentialMap                  map[string]bean4.RegistryCredentials `json:"registryCredentialMap"`
+	PluginArtifactStage                    string                               `json:"pluginArtifactStage"`
+	PushImageBeforePostCI                  bool                                 `json:"pushImageBeforePostCI"`
+	ImageScanMaxRetries                    int                                  `json:"imageScanMaxRetries,omitempty"`
+	ImageScanRetryDelay                    int                                  `json:"imageScanRetryDelay,omitempty"`
+	Type                                   bean.WorkflowPipelineType
+	Pipeline                               *pipelineConfig.Pipeline
+	Env                                    *repository.Environment
+	AppLabels                              map[string]string
+	Scope                                  resourceQualifiers.Scope
+	BuildxCacheModeMin                     bool `json:"buildxCacheModeMin"`
+	AsyncBuildxCacheExport                 bool `json:"asyncBuildxCacheExport"`
+	UseDockerApiToGetDigest                bool `json:"useDockerApiToGetDigest"`
+	UseAppDockerConfigForPrivateRegistries bool `json:"useAppDockerConfigForPrivateRegistries"`
 }
 
 func (workflowRequest *WorkflowRequest) updateExternalRunMetadata() {

Original file line number	Diff line number	Diff line change
`@@ -158,21 +158,31 @@ func (impl CiServiceImpl) GetCiMaterials(pipelineId int, ciMaterials []pipelin`
`158`	`158`	`}`
`159`	`159`	`}`
`160`	`160`
`161`		`-func (impl CiServiceImpl) handleRuntimeParamsValidations(trigger types.Trigger, ciMaterials []pipelineConfig.CiPipelineMaterial) error {`
	`161`	`+func (impl CiServiceImpl) handleRuntimeParamsValidations(trigger types.Trigger, ciMaterials []pipelineConfig.CiPipelineMaterial) (bool, error) {`
	`162`	`+ var useAppDockerConfigForPrivateRegistries bool`
	`163`	`+ var err error`
`162`	`164`	`// checking if user has given run time parameters for externalCiArtifact, if given then sending git material to Ci-Runner`
`163`	`165`	`externalCiArtifact, exists := trigger.ExtraEnvironmentVariables[CiPipeline.ExtraEnvVarExternalCiArtifactKey]`
`164`	`166`	`// validate externalCiArtifact as docker image`
`165`	`167`	`if exists {`
`166`	`168`	`if !strings.Contains(externalCiArtifact, ":") {`
`167`	`169`	`impl.Logger.Errorw("validation error", "externalCiArtifact", externalCiArtifact)`
`168`		`- return fmt.Errorf("invalid image name given in externalCiArtifact")`
	`170`	`+ return useAppDockerConfigForPrivateRegistries, fmt.Errorf("invalid image name given in externalCiArtifact")`
	`171`	`+ }`
	`172`	`+ useAppBuildConfig, ok := trigger.ExtraEnvironmentVariables[CiPipeline.ExtraEnvVarUseAppDockerConfig]`
	`173`	`+ if ok && len(useAppBuildConfig) > 0 {`
	`174`	`+ useAppDockerConfigForPrivateRegistries, err = strconv.ParseBool(useAppBuildConfig)`
	`175`	`+ if err != nil {`
	`176`	`+ impl.Logger.Errorw("error in parsing useAppBuildConfig string data to bool", "err", err)`
	`177`	`+ return useAppDockerConfigForPrivateRegistries, fmt.Errorf("error in parsing useAppBuildConfig string data to bool, err:- %v", err)`
	`178`	`+ }`
`169`	`179`	`}`
`170`	`180`	`}`
`171`	`181`	`if trigger.PipelineType == string(CiPipeline.CI_JOB) && len(ciMaterials) != 0 && !exists && externalCiArtifact == "" {`
`172`	`182`	`ciMaterials[0].GitMaterial = nil`
`173`	`183`	`ciMaterials[0].GitMaterialId = 0`
`174`	`184`	`}`
`175`		`- return nil`
	`185`	`+ return useAppDockerConfigForPrivateRegistries, nil`
`176`	`186`	`}`
`177`	`187`
`178`	`188`	`func (impl *CiServiceImpl) TriggerCiPipeline(trigger types.Trigger) (int, error) {`
`@@ -181,7 +191,7 @@ func (impl *CiServiceImpl) TriggerCiPipeline(trigger types.Trigger) (int, error)`
`181`	`191`	`if err != nil {`
`182`	`192`	`return 0, err`
`183`	`193`	`}`
`184`		`- err = impl.handleRuntimeParamsValidations(trigger, ciMaterials)`
	`194`	`+ useAppDockerConfigForPrivateRegistries, err := impl.handleRuntimeParamsValidations(trigger, ciMaterials)`
`185`	`195`	`if err != nil {`
`186`	`196`	`return 0, err`
`187`	`197`	`}`
`@@ -265,6 +275,7 @@ func (impl *CiServiceImpl) TriggerCiPipeline(trigger types.Trigger) (int, error)`
`265`	`275`	`impl.Logger.Errorw("make workflow req", "err", err)`
`266`	`276`	`return 0, err`
`267`	`277`	`}`
	`278`	`+ workflowRequest.UseAppDockerConfigForPrivateRegistries = useAppDockerConfigForPrivateRegistries`
`268`	`279`	`workflowRequest.Scope = scope`
`269`	`280`	`workflowRequest.BuildxCacheModeMin = impl.buildxCacheFlags.BuildxCacheModeMin`
`270`	`281`	`workflowRequest.AsyncBuildxCacheExport = impl.buildxCacheFlags.AsyncBuildxCacheExport`
Original file line number	Diff line number	Diff line change
`@@ -89,4 +89,5 @@ func (pType PipelineType) IsValidPipelineType() bool {`
`89`	`89`	`const (`
`90`	`90`	`ExtraEnvVarExternalCiArtifactKey = "externalCiArtifact"`
`91`	`91`	`ExtraEnvVarImageDigestKey = "imageDigest"`
	`92`	`+ ExtraEnvVarUseAppDockerConfig = "useAppDockerConfig"`
`92`	`93`	`)`