Skip to content

Added tests #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ aws-assumed-role/
*.iml
.direnv
.envrc
.cache

# Compiled and auto-generated files
# Note that the leading "**/" appears necessary for Docker even if not for Git
Expand Down
10 changes: 5 additions & 5 deletions src/remote-state.tf
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ locals {

module "dns-delegated" {
source = "cloudposse/stack-config/yaml//modules/remote-state"
version = "1.5.0"
version = "1.8.0"

component = "dns-delegated"
environment = "gbl"
Expand All @@ -14,7 +14,7 @@ module "dns-delegated" {

module "eks" {
source = "cloudposse/stack-config/yaml//modules/remote-state"
version = "1.5.0"
version = "1.8.0"

for_each = var.eks_component_names

Expand All @@ -25,7 +25,7 @@ module "eks" {

module "vpc" {
source = "cloudposse/stack-config/yaml//modules/remote-state"
version = "1.5.0"
version = "1.8.0"

component = var.vpc_component_name

Expand All @@ -34,7 +34,7 @@ module "vpc" {

module "vpc_ingress" {
source = "cloudposse/stack-config/yaml//modules/remote-state"
version = "1.5.0"
version = "1.8.0"

for_each = local.accounts_with_vpc

Expand All @@ -49,7 +49,7 @@ module "vpc_ingress" {

module "primary_cluster" {
source = "cloudposse/stack-config/yaml//modules/remote-state"
version = "1.5.0"
version = "1.8.0"

count = local.remote_read_replica_enabled ? 1 : 0

Expand Down
4 changes: 4 additions & 0 deletions test/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
state/
.cache
test/test-suite.json
.atmos
154 changes: 154 additions & 0 deletions test/component_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
package test

import (
"testing"

awssdk "github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/service/ec2"
"github.com/cloudposse/test-helpers/pkg/atmos"
helper "github.com/cloudposse/test-helpers/pkg/atmos/aws-component-helper"
"github.com/gruntwork-io/terratest/modules/aws"
"github.com/stretchr/testify/require"
)

func TestComponent(t *testing.T) {
awsRegion := "us-east-2"

fixture := helper.NewFixture(t, "../", awsRegion, "test/fixtures")

defer fixture.TearDown()
fixture.SetUp(&atmos.Options{})

fixture.Suite("default", func(t *testing.T, suite *helper.Suite) {
suite.AddDependency("vpc", "default-test")

suite.Setup(t, func(t *testing.T, atm *helper.Atmos) {
randomID := suite.GetRandomIdentifier()
inputs := map[string]interface{}{
"zone_config": []map[string]string{
{
"subdomain": randomID,
"zone_name": "example.net",
},
},
}
atm.GetAndDeploy("dns-delegated", "default-test", inputs)
})

suite.TearDown(t, func(t *testing.T, atm *helper.Atmos) {
atm.GetAndDestroy("dns-delegated", "default-test", map[string]interface{}{})
})

suite.Test(t, "single-cluster", func(t *testing.T, atm *helper.Atmos) {
inputs := map[string]interface{}{
"name": "rds",
"mysql_deletion_protection": false,
"mysql_storage_encrypted": true,
"aurora_mysql_engine": "aurora-mysql",
"allowed_cidr_blocks": []string{},
"eks_component_names": []string{},
"publicly_accessible": true,
"aurora_mysql_engine_version": "8.0.mysql_aurora.3.02.0",
"aurora_mysql_cluster_family": "aurora-mysql8.0",
"mysql_name": "shared",
"mysql_cluster_size": 2,
"mysql_admin_user": "",
"mysql_admin_password": "",
"mysql_db_name": "",
"mysql_instance_type": "db.t3.medium",
"mysql_skip_final_snapshot": true,
}

defer atm.GetAndDestroy("aurora-mysql/cluster", "default-test", inputs)
component := atm.GetAndDeploy("aurora-mysql/cluster", "default-test", inputs)

clusterARN := atm.Output(component, "aurora_mysql_cluster_arn")
require.Equal(t, clusterARN, "")

// output "aurora_mysql_cluster_id" {
// output "aurora_mysql_cluster_name" {
// output "aurora_mysql_endpoint" {
// output "aurora_mysql_master_hostname" {
// output "aurora_mysql_master_password" {
// output "aurora_mysql_master_password_ssm_key" {
// output "aurora_mysql_master_username" {
// output "aurora_mysql_reader_endpoint" {
// output "aurora_mysql_replicas_hostname" {
// output "cluster_domain" {
// output "kms_key_arn" {

})

// suite.Test(t, "public-private-subnets", func(t *testing.T, atm *helper.Atmos) {
// inputs := map[string]interface{}{
// "name": "vpc-terraform",
// "availability_zones": []string{"b", "c"},
// "public_subnets_enabled": true,
// "nat_gateway_enabled": true,
// "nat_instance_enabled": false,
// "subnet_type_tag_key": "eg.cptest.co/subnet/type",
// "max_nats": 1,
// "max_subnet_count": 3,
// "vpc_flow_logs_enabled": false,
// "ipv4_primary_cidr_block": "172.16.0.0/16",
// }

// defer atm.GetAndDestroy("vpc/public", "default-test", inputs)
// component := atm.GetAndDeploy("vpc/public", "default-test", inputs)

// vpcId := atm.Output(component, "vpc_id")
// require.True(t, strings.HasPrefix(vpcId, "vpc-"))

// vpc := aws.GetVpcById(t, vpcId, awsRegion)

// assert.Equal(t, vpc.Name, fmt.Sprintf("eg-default-ue2-test-vpc-terraform-%s", component.RandomIdentifier))
// assert.Equal(t, *vpc.CidrAssociations[0], "172.16.0.0/16")
// assert.Equal(t, *vpc.CidrBlock, "172.16.0.0/16")
// assert.Nil(t, vpc.Ipv6CidrAssociations)
// assert.Equal(t, vpc.Tags["Environment"], "ue2")
// assert.Equal(t, vpc.Tags["Namespace"], "eg")
// assert.Equal(t, vpc.Tags["Stage"], "test")
// assert.Equal(t, vpc.Tags["Tenant"], "default")

// subnets := vpc.Subnets
// require.Equal(t, 4, len(subnets))

// public_subnet_ids := atm.OutputList(component, "public_subnet_ids")
// assert.Equal(t, 2, len(public_subnet_ids))

// public_subnet_cidrs := atm.OutputList(component, "public_subnet_cidrs")
// assert.Equal(t, 2, len(public_subnet_cidrs))

// private_subnet_ids := atm.OutputList(component, "private_subnet_ids")
// assert.Equal(t, 2, len(private_subnet_ids))

// private_subnet_cidrs := atm.OutputList(component, "private_subnet_cidrs")
// assert.Equal(t, 2, len(private_subnet_cidrs))

// assert.False(t, aws.IsPublicSubnet(t, private_subnet_ids[0], awsRegion))
// assert.False(t, aws.IsPublicSubnet(t, private_subnet_ids[1], awsRegion))

// assert.True(t, aws.IsPublicSubnet(t, public_subnet_ids[0], awsRegion))
// assert.True(t, aws.IsPublicSubnet(t, public_subnet_ids[1], awsRegion))

// nats, err := GetNatsByVpcIdE(t, vpcId, awsRegion)
// assert.NoError(t, err)
// assert.Equal(t, 1, len(nats))
// })
Comment on lines +68 to +137
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are we commenting all this out?


})
}

func GetNatsByVpcIdE(t *testing.T, vpcId string, awsRegion string) ([]*ec2.NatGateway, error) {
client, err := aws.NewEc2ClientE(t, awsRegion)
if err != nil {
return nil, err
}

filter := ec2.Filter{Name: awssdk.String("vpc-id"), Values: []*string{&vpcId}}
response, err := client.DescribeNatGateways(&ec2.DescribeNatGatewaysInput{Filter: []*ec2.Filter{&filter}})
if err != nil {
return nil, err
}
return response.NatGateways, nil
}
87 changes: 87 additions & 0 deletions test/fixtures/atmos.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# CLI config is loaded from the following locations (from lowest to highest priority):
# system dir (`/usr/local/etc/atmos` on Linux, `%LOCALAPPDATA%/atmos` on Windows)
# home dir (~/.atmos)
# current directory
# ENV vars
# Command-line arguments
#
# It supports POSIX-style Globs for file names/paths (double-star `**` is supported)
# https://en.wikipedia.org/wiki/Glob_(programming)

# Base path for components, stacks and workflows configurations.
# Can also be set using `ATMOS_BASE_PATH` ENV var, or `--base-path` command-line argument.
# Supports both absolute and relative paths.
# If not provided or is an empty string, `components.terraform.base_path`, `components.helmfile.base_path`, `stacks.base_path` and `workflows.base_path`
# are independent settings (supporting both absolute and relative paths).
# If `base_path` is provided, `components.terraform.base_path`, `components.helmfile.base_path`, `stacks.base_path` and `workflows.base_path`
# are considered paths relative to `base_path`.
base_path: ""

components:
terraform:
# Can also be set using `ATMOS_COMPONENTS_TERRAFORM_BASE_PATH` ENV var, or `--terraform-dir` command-line argument
# Supports both absolute and relative paths
base_path: "components/terraform"
# Can also be set using `ATMOS_COMPONENTS_TERRAFORM_APPLY_AUTO_APPROVE` ENV var
apply_auto_approve: true
# Can also be set using `ATMOS_COMPONENTS_TERRAFORM_DEPLOY_RUN_INIT` ENV var, or `--deploy-run-init` command-line argument
deploy_run_init: true
# Can also be set using `ATMOS_COMPONENTS_TERRAFORM_INIT_RUN_RECONFIGURE` ENV var, or `--init-run-reconfigure` command-line argument
init_run_reconfigure: true
# Can also be set using `ATMOS_COMPONENTS_TERRAFORM_AUTO_GENERATE_BACKEND_FILE` ENV var, or `--auto-generate-backend-file` command-line argument
auto_generate_backend_file: true

stacks:
# Can also be set using `ATMOS_STACKS_BASE_PATH` ENV var, or `--config-dir` and `--stacks-dir` command-line arguments
# Supports both absolute and relative paths
base_path: "stacks"
# Can also be set using `ATMOS_STACKS_INCLUDED_PATHS` ENV var (comma-separated values string)
# Since we are distinguishing stacks based on namespace, and namespace is not part
# of the stack name, we have to set `included_paths` via the ENV var in the Dockerfile
included_paths:
- "orgs/**/*"

# Can also be set using `ATMOS_STACKS_EXCLUDED_PATHS` ENV var (comma-separated values string)
excluded_paths:
- "**/_defaults.yaml"

# Can also be set using `ATMOS_STACKS_NAME_PATTERN` ENV var
name_pattern: "{tenant}-{stage}"

workflows:
# Can also be set using `ATMOS_WORKFLOWS_BASE_PATH` ENV var, or `--workflows-dir` command-line arguments
# Supports both absolute and relative paths
base_path: "stacks/workflows"

# https://github.com/cloudposse/atmos/releases/tag/v1.33.0
logs:
file: "/dev/stdout"
# Supported log levels: Trace, Debug, Info, Warning, Off
level: Info

settings:
# Can also be set using 'ATMOS_SETTINGS_LIST_MERGE_STRATEGY' environment variable, or '--settings-list-merge-strategy' command-line argument
list_merge_strategy: replace

# `Go` templates in Atmos manifests
# https://atmos.tools/core-concepts/stacks/templating
# https://pkg.go.dev/text/template
templates:
settings:
enabled: true
# https://masterminds.github.io/sprig
sprig:
enabled: true
# https://docs.gomplate.ca
gomplate:
enabled: true

commands:
- name: "test-components"
description: "List the Atmos virtual components configured for testing"
steps:
- >
atmos describe stacks --format json --sections=component,metadata --components=component -s sandbox
| jq '.[] | .components.terraform | to_entries |
map(select(.value.component == "component" and (.value.metadata.type != "abstract" or .value.metadata.type == null)))
| .[].key'
46 changes: 46 additions & 0 deletions test/fixtures/stacks/catalog/account-map.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
components:
terraform:
account-map:
metadata:
terraform_workspace: core-gbl-root
vars:
tenant: core
environment: gbl
stage: root

# This remote state is only for Cloud Posse internal use.
# It references the Cloud Posse test organizations actual infrastructure.
# remote_state_backend:
# s3:
# bucket: cptest-core-ue2-root-tfstate-core
# dynamodb_table: cptest-core-ue2-root-tfstate-core-lock
# role_arn: arn:aws:iam::822777368227:role/cptest-core-gbl-root-tfstate-core-ro
# encrypt: true
# key: terraform.tfstate
# acl: bucket-owner-full-control
# region: us-east-2

Comment on lines +11 to +22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Remove sensitive information from comments

The commented section contains actual infrastructure references including:

  • S3 bucket names
  • DynamoDB table names
  • IAM role ARNs

Consider removing or replacing with placeholder values in test fixtures.

remote_state_backend_type: static
remote_state_backend:
# This static backend is used for tests that only need to use the account map iam-roles module
# to find the role to assume for Terraform operations. It is configured to use whatever
# the current user's role is, but the environment variable `TEST_ACCOUNT_ID` must be set to
# the account ID of the account that the user is currently assuming a role in.
#
# For some components, this backend is missing important data, and those components
# will need that data added to the backend configuration in order to work properly.
static:
account_info_map: {}
all_accounts: []
aws_partition: aws
full_account_map: {}
iam_role_arn_templates: {}
non_eks_accounts: []
profiles_enabled: false
root_account_aws_name: root
terraform_access_map: {}
terraform_dynamic_role_enabled: false
terraform_role_name_map:
apply: terraform
plan: planner
terraform_roles: {}
8 changes: 8 additions & 0 deletions test/fixtures/stacks/catalog/dns-delegated.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
components:
terraform:
dns-delegated:
vars:
name: "dns-delegated"
zone_config: []
request_acm_certificate: false
dns_private_zone_enabled: false
5 changes: 5 additions & 0 deletions test/fixtures/stacks/catalog/dns-primary.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
components:
terraform:
dns-primary:
vars:
domain_names: []
Loading
Loading