Merge pull request #36 from aws-ia/ephemeral_project-updates

Updates from project type

.copier-answers.yml

@@ -1,6 +1,6 @@
 # This file is auto-generated, changes will be overwritten
-_commit: v0.0.1
-_src_path: /task/41906a63-e3bb-11ed-90bf-1a813f494731/projecttype
+_commit: v0.0.6
+_src_path: /task/04dba63e-eac8-11ed-962f-66a115cc3c0d/projecttype
 starting_version: v0.0.0
 version_file: VERSION
 

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+---
+fail_fast: false
+minimum_pre_commit_version: "2.6.0"
+repos:
+  -
+    repo: https://github.com/terraform-docs/terraform-docs
+    # To update run:
+    # pre-commit autoupdate --freeze
+    rev: 212db41760d7fc45d736d5eb94a483d0d2a12049  # frozen: v0.16.0
+    hooks:
+      - id: terraform-docs-go
+        args: 
+          - "--config=.terraform-docs.yaml"
+          - "--lockfile=false"
+          - "--recursive"
+          - "--recursive-path=examples/"
+          - "./"

.project_automation/functional_tests/entrypoint.sh

@@ -1,10 +1,12 @@
-#!/bin/bash -ex
+#!/bin/bash -e
 
 ## NOTE: paths may differ when running in a managed task. To ensure behavior is consistent between
 # managed and local tasks always use these variables for the project and project type path
 PROJECT_PATH=${BASE_PATH}/project
 PROJECT_TYPE_PATH=${BASE_PATH}/projecttype
 
+echo "Starting Funtional Tests"
+
 cd ${PROJECT_PATH}
 
 #********** Checkov Analysis *************
@@ -23,27 +25,4 @@ go mod tidy
 go install github.com/gruntwork-io/terratest/modules/terraform
 go test -timeout 45m
 
-#********** Terratest execution **********
-cd ${PROJECT_PATH}
-echo "Building readme.md file"
-UPDATE_BRANCH="ephemeral_readme-updates" 
-
-export GH_DEBUG=1
-REMOTE=$(git remote -v | awk '{print $2}' | head -n 1)
-git remote remove origin
-git remote add origin ${REMOTE}
-git fetch --all
-
-git push origin -d $UPDATE_BRANCH || true
-git checkout -b "$UPDATE_BRANCH"
-terraform-docs --lockfile=false ./
-
-if [ -n "${BASE_PATH}" ]
-then
-  git add . --all
-  git commit -m "(automated) Updates from project type"
-  git push -f --set-upstream origin $UPDATE_BRANCH
-  gh pr create --title "Updates from functional tests " --body "_This is an automated PR incorporating updates to this project's readme.md file. Please review and either approve/merge or reject as appropriate_"
-else
-  echo "Local build mode (skipping git commit)"
-fi
+echo "End of Functional Tests"

.project_automation/publication/entrypoint.sh

@@ -19,5 +19,4 @@ else
   gh release create ${VERSION} --target ${BRANCH} --generate-notes
 fi
 
-aws sts get-caller-identity
-aws s3 ls s3://ia-prj-cfg-versions/
+

.project_automation/static_tests/Dockerfile

@@ -21,3 +21,7 @@ RUN wget -O /tmp/tflint-ruleset-aws.zip https://github.com/terraform-linters/tfl
 RUN curl -s https://raw.githubusercontent.com/aquasecurity/tfsec/master/scripts/install_linux.sh | bash
 
 RUN gem install mdl
+
+ENV TERRAFORM_DOCS_VERSION=v0.16.0
+RUN wget https://github.com/terraform-docs/terraform-docs/releases/download/${TERRAFORM_DOCS_VERSION}/terraform-docs-${TERRAFORM_DOCS_VERSION}-linux-amd64.tar.gz && \
+    tar -C /usr/local/bin -xzf terraform-docs-${TERRAFORM_DOCS_VERSION}-linux-amd64.tar.gz && chmod +x /usr/local/bin/terraform-docs

.project_automation/static_tests/entrypoint.sh

@@ -1,17 +1,55 @@
-#!/bin/bash -ex
+#!/bin/bash -e
 
 ## NOTE: paths may differ when running in a managed task. To ensure behavior is consistent between
 # managed and local tasks always use these variables for the project and project type path
 PROJECT_PATH=${BASE_PATH}/project
 PROJECT_TYPE_PATH=${BASE_PATH}/projecttype
 
+echo "Starting Static Tests"
+
 cd ${PROJECT_PATH}
 terraform init
 terraform validate
 
+#********** tflint ********************
+echo 'Starting tflint'
 tflint --init
-tflint
-
+MYLINT=$(tflint --force)
+if [ -z "$MYLINT" ]
+then
+    echo "Success - tflint found no linting issues!"
+else
+    echo "Failure - tflint found linting issues!" 
+    echo "$MYLINT"
+    exit 1
+fi
+#********** tfsec *********************
+# tfsec will report to the console with success or Failure
+# therefore there is no need to provide such conditional stetements
+echo 'Starting tfsec'
 tfsec .
-
-mdl .header.md
+#********** Markdown Lint **************
+echo 'Starting markdown lint'
+MYMDL=$(mdl .header.md || true)
+if [ -z "$MYMDL" ]
+then
+    echo "Success - markdown lint found no linting issues!"
+else
+    echo "Failure - markdown lint found linting issues!" 
+    echo "$MYMDL"
+    exit 1
+fi
+#********** Terraform Docs *************
+echo 'Starting terraform-docs'
+TDOCS="$(terraform-docs --lockfile=false ./)"
+git add -N README.md
+GDIFF="$(git diff --compact-summary)"
+if [ -z "$GDIFF" ]
+then
+    echo "Success - Terraform Docs creation verified!"
+else
+    echo "Failure - Terraform Docs creation failed, ensure you have precommit installed and running before submitting the Pull Request"
+    exit 1
+fi
+#***************************************
+echo "End of Static Tests"