fix: Add codegen for AWS regions (#2701)

hermanschaaf · web-flow · commit 9b1b2ca6cd1b · 2022-10-16T08:24:20.000Z
Found another case of an AWS resource not being generated with codegen. It was unfortunately not so easy to deal with this one in a backwards-compatible way. The biggest issue is keeping the name `aws_regions` rather than `aws_ec2_regions` (which would be in line with all other resources). 

Note: This could perhaps be considered a `chore`, as it should change no user-facing functionality, but since there is a small change in the ordering of the columns I think I'd rather have it reported as one of the changes in the next release.
diff --git a/plugins/source/aws/codegen/recipes/base.go b/plugins/source/aws/codegen/recipes/base.go
@@ -19,6 +19,8 @@ import (
 )
 
 type Resource struct {
+	// Name overrides the table name: used only in rare cases for backwards-compatibility.
+	Name                  string
 	Service               string
 	SubService            string
 	Struct                interface{}
@@ -96,8 +98,12 @@ func (r *Resource) Generate() error {
 	if r.UnwrapEmbeddedStructs {
 		opts = append(opts, codegen.WithUnwrapAllEmbeddedStructs())
 	}
+	name := fmt.Sprintf("aws_%s_%s", r.Service, r.SubService)
+	if r.Name != "" {
+		name = r.Name
+	}
 	r.Table, err = codegen.NewTableFromStruct(
-		fmt.Sprintf("aws_%s_%s", r.Service, r.SubService),
+		name,
 		r.Struct,
 		opts...,
 	)
diff --git a/plugins/source/aws/codegen/recipes/ec2.go b/plugins/source/aws/codegen/recipes/ec2.go
@@ -279,6 +279,36 @@ func EC2Resources() []*Resource {
 					},
 				}...),
 		},
+		{
+			Name:       "aws_regions", // rename table for backwards-compatibility
+			SubService: "regions",
+			Struct:     &types.Region{},
+			SkipFields: []string{"RegionName"},
+			Multiplex:  `client.AccountMultiplex`,
+			ExtraColumns: []codegen.ColumnDefinition{
+				{
+					Name:     "account_id",
+					Type:     schema.TypeString,
+					Resolver: `client.ResolveAWSAccount`,
+				},
+				{
+					Name:     "enabled",
+					Type:     schema.TypeBool,
+					Resolver: `resolveRegionEnabled`,
+				},
+				{
+					Name:     "partition",
+					Type:     schema.TypeString,
+					Resolver: `resolveRegionPartition`,
+				},
+				// for backwards-compatibility: renamed "region_name" to "region"
+				{
+					Name:     "region",
+					Type:     schema.TypeString,
+					Resolver: `schema.PathResolver("RegionName")`,
+				},
+			},
+		},
 		{
 			SubService: "regional_config",
 			Struct:     &models.RegionalConfig{},
@@ -591,7 +621,9 @@ func EC2Resources() []*Resource {
 	}
 	for _, r := range resources {
 		r.Service = "ec2"
-		r.Multiplex = `client.ServiceAccountRegionMultiplexer("ec2")`
+		if r.Multiplex == "" {
+			r.Multiplex = `client.ServiceAccountRegionMultiplexer("ec2")`
+		}
 	}
 	return resources
 }
diff --git a/plugins/source/aws/docs/tables/README.md b/plugins/source/aws/docs/tables/README.md
@@ -66,7 +66,7 @@
 | [aws_ec2_network_acls](aws_ec2_network_acls.md)| | https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_NetworkAcl.html|
 | [aws_ec2_network_interfaces](aws_ec2_network_interfaces.md)| | https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_NetworkInterface.html|
 | [aws_ec2_regional_config](aws_ec2_regional_config.md)| | |
-| [aws_regions](aws_regions.md)| | Describes a Region.|
+| [aws_regions](aws_regions.md)| | |
 | [aws_ec2_reserved_instances](aws_ec2_reserved_instances.md)| | https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReservedInstances.html|
 | [aws_ec2_route_tables](aws_ec2_route_tables.md)| | https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RouteTable.html|
 | [aws_ec2_security_groups](aws_ec2_security_groups.md)| | https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SecurityGroup.html|
diff --git a/plugins/source/aws/docs/tables/aws_regions.md b/plugins/source/aws/docs/tables/aws_regions.md
@@ -1,6 +1,6 @@
 # Table: aws_regions
 
-Describes a Region.
+
 
 The primary key for this table is **_cq_id**.
 
@@ -14,7 +14,7 @@ The primary key for this table is **_cq_id**.
 |_cq_parent_id|UUID|
 |account_id|String|
 |enabled|Bool|
-|endpoint|String|
-|opt_in_status|String|
+|partition|String|
 |region|String|
-|partition|String|
+|endpoint|String|
+|opt_in_status|String|
diff --git a/plugins/source/aws/resources/services/ec2/regions.go b/plugins/source/aws/resources/services/ec2/regions.go
diff --git a/plugins/source/aws/resources/services/ec2/regions_fetch.go b/plugins/source/aws/resources/services/ec2/regions_fetch.go
@@ -0,0 +1,36 @@
+package ec2
+
+import (
+	"context"
+	"github.com/aws/aws-sdk-go-v2/aws"
+	"github.com/aws/aws-sdk-go-v2/service/ec2"
+	"github.com/aws/aws-sdk-go-v2/service/ec2/types"
+	"github.com/cloudquery/cloudquery/plugins/source/aws/client"
+	"github.com/cloudquery/plugin-sdk/schema"
+)
+
+func fetchEc2Regions(ctx context.Context, meta schema.ClientMeta, parent *schema.Resource, res chan<- interface{}) error {
+	c := meta.(*client.Client)
+	output, err := c.Services().EC2.DescribeRegions(ctx, &ec2.DescribeRegionsInput{AllRegions: aws.Bool(true)})
+	if err != nil {
+		return err
+	}
+	res <- output.Regions
+	return nil
+}
+
+func resolveRegionEnabled(ctx context.Context, meta schema.ClientMeta, resource *schema.Resource, c schema.Column) error {
+	region := resource.Item.(types.Region)
+	switch *region.OptInStatus {
+	case "opt-in-not-required", "opted-in":
+		return resource.Set(c.Name, true)
+	case "not-opted-in":
+		return resource.Set(c.Name, false)
+	}
+	return nil
+}
+
+func resolveRegionPartition(ctx context.Context, meta schema.ClientMeta, resource *schema.Resource, c schema.Column) error {
+	cl := meta.(*client.Client)
+	return resource.Set(c.Name, cl.Partition)
+}
