another checkpoint

cmd/deploy.go

@@ -21,6 +21,10 @@ import (
 	yaml "gopkg.in/yaml.v2"
 )
 
+const (
+	minimumChromiumVersion = 86
+)
+
 var (
 	name, region, email, device, sshKey, maxPrice, skipPrice, schedule, cloud string
 	instanceType, instanceRegions, chromiumVersion, latestURL string
@@ -91,13 +95,13 @@ func init() {
 		"specify the version of Chromium you want (e.g. 80.0.3971.4) to pin to. if not specified, the latest stable version of Chromium is used.")
 	_ = viper.BindPFlag("chromium-version", flags.Lookup("chromium-version"))
 
-	flags.StringVar(&coreConfigRepo, "core-config-repo", stack.DefaultCoreConfigRepo, "a specially formatted repo that contains core customizations on top of AOSP.")
+	flags.StringVar(&coreConfigRepo, "core-config-repo", templates.DefaultCoreConfigRepo, "a specially formatted repo that contains core customizations on top of AOSP.")
 	_ = viper.BindPFlag("core-config-repo", flags.Lookup("core-config-repo"))
 
 	flags.StringVar(&customConfigRepo, "custom-config-repo", "", "a specially formatted repo that contains customizations on top of core.")
 	_ = viper.BindPFlag("custom-config-repo", flags.Lookup("custom-config-repo"))
 
-	flags.StringVar(&latestURL, "latest-url", stack.DefaultLatestURL, "url that is used to check versions of aosp/chromium and whether build is required.")
+	flags.StringVar(&latestURL, "latest-url", templates.DefaultLatestURL, "url that is used to check versions of aosp/chromium and whether build is required.")
 	_ = viper.BindPFlag("latest-url", flags.Lookup("latest-url"))
 
 	flags.StringVar(&cloud, "cloud", "aws", "cloud (aws only right now)")
@@ -134,8 +138,8 @@ var deployCmd = &cobra.Command{
 			if err != nil {
 				return fmt.Errorf("unable to parse specified chromium-version: %v", err)
 			}
-			if chromiumMajorNumber < stack.MinimumChromiumVersion {
-				return fmt.Errorf("pinned chromium-version must have major version of at least %v", stack.MinimumChromiumVersion)
+			if chromiumMajorNumber < minimumChromiumVersion {
+				return fmt.Errorf("pinned chromium-version must have major version of at least %v", minimumChromiumVersion)
 			}
 		}
 		for _, device := range supportedDevicesCodename {
@@ -201,21 +205,29 @@ var deployCmd = &cobra.Command{
 			log.Fatalf("failed to create template client: %v", err)
 		}
 
-		cloudClient, err := cloudaws.New(
+		awsSetupClient, err := cloudaws.NewSetupClient(
+			viper.GetString("name"),
+			viper.GetString("region"),
+		)
+		if err != nil {
+			log.Fatalf("failed to create aws setup client: %v", err)
+		}
+
+		awsSubscribeClient, err := cloudaws.NewSubscribeClient(
 			viper.GetString("name"),
 			viper.GetString("region"),
 			viper.GetString("email"),
 		)
 		if err != nil {
-			log.Fatalf("failed to create cloud client: %v", err)
+			log.Fatalf("failed to create aws subscribe client: %v", err)
 		}
 
 		terraformClient, err := terraform.New(outputDirFullPath)
 		if err != nil {
 			log.Fatalf("failed to create terraform client: %v", err)
 		}
 
-		s := stack.New(viper.GetString("name"), templateRenderer, cloudClient, terraformClient)
+		s := stack.New(viper.GetString("name"), templateRenderer, awsSetupClient, awsSubscribeClient, terraformClient)
 		if err != nil {
 			log.Fatal(err)
 		}

internal/cloudaws/aws.go → internal/cloudaws/client_setup.go

@@ -10,8 +10,6 @@ import (
 	iamtypes "github.com/aws/aws-sdk-go-v2/service/iam/types"
 	"github.com/aws/aws-sdk-go-v2/service/s3"
 	s3types "github.com/aws/aws-sdk-go-v2/service/s3/types"
-	"github.com/aws/aws-sdk-go-v2/service/sns"
-	"strings"
 	"time"
 )
 
@@ -20,14 +18,13 @@ const (
 	DefaultInstanceRegions = "us-west-2,us-west-1,us-east-2"
 )
 
-type AWS struct {
-	cfg          aws.Config
-	name         string
-	region       string
-	emailAddress string
+type SetupClient struct {
+	cfg    aws.Config
+	name   string
+	region string
 }
 
-func New(name, region, emailAddress string) (*AWS, error) {
+func NewSetupClient(name, region string) (*SetupClient, error) {
 	cfg, err := config.LoadDefaultConfig(context.Background(), config.WithRegion(region))
 	if err != nil {
 		return nil, fmt.Errorf("failed to load default aws config: %w", err)
@@ -37,68 +34,24 @@ func New(name, region, emailAddress string) (*AWS, error) {
 		return nil, err
 	}
 
-	return &AWS{
-		cfg:          cfg,
-		name:         name,
-		region:       region,
-		emailAddress: emailAddress,
+	return &SetupClient{
+		cfg:    cfg,
+		name:   name,
+		region: region,
 	}, nil
 }
 
-func (c *AWS) Setup(ctx context.Context) error {
-	if err := c.s3Setup(ctx); err != nil {
+func (c *SetupClient) Setup(ctx context.Context) error {
+	if err := c.s3BucketSetup(ctx); err != nil {
 		return err
 	}
-	if err := c.rolesSetup(ctx); err != nil {
+	if err := c.serviceLinkedRolesSetup(ctx); err != nil {
 		return err
 	}
 	return nil
 }
 
-func (c *AWS) SubscribeNotifications(ctx context.Context) error {
-	return c.subscribeNotifications(ctx)
-}
-
-func (c *AWS) subscribeNotifications(ctx context.Context) error {
-	snsClient := sns.NewFromConfig(c.cfg)
-	resp, err := snsClient.ListTopics(ctx, &sns.ListTopicsInput{NextToken: aws.String("")})
-	if err != nil {
-		return fmt.Errorf("failed to list sns topics: %w", err)
-	}
-
-	for _, topic := range resp.Topics {
-		if c.name == strings.Split(*topic.TopicArn, ":")[5] {
-			resp, err := snsClient.ListSubscriptionsByTopic(ctx, &sns.ListSubscriptionsByTopicInput{
-				NextToken: aws.String(""),
-				TopicArn:  aws.String(*topic.TopicArn),
-			})
-			if err != nil {
-				return fmt.Errorf("failed to list SNS subscriptions for topic %v: %w", *topic.TopicArn, err)
-			}
-
-			// if subscription already exists return
-			for _, subscription := range resp.Subscriptions {
-				if *subscription.Endpoint == c.emailAddress {
-					return nil
-				}
-			}
-
-			// subscribe if not setup
-			_, err = snsClient.Subscribe(ctx, &sns.SubscribeInput{
-				Protocol: aws.String("email"),
-				TopicArn: aws.String(*topic.TopicArn),
-				Endpoint: aws.String(c.emailAddress),
-			})
-			if err != nil {
-				return fmt.Errorf("failed to setup email notifications: %w", err)
-			}
-			return nil
-		}
-	}
-	return fmt.Errorf("failed to subscribe to notifications - unable to find topic %v", c.name)
-}
-
-func (c *AWS) rolesSetup(ctx context.Context) error {
+func (c *SetupClient) serviceLinkedRolesSetup(ctx context.Context) error {
 	iamClient := iam.NewFromConfig(c.cfg)
 
 	_, err := iamClient.CreateServiceLinkedRole(ctx, &iam.CreateServiceLinkedRoleInput{
@@ -124,7 +77,7 @@ func (c *AWS) rolesSetup(ctx context.Context) error {
 	return nil
 }
 
-func (c *AWS) s3Setup(ctx context.Context) error {
+func (c *SetupClient) s3BucketSetup(ctx context.Context) error {
 	s3Client := s3.NewFromConfig(c.cfg)
 	_, err := s3Client.HeadBucket(ctx, &s3.HeadBucketInput{Bucket: &c.name})
 	if err != nil {

internal/cloudaws/client_subscribe.go

@@ -0,0 +1,87 @@
+package cloudaws
+
+import (
+	"context"
+	"fmt"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/config"
+	"github.com/aws/aws-sdk-go-v2/service/sns"
+	"strings"
+	"time"
+)
+
+type SubscribeClient struct {
+	cfg    aws.Config
+	name   string
+	region string
+	email  string
+}
+
+func NewSubscribeClient(name, region, email string) (*SubscribeClient, error) {
+	cfg, err := config.LoadDefaultConfig(context.Background(), config.WithRegion(region))
+	if err != nil {
+		return nil, fmt.Errorf("failed to load default aws config: %w", err)
+	}
+
+	if err := checkSNSAccess(cfg); err != nil {
+		return nil, err
+	}
+
+	return &SubscribeClient{
+		cfg:    cfg,
+		name:   name,
+		region: region,
+		email:  email,
+	}, nil
+}
+
+func (c *SubscribeClient) Subscribe(ctx context.Context) error {
+	snsClient := sns.NewFromConfig(c.cfg)
+	resp, err := snsClient.ListTopics(ctx, &sns.ListTopicsInput{NextToken: aws.String("")})
+	if err != nil {
+		return fmt.Errorf("failed to list sns topics: %w", err)
+	}
+
+	for _, topic := range resp.Topics {
+		if c.name == strings.Split(*topic.TopicArn, ":")[5] {
+			resp, err := snsClient.ListSubscriptionsByTopic(ctx, &sns.ListSubscriptionsByTopicInput{
+				NextToken: aws.String(""),
+				TopicArn:  aws.String(*topic.TopicArn),
+			})
+			if err != nil {
+				return fmt.Errorf("failed to list SNS subscriptions for topic %v: %w", *topic.TopicArn, err)
+			}
+
+			// if subscription already exists return
+			for _, subscription := range resp.Subscriptions {
+				if *subscription.Endpoint == c.email {
+					return nil
+				}
+			}
+
+			// subscribe if not setup
+			_, err = snsClient.Subscribe(ctx, &sns.SubscribeInput{
+				Protocol: aws.String("email"),
+				TopicArn: aws.String(*topic.TopicArn),
+				Endpoint: aws.String(c.email),
+			})
+			if err != nil {
+				return fmt.Errorf("failed to setup email notifications: %w", err)
+			}
+			return nil
+		}
+	}
+	return fmt.Errorf("failed to subscribe to notifications - unable to find topic %v", c.name)
+}
+
+func checkSNSAccess(cfg aws.Config) error {
+	ctx, cancel := context.WithTimeout(context.Background(), time.Second * 10)
+	defer cancel()
+
+	snsClient := sns.NewFromConfig(cfg)
+	_, err := snsClient.ListTopics(ctx, &sns.ListTopicsInput{NextToken: aws.String("")})
+	if err != nil {
+		return fmt.Errorf("unable to list S3 buckets - make sure you have valid admin AWS credentials: %w", err)
+	}
+	return nil
+}

internal/cloudaws/ec2.go

@@ -10,6 +10,7 @@ import (
 	"strings"
 )
 
+// TerminateEC2Instance terminates the specified ec2 instance
 func TerminateEC2Instance(ctx context.Context, instanceID, region string) (*ec2.TerminateInstancesOutput, error) {
 	cfg, err := config.LoadDefaultConfig(ctx, config.WithRegion(region))
 	if err != nil {
@@ -27,6 +28,7 @@ func TerminateEC2Instance(ctx context.Context, instanceID, region string) (*ec2.
 	return output, nil
 }
 
+// GetRunningEC2InstancesWithProfileName returns a list of instances running with a profile name
 func GetRunningEC2InstancesWithProfileName(ctx context.Context, profileName, listRegions string) ([]string, error) {
 	cfg, err := config.LoadDefaultConfig(ctx)
 	if err != nil {

internal/cloudaws/lambda.go

@@ -9,6 +9,7 @@ import (
 	lambdatypes "github.com/aws/aws-sdk-go-v2/service/lambda/types"
 )
 
+// ExecuteLambdaFunction executes a synchronous Lambda function
 func ExecuteLambdaFunction(ctx context.Context, functionName, region string, payload []byte) (*lambda.InvokeOutput, error) {
 	cfg, err := config.LoadDefaultConfig(ctx, config.WithRegion(region))
 	if err != nil {

internal/cloudaws/regions.go

@@ -7,7 +7,9 @@ var (
 
 // Region contains details about an AWS region
 type Region struct {
+	// Name is the name of the region (e.g. us-west-2)
 	Name string
+	// AMI is the AMI to use in this region
 	AMI  string
 }
 

internal/devices/devices.go

@@ -18,11 +18,11 @@ var (
 	deviceSortOrder  []string
 )
 
+// Device contains details and metadata about a device
 type Device struct {
 	Name     string
 	Friendly string
 	Family   string
-	Common   string
 	AVBMode  string
 	ExtraOTA string
 }
@@ -33,60 +33,52 @@ func init() {
 			Name:     blueline,
 			Friendly: "Pixel 3",
 			Family:   "crosshatch",
-			Common:   "crosshatch",
 			AVBMode:  avbModeChained,
 			ExtraOTA: "(--retrofit_dynamic_partitions)",
 		},
 		Device{
 			Name:     crosshatch,
 			Friendly: "Pixel 3 XL",
 			Family:   "crosshatch",
-			Common:   "crosshatch",
 			AVBMode:  avbModeChained,
 			ExtraOTA: "(--retrofit_dynamic_partitions)",
 		},
 		Device{
 			Name:     sargo,
 			Friendly: "Pixel 3a",
 			Family:   "bonito",
-			Common:   "bonito",
 			AVBMode:  avbModeChained,
 			ExtraOTA: "(--retrofit_dynamic_partitions)",
 		},
 		Device{
 			Name:     bonito,
 			Friendly: "Pixel 3a XL",
 			Family:   "bonito",
-			Common:   "bonito",
 			AVBMode:  avbModeChained,
 			ExtraOTA: "(--retrofit_dynamic_partitions)",
 		},
 		Device{
 			Name:     flame,
 			Friendly: "Pixel 4",
 			Family:   "coral",
-			Common:   "coral",
 			AVBMode:  avbModeChainedV2,
 		},
 		Device{
 			Name:     coral,
 			Friendly: "Pixel 4 XL",
 			Family:   "coral",
-			Common:   "coral",
 			AVBMode:  avbModeChainedV2,
 		},
 		Device{
 			Name:     sunfish,
 			Friendly: "Pixel 4a",
 			Family:   "sunfish",
-			Common:   "sunfish",
 			AVBMode:  avbModeChainedV2,
 		},
 		Device{
 			Name:     redfin,
 			Friendly: "Pixel 5",
 			Family:   "redfin",
-			Common:   "redfin",
 			AVBMode:  avbModeChainedV2,
 		},
 	)