create a new API to download artifacts from a PipelineRun

kubesphere · JohnNiang · Mar 18, 2022 · Feb 27, 2022 · Feb 27, 2022 · Feb 28, 2022
commit 2f4c6f47ee02c836d3e2f021edc3a62d3bb5d70d
diff --git a/pkg/kapis/devops/v1alpha2/devops.go b/pkg/kapis/devops/v1alpha2/devops.go
@@ -907,3 +907,33 @@ func parseErr(err error, resp *restful.Response) {
 	}
 	return
 }
+
+// downloadArtifact API to download artifacts from Jenkins
+func (h *ProjectPipelineHandler) downloadArtifact(request *restful.Request, response *restful.Response) {
+	projectName := request.PathParameter("devops")
+	pipelineName := request.PathParameter("pipeline")
+	runId := request.PathParameter("run")
+	fileName := request.QueryParameter("filename")
+
+	artifactUrl := fmt.Sprintf("/job/%s/job/%s/%s/artifact/%s", projectName, pipelineName, runId, fileName)
+	statusCode, body, err := h.jenkinsClient.Request(http.MethodGet, artifactUrl, nil, nil)
+	if err != nil {
+		kapis.HandleError(request, response, err)
+		return
+	}
+
+	if statusCode != http.StatusOK {
+		err := fmt.Errorf("failed to get artifact. The HTTP status code is %d", statusCode)
+		kapis.HandleError(request, response, err)
+		return
+	}
+
+	// add download header
+	response.AddHeader("Content-Type", "application/octet-stream")
+	response.AddHeader("Content-Disposition", fmt.Sprintf("attachment; filename=%s", fileName))
+	_, err = response.Write(body)
+	if err != nil {
+		kapis.HandleError(request, response, err)
+		return
+	}
+}
diff --git a/pkg/kapis/devops/v1alpha2/handler.go b/pkg/kapis/devops/v1alpha2/handler.go
@@ -17,6 +17,7 @@ limitations under the License.
 package v1alpha2
 
 import (
+	"github.com/jenkins-zh/jenkins-client/pkg/core"
 	"kubesphere.io/devops/pkg/client/clientset/versioned"
 	devopsClient "kubesphere.io/devops/pkg/client/devops"
 	"kubesphere.io/devops/pkg/client/informers/externalversions"
@@ -30,18 +31,20 @@ type ProjectPipelineHandler struct {
 	k8sClient               k8s.Client
 	devopsOperator          devops.DevopsOperator
 	projectCredentialGetter devops.ProjectCredentialGetter
+	jenkinsClient           core.JenkinsCore
 }
 
 type PipelineSonarHandler struct {
 	k8sClient           k8s.Client
 	pipelineSonarGetter devops.PipelineSonarGetter
 }
 
-func NewProjectPipelineHandler(devopsClient devopsClient.Interface, k8sClient k8s.Client) ProjectPipelineHandler {
+func NewProjectPipelineHandler(devopsClient devopsClient.Interface, k8sClient k8s.Client, jenkinsClient core.JenkinsCore) ProjectPipelineHandler {
 	return ProjectPipelineHandler{
 		devopsOperator:          devops.NewDevopsOperator(devopsClient, k8sClient.Kubernetes(), k8sClient.KubeSphere()),
 		projectCredentialGetter: devops.NewProjectCredentialOperator(devopsClient),
 		k8sClient:               k8sClient,
+		jenkinsClient:           jenkinsClient,
 	}
 }
 

diff --git a/pkg/kapis/devops/v1alpha2/register.go b/pkg/kapis/devops/v1alpha2/register.go
@@ -70,7 +70,7 @@ func AddToContainer(container *restful.Container, ksInformers externalversions.S
 func addToContainerWithWebService(container *restful.Container, ksInformers externalversions.SharedInformerFactory,
 	devopsClient devops.Interface, sonarqubeClient sonarqube.SonarInterface, ksClient versioned.Interface,
 	s3Client s3.Interface, endpoint string, k8sClient k8s.Client, jenkinsClient core.JenkinsCore, ws *restful.WebService) error {
-	err := AddPipelineToWebService(ws, devopsClient, k8sClient)
+	err := AddPipelineToWebService(ws, devopsClient, k8sClient, jenkinsClient)
 	if err != nil {
 		return err
 	}
@@ -94,11 +94,11 @@ func addToContainerWithWebService(container *restful.Container, ksInformers exte
 	return nil
 }
 
-func AddPipelineToWebService(webservice *restful.WebService, devopsClient devops.Interface, k8sClient k8s.Client) error {
+func AddPipelineToWebService(webservice *restful.WebService, devopsClient devops.Interface, k8sClient k8s.Client, jenkinsClient core.JenkinsCore) error {
 	projectPipelineEnable := devopsClient != nil
 
 	if projectPipelineEnable {
-		projectPipelineHandler := NewProjectPipelineHandler(devopsClient, k8sClient)
+		projectPipelineHandler := NewProjectPipelineHandler(devopsClient, k8sClient, jenkinsClient)
 
 		webservice.Route(webservice.GET("/devops/{devops}/credentials/{credential}/usage").
 			To(projectPipelineHandler.GetProjectCredentialUsage).
@@ -653,6 +653,26 @@ func AddPipelineToWebService(webservice *restful.WebService, devopsClient devops
 			Reads(devops.ReqJenkinsfile{}).
 			Returns(http.StatusOK, api.StatusOK, map[string]interface{}{}).
 			Writes(map[string]interface{}{}))
+
+		webservice.Route(webservice.GET("/devops/{devops}/pipelines/{pipeline}/runs/{run}").
+			To(projectPipelineHandler.GetPipelineRun).
+			Metadata(restfulspec.KeyOpenAPITags, []string{constants.DevOpsPipelineTag}).
+			Doc("Get details in the specified pipeline activity.").
+			Param(webservice.PathParameter("devops", "the name of devops project")).
+			Param(webservice.PathParameter("pipeline", "the name of the CI/CD pipeline")).
+			Param(webservice.PathParameter("run", "pipeline run ID, the unique ID for a pipeline once build.")).
+			Returns(http.StatusOK, api.StatusOK, devops.PipelineRun{}).
+			Writes(devops.PipelineRun{}))
+
+		// download PipelineRun artifact
+		webservice.Route(webservice.GET("/devops/{devops}/pipelines/{pipeline}/artifact/runs/{run}").
+			Param(webservice.PathParameter("devops", "DevOps project's ID, e.g. project-RRRRAzLBlLEm")).
+			Param(webservice.PathParameter("pipeline", "the name of the CI/CD pipeline")).
+			Param(webservice.PathParameter("run", "pipeline run ID, the unique ID for a pipeline once build.")).
+			Param(webservice.QueryParameter("filename", "artifact filename. e.g. artifact:v1.0.1")).
+			To(projectPipelineHandler.downloadArtifact).
+			Returns(http.StatusOK, api.StatusOK, nil).
+			Metadata(restfulspec.KeyOpenAPITags, []string{constants.DevOpsPipelineTag}))
 	}
 	return nil
 }
@@ -725,6 +745,7 @@ func addJenkinsToContainer(webservice *restful.WebService, devopsClient devops.I
 		To(jenkinsProxy.proxyWithDevOps).
 		Returns(http.StatusOK, api.StatusOK, nil).
 		Metadata(restfulspec.KeyOpenAPITags, []string{constants.DevOpsJenkinsTag}))
+
 	return nil
 }
 

diff --git a/pkg/kapis/devops/v1alpha2/register_test.go b/pkg/kapis/devops/v1alpha2/register_test.go
@@ -209,6 +209,12 @@ func TestAPIsExist(t *testing.T) {
 			method: http.MethodPost,
 			uri:    "/tojenkinsfile",
 		},
+	}, {
+		name: "artifact download",
+		args: args{
+			method: http.MethodGet,
+			uri:    "/devops/fake/pipelines/fake/artifact/runs/fake",
+		},
 	}}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {