Feature/resources-onboarding-team

.github/workflows/release.yaml

@@ -38,16 +38,17 @@ jobs:
         uses: hashicorp/setup-terraform@v3
         with:
           terraform_wrapper: false
-          terraform_version: '1.5.7' # TODO: matrix of terraform & tofu versions
+          terraform_version: '1.5.7'
 
       - name: "Test Provider with quickstart example"
         run: |
           set -eu -x;
           TAG=${{ github.ref_name }};
           VERSION=${TAG#v};
-          make test-example ARGS="-v ${VERSION} -f github-release-draft";
+          make test-examples-quickstart ARGS="-v ${VERSION} -f github-release-draft";
         shell: bash
         env:
-          STACKGUARDIAN_API_KEY: ${{ secrets.STACKGUARDIAN_API_KEY }}
-          STACKGUARDIAN_ORG_NAME: ${{ secrets.STACKGUARDIAN_ORG_NAME }}
-          GH_TOKEN: ${{ github.token }}
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'
+          GH_TOKEN: '${{ github.token }}'

.github/workflows/test-api-prd.yaml

@@ -0,0 +1,16 @@
+name: "Test API-PRD with TF-Provider"  # for API High-Load with examples on API-PRD
+
+on:
+  schedule:
+    - cron: '*/10 * 1-10 4 *'
+  workflow_dispatch:
+
+jobs:
+
+  api_test:
+    name: "Test API-PRD with TF-Provider"
+    uses: ./.github/workflows/test-api.yaml
+    secrets: inherit
+    with:
+      gitref: main
+      testenv: PRD

.github/workflows/test-api-stg.yaml

@@ -0,0 +1,16 @@
+name: "Test API-STG with TF-Provider"  # for API High-Load with examples on API-STG
+
+on:
+  schedule:
+    - cron: '*/10 * 1-10 4 *'
+  workflow_dispatch:
+
+jobs:
+
+  api_test:
+    name: "Test API-STG with TF-Provider"
+    uses: ./.github/workflows/test-api.yaml
+    secrets: inherit
+    with:
+      gitref: devel
+      testenv: STG

.github/workflows/test-api.yaml

@@ -0,0 +1,121 @@
+name: "Test API with TF-Provider"  # with examples on one API env
+
+on:
+  workflow_call:
+    inputs:
+      gitref:
+        type: string
+        default: 'devel'
+        required: true
+      testenv:
+        type: string
+        default: PRD
+        required: true
+        description: "STG|PRD"
+
+jobs:
+
+  api_examples-test:
+    name: "Test API with Provider examples"
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: "Checkout code"
+        if: ${{ !env.ACT }}
+        uses: actions/checkout@v4
+        with:
+          ref: '${{ inputs.gitref }}'
+
+      - name: "Checkout code (local)"
+        if: env.ACT
+        uses: actions/checkout@v4
+
+      - name: "Verify checked-out code (local)"
+        if: ${{ env.ACT }}
+        run: |
+          git --no-pager show --stat;
+          git --no-pager status;
+
+      - name: "Install Go"
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: 'go.mod'
+
+      - name: "Install Terraform"
+        uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_wrapper: false
+          terraform_version: '1.5.7'
+
+      - name: "Build Provider"
+        run: make build
+
+
+      ### --- testenv: STG ----------------------------------------------------
+
+      - name: "Test API-STG with Provider acceptance tests"
+        if: inputs.testenv=='STG'
+        run: make test-acc
+        env:
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_STG_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_STG_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_STG_ORG_NAME }}'
+
+      - name: "Test API-STG with Provider quickstart example"
+        if: inputs.testenv=='STG'
+        run: |
+          set -eu -x;
+          make install;
+          make test-examples-quickstart ARGS="-f local-build";
+        shell: bash
+        env:
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_STG_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_STG_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_STG_ORG_NAME }}'
+
+      - name: "Test API-STG with Provider onboarding example"
+        if: inputs.testenv=='STG'
+        run: |
+          set -eu -x;
+          make install;
+          make test-examples-onboarding ARGS="-f local-build";
+        shell: bash
+        env:
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_STG_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_STG_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_STG_ORG_NAME }}'
+
+
+      ### --- testenv: PRD ----------------------------------------------------
+
+      - name: "Test API-PRD with Provider acceptance tests"
+        if: inputs.testenv=='PRD'
+        run: make test-acc
+        env:
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'
+
+      - name: "Test API-PRD with Provider quickstart example"
+        if: inputs.testenv=='PRD'
+        run: |
+          set -eu -x;
+          make install;
+          make test-examples-quickstart ARGS="-f local-build";
+        shell: bash
+        env:
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'
+
+      - name: "Test API-PRD with Provider onboarding example"
+        if: inputs.testenv=='PRD'
+        run: |
+          set -eu -x;
+          make install;
+          make test-examples-onboarding ARGS="-f local-build";
+        shell: bash
+        env:
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'

.github/workflows/test.yaml

@@ -1,11 +1,9 @@
-name: "Test TF-Provider on SG-Prod"
+name: "Test TF-Provider on API-PROD"
 
 on:
   push:
     branches:
       - main
-      - devel
-  # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
   pull_request:
     branches:
       - 'main'
@@ -28,32 +26,45 @@ jobs:
       - name: "Install Go"
         uses: actions/setup-go@v5
         with:
-          go-version: '1.21'
+          go-version-file: 'go.mod'
 
       - name: "Install Terraform"
         uses: hashicorp/setup-terraform@v3
         with:
           terraform_wrapper: false
-          terraform_version: '1.5.7' # TODO: matrix of terraform & tofu versions
+          terraform_version: '1.5.7'
 
       - name: "Build Provider"
         run: make build
 
       - name: "Test Provider with acceptance tests"
         run: make test-acc
         env:
-          STACKGUARDIAN_API_KEY: ${{ secrets.STACKGUARDIAN_API_KEY }}
-          STACKGUARDIAN_ORG_NAME: ${{ secrets.STACKGUARDIAN_ORG_NAME }}
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'
 
       - name: "Test Provider with quickstart example"
         run: |
           set -eu -x;
           make install;
-          make test-example ARGS="-f local-build";
+          make test-examples-quickstart ARGS="-f local-build";
         shell: bash
         env:
-          STACKGUARDIAN_API_KEY: ${{ secrets.STACKGUARDIAN_API_KEY }}
-          STACKGUARDIAN_ORG_NAME: ${{ secrets.STACKGUARDIAN_ORG_NAME }}
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'
+
+      - name: "Test Provider with onboarding example"
+        run: |
+          set -eu -x;
+          make install;
+          make test-examples-onboarding ARGS="-f local-build";
+        shell: bash
+        env:
+          STACKGUARDIAN_API_KEY: '${{ secrets.SG_PRD_API_KEY }}'
+          STACKGUARDIAN_API_URI: '${{ secrets.SG_PRD_API_URI }}'
+          STACKGUARDIAN_ORG_NAME: '${{ secrets.SG_PRD_ORG_NAME }}'
 
       - name: "Check Provider docs"
         run: |

.gitignore

@@ -36,6 +36,8 @@ override.tf.json
 # Ignore CLI configuration files
 .terraformrc
 terraform.rc
+examples/**.png
+examples/**.dot
 
 # Terraform provider build files
 terraform-provider-stackguardian

.vscode/launch.json

@@ -11,6 +11,18 @@
             "mode": "local",
             "processId": 0,
             //"preLaunchTask": "Exec sg-tf-provider",
+        },
+        {
+            "name": "Debug Terraform Provider",
+            "type": "go",
+            "request": "launch",
+            "mode": "debug",
+            // this assumes your workspace is the root of the repo
+            "program": "${workspaceFolder}",
+            "env": {},
+            "args": [
+                "-debug",
+            ]
         }
     ]
 }

Makefile

@@ -8,6 +8,13 @@ OS_ARCH=linux_amd64
 
 default: install
 
+clean: clean-examples
+
+clean-examples:
+	find examples/ -type d -name '.terraform' -exec rm -rv {} \+
+	find examples/ -type f -name '.terraform.lock.hcl' -exec rm -v {} \+
+	find examples/ -type f -regextype posix-extended -regex '.+.tfstate(.[[:digit:]]+)?(.backup)?' -exec rm -v {} \+
+
 build:
 	go build -o ${BINARY}
 
@@ -23,29 +30,61 @@ test:
 	echo $(TEST) | xargs -t -n4 go test $(TESTARGS) -timeout=30s -parallel=4
 
 test-acc:
-	TF_ACC=1 STACKGUARDIAN_ORG_NAME=wicked-hop go test -parallel=1 $(TEST) -v $(TESTARGS) -timeout=15m
+	TF_ACC=1 go test -parallel=1 $(TEST) -v $(TESTARGS) -timeout=15m
 
-test-example:
-	bash docs/guides/quickstart/test-quickstart.sh $(ARGS)
+test-examples-quickstart:
+	bash docs-guides-assets/quickstart/test-quickstart.sh $(ARGS)
+
+#	bash docs-guides-assets/onboarding/project-test/test-onboarding.sh $(ARGS)
+test-examples-onboarding:
+	echo "Implemented in next PR - Dummy Test"
 
 docs-generate:
-	mv docs/guides docs_guides
-	tfplugindocs generate
-	mv docs_guides docs/guides
+	tfplugindocs generate \
+		--website-source-dir docs-templates
 
 docs-validate:
-	mv docs/guides docs_guides
 	tfplugindocs validate
-	mv docs_guides docs/guides
 
 tools-install:
 	cd tools; go install github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs
 
-gh-workflow:
+gh-workflow-test-provider:
 	act \
 		--workflows ${PWD}/.github/workflows/test.yaml \
 		--job provider-project_test \
-		--secret STACKGUARDIAN_ORG_NAME=${STACKGUARDIAN_ORG_NAME} \
-		--secret STACKGUARDIAN_API_KEY=${STACKGUARDIAN_API_KEY} \
+		--secret SG_PRD_API_URI=${SG_PRD_API_URI} \
+		--secret SG_PRD_API_KEY=${SG_PRD_API_KEY} \
+		--secret SG_PRD_ORG_NAME=${SG_PRD_ORG_NAME} \
 		push \
 		;
+
+gh-workflow-test-provider-mock-stg-as-prd:
+	act \
+		--workflows ${PWD}/.github/workflows/test.yaml \
+		--job provider-project_test \
+		--secret SG_PRD_API_URI=${SG_STG_API_URI} \
+		--secret SG_PRD_API_KEY=${SG_STG_API_KEY} \
+		--secret SG_PRD_ORG_NAME=${SG_STG_ORG_NAME} \
+		push \
+		;
+
+#		--local-repository StackGuardian/terraform-provider-stackguardian@devel=${PWD} \#
+gh-workflow-test-api-stg:
+	act \
+		--workflows ${PWD}/.github/workflows/test-api-stg.yaml \
+		--secret SG_STG_API_URI=${SG_STG_API_URI} \
+		--secret SG_STG_API_KEY=${SG_STG_API_KEY} \
+		--secret SG_STG_ORG_NAME=${SG_STG_ORG_NAME} \
+		workflow_dispatch \
+		;
+
+#		--local-repository StackGuardian/terraform-provider-stackguardian@devel=${PWD} \#
+gh-workflow-test-api-prd:
+	act \
+		--workflows ${PWD}/.github/workflows/test-api-prd.yaml \
+		--secret SG_PRD_API_URI=${SG_PRD_API_URI} \
+		--secret SG_PRD_API_KEY=${SG_PRD_API_KEY} \
+		--secret SG_PRD_ORG_NAME=${SG_PRD_ORG_NAME} \
+		workflow_dispatch \
+		;

docs-examples/data-sources/stackguardian_workflow_outputs/data-source.tf

@@ -0,0 +1,17 @@
+data "stackguardian_workflow_outputs" "TPS-Example-WorkflowOutputs" {
+  wfgrp           = "aws-dev-environments"
+  wf              = "wf-musical-coral"
+  // stack        = "test-stack-1" // optionally
+}
+
+output "website_url_from_mapstr" {
+  value = data.stackguardian_workflow_outputs.TPS-Example-WorkflowOutputs.outputs_str.sample_website_url
+}
+
+output "website_url_from_json" {
+  value = jsondecode(data.stackguardian_workflow_outputs.TPS-Example-WorkflowOutputs.outputs_json).sample_website_url.value
+}
+
+output "outputs_full_json" {
+  value = jsondecode(data.stackguardian_workflow_outputs.TPS-Example-WorkflowOutputs.outputs_json)
+}

docs-examples/resources/stackguardian_connector_cloud/resource.tf

@@ -0,0 +1,18 @@
+resource "stackguardian_connector_cloud" "TPS-Example-ConnectorCloud" {
+  // integrationgroup = "TPS-Example"
+  data = jsonencode({
+    "ResourceName" : "TPS-Example-ConnectorCloud",
+    "Tags" : ["tf-provider-example"]
+    "Description" : "Example of terraform-provider-stackguardian for ConnectorCloud",
+    "Settings" : {
+      "kind" : "AWS_STATIC",
+      "config" : [
+        {
+          "awsAccessKeyId" : "example-aws-key",
+          "awsSecretAccessKey" : "example-aws-key",
+          "awsDefaultRegion" : "us-west-2"
+        }
+      ]
+    }
+  })
+}