Merge pull request #1133 from CircleCI-Public/LIFE-1564-add-the-ability-to-create-a-project-via-the-cli

[LIFE-1564] Add the ability to create a project via the cli

Author: Klaney

api/project/project.go

@@ -11,11 +11,19 @@ type ProjectInfo struct {
 	Id string
 }
 
+type CreateProjectInfo struct {
+	Id      string
+	Name    string
+	Slug    string
+	OrgName string
+}
+
 // ProjectClient is the interface to interact with project and it's
 // components.
 type ProjectClient interface {
 	ProjectInfo(vcs, org, project string) (*ProjectInfo, error)
 	ListAllEnvironmentVariables(vcs, org, project string) ([]*ProjectEnvironmentVariable, error)
 	GetEnvironmentVariable(vcs, org, project, envName string) (*ProjectEnvironmentVariable, error)
 	CreateEnvironmentVariable(vcs, org, project string, v ProjectEnvironmentVariable) (*ProjectEnvironmentVariable, error)
+	CreateProject(vcs, org, project string) (*CreateProjectInfo, error)
 }

api/project/project_rest.go

@@ -31,6 +31,24 @@ type listAllProjectEnvVarsResponse struct {
 	NextPageToken string `json:"next_page_token"`
 }
 
+type createProjectRequest struct {
+	Name string `json:"name"`
+}
+
+type createProjectResponse struct {
+	Slug             string `json:"slug"`
+	Name             string `json:"name"`
+	Id               string `json:"id"`
+	OrganizationName string `json:"organization_name"`
+	OrganizationSlug string `json:"organization_slug"`
+	OrganizationId   string `json:"organization_id"`
+	VcsInfo          struct {
+		VcsUrl        string `json:"vcs_url"`
+		Provider      string `json:"provider"`
+		DefaultBranch string `json:"default_branch"`
+	} `json:"vcs_info"`
+}
+
 type createProjectEnvVarRequest struct {
 	Name  string `json:"name"`
 	Value string `json:"value"`
@@ -129,6 +147,35 @@ func (c *projectRestClient) GetEnvironmentVariable(vcs string, org string, proje
 	}, nil
 }
 
+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)
+
+	reqBody := createProjectRequest{
+		Name: name,
+	}
+
+	urlObj := &url.URL{Path: path}
+	req, err := c.client.NewRequest("POST", urlObj, reqBody)
+	if err != nil {
+		return nil, err
+	}
+
+	var resp createProjectResponse
+	_, err = c.client.DoRequest(req, &resp)
+	if err != nil {
+		return nil, err
+	}
+
+	return &CreateProjectInfo{
+		Id:      resp.Id,
+		Name:    resp.Name,
+		Slug:    resp.Slug,
+		OrgName: resp.OrganizationName,
+	}, nil
+}
+
 // 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) {

api/project/project_rest_test.go

@@ -241,6 +241,77 @@ func Test_projectRestClient_GetEnvironmentVariable(t *testing.T) {
 	}
 }
 
+func Test_projectRestClient_CreateProject(t *testing.T) {
+	const (
+		vcsType     = "github"
+		orgName     = "test-org"
+		projName    = "test-proj"
+		testId      = "this-is-the-id"
+		projectSlug = "github/test-org/test-proj"
+	)
+	tests := []struct {
+		name    string
+		handler http.HandlerFunc
+		want    *project.CreateProjectInfo
+		wantErr bool
+	}{
+		{
+			name: "Should handle a successful request",
+			handler: func(w http.ResponseWriter, r *http.Request) {
+				orgSlug := fmt.Sprintf("%s/%s", vcsType, orgName)
+				assert.Equal(t, r.Header.Get("circle-token"), "token")
+				assert.Equal(t, r.Header.Get("accept"), "application/json")
+				assert.Equal(t, r.Header.Get("user-agent"), version.UserAgent())
+				assert.Equal(t, r.Method, "POST")
+				assert.Equal(t, r.URL.Path, fmt.Sprintf("/api/v2/organization/%s/project", orgSlug))
+				w.Header().Set("Content-Type", "application/json")
+				w.WriteHeader(http.StatusOK)
+				_, err := w.Write([]byte(`
+				{
+					"id": "` + testId + `",
+					"name": "` + projName + `",
+					"slug": "` + projectSlug + `",
+					"organization_name": "` + orgName + `"
+				}`))
+				assert.NilError(t, err)
+			},
+			want: &project.CreateProjectInfo{
+				Id:      testId,
+				Name:    projName,
+				Slug:    projectSlug,
+				OrgName: orgName,
+			},
+		},
+		{
+			name: "Should handle an error request",
+			handler: func(w http.ResponseWriter, _ *http.Request) {
+				w.Header().Set("content-type", "application/json")
+				w.WriteHeader(http.StatusInternalServerError)
+				_, err := w.Write([]byte(`{"message": "error"}`))
+				assert.NilError(t, err)
+			},
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			server := httptest.NewServer(tt.handler)
+			defer server.Close()
+			p, err := getProjectRestClient(server)
+			assert.NilError(t, err)
+
+			got, err := p.CreateProject(vcsType, orgName, projName)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("projectRestClient.CreateProject() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("projectRestClient.CreateProject() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
 func Test_projectRestClient_CreateEnvironmentVariable(t *testing.T) {
 	const (
 		vcsType  = "github"

cmd/project/create.go

@@ -0,0 +1,51 @@
+package project
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/CircleCI-Public/circleci-cli/cmd/validator"
+	"github.com/CircleCI-Public/circleci-cli/prompt"
+)
+
+var projectName string
+
+func newProjectCreateCommand(ops *projectOpts, preRunE validator.Validator) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "create <vcs-type> <org-name> [--name <project-name>]",
+		Short: "Create a new project in a CircleCI organization.",
+		Long: `Create a new project in a CircleCI organization.
+
+The project name can be provided using the --name flag. If not provided, you will be prompted to enter it.
+
+Example:
+  circleci project create github my-org --name my-new-project
+
+Note: For those with the circleci vcs type, you must use the hashed organization name, not the human readable name.
+You can get this from the URL of the organization on the web.
+
+Example: 
+  https://app.circleci.com/organization/circleci/GQERGDFG13454135 -> GQERGDFG13454135
+  Not the org name like: "test-org"`,
+		PreRunE: preRunE,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			vcsType := args[0]
+			orgName := args[1]
+			if projectName == "" {
+				projectName = prompt.ReadStringFromUser("Enter a name for the project", "")
+			}
+			res, err := ops.projectClient.CreateProject(vcsType, orgName, projectName)
+			if err != nil {
+				return err
+			}
+
+			cmd.Printf("Project '%s' successfully created in organization '%s'\n", projectName, res.OrgName)
+			cmd.Println("You may view your new project at: https://app.circleci.com/projects/" + res.Slug)
+			return nil
+		},
+		Args: cobra.ExactArgs(2),
+	}
+
+	cmd.Flags().StringVar(&projectName, "name", "", "Name of the project to create")
+
+	return cmd
+}

cmd/project/project.go

@@ -58,6 +58,7 @@ func NewProjectCommand(config *settings.Config, preRunE validator.Validator, opt
 
 	command.AddCommand(newProjectEnvironmentVariableCommand(&pos, preRunE))
 	command.AddCommand(newProjectDLCCommand(config, &pos, preRunE))
+	command.AddCommand(newProjectCreateCommand(&pos, preRunE))
 
 	return command
 }

cmd/root.go

@@ -356,7 +356,7 @@ func (helpCmd *helpCmd) helpTemplate(cmd *cobra.Command, s []string) {
 		Foreground(lipgloss.AdaptiveColor{Light: `#003740`, Dark: `#3B6385`}).
 		BorderBottom(true).
 		Margin(1, 0, 1, 0).
-		Padding(0, 1, 0, 1).Align(lipgloss.Center)
+		Padding(0, 1, 0, 1).Align(lipgloss.Left)
 	subCmdStyle := lipgloss.NewStyle().
 		Foreground(lipgloss.AdaptiveColor{Light: `#161616`, Dark: `#FFFFFF`}).
 		Padding(0, 4, 0, 4).Align(lipgloss.Left)