Merge pull request #1164 from CircleCI-Public/test-72/run-autodetect-env

TEST-72 Update run command to autodetect envars

Author: liamclarkedev

api/project/project_rest.go

@@ -8,11 +8,11 @@ import (
 	"github.com/CircleCI-Public/circleci-cli/settings"
 )
 
-type projectRestClient struct {
+type ProjectRestClient struct {
 	client *rest.Client
 }
 
-var _ ProjectClient = &projectRestClient{}
+var _ ProjectClient = &ProjectRestClient{}
 
 type listProjectEnvVarsParams struct {
 	vcs       string
@@ -60,10 +60,10 @@ type projectInfo struct {
 	Id string `json:"id"`
 }
 
-// NewProjectRestClient returns a new projectRestClient satisfying the api.ProjectInterface
+// NewProjectRestClient returns a new ProjectRestClient satisfying the api.ProjectInterface
 // interface via the REST API.
-func NewProjectRestClient(config settings.Config) (*projectRestClient, error) {
-	client := &projectRestClient{
+func NewProjectRestClient(config settings.Config) (*ProjectRestClient, error) {
+	client := &ProjectRestClient{
 		client: rest.NewFromConfig(config.Host, &config),
 	}
 	return client, nil
@@ -72,7 +72,7 @@ func NewProjectRestClient(config settings.Config) (*projectRestClient, error) {
 // ListAllEnvironmentVariables returns all of the environment variables owned by the
 // given project. Note that pagination is not supported - we get all
 // pages of env vars and return them all.
-func (p *projectRestClient) ListAllEnvironmentVariables(vcs, org, project string) ([]*ProjectEnvironmentVariable, error) {
+func (p *ProjectRestClient) ListAllEnvironmentVariables(vcs, org, project string) ([]*ProjectEnvironmentVariable, error) {
 	res := make([]*ProjectEnvironmentVariable, 0)
 	var nextPageToken string
 	for {
@@ -102,7 +102,7 @@ func (p *projectRestClient) ListAllEnvironmentVariables(vcs, org, project string
 	return res, nil
 }
 
-func (c *projectRestClient) listEnvironmentVariables(params *listProjectEnvVarsParams) (*listAllProjectEnvVarsResponse, error) {
+func (c *ProjectRestClient) listEnvironmentVariables(params *listProjectEnvVarsParams) (*listAllProjectEnvVarsResponse, error) {
 	path := fmt.Sprintf("project/%s/%s/%s/envvar", params.vcs, params.org, params.project)
 	urlParams := url.Values{}
 	if params.pageToken != "" {
@@ -124,7 +124,7 @@ func (c *projectRestClient) listEnvironmentVariables(params *listProjectEnvVarsP
 
 // GetEnvironmentVariable retrieves and returns a variable with the given name.
 // If the response status code is 404, nil is returned.
-func (c *projectRestClient) GetEnvironmentVariable(vcs string, org string, project string, envName string) (*ProjectEnvironmentVariable, error) {
+func (c *ProjectRestClient) GetEnvironmentVariable(vcs string, org string, project string, envName string) (*ProjectEnvironmentVariable, error) {
 	path := fmt.Sprintf("project/%s/%s/%s/envvar/%s", vcs, org, project, envName)
 	req, err := c.client.NewRequest("GET", &url.URL{Path: path}, nil)
 	if err != nil {
@@ -147,7 +147,7 @@ func (c *projectRestClient) GetEnvironmentVariable(vcs string, org string, proje
 	}, nil
 }
 
-func (c *projectRestClient) CreateProject(vcs string, org string, name string) (*CreateProjectInfo, error) {
+func (c *ProjectRestClient) CreateProject(vcs string, org string, name string) (*CreateProjectInfo, error) {
 	orgSlug := fmt.Sprintf("%s/%s", vcs, org)
 
 	path := fmt.Sprintf("organization/%s/project", orgSlug)
@@ -178,7 +178,7 @@ func (c *projectRestClient) CreateProject(vcs string, org string, name string) (
 
 // CreateEnvironmentVariable creates a variable on the given project.
 // This returns the variable if successfully created.
-func (c *projectRestClient) CreateEnvironmentVariable(vcs string, org string, project string, v ProjectEnvironmentVariable) (*ProjectEnvironmentVariable, error) {
+func (c *ProjectRestClient) CreateEnvironmentVariable(vcs string, org string, project string, v ProjectEnvironmentVariable) (*ProjectEnvironmentVariable, error) {
 	path := fmt.Sprintf("project/%s/%s/%s/envvar", vcs, org, project)
 	req, err := c.client.NewRequest("POST", &url.URL{Path: path}, &createProjectEnvVarRequest{
 		Name:  v.Name,
@@ -200,7 +200,7 @@ func (c *projectRestClient) CreateEnvironmentVariable(vcs string, org string, pr
 }
 
 // ProjectInfo retrieves and returns the project info.
-func (c *projectRestClient) ProjectInfo(vcs string, org string, project string) (*ProjectInfo, error) {
+func (c *ProjectRestClient) ProjectInfo(vcs string, org string, project string) (*ProjectInfo, error) {
 	path := fmt.Sprintf("project/%s/%s/%s", vcs, org, project)
 	req, err := c.client.NewRequest("GET", &url.URL{Path: path}, nil)
 	if err != nil {

cmd/run.go

@@ -4,9 +4,13 @@ import (
 	"fmt"
 	"os"
 	"os/exec"
+	"strings"
 
-	"github.com/CircleCI-Public/circleci-cli/settings"
 	"github.com/spf13/cobra"
+
+	"github.com/CircleCI-Public/circleci-cli/api/project"
+	"github.com/CircleCI-Public/circleci-cli/git"
+	"github.com/CircleCI-Public/circleci-cli/settings"
 )
 
 func newRunCommand(config *settings.Config) *cobra.Command {
@@ -36,6 +40,11 @@ you can run it with: circleci run foo [args...]`,
 			pluginName := args[0]
 			pluginArgs := args[1:]
 
+			projectClient, err := project.NewProjectRestClient(*config)
+			if err != nil {
+				return err
+			}
+
 			// Construct the plugin binary name
 			binaryName := fmt.Sprintf("circleci-%s", pluginName)
 
@@ -47,11 +56,23 @@ you can run it with: circleci run foo [args...]`,
 
 			// Create the command to execute the plugin
 			pluginCmd := exec.Command(binaryPath, pluginArgs...)
-
 			// Connect stdin, stdout, and stderr to the current process
 			pluginCmd.Stdin = os.Stdin
-			pluginCmd.Stdout = os.Stdout
-			pluginCmd.Stderr = os.Stderr
+			pluginCmd.Stdout = config.Stdout
+			pluginCmd.Stderr = config.Stderr
+			pluginCmd.Env = os.Environ()
+
+			info := autoDetectProject(projectClient)
+			configEnv := map[string]string{
+				"CIRCLE_URL":   config.Host,
+				"CIRCLE_TOKEN": config.Token,
+			}
+			if info != nil {
+				configEnv["CIRCLE_PROJECT_ID"] = info.Id
+			}
+			for k, v := range configEnv {
+				pluginCmd.Env = append(pluginCmd.Env, fmt.Sprintf("%s=%s", k, v))
+			}
 
 			// Run the plugin
 			if err := pluginCmd.Run(); err != nil {
@@ -64,3 +85,19 @@ you can run it with: circleci run foo [args...]`,
 
 	return runCmd
 }
+
+func autoDetectProject(projectClient project.ProjectClient) *project.ProjectInfo {
+	remote, err := git.InferProjectFromGitRemotes()
+	if err != nil {
+		_, _ = fmt.Fprintln(os.Stderr, "unable to autodetect project from git remotes")
+		return nil
+	}
+
+	info, err := projectClient.ProjectInfo(strings.ToLower(string(remote.VcsType)), remote.Organization, remote.Project)
+	if err != nil {
+		_, _ = fmt.Fprintf(os.Stderr, "failed to get project info: %s\n", err)
+		return nil
+	}
+
+	return info
+}

cmd/run_test.go

@@ -1,20 +1,27 @@
 package cmd
 
 import (
+	"bytes"
+	"net/http"
+	"net/http/httptest"
 	"os"
 	"path/filepath"
 	"runtime"
 
-	"github.com/CircleCI-Public/circleci-cli/settings"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+
+	"github.com/CircleCI-Public/circleci-cli/settings"
 )
 
 var _ = Describe("run", func() {
 	var (
 		tempDir    string
 		pluginPath string
 		config     *settings.Config
+		fakeSrv    *httptest.Server
+		stdout     bytes.Buffer
+		stderr     bytes.Buffer
 	)
 
 	BeforeEach(func() {
@@ -23,23 +30,51 @@ var _ = Describe("run", func() {
 		Expect(err).ToNot(HaveOccurred())
 
 		// Create a test plugin
+		var pluginScript string
 		pluginPath = filepath.Join(tempDir, "circleci-test-plugin")
 		if runtime.GOOS == "windows" {
 			pluginPath = pluginPath + ".bat"
-		}
-		pluginScript := `#!/bin/bash
+			pluginScript = `#!/bin/bash
+echo "Plugin executed"
+echo "Args: %@%"
+echo "Project ID: %CIRCLE_PROJECT_ID%"
+echo "Circle URL: %CIRCLE_URL%"
+echo "Circle Token: %CIRCLE_TOKEN%"
+exit 0
+`
+		} else {
+			pluginScript = `#!/bin/bash
 echo "Plugin executed"
 echo "Args: $@"
+echo "Project ID: $CIRCLE_PROJECT_ID"
+echo "Circle URL: $CIRCLE_URL"
+echo "Circle Token: $CIRCLE_TOKEN"
 exit 0
 `
+		}
 		err = os.WriteFile(pluginPath, []byte(pluginScript), 0755)
 		Expect(err).ToNot(HaveOccurred())
 
-		config = &settings.Config{}
+		fakeSrv = httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Content-Type", "application/json")
+			w.WriteHeader(http.StatusOK)
+			_, err := w.Write([]byte(`{"id": "test-project-id"}`))
+			Expect(err).ToNot(HaveOccurred())
+		}))
+
+		config = &settings.Config{
+			Host:   fakeSrv.URL,
+			Token:  "test-token",
+			Stdout: &stdout,
+			Stderr: &stderr,
+		}
+		err = config.WithHTTPClient()
+		Expect(err).ToNot(HaveOccurred())
 	})
 
 	AfterEach(func() {
 		os.RemoveAll(tempDir)
+		fakeSrv.Close()
 	})
 
 	Describe("plugin execution", func() {
@@ -52,6 +87,9 @@ exit 0
 			cmd := newRunCommand(config)
 			cmd.SetArgs([]string{"test-plugin", "arg1", "arg2"})
 			err := cmd.Execute()
+			Expect(stdout.String()).To(ContainSubstring("Project ID: test-project-id"))
+			Expect(stdout.String()).To(ContainSubstring("Circle Token: test-token"))
+			Expect(stdout.String()).To(ContainSubstring("Circle URL: %s", fakeSrv.URL))
 			Expect(err).ToNot(HaveOccurred())
 		})
 

settings/settings.go

@@ -5,6 +5,7 @@ import (
 	"crypto/x509"
 	"errors"
 	"fmt"
+	"io"
 	"net/http"
 	"net/url"
 	"os"
@@ -14,11 +15,12 @@ import (
 	"strings"
 	"time"
 
-	yaml "gopkg.in/yaml.v3"
+	"gopkg.in/yaml.v3"
+
+	"github.com/spf13/afero"
 
 	"github.com/CircleCI-Public/circleci-cli/api/header"
 	"github.com/CircleCI-Public/circleci-cli/data"
-	"github.com/spf13/afero"
 )
 
 var (
@@ -50,6 +52,8 @@ type Config struct {
 	MockTelemetry string            `yaml:"-"`
 	OrbPublishing OrbPublishingInfo `yaml:"orb_publishing"`
 	TempDir       string            `yaml:"temp_dir,omitempty"`
+	Stdout        io.Writer         `yaml:"-"`
+	Stderr        io.Writer         `yaml:"-"`
 }
 
 type OrbPublishingInfo struct {
@@ -162,6 +166,9 @@ func (cfg *Config) LoadFromDisk() error {
 		return nil
 	}
 
+	cfg.Stdout = os.Stdout
+	cfg.Stderr = os.Stderr
+
 	return cfg.WithHTTPClient()
 }