feat(runner): Integrate runner for CircleCI builds (#437)

Signed-off-by: Mattia Buccarella <[email protected]>

Author: buccarel

app/cli/internal/action/workflow_run_list.go

@@ -116,6 +116,7 @@ func humanizedRunnerType(in v1.CraftingSchema_Runner_RunnerType) string {
 		*v1.CraftingSchema_Runner_GITLAB_PIPELINE.Enum():         "GitLab",
 		*v1.CraftingSchema_Runner_AZURE_PIPELINE.Enum():          "Azure Pipeline",
 		*v1.CraftingSchema_Runner_JENKINS_JOB.Enum():             "Jenkins Job",
+		*v1.CraftingSchema_Runner_CIRCLECI_BUILD.Enum():          "CircleCI Build",
 	}
 
 	hrt, ok := mapping[in]

app/cli/internal/action/workflow_run_list_test.go

@@ -52,6 +52,10 @@ func (s *workflowRunListSuite) TestHumanizedRunnerType() {
 			name:           "jenkins runner",
 			testInput:      v1.CraftingSchema_Runner_JENKINS_JOB,
 			expectedOutput: "Jenkins Job",
+		}, {
+			name:           "circleci runner",
+			testInput:      v1.CraftingSchema_Runner_CIRCLECI_BUILD,
+			expectedOutput: "CircleCI Build",
 		}, {
 			name:           "unknown runner",
 			testInput:      -34,

app/controlplane/api/gen/frontend/workflowcontract/v1/crafting_schema.ts

@@ -45,6 +45,7 @@ message CraftingSchema {
       GITLAB_PIPELINE = 2;
       AZURE_PIPELINE = 3;
       JENKINS_JOB = 4;
+      CIRCLECI_BUILD = 5;
     }
   }
 

app/controlplane/api/workflowcontract/v1/crafting_schema.pb.go

@@ -39,14 +39,16 @@ type supportedRunner interface {
 func NewRunner(t schemaapi.CraftingSchema_Runner_RunnerType) supportedRunner {
 	switch t {
 	case schemaapi.CraftingSchema_Runner_GITHUB_ACTION:
-		return &runners.GitHubAction{}
+		return runners.NewGithubAction()
 	case schemaapi.CraftingSchema_Runner_GITLAB_PIPELINE:
-		return &runners.GitlabPipeline{}
+		return runners.NewGitlabPipeline()
 	case schemaapi.CraftingSchema_Runner_AZURE_PIPELINE:
-		return &runners.AzurePipeline{}
+		return runners.NewAzurePipeline()
 	case schemaapi.CraftingSchema_Runner_JENKINS_JOB:
-		return &runners.JenkinsJob{}
+		return runners.NewJenkinsJob()
+	case schemaapi.CraftingSchema_Runner_CIRCLECI_BUILD:
+		return runners.NewCircleCIBuild()
 	default:
-		return &runners.Generic{}
+		return runners.NewGeneric()
 	}
 }

app/controlplane/api/workflowcontract/v1/crafting_schema.proto

@@ -0,0 +1,64 @@
+//
+// Copyright 2023 The Chainloop Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package runners
+
+import "os"
+
+type CircleCIBuild struct{}
+
+const CircleCIBuildID = "circleci-build"
+
+func NewCircleCIBuild() *CircleCIBuild {
+	return &CircleCIBuild{}
+}
+
+func (r *CircleCIBuild) CheckEnv() bool {
+	for _, envVarName := range []string{"CI", "CIRCLECI"} {
+		if os.Getenv(envVarName) != "true" {
+			return false
+		}
+	}
+
+	return true
+}
+
+func (r *CircleCIBuild) ListEnvVars() []string {
+	return []string{
+		// Some info about the job
+		"CIRCLE_BUILD_URL",
+		"CIRCLE_JOB",
+
+		// Some info about the commit
+		"CIRCLE_BRANCH",
+		"CIRCLE_PR_NUMBER",
+
+		// Some info about the agent
+		"CIRCLE_NODE_TOTAL",
+		"CIRCLE_NODE_INDEX",
+	}
+}
+
+func (r *CircleCIBuild) ResolveEnvVars() map[string]string {
+	return resolveEnvVars(r.ListEnvVars())
+}
+
+func (r *CircleCIBuild) String() string {
+	return JenkinsJobID
+}
+
+func (r *CircleCIBuild) RunURI() string {
+	return os.Getenv("CIRCLE_BUILD_URL")
+}