Skip to content

Commit

Permalink
fix linter issues and address reviews
Browse files Browse the repository at this point in the history
Signed-off-by: Erhan Cagirici <[email protected]>
  • Loading branch information
erhancagirici committed Mar 14, 2024
1 parent 1fabbe6 commit f148c02
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 31 deletions.
1 change: 1 addition & 0 deletions config/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"context"
// Note(ezgidemirel): we are importing this to embed provider schema document
_ "embed"

"github.com/crossplane/upjet/pkg/config"
"github.com/crossplane/upjet/pkg/registry/reference"
conversiontfjson "github.com/crossplane/upjet/pkg/types/conversion/tfjson"
Expand Down
50 changes: 28 additions & 22 deletions internal/clients/aws.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ package clients

import (
"context"
"k8s.io/apimachinery/pkg/runtime"
"reflect"
"unsafe"

Expand All @@ -23,7 +24,7 @@ import (
)

const (
keyAccountId = "account_id"
keyAccountID = "account_id"
)

type SetupConfig struct {
Expand All @@ -34,15 +35,15 @@ func SelectTerraformSetup(config *SetupConfig) terraform.SetupFn { // nolint:goc
return func(ctx context.Context, c client.Client, mg resource.Managed) (terraform.Setup, error) {
pc := &v1beta1.ProviderConfig{}
if err := c.Get(ctx, types.NamespacedName{Name: mg.GetProviderConfigReference().Name}, pc); err != nil {
return terraform.Setup{}, errors.Wrapf(err, "cannot get referenced Provider: %s", mg.GetProviderConfigReference().Name)
return terraform.Setup{}, errors.Wrapf(err, "cannot get referenced ProviderConfig: %q", mg.GetProviderConfigReference().Name)
}
t := resource.NewProviderConfigUsageTracker(c, &v1beta1.ProviderConfigUsage{})
if err := t.Track(ctx, mg); err != nil {
return terraform.Setup{}, errors.Wrap(err, "cannot track ProviderConfig usage")
return terraform.Setup{}, errors.Wrapf(err, "cannot track ProviderConfig usage for %q", mg.GetProviderConfigReference().Name)
}

ps := terraform.Setup{}
awsCfg, err := GetAWSConfigWithDefaultRegion(ctx, c, mg, pc)
awsCfg, err := getAWSConfigWithDefaultRegion(ctx, c, mg, pc)
if err != nil {
return terraform.Setup{}, errors.Wrap(err, "cannot get aws config")
} else if awsCfg == nil {
Expand All @@ -61,12 +62,12 @@ func SelectTerraformSetup(config *SetupConfig) terraform.SetupFn { // nolint:goc
}
}
ps.ClientMetadata = map[string]string{
keyAccountId: account,
keyAccountID: account,
}
if config.TerraformProvider == nil {
return terraform.Setup{}, errors.New("terraform provider cannot be nil")
}
return ps, errors.Wrap(configureNoForkAWSClient(ctx, &ps, config, awsCfg, creds, pc), "could not configure the no-fork AWS client")
return ps, errors.Wrap(configureNoForkAWSClient(ctx, &ps, config, awsCfg.Region, creds, pc), "could not configure the no-fork AWS client")
}
}

Expand All @@ -80,10 +81,16 @@ func getAccountId(ctx context.Context, cfg *aws.Config, creds aws.Credentials) (
return *identity.Account, nil
}

func GetAWSConfigWithDefaultRegion(ctx context.Context, c client.Client, mg resource.Managed, pc *v1beta1.ProviderConfig) (*aws.Config, error) {
cfg, err := GetAWSConfigViaProviderConfig(ctx, c, mg, pc)
// getAWSConfigWithDefaultRegion is a utility function that wraps the
// GetAWSConfigWithoutTracking and fills empty region in the returned for
// "iam.aws.upbound.io" group with a default "us-east-1" region. Although
// this does not have an effect on the resource, as IAM group resources
// has no concept of region, this is done to conform with the TF AWS config
// which requires non-empty region
func getAWSConfigWithDefaultRegion(ctx context.Context, c client.Client, obj runtime.Object, pc *v1beta1.ProviderConfig) (*aws.Config, error) {
cfg, err := GetAWSConfigWithoutTracking(ctx, c, obj, pc)
if err != nil {
return nil, errors.Wrap(err, "cannot get AWS config")
return nil, err
}
if cfg.Region == "" && mg.GetObjectKind().GroupVersionKind().Group == "iam.aws.upbound.io" {

Check failure on line 95 in internal/clients/aws.go

View workflow job for this annotation

GitHub Actions / ci / local-deploy

undefined: mg

Check failure on line 95 in internal/clients/aws.go

View workflow job for this annotation

GitHub Actions / ci / unit-tests

undefined: mg
cfg.Region = "us-east-1"
Expand All @@ -102,22 +109,21 @@ func (m *metaOnlyPrimary) Meta() any {
// configureNoForkAWSClient populates the supplied *terraform.Setup with
// Terraform Plugin SDK style AWS client (Meta) and Terraform Plugin Framework
// style FrameworkProvider
func configureNoForkAWSClient(ctx context.Context, ps *terraform.Setup, config *SetupConfig, awsCfg *aws.Config, creds aws.Credentials, pc *v1beta1.ProviderConfig) error { //nolint:gocyclo
func configureNoForkAWSClient(ctx context.Context, ps *terraform.Setup, config *SetupConfig, region string, creds aws.Credentials, pc *v1beta1.ProviderConfig) error { //nolint:gocyclo
tfAwsConnsCfg := xpprovider.AWSConfig{
AccessKey: creds.AccessKeyID,
EC2MetadataServiceEnableState: imds.ClientDefaultEnableState,
Endpoints: map[string]string{},
Region: awsCfg.Region,
S3UsePathStyle: pc.Spec.S3UsePathStyle,
SecretKey: creds.SecretAccessKey,
SkipCredsValidation: true, // disabled to prevent extra AWS STS call
SkipRegionValidation: pc.Spec.SkipRegionValidation,
SkipRequestingAccountId: true, // disabled to prevent extra AWS STS call
Token: creds.SessionToken,
AccessKey: creds.AccessKeyID,
Endpoints: map[string]string{},
Region: region,
S3UsePathStyle: pc.Spec.S3UsePathStyle,
SecretKey: creds.SecretAccessKey,
SkipCredsValidation: true, // disabled to prevent extra AWS STS call
SkipRegionValidation: pc.Spec.SkipRegionValidation,
SkipRequestingAccountId: true, // disabled to prevent extra AWS STS call
Token: creds.SessionToken,
}

if pc.Spec.SkipMetadataApiCheck {
tfAwsConnsCfg.EC2MetadataServiceEnableState = imds.ClientEnabled
tfAwsConnsCfg.EC2MetadataServiceEnableState = imds.ClientDisabled
}

if pc.Spec.Endpoint != nil {
Expand Down Expand Up @@ -147,7 +153,7 @@ func configureNoForkAWSClient(ctx context.Context, ps *terraform.Setup, config *
// the resulting TF AWS Client has empty account ID.
// Fill with previously calculated account ID.
// No need for nil check on ps.ClientMetadata per golang spec.
tfAwsConnsClient.AccountID = ps.ClientMetadata[keyAccountId]
tfAwsConnsClient.AccountID = ps.ClientMetadata[keyAccountID]
ps.Meta = tfAwsConnsClient
fwProvider := xpprovider.GetFrameworkProviderWithMeta(&metaOnlyPrimary{meta: tfAwsConnsClient})
ps.FrameworkProvider = fwProvider
Expand Down
17 changes: 9 additions & 8 deletions internal/clients/provider_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ const (
authKeyWebIdentity = "WebIdentity"
authKeyUpbound = "Upbound"
// authKeySAML = "SAML"
// authKeySecret = "Secret"

envWebIdentityTokenFile = "AWS_WEB_IDENTITY_TOKEN_FILE"
envWebIdentityRoleARN = "AWS_ROLE_ARN"
Expand Down Expand Up @@ -85,10 +84,12 @@ func getRegion(obj runtime.Object) (string, error) {
return r, err
}

// GetAWSConfigViaProviderConfig produces an AWS config from the specified
// v1beta1.ProviderConfig that can be used to authenticate to AWS
func GetAWSConfigViaProviderConfig(ctx context.Context, c client.Client, mg resource.Managed, pc *v1beta1.ProviderConfig) (*aws.Config, error) { // nolint:gocyclo
region, err := getRegion(mg)
// GetAWSConfigWithoutTracking produces an AWS config from the specified
// v1beta1.ProviderConfig that can be used to authenticate to AWS.
// ProviderConfigUsage is not tracked when this function is called.
// The caller is responsible for tracking the usage if needed.
func GetAWSConfigWithoutTracking(ctx context.Context, c client.Client, obj runtime.Object, pc *v1beta1.ProviderConfig) (*aws.Config, error) { // nolint:gocyclo
region, err := getRegion(obj)
if err != nil {
return nil, errors.Wrap(err, "cannot get region")
}
Expand Down Expand Up @@ -127,11 +128,11 @@ func GetAWSConfigViaProviderConfig(ctx context.Context, c client.Client, mg reso
return SetResolver(pc, cfg), nil
}

// GetAWSConfigWithProviderUsage obtains the provider config referenced by the
// GetAWSConfigWithTracking obtains the provider config referenced by the
// specified managed resource and produces a config that can be used to
// authenticate to AWS and tracks the ProviderConfigUsage. Useful for obtaining
// AWS config for non-upjet based MR controllers.
func GetAWSConfigWithProviderUsage(ctx context.Context, c client.Client, mg resource.Managed) (*aws.Config, error) { // nolint:gocyclo
func GetAWSConfigWithTracking(ctx context.Context, c client.Client, mg resource.Managed) (*aws.Config, error) {
if mg.GetProviderConfigReference() == nil {
return nil, errors.New("no providerConfigRef provided")
}
Expand All @@ -144,7 +145,7 @@ func GetAWSConfigWithProviderUsage(ctx context.Context, c client.Client, mg reso
if err := t.Track(ctx, mg); err != nil {
return nil, errors.Wrap(err, "cannot track ProviderConfig usage")
}
return GetAWSConfigViaProviderConfig(ctx, c, mg, pc)
return GetAWSConfigWithoutTracking(ctx, c, mg, pc)
}

type awsEndpointResolverAdaptorWithOptions func(service, region string, options interface{}) (aws.Endpoint, error)
Expand Down
2 changes: 1 addition & 1 deletion internal/controller/eks/clusterauth/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ type connector struct {
}

func (c *connector) Connect(ctx context.Context, mg resource.Managed) (managed.ExternalClient, error) {
cfg, err := clients.GetAWSConfigWithProviderUsage(ctx, c.kube, mg)
cfg, err := clients.GetAWSConfigWithTracking(ctx, c.kube, mg)
if err != nil {
return nil, err
}
Expand Down

0 comments on commit f148c02

Please sign in to comment.