Skip to content

Commit

Permalink
Added tests (#14)
Browse files Browse the repository at this point in the history
* Added tests

* Use new pattern

* Pin version

* Pin version
  • Loading branch information
goruha authored Feb 19, 2025
1 parent 3370723 commit d2af42d
Show file tree
Hide file tree
Showing 13 changed files with 768 additions and 3 deletions.
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
6 changes: 6 additions & 0 deletions test/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
state/
.cache
test/test-suite.json
.atmos
test_suite.yaml

84 changes: 84 additions & 0 deletions test/component_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
package test

import (
"context"
"fmt"
"strings"
"testing"

"github.com/aws/aws-sdk-go-v2/service/backup"
"github.com/cloudposse/test-helpers/pkg/atmos"
helper "github.com/cloudposse/test-helpers/pkg/atmos/component-helper"
awshelper "github.com/cloudposse/test-helpers/pkg/aws"
"github.com/gruntwork-io/terratest/modules/aws"
"github.com/gruntwork-io/terratest/modules/random"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

type ComponentSuite struct {
helper.TestSuite
}

func (s *ComponentSuite) TestBasic() {
const component = "aws-backup/basic"
const stack = "default-test"
const awsRegion = "us-east-2"

planNameSuffix := strings.ToLower(random.UniqueId())
inputs := map[string]interface{}{
"plan_name_suffix": planNameSuffix,
}

defer s.DestroyAtmosComponent(s.T(), component, stack, &inputs)
options, _ := s.DeployAtmosComponent(s.T(), component, stack, &inputs)
assert.NotNil(s.T(), options)

vaultId := atmos.Output(s.T(), options, "backup_vault_id")
assert.NotEmpty(s.T(), vaultId)

AwsAccountId := aws.GetAccountId(s.T())

vaultArn := atmos.Output(s.T(), options, "backup_vault_arn")
assert.Equal(s.T(), fmt.Sprintf("arn:aws:backup:%s:%s:backup-vault:%s", awsRegion, AwsAccountId, vaultId), vaultArn)

planArn := atmos.Output(s.T(), options, "backup_plan_arn")
assert.NotEmpty(s.T(), planArn)

planVersion := atmos.Output(s.T(), options, "backup_plan_version")
assert.NotEmpty(s.T(), planVersion)

planSelectionId := atmos.Output(s.T(), options, "backup_selection_id")
assert.NotEmpty(s.T(), planSelectionId)

client := awshelper.NewBackupClient(s.T(), awsRegion)
vault, err := client.DescribeBackupVault(context.Background(), &backup.DescribeBackupVaultInput{
BackupVaultName: &vaultId,
})
require.NoError(s.T(), err)

assert.Equal(s.T(), vaultId, *vault.BackupVaultName)
assert.Equal(s.T(), vaultArn, *vault.BackupVaultArn)
assert.EqualValues(s.T(), "BACKUP_VAULT", vault.VaultType)
assert.EqualValues(s.T(), "", vault.VaultState)
assert.False(s.T(), *vault.Locked)

s.DriftTest(component, stack, &inputs)
}

func (s *ComponentSuite) TestEnabledFlag() {
const component = "aws-backup/disabled"
const stack = "default-test"
const awsRegion = "us-east-2"

planNameSuffix := strings.ToLower(random.UniqueId())
inputs := map[string]interface{}{
"plan_name_suffix": planNameSuffix,
}
s.VerifyEnabledFlag(component, stack, &inputs)
}

func TestRunSuite(t *testing.T) {
suite := new(ComponentSuite)
helper.Run(t, suite)
}
77 changes: 77 additions & 0 deletions test/fixtures/atmos.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# 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
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

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: {}
22 changes: 22 additions & 0 deletions test/fixtures/stacks/catalog/usecase/basic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
components:
terraform:
aws-backup/basic:
metadata:
component: target
vars:
plan_name_suffix: test
# https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
rules:
- name: "plan-weekly"
schedule: "cron(0 5 ? * SAT *)"
start_window: 320 # 60 * 8 # minutes
completion_window: 10080 # 60 * 24 * 7 # minutes
lifecycle:
delete_after: 90 # 30 * 3 # days
selection_tags:
- type: STRINGEQUALS
key: aws-backup/efs
value: weekly
- type: STRINGEQUALS
key: aws-backup/rds
value: weekly
23 changes: 23 additions & 0 deletions test/fixtures/stacks/catalog/usecase/disabled.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
components:
terraform:
aws-backup/disabled:
metadata:
component: target
vars:
enabled: false
plan_name_suffix: test
# https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html
rules:
- name: "plan-weekly"
schedule: "cron(0 5 ? * SAT *)"
start_window: 320 # 60 * 8 # minutes
completion_window: 10080 # 60 * 24 * 7 # minutes
lifecycle:
delete_after: 90 # 30 * 3 # days
selection_tags:
- type: STRINGEQUALS
key: aws-backup/efs
value: weekly
- type: STRINGEQUALS
key: aws-backup/rds
value: weekly
66 changes: 66 additions & 0 deletions test/fixtures/stacks/orgs/default/test/_defaults.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import:
- catalog/account-map

terraform:
backend_type: local
backend:
local:
path: '{{ getenv "COMPONENT_HELPER_STATE_DIR" | default "../../../state" }}/{{ .component }}/terraform.tfstate'
workspace_dir: '{{ getenv "COMPONENT_HELPER_STATE_DIR" | default "../../../state" }}/{{ .component }}/'
vars:
namespace: eg
tenant: default
environment: ue2
region: us-east-2
stage: test
label_order:
- namespace
- tenant
- environment
- stage
- name
- attributes
descriptor_formats:
account_name:
format: "%v-%v"
labels:
- tenant
- stage
stack:
format: "%v-%v-%v"
labels:
- tenant
- environment
- stage

components:
terraform:
account-map:
remote_state_backend:
static:
account_info_map:
default-test:
account_email_format: aws+cptest-%[email protected]
eks: true
id: '{{ getenv "TEST_ACCOUNT_ID" | default "<TEST_ACCOUNT_ID>" }}'
ou: default
parent_ou: none
stage: test
tags:
eks: false
tenant: default
all_accounts:
- default-test
artifacts_account_account_name: default-test
audit_account_account_name: default-test
dns_account_account_name: default-test
eks_accounts:
- default-test
full_account_map:
default-test: '{{ getenv "TEST_ACCOUNT_ID" | default "<TEST_ACCOUNT_ID>" }}'
iam_role_arn_templates:
default-test: 'arn:aws:iam::{{ getenv "TEST_ACCOUNT_ID" | default "<TEST_ACCOUNT_ID>" }}:role/tester-%s'
identity_account_account_name: default-test
root_account_account_name: default-test
terraform_roles:
default-test: ''
5 changes: 5 additions & 0 deletions test/fixtures/stacks/orgs/default/test/tests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import:
- orgs/default/test/_defaults
- catalog/usecase/basic
- catalog/usecase/disabled

18 changes: 18 additions & 0 deletions test/fixtures/vendor.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
apiVersion: atmos/v1
kind: AtmosVendorConfig
metadata:
name: fixtures
description: Atmos vendoring manifest
spec:
sources:
- component: "account-map"
source: github.com/cloudposse/terraform-aws-components.git//modules/account-map?ref={{.Version}}
version: 1.520.0
targets:
- "components/terraform/account-map"
included_paths:
- "**/*.tf"
- "**/*.md"
- "**/*.tftmpl"
- "**/modules/**"
excluded_paths: []
Loading

0 comments on commit d2af42d

Please sign in to comment.