Merge pull request #662 from iamhopaul123/addons/parse-to-template

chore(addons): parse addons folder to generate template

Author: iamhopaul123

Makefile

@@ -151,3 +151,4 @@ gen-mocks: tools
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/aws/secretsmanager/mocks/mock_secretsmanager.go -source=./internal/pkg/aws/secretsmanager/secretsmanager.go
 	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/aws/cloudwatchlogs/mocks/mock_cloudwatchlogs.go -source=./internal/pkg/aws/cloudwatchlogs/cloudwatchlogs.go
 	${GOBIN}/mockgen -source=./internal/pkg/build/docker/docker.go -package=mocks -destination=./internal/pkg/build/docker/mocks/mock_docker.go
+	${GOBIN}/mockgen -package=mocks -destination=./internal/pkg/addons/mocks/mock_addons.go -source=./internal/pkg/addons/addons.go

go.mod

@@ -5,8 +5,8 @@ go 1.13
 require (
 	github.com/AlecAivazis/survey/v2 v2.0.5
 	github.com/Netflix/go-expect v0.0.0-20190729225929-0e00d9168667 // indirect
-	github.com/briandowns/spinner v1.9.0
 	github.com/aws/aws-sdk-go v1.29.3
+	github.com/briandowns/spinner v1.9.0
 	github.com/fatih/color v1.9.0
 	github.com/fatih/structs v1.1.0
 	github.com/gobuffalo/packd v0.4.0

go.sum

@@ -227,6 +227,7 @@ golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn
 golang.org/x/net v0.0.0-20190522155817-f3200d17e092/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859 h1:R/3boaszxrf1GEUWTVDzSKVwLmSJpwZ1yqXm8j0v2QI=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/net v0.0.0-20200202094626-16171245cfb2 h1:CCH4IOTTfewWjGOlSp+zGcjutRKlBEZQ6wTn8ozI/nI=
 golang.org/x/net v0.0.0-20200202094626-16171245cfb2/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=

internal/pkg/addons/addons.go

@@ -0,0 +1,73 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+// Package addons contains the service to manage addons.
+package addons
+
+import (
+	"bytes"
+	"fmt"
+	"text/template"
+
+	"github.com/aws/amazon-ecs-cli-v2/internal/pkg/workspace"
+	"github.com/aws/amazon-ecs-cli-v2/templates"
+	"github.com/gobuffalo/packd"
+)
+
+const (
+	addonsTemplatePath = "addons/cf.yml"
+)
+
+type workspaceService interface {
+	ReadAddonFiles(appName string) (*workspace.ReadAddonFilesOutput, error)
+}
+
+// Addons represent additional resources for an application.
+type Addons struct {
+	appName string
+
+	box packd.Box
+	ws  workspaceService
+}
+
+// New creates an Addons struct given an application name.
+func New(appName string) (*Addons, error) {
+	ws, err := workspace.New()
+	if err != nil {
+		return nil, fmt.Errorf("workspace cannot be created: %w", err)
+	}
+	return &Addons{
+		appName: appName,
+		box:     templates.Box(),
+		ws:      ws,
+	}, nil
+}
+
+// Template parses params.yml, policy.yml, {resource}.yml, and outputs.yml to generate
+// the addons CloudFormation template.
+func (a *Addons) Template() (string, error) {
+	addonContent, err := a.ws.ReadAddonFiles(a.appName)
+	if err != nil {
+		return "", err
+	}
+	content, err := a.box.FindString(addonsTemplatePath)
+	if err != nil {
+		return "", fmt.Errorf("failed to find the cloudformation template at %s", addonsTemplatePath)
+	}
+	tpl, err := template.New("template").Parse(content)
+	if err != nil {
+		return "", fmt.Errorf("parse CloudFormation template for %s: %w", a.appName, err)
+	}
+	var buf bytes.Buffer
+	templateData := struct {
+		AppName      string
+		AddonContent *workspace.ReadAddonFilesOutput
+	}{
+		AppName:      a.appName,
+		AddonContent: addonContent,
+	}
+	if err := tpl.Execute(&buf, templateData); err != nil {
+		return "", fmt.Errorf("execute CloudFormation template for %s: %w", a.appName, err)
+	}
+	return buf.String(), nil
+}

internal/pkg/addons/addons_test.go

@@ -0,0 +1,83 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package addons
+
+import (
+	"testing"
+
+	"github.com/aws/amazon-ecs-cli-v2/internal/pkg/addons/mocks"
+	"github.com/aws/amazon-ecs-cli-v2/internal/pkg/workspace"
+	"github.com/gobuffalo/packd"
+	"github.com/golang/mock/gomock"
+	"github.com/stretchr/testify/require"
+)
+
+func TestTemplate(t *testing.T) {
+	testCases := map[string]struct {
+		appName string
+
+		mockWorkspace func(m *mocks.MockworkspaceService)
+		mockBox       func(box *packd.MemoryBox)
+
+		wantTemplate string
+		wantErr      error
+	}{
+		"should return addon template": {
+			appName: "my-app",
+
+			mockBox: func(box *packd.MemoryBox) {
+				box.AddString(addonsTemplatePath, `Description: Additional resources for application '{{.AppName}}'
+Parameters:
+{{.AddonContent.Parameters}}
+Resources:
+{{.AddonContent.Resources}}
+Outputs:
+{{.AddonContent.Outputs}}`)
+			},
+
+			mockWorkspace: func(m *mocks.MockworkspaceService) {
+				m.EXPECT().ReadAddonFiles("my-app").Return(&workspace.ReadAddonFilesOutput{
+					Outputs:    []string{"outputs"},
+					Parameters: []string{"params"},
+					Resources:  []string{"resources"},
+				}, nil)
+			},
+
+			wantTemplate: `Description: Additional resources for application 'my-app'
+Parameters:
+[params]
+Resources:
+[resources]
+Outputs:
+[outputs]`,
+		},
+	}
+
+	for name, tc := range testCases {
+		t.Run(name, func(t *testing.T) {
+			// GIVEN
+			ctrl := gomock.NewController(t)
+			defer ctrl.Finish()
+
+			mockWorkspace := mocks.NewMockworkspaceService(ctrl)
+			tc.mockWorkspace(mockWorkspace)
+			box := packd.NewMemoryBox()
+			tc.mockBox(box)
+
+			service := Addons{
+				appName: tc.appName,
+				ws:      mockWorkspace,
+				box:     box,
+			}
+
+			gotTemplate, gotErr := service.Template()
+
+			if gotErr != nil {
+				require.Equal(t, tc.wantErr, gotErr)
+			} else {
+				require.Equal(t, tc.wantTemplate, gotTemplate)
+			}
+		})
+	}
+}

internal/pkg/addons/mocks/mock_addons.go

@@ -1,4 +1,4 @@
-// Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 
 // Package workspace contains functionality to manage a user's local workspace. This includes
@@ -21,6 +21,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"github.com/spf13/afero"
 	"gopkg.in/yaml.v3"
@@ -29,12 +30,17 @@ import (
 const (
 	// ProjectDirectoryName is the name of the directory where generated infrastructure code will be stored.
 	ProjectDirectoryName = "ecs-project"
+	// AddonsFileSuffix is the suffix of the addons files.
+	AddonsFileSuffix = ".yml"
 
+	addonsDirName             = "addons"
 	workspaceSummaryFileName  = ".ecs-workspace"
 	maximumParentDirsToSearch = 5
 	pipelineFileName          = "pipeline.yml"
 	manifestFileName          = "manifest.yml"
 	buildspecFileName         = "buildspec.yml"
+	paramsFileName            = "params.yml"
+	outputsFileName           = "outputs.yml"
 )
 
 // Summary is a description of what's associated with this workspace.
@@ -49,6 +55,13 @@ type Workspace struct {
 	fsUtils    *afero.Afero
 }
 
+// ReadAddonFilesOutput is the output for ReadAddonFiles.
+type ReadAddonFilesOutput struct {
+	Parameters []string
+	Resources  []string
+	Outputs    []string
+}
+
 // New returns a workspace, used for reading and writing to
 // user's local workspace.
 func New() (*Workspace, error) {
@@ -203,6 +216,54 @@ func (ws *Workspace) DeleteAll() error {
 	return ws.fsUtils.RemoveAll(ProjectDirectoryName)
 }
 
+// ListAddonFiles lists addon file names for an application.
+func (ws *Workspace) ListAddonFiles(appName string) ([]string, error) {
+	projectDir, err := ws.projectDirPath()
+	if err != nil {
+		return nil, err
+	}
+	addonsFiles, err := ws.fsUtils.ReadDir(filepath.Join(projectDir, appName, addonsDirName))
+	if err != nil {
+		return nil, err
+	}
+	var addonsFileNames []string
+	for _, file := range addonsFiles {
+		if !file.IsDir() && strings.HasSuffix(file.Name(), AddonsFileSuffix) {
+			addonsFileNames = append(addonsFileNames, file.Name())
+		}
+	}
+
+	return addonsFileNames, nil
+}
+
+// ReadAddonFiles reads all addon files.
+func (ws *Workspace) ReadAddonFiles(appName string) (*ReadAddonFilesOutput, error) {
+	addonFiles, err := ws.ListAddonFiles(appName)
+	if err != nil {
+		return nil, fmt.Errorf("list addon files: %w", err)
+	}
+	var resources, params, outputs string
+	for _, fileName := range addonFiles {
+		content, err := ws.read(appName, addonsDirName, fileName)
+		if err != nil {
+			return nil, fmt.Errorf("read addon file %s: %w", fileName, err)
+		}
+		switch fileName {
+		case paramsFileName:
+			params = string(content)
+		case outputsFileName:
+			outputs = string(content)
+		default:
+			resources += string(content)
+		}
+	}
+	return &ReadAddonFilesOutput{
+		Parameters: strings.Split(params, "\n"),
+		Resources:  strings.Split(resources, "\n"),
+		Outputs:    strings.Split(outputs, "\n"),
+	}, nil
+}
+
 func (ws *Workspace) writeSummary(projectName string) error {
 	summaryPath, err := ws.summaryPath()
 	if err != nil {