test(e2e): add skeleton for pipeline e2e test (#2422)

This initial e2e/pipeline pkg just creates a codecommit repository
where we can push the service code. Once this PR is merged and we know
that it works with CodeBuild, we'll send a follow-up PR to actually run
the "copilot pipeline" commands.

- [x] Tested the changes against my AWS account and local machine

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Author: efekarakus

.release/buildspec_e2e.yml

@@ -109,6 +109,15 @@ batch:
         variables:
           TEST_SUITE: apprunner
           APP_REGION: ap-northeast-1
+    - identifier: pipeline
+      env:
+        privileged-mode: true
+        type: LINUX_CONTAINER
+        compute-type: BUILD_GENERAL1_LARGE
+        image: aws/codebuild/standard:5.0
+        variables:
+          TEST_SUITE: pipeline
+          APP_REGION: eu-west-1
 
 
 phases:

Makefile

@@ -96,14 +96,12 @@ package-custom-resources-clean:
 
 .PHONY: run-unit-test
 run-unit-test:
-	go test -race -cover -count=1 -coverprofile ${COVERAGE} ${PACKAGES}
+	go test -race -count=1 -coverprofile=${COVERAGE} ${PACKAGES}
 
 .PHONY: generate-coverage
-generate-coverage: ${COVERAGE}
+generate-coverage: test
 	go tool cover -html=${COVERAGE}
 
-${COVERAGE}: test
-
 .PHONY: integ-test
 integ-test: packr-build run-integ-test packr-clean
 

e2e/internal/client/aws.go

@@ -13,6 +13,11 @@ import (
 	cmd "github.com/aws/copilot-cli/e2e/internal/command"
 )
 
+// IAM policy ARNs.
+const (
+	codeCommitPowerUserPolicyARN = "arn:aws:iam::aws:policy/AWSCodeCommitPowerUser"
+)
+
 // AWS is a wrapper around aws commands.
 type AWS struct{}
 
@@ -63,6 +68,170 @@ func (a *AWS) WaitStackCreateComplete(name string) error {
 	return a.exec(command)
 }
 
+// CreateCodeCommitRepo creates a repository with AWS CodeCommit and returns
+// the HTTP git clone url.
+func (a *AWS) CreateCodeCommitRepo(name string) (cloneURL string, err error) {
+	out := new(bytes.Buffer)
+	args := strings.Join([]string{
+		"codecommit",
+		"create-repository",
+		"--repository-name",
+		name,
+	}, " ")
+	if err := a.exec(args, cmd.Stdout(out)); err != nil {
+		return "", fmt.Errorf("create commit repository %s cmd: %v", name, err)
+	}
+
+	data := struct {
+		RepositoryMetadata struct {
+			CloneURLHTTP string `json:"cloneUrlHttp"`
+		} `json:"repositoryMetadata"`
+	}{}
+	if err := json.Unmarshal(out.Bytes(), &data); err != nil {
+		return "", fmt.Errorf("unmarshal json response from create commit repository: %v", err)
+	}
+	return data.RepositoryMetadata.CloneURLHTTP, nil
+}
+
+// DeleteCodeCommitRepo delete a CodeCommit repository.
+func (a *AWS) DeleteCodeCommitRepo(name string) error {
+	args := strings.Join([]string{
+		"codecommit",
+		"delete-repository",
+		"--repository-name",
+		name,
+	}, " ")
+	if err := a.exec(args); err != nil {
+		return fmt.Errorf("delete repository %s: %v", name, err)
+	}
+	return nil
+}
+
+// IAMServiceCreds represents service-specific IAM credentials.
+type IAMServiceCreds struct {
+	UserName     string `json:"ServiceUserName"`             // Git username.
+	Password     string `json:"ServicePassword"`             // Git password.
+	CredentialID string `json:"ServiceSpecificCredentialId"` // ID for the creds in order to delete them.
+}
+
+// CreateCodeCommitIAMUser creates an IAM user that can push and pull from codecommit.
+// Returns the credentials needed to interact with codecommit.
+func (a *AWS) CreateCodeCommitIAMUser(userName string) (*IAMServiceCreds, error) {
+	if err := a.createIAMUser("/copilot/e2etests/", userName); err != nil {
+		return nil, err
+	}
+	if err := a.attachUserPolicy(userName, codeCommitPowerUserPolicyARN); err != nil {
+		return nil, err
+	}
+	return a.createCodeCommitCreds(userName)
+}
+
+// DeleteCodeCommitIAMUser deletes an IAM user that can access codecommit.
+func (a *AWS) DeleteCodeCommitIAMUser(userName, credentialID string) error {
+	if err := a.deleteServiceSpecificCreds(userName, credentialID); err != nil {
+		return err
+	}
+	if err := a.detachUserPolicy(userName, codeCommitPowerUserPolicyARN); err != nil {
+		return err
+	}
+	return a.deleteIAMUser(userName)
+}
+
+func (a *AWS) createIAMUser(path, userName string) error {
+	args := strings.Join([]string{
+		"iam",
+		"create-user",
+		"--path",
+		path,
+		"--user-name",
+		userName,
+	}, " ")
+	if err := a.exec(args); err != nil {
+		return fmt.Errorf("create IAM user under path %s and name %s: %v", path, userName, err)
+	}
+	return nil
+}
+
+func (a *AWS) attachUserPolicy(userName, policyARN string) error {
+	args := strings.Join([]string{
+		"iam",
+		"attach-user-policy",
+		"--user-name",
+		userName,
+		"--policy-arn",
+		policyARN,
+	}, " ")
+	if err := a.exec(args); err != nil {
+		return fmt.Errorf("attach policy arn %s to user %s: %v", policyARN, userName, err)
+	}
+	return nil
+}
+
+func (a *AWS) createCodeCommitCreds(userName string) (*IAMServiceCreds, error) {
+	out := new(bytes.Buffer)
+	args := strings.Join([]string{
+		"iam",
+		"create-service-specific-credential",
+		"--user-name",
+		userName,
+		"--service-name",
+		"codecommit.amazonaws.com",
+	}, " ")
+	if err := a.exec(args, cmd.Stdout(out)); err != nil {
+		return nil, fmt.Errorf("create commit credentials for user %s: %v", userName, err)
+	}
+	data := struct {
+		Creds IAMServiceCreds `json:"ServiceSpecificCredential"`
+	}{}
+	if err := json.Unmarshal(out.Bytes(), &data); err != nil {
+		return nil, fmt.Errorf("unmarshal credentials for codecommit: %v", err)
+	}
+	return &data.Creds, nil
+}
+
+func (a *AWS) deleteServiceSpecificCreds(userName, credentialID string) error {
+	args := strings.Join([]string{
+		"iam",
+		"delete-service-specific-credential",
+		"--user-name",
+		userName,
+		"--service-specific-credential-id",
+		credentialID,
+	}, " ")
+	if err := a.exec(args); err != nil {
+		return fmt.Errorf("delete service specific creds %s for user %s: %v", credentialID, userName, err)
+	}
+	return nil
+}
+
+func (a *AWS) detachUserPolicy(userName, policyARN string) error {
+	args := strings.Join([]string{
+		"iam",
+		"detach-user-policy",
+		"--user-name",
+		userName,
+		"--policy-arn",
+		policyARN,
+	}, " ")
+	if err := a.exec(args); err != nil {
+		return fmt.Errorf("detach user policy %s for user %s: %v", policyARN, userName, err)
+	}
+	return nil
+}
+
+func (a *AWS) deleteIAMUser(userName string) error {
+	args := strings.Join([]string{
+		"iam",
+		"delete-user",
+		"--user-name",
+		userName,
+	}, " ")
+	if err := a.exec(args); err != nil {
+		return fmt.Errorf("delete iam user %s: %v", userName, err)
+	}
+	return nil
+}
+
 /*VPCStackOutput runs:
 aws cloudformation describe-stacks --stack-name $name |
 	jq -r .Stacks[0].Outputs

e2e/internal/client/cli.go

@@ -16,7 +16,8 @@ import (
 
 // CLI is a wrapper around os.execs.
 type CLI struct {
-	path string
+	path       string
+	workingDir string
 }
 
 // AppInitRequest contains the parameters for calling copilot app init.
@@ -225,6 +226,17 @@ func NewCLI() (*CLI, error) {
 	}, nil
 }
 
+// NewCLIWithDir returns the Copilot CLI such that the commands are run in the specified
+// working directory.
+func NewCLIWithDir(workingDir string) (*CLI, error) {
+	cli, err := NewCLI()
+	if err != nil {
+		return nil, err
+	}
+	cli.workingDir = workingDir
+	return cli, nil
+}
+
 /*Help runs
 copilot --help
 */
@@ -850,6 +862,7 @@ func (cli *CLI) SvcPackage(opts *PackageInput) (string, error) {
 func (cli *CLI) exec(command *exec.Cmd) (string, error) {
 	// Turn off colors
 	command.Env = append(os.Environ(), "COLOR=false")
+	command.Dir = cli.workingDir
 	sess, err := gexec.Start(command, ginkgo.GinkgoWriter, ginkgo.GinkgoWriter)
 	if err != nil {
 		return "", err

e2e/pipeline/frontend/Dockerfile

@@ -0,0 +1,6 @@
+FROM nginx
+
+COPY nginx.conf /etc/nginx/nginx.conf
+
+RUN mkdir -p /www/data/frontend
+COPY index.html /www/data/frontend

e2e/pipeline/frontend/index.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <title>AWS Copilot CLI</title>
+</head>
+<body style="background-color:rgb(35, 47, 62);">
+<div style='vertical-align: middle; margin:auto; width:50%; padding-top:200px; text-align: center;'>
+    <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="141px" height="171px" viewBox="-0.5 -0.5 81 101"><defs><linearGradient x1="0%" y1="0%" x2="0%" y2="100%" id="mx-gradient-232f3e-100-232f3e-100-s-0"><stop offset="0%" style="stop-color:#232F3E"/><stop offset="100%" style="stop-color:#232F3E"/></linearGradient></defs><g><path d="M 0 0 L 80 0 L 80 100 L 0 100 Z" fill="#ffffff" stroke="none" pointer-events="all"/><path d="M 1 1 L 79 1 L 79 79 L 1 79 Z" fill="url(#mx-gradient-232f3e-100-232f3e-100-s-0)" stroke="none" pointer-events="all"/><path d="M 38.07 13.01 C 37.9 13.01 37.73 13.06 37.57 13.15 L 16.61 25.24 C 16.28 25.43 16.08 25.79 16.08 26.17 L 16.08 52.54 C 16.09 52.92 16.29 53.26 16.61 53.45 L 39.42 66.81 C 39.75 67.01 40.16 67.01 40.49 66.81 L 61.42 54.63 C 61.75 54.44 61.95 54.09 61.95 53.71 C 61.95 53.33 61.74 52.98 61.41 52.79 L 51.36 47.12 C 51.03 46.94 50.63 46.94 50.31 47.13 L 40.07 53.14 L 28.12 46.26 L 28.12 32.5 L 38.63 26.49 C 38.96 26.3 39.16 25.95 39.16 25.57 L 39.16 14.07 C 39.16 13.78 39.04 13.51 38.84 13.31 C 38.64 13.11 38.36 13 38.07 13.01 Z M 42.08 13.05 C 41.79 13.04 41.51 13.15 41.31 13.35 C 41.1 13.55 40.98 13.82 40.98 14.11 L 40.98 25.62 C 40.99 26 41.19 26.35 41.52 26.54 L 51.84 32.55 L 51.84 44.59 C 51.84 44.96 52.04 45.31 52.37 45.5 L 62.32 51.28 C 62.65 51.47 63.05 51.47 63.38 51.28 C 63.71 51.09 63.92 50.74 63.92 50.36 L 63.92 26.19 C 63.91 25.81 63.71 25.46 63.38 25.28 L 42.58 13.2 C 42.43 13.11 42.25 13.06 42.08 13.05 Z M 37.05 15.91 L 37.05 24.96 L 26.54 30.97 C 26.21 31.16 26 31.51 26 31.89 L 26 46.87 C 26 47.25 26.2 47.6 26.54 47.79 L 39.54 55.28 C 39.87 55.47 40.28 55.47 40.6 55.28 L 50.85 49.27 L 58.76 53.73 L 39.96 64.67 L 18.2 51.92 L 18.2 26.77 Z M 43.11 15.95 L 61.8 26.8 L 61.8 48.52 L 53.96 43.97 L 53.96 31.94 C 53.96 31.56 53.76 31.21 53.43 31.02 L 43.11 25.01 Z" fill="#ffffff" stroke="none" pointer-events="all"/><g transform="translate(8.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="62" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(35, 47, 62); line-height: 1.2; vertical-align: top; width: 63px; white-space: nowrap; overflow-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Amazon ECS</div></div></foreignObject><text x="31" y="10" fill="#232F3E" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">Amazon ECS</text></switch></g></g></svg>
+</div>
+</body>
+</html>

e2e/pipeline/frontend/nginx.conf

@@ -0,0 +1,17 @@
+events {
+  worker_connections 768;
+}
+
+http {
+  server {
+    root /www/data;
+    listen 80;
+
+    location / {
+        return 200 'healthcheck okay!';
+    }
+
+    location /frontend/ {
+    }
+  }
+}

e2e/pipeline/pipeline_suite_test.go

@@ -0,0 +1,54 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package pipeline_test
+
+import (
+	"fmt"
+	"testing"
+	"time"
+
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+
+	"github.com/aws/copilot-cli/e2e/internal/client"
+)
+
+// Command-line tools.
+var (
+	copilot *client.CLI
+	aws     *client.AWS
+)
+
+// Application identifiers.
+var (
+	appName = fmt.Sprintf("e2e-pipeline-%d", time.Now().Unix())
+)
+
+// CodeCommit credentials.
+var (
+	repoName          = appName
+	codeCommitIAMUser = fmt.Sprintf("%s-cc", appName)
+	codeCommitCreds   *client.IAMServiceCreds
+)
+
+func TestPipeline(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Pipeline Suite")
+}
+
+var _ = BeforeSuite(func() {
+	cli, err := client.NewCLIWithDir(repoName)
+	Expect(err).NotTo(HaveOccurred())
+	copilot = cli
+	aws = client.NewAWS()
+
+	creds, err := aws.CreateCodeCommitIAMUser(codeCommitIAMUser)
+	Expect(err).NotTo(HaveOccurred())
+	codeCommitCreds = creds
+})
+
+var _ = AfterSuite(func() {
+	_ = aws.DeleteCodeCommitRepo(appName)
+	_ = aws.DeleteCodeCommitIAMUser(codeCommitIAMUser, codeCommitCreds.CredentialID)
+})