Component testing guide (#733)

Co-authored-by: Dan Miller <miller0daniel@gmail.com>
Co-authored-by: RoseSecurity <72598486+RoseSecurity@users.noreply.github.com>

Author: 3 people

docs/community/contribute/components-testing.mdx

@@ -40,7 +40,6 @@ Geodesic is a powerful Linux toolbox container designed to optimize DevOps workf
 Build a Geodesic infrastructure container. This container that has all the tools like terraform and atmos for building infrastructure. It's built from the `Dockerfile` and there are some predefined targets defined in the `Makefile` to make this easy. Customize these for your organization. Here are examples of both for reference.
 
 <CollapsibleText type="medium">
-  <CodeBlock title="Dockerfile">{PartialDockerfile}</CodeBlock>
 </CollapsibleText>
 
 <CollapsibleText type="medium">

docs/layers/project/toolbox.mdx

@@ -0,0 +1,19 @@
+components:
+  terraform:
+    vpc:
+      metadata:
+        component: vpc
+      vars:
+        name: "vpc"
+        availability_zones:
+          - "b"
+          - "c"
+        public_subnets_enabled: true
+        max_nats: 1
+        # Private subnets do not need internet access
+        nat_gateway_enabled: false
+        nat_instance_enabled: false
+        subnet_type_tag_key: "eg.cptest.co/subnet/type"
+        max_subnet_count: 3
+        vpc_flow_logs_enabled: false
+        ipv4_primary_cidr_block: "172.16.0.0/16"

examples/components-testing/step-3/catalog-vpc.yaml

@@ -0,0 +1,20 @@
+package test
+
+import (
+	"testing"
+
+	helper "github.com/cloudposse/test-helpers/pkg/atmos/component-helper"
+)
+
+type ComponentSuite struct {
+	helper.TestSuite
+}
+
+func TestRunSuite(t *testing.T) {
+	suite := new(ComponentSuite)
+
+  // Deploy the dependent vpc component
+	suite.AddDependency(t, "vpc", "default-test", nil)
+
+	helper.Run(t, suite)
+}

examples/components-testing/step-3/component_test.go

@@ -0,0 +1,4 @@
+import:
+  - orgs/default/test/_defaults
+  # Import the dependent component
+  - catalog/vpc

examples/components-testing/step-3/stack.yaml

@@ -0,0 +1,33 @@
+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: []
+
+    # Example of a dependency from vpc component
+    - component: "vpc"
+      source: github.com/cloudposse-terraform-components/aws-vpc.git//src?ref={{.Version}}
+      version: v1.536.0
+      # Specify the path to the component directory
+      targets:
+        - "components/terraform/vpc"
+      included_paths:
+        - "**/*.tf"
+        - "**/*.md"
+        - "**/*.tftmpl"
+        - "**/modules/**"
+      excluded_paths: []
+      # Example of a dependency from vpc component

examples/components-testing/step-3/vendor.yaml

@@ -0,0 +1,5 @@
+import:
+  - orgs/default/test/_defaults
+  - catalog/vpc
+  # Import the usecase
+  - catalog/usecase/basic

examples/components-testing/step-4/stack.yaml

@@ -0,0 +1,10 @@
+components:
+  terraform:
+    # You can replace example-component with your component name
+    example-component/basic:
+      metadata:
+        # Component name dir should be always `target`
+        component: target
+      vars:
+        enabled: true
+        # Add other inputs that are required for the use case

examples/components-testing/step-4/usecase.yaml

@@ -0,0 +1,6 @@
+import:
+  - orgs/default/test/_defaults
+  - catalog/vpc
+  - catalog/usecase/basic
+  # Import the "disabled" usecase
+  - catalog/usecase/disabled

examples/components-testing/step-7/stack.yaml

@@ -0,0 +1,9 @@
+components:
+  terraform:
+    # You can replace example-component with your component name
+    example-component/disabled:
+      metadata:
+        component: target
+      vars:
+        # Disable the component
+        enabled: false