Use Cirrus CLI artifacts instead of Cirrus CI Agent artifacts (#728)

edigaryev · web-flow · commit 2a07c0284c95 · 2024-04-25T17:34:41.000+04:00
diff --git a/internal/commands/run_darwin_test.go b/internal/commands/run_darwin_test.go
@@ -38,7 +38,7 @@ task:
   install_proctools_script:
     - brew install proctools
   script:
-    - pkill -STOP cirrus-ci-agent
+    - pkill -STOP -f "cirrus agent"
 `, image, user, password)
 
 	testutil.TempChdir(t)
diff --git a/internal/executor/agent/agent.go b/internal/executor/agent/agent.go
@@ -36,7 +36,7 @@ func RetrieveBinary(
 
 	agentPath := filepath.Join(
 		agentCacheDir,
-		fmt.Sprintf("cirrus-ci-agent-%s-%s-%s%s", agentVersion, agentOS, agentArchitecture, agentSuffix),
+		fmt.Sprintf("cirrus-%s-%s-%s%s", agentVersion, agentOS, agentArchitecture, agentSuffix),
 	)
 
 	// Agent found in the cache
@@ -51,7 +51,7 @@ func RetrieveBinary(
 	}
 
 	// Download the agent
-	agentURL := fmt.Sprintf("https://github.com/cirruslabs/cirrus-ci-agent/releases/download/v%s/agent-%s-%s%s",
+	agentURL := fmt.Sprintf("https://github.com/cirruslabs/cirrus-cli/releases/download/v%s/cirrus-%s-%s%s",
 		agentVersion, agentOS, agentArchitecture, agentSuffix)
 
 	req, err := http.NewRequestWithContext(ctx, "GET", agentURL, http.NoBody)
diff --git a/internal/executor/executor.go b/internal/executor/executor.go
@@ -194,8 +194,8 @@ func (e *Executor) runSingleTask(ctx context.Context, task *build.Task) (err err
 	instanceRunOpts.SetLogger(taskLogger)
 
 	// Respect custom agent version
-	if agentVersionFromEnv, ok := task.Environment["CIRRUS_AGENT_VERSION"]; ok {
-		instanceRunOpts.SetAgentVersion(agentVersionFromEnv)
+	if agentVersionFromEnv, ok := task.Environment["CIRRUS_CLI_VERSION"]; ok {
+		instanceRunOpts.SetCLIVersion(agentVersionFromEnv)
 	}
 
 	// Wrap the context to enforce a timeout for this task
diff --git a/internal/executor/executor_test.go b/internal/executor/executor_test.go
@@ -63,6 +63,9 @@ func TestExecutorClone(t *testing.T) {
 		t.Fatal(err)
 	}
 
+	renderer := renderers.NewSimpleRenderer(os.Stdout, nil)
+	logger := echelon.NewLogger(echelon.TraceLevel, renderer)
+
 	e, err := executor.New(dir, []*api.Task{
 		{
 			LocalGroupId: 0,
@@ -85,7 +88,7 @@ func TestExecutorClone(t *testing.T) {
 			},
 			Instance: testutil.GetBasicContainerInstance(t, "debian:latest"),
 		},
-	})
+	}, executor.WithLogger(logger))
 	if err != nil {
 		t.Fatal(err)
 	}
diff --git a/internal/executor/instance/container/run.go b/internal/executor/instance/container/run.go
@@ -63,7 +63,8 @@ func RunContainerizedAgent(ctx context.Context, config *runconfig.RunConfig, par
 		Image:        params.Image,
 		Architecture: params.Architecture,
 		Entrypoint: []string{
-			params.Platform.ContainerAgentPath(),
+			params.Platform.ContainerCLIPath(),
+			"agent",
 			"-api-endpoint",
 			config.Endpoint.Container(),
 			"-server-token",
diff --git a/internal/executor/instance/persistentworker/isolation/none/none.go b/internal/executor/instance/persistentworker/isolation/none/none.go
@@ -62,12 +62,13 @@ func (pwi *PersistentWorkerInstance) Attributes() []attribute.KeyValue {
 
 func (pwi *PersistentWorkerInstance) Run(ctx context.Context, config *runconfig.RunConfig) (err error) {
 	// Retrieve the agent's binary
-	agentPath, err := agent.RetrieveBinary(ctx, config.GetAgentVersion(), runtime.GOOS, runtime.GOARCH)
+	cliPath, err := agent.RetrieveBinary(ctx, config.GetAgentVersion(), runtime.GOOS, runtime.GOARCH)
 	if err != nil {
 		return err
 	}
 
-	cmd := exec.Command(agentPath,
+	cmd := exec.Command(cliPath,
+		"agent",
 		"-api-endpoint",
 		config.Endpoint.Direct(),
 		"-server-token",
diff --git a/internal/executor/instance/persistentworker/remoteagent/remoteagent.go b/internal/executor/instance/persistentworker/remoteagent/remoteagent.go
@@ -80,7 +80,7 @@ func WaitForAgent(
 
 	logger.Debugf("uploading agent to %s...", addr)
 
-	remoteAgentPath, err := uploadAgent(ctx, cli, agentOS, config.GetAgentVersion(), agentArchitecture)
+	remoteCLIPath, err := uploadAgent(ctx, cli, agentOS, config.GetAgentVersion(), agentArchitecture)
 	if err != nil {
 		return fmt.Errorf("%w: failed to upload agent via SFTP: %v",
 			ErrFailed, err)
@@ -155,7 +155,8 @@ func WaitForAgent(
 	}
 
 	command := []string{
-		remoteAgentPath,
+		remoteCLIPath,
+		"agent",
 		"-api-endpoint",
 		apiEndpoint,
 		"-server-token",
diff --git a/internal/executor/instance/persistentworker/remoteagent/sftp.go b/internal/executor/instance/persistentworker/remoteagent/sftp.go
@@ -43,7 +43,7 @@ func uploadAgent(
 	}
 
 	// Create agent's binary remotely
-	remoteAgentPath := path.Join(platform.NewUnix().CirrusDir(), "cirrus-ci-agent")
+	remoteAgentPath := path.Join(platform.NewUnix().CirrusDir(), "cirrus")
 	remoteAgentFile, err := sftpCli.Create(remoteAgentPath)
 	if err != nil {
 		return "", err
diff --git a/internal/executor/instance/runconfig/runconfig.go b/internal/executor/instance/runconfig/runconfig.go
@@ -66,11 +66,11 @@ func (rc *RunConfig) GetAgentVersion() string {
 	return rc.agentVersion
 }
 
-func (rc *RunConfig) SetAgentVersion(agentVersion string) {
+func (rc *RunConfig) SetCLIVersion(agentVersion string) {
 	rc.agentVersion = agentVersion
 }
 
-func (rc *RunConfig) SetAgentVersionWithoutDowngrade(agentVersion string) error {
+func (rc *RunConfig) SetCLIVersionWithoutDowngrade(agentVersion string) error {
 	if agentVersion == "" {
 		return nil
 	}
diff --git a/internal/executor/instance/runconfig/runconfig_test.go b/internal/executor/instance/runconfig/runconfig_test.go
@@ -14,14 +14,14 @@ func TestSetAgentVersionWithoutDowngrade(t *testing.T) {
 
 	// No downgrade
 	prettyLowVersion := "0.1.0"
-	if err := rc.SetAgentVersionWithoutDowngrade(prettyLowVersion); err != nil {
+	if err := rc.SetCLIVersionWithoutDowngrade(prettyLowVersion); err != nil {
 		t.Fatal(err)
 	}
 	assert.Equal(t, platform.DefaultAgentVersion, rc.GetAgentVersion())
 
 	// Only upgrade
 	prettyHighVersion := fmt.Sprintf("%d.0.0", math.MaxInt32)
-	if err := rc.SetAgentVersionWithoutDowngrade(prettyHighVersion); err != nil {
+	if err := rc.SetCLIVersionWithoutDowngrade(prettyHighVersion); err != nil {
 		t.Fatal(err)
 	}
 	assert.Equal(t, prettyHighVersion, rc.GetAgentVersion())
diff --git a/internal/executor/instance/volume/volume.go b/internal/executor/instance/volume/volume.go
@@ -97,7 +97,7 @@ func CreateWorkingVolume(
 	input := &containerbackend.ContainerCreateInput{
 		Image:        agentImage,
 		Architecture: architecture,
-		Command:      copyCommand.Command,
+		Entrypoint:   copyCommand.Command,
 		Mounts: []containerbackend.ContainerMount{
 			{
 				Type:   containerbackend.MountTypeVolume,
diff --git a/internal/executor/platform/platform.go b/internal/executor/platform/platform.go
@@ -5,13 +5,13 @@ const (
 	workingVolumeWorkingDir = "working-dir"
 
 	// workingVolumeAgentBinary is the name of the agent binary relative to the CirrusDir().
-	workingVolumeAgentBinary = "cirrus-ci-agent"
+	workingVolumeAgentBinary = "cirrus"
 
 	// agentImageBase is used as a prefix to the agent's version to craft the full agent image name.
-	agentImageBase = "ghcr.io/cirruslabs/cirrus-ci-agent:v"
+	agentImageBase = "ghcr.io/cirruslabs/cirrus-cli:v"
 
 	// DefaultAgentVersion represents the default version of the https://github.com/cirruslabs/cirrus-ci-agent to use.
-	DefaultAgentVersion = "1.134.0"
+	DefaultAgentVersion = "0.117.0"
 )
 
 type CopyCommand struct {
@@ -24,7 +24,7 @@ type CopyCommand struct {
 type Platform interface {
 	ContainerAgentImage(version string) string
 	ContainerCopyCommand(populate bool) *CopyCommand
-	ContainerAgentPath() string
+	ContainerCLIPath() string
 	ContainerAgentVolumeDir() string
 
 	CirrusDir() string
diff --git a/internal/executor/platform/unix.go b/internal/executor/platform/unix.go
@@ -12,7 +12,7 @@ func NewUnix() Platform {
 	return &UnixPlatform{}
 }
 
-func (platform *UnixPlatform) ContainerAgentPath() string {
+func (platform *UnixPlatform) ContainerCLIPath() string {
 	return filepath.Join(platform.ContainerAgentVolumeDir(), workingVolumeAgentBinary)
 }
 
@@ -35,7 +35,7 @@ func (platform *UnixPlatform) ContainerCopyCommand(populate bool) *CopyCommand {
 		CopiesProjectToDir:   "/project-volume",
 	}
 
-	copyCmd := fmt.Sprintf("cp /bin/cirrus-ci-agent %s",
+	copyCmd := fmt.Sprintf("cp /usr/local/bin/cirrus %s",
 		path.Join(copyCommand.CopiesAgentToDir, workingVolumeAgentBinary))
 
 	if populate {
diff --git a/internal/executor/platform/windows.go b/internal/executor/platform/windows.go
@@ -26,7 +26,7 @@ func NewWindows(osVersion string) Platform {
 	}
 }
 
-func (platform *WindowsPlatform) ContainerAgentPath() string {
+func (platform *WindowsPlatform) ContainerCLIPath() string {
 	return filepath.Join(platform.ContainerAgentVolumeDir(), workingVolumeAgentBinary)
 }
 
@@ -49,8 +49,8 @@ func (platform *WindowsPlatform) ContainerCopyCommand(populate bool) *CopyComman
 		CopiesProjectToDir:   "C:\\project-volume",
 	}
 
-	windowsAgentURL := fmt.Sprintf("https://github.com/cirruslabs/cirrus-ci-agent/releases/"+
-		"download/v%s/agent-windows-amd64.exe", DefaultAgentVersion)
+	windowsAgentURL := fmt.Sprintf("https://github.com/cirruslabs/cirrus-cli/releases/"+
+		"download/v%s/cirrus-windows-amd64.exe", DefaultAgentVersion)
 
 	copyCmd := fmt.Sprintf("(New-Object System.Net.WebClient).DownloadFile(\"%s\", \"%s\")",
 		windowsAgentURL, filepath.Join(copyCommand.CopiesAgentToDir, workingVolumeAgentBinary))
diff --git a/internal/worker/task.go b/internal/worker/task.go
@@ -166,8 +166,8 @@ func (worker *Worker) runTask(
 		},
 	}
 
-	if err := config.SetAgentVersionWithoutDowngrade(agentAwareTask.AgentVersion); err != nil {
-		worker.logger.Warnf("failed to set agent's version for task %d: %v", agentAwareTask.TaskId, err)
+	if err := config.SetCLIVersionWithoutDowngrade(agentAwareTask.CliVersion); err != nil {
+		worker.logger.Warnf("failed to set CLI's version for task %d: %v", agentAwareTask.TaskId, err)
 	}
 
 	err := inst.Run(ctx, &config)
diff --git a/pkg/api/cirrus_ci_service.pb.go b/pkg/api/cirrus_ci_service.pb.go

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func RetrieveBinary(`
`36`	`36`
`37`	`37`	`agentPath := filepath.Join(`
`38`	`38`	`agentCacheDir,`
`39`		`- fmt.Sprintf("cirrus-ci-agent-%s-%s-%s%s", agentVersion, agentOS, agentArchitecture, agentSuffix),`
	`39`	`+ fmt.Sprintf("cirrus-%s-%s-%s%s", agentVersion, agentOS, agentArchitecture, agentSuffix),`
`40`	`40`	`)`
`41`	`41`
`42`	`42`	`// Agent found in the cache`
`@@ -51,7 +51,7 @@ func RetrieveBinary(`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`// Download the agent`
`54`		`- agentURL := fmt.Sprintf("https://github.com/cirruslabs/cirrus-ci-agent/releases/download/v%s/agent-%s-%s%s",`
	`54`	`+ agentURL := fmt.Sprintf("https://github.com/cirruslabs/cirrus-cli/releases/download/v%s/cirrus-%s-%s%s",`
`55`	`55`	`agentVersion, agentOS, agentArchitecture, agentSuffix)`
`56`	`56`
`57`	`57`	`req, err := http.NewRequestWithContext(ctx, "GET", agentURL, http.NoBody)`
Original file line number	Diff line number	Diff line change
`@@ -194,8 +194,8 @@ func (e Executor) runSingleTask(ctx context.Context, task build.Task) (err err`
`194`	`194`	`instanceRunOpts.SetLogger(taskLogger)`
`195`	`195`
`196`	`196`	`// Respect custom agent version`
`197`		`- if agentVersionFromEnv, ok := task.Environment["CIRRUS_AGENT_VERSION"]; ok {`
`198`		`- instanceRunOpts.SetAgentVersion(agentVersionFromEnv)`
	`197`	`+ if agentVersionFromEnv, ok := task.Environment["CIRRUS_CLI_VERSION"]; ok {`
	`198`	`+ instanceRunOpts.SetCLIVersion(agentVersionFromEnv)`
`199`	`199`	`}`
`200`	`200`
`201`	`201`	`// Wrap the context to enforce a timeout for this task`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,9 @@ func TestExecutorClone(t *testing.T) {`
`63`	`63`	`t.Fatal(err)`
`64`	`64`	`}`
`65`	`65`
	`66`	`+ renderer := renderers.NewSimpleRenderer(os.Stdout, nil)`
	`67`	`+ logger := echelon.NewLogger(echelon.TraceLevel, renderer)`
	`68`	`+`
`66`	`69`	`e, err := executor.New(dir, []*api.Task{`
`67`	`70`	`{`
`68`	`71`	`LocalGroupId: 0,`
`@@ -85,7 +88,7 @@ func TestExecutorClone(t *testing.T) {`
`85`	`88`	`},`
`86`	`89`	`Instance: testutil.GetBasicContainerInstance(t, "debian:latest"),`
`87`	`90`	`},`
`88`		`- })`
	`91`	`+ }, executor.WithLogger(logger))`
`89`	`92`	`if err != nil {`
`90`	`93`	`t.Fatal(err)`
`91`	`94`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ func uploadAgent(`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`// Create agent's binary remotely`
`46`		`- remoteAgentPath := path.Join(platform.NewUnix().CirrusDir(), "cirrus-ci-agent")`
	`46`	`+ remoteAgentPath := path.Join(platform.NewUnix().CirrusDir(), "cirrus")`
`47`	`47`	`remoteAgentFile, err := sftpCli.Create(remoteAgentPath)`
`48`	`48`	`if err != nil {`
`49`	`49`	`return "", err`
Original file line number	Diff line number	Diff line change
`@@ -66,11 +66,11 @@ func (rc *RunConfig) GetAgentVersion() string {`
`66`	`66`	`return rc.agentVersion`
`67`	`67`	`}`
`68`	`68`
`69`		`-func (rc *RunConfig) SetAgentVersion(agentVersion string) {`
	`69`	`+func (rc *RunConfig) SetCLIVersion(agentVersion string) {`
`70`	`70`	`rc.agentVersion = agentVersion`
`71`	`71`	`}`
`72`	`72`
`73`		`-func (rc *RunConfig) SetAgentVersionWithoutDowngrade(agentVersion string) error {`
	`73`	`+func (rc *RunConfig) SetCLIVersionWithoutDowngrade(agentVersion string) error {`
`74`	`74`	`if agentVersion == "" {`
`75`	`75`	`return nil`
`76`	`76`	`}`