Add tftest POC (#349)

Add tftest about terraform init, add it to the terraform github
workflow.

Author: mpagot

.github/workflows/ansible.yml

@@ -3,12 +3,12 @@ name: Ansible
 on:
   push:
     branches:
-      - "main"
+      - 'main'
   pull_request:
     paths:
-      - ansible/**
-      - requirements.txt
-      - .github/workflows/ansible.yml
+      - 'ansible/**'
+      - 'requirements.txt'
+      - '.github/workflows/ansible.yml'
 
 jobs:
   build:
@@ -26,4 +26,4 @@ jobs:
       - name: Run ansible static tests
         run: |
            make -n static-ansible
-           make SHELL='sh -x' static-ansible
+           make SHELL='sh -x' static-ansible

.github/workflows/gluescript.yml

@@ -3,26 +3,26 @@ name: Glue Script
 on:
   push:
     branches:
-      - "main"
+      - 'main'
   pull_request:
     paths:
-      - scripts/qesap/**
-      - .github/workflows/gluescript.yml
+      - 'scripts/qesap/**'
+      - '.github/workflows/gluescript.yml'
 
 env:
   TF_VERSION: 1.5.7
 
 jobs:
   build:
-    runs-on: ${{ matrix.platform }}
+    runs-on: ubuntu-latest
     strategy:
       matrix:
-        platform: [ubuntu-latest]
         # all available versions are in https://github.com/actions/python-versions/blob/main/versions-manifest.json
         python-version: ['3.10.14', '3.11.9', '3.12.3']
 
     steps:
-    - uses: actions/checkout@v3
+    - name: Checkout
+      uses: actions/checkout@v3
 
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
@@ -68,6 +68,7 @@ jobs:
       env:
         PLATFORM: '3.11.9'
 
+    # Install the specific version of Terraform that the project support and
     - name: Setup Terraform
       uses: hashicorp/setup-terraform@v2
       with:

.github/workflows/markdown.yml

@@ -3,15 +3,15 @@ name: 'Markdown'
 on:
   push:
     branches:
-      - "main"
+      - 'main'
   pull_request:
     paths:
-      - README.md
-      - CONTRIBUTING.md
-      - terraform/aws/README.md
-      - terraform/azure/README.md
-      - terraform/gcp/README.md
-      - .github/workflows/markdown.yml
+      - 'README.md'
+      - 'CONTRIBUTING.md'
+      - 'terraform/aws/README.md'
+      - 'terraform/azure/README.md'
+      - 'terraform/gcp/README.md'
+      - '.github/workflows/markdown.yml'
 
 permissions:
   contents: read

.github/workflows/terraform.yml

@@ -1,48 +1,46 @@
-name: 'Terraform'
+name: Terraform
 
 on:
   push:
     branches:
-      - "main"
+      - 'main'
   pull_request:
     paths:
-      - terraform/**
-      - .github/workflows/terraform.yml
-
-permissions:
-  contents: read
+      - 'terraform/**'
+      - '.github/workflows/terraform.yml'
 
 env:
+  PYTEST_ADDOPTS: "--color=yes"
+  PYTHON_VERSION: 3.11
+  TF_PLUGIN_CACHE_DIR: "/home/runner/.terraform.d/plugin-cache"
   TF_VERSION: 1.5.7
+  TFTESTS_FOLDER: "terraform/tests"
 
 jobs:
   terraform:
-    name: 'Terraform'
     runs-on: ubuntu-latest
-    environment: production
     strategy:
       matrix:
         provider: ['azure', 'gcp', 'aws']
 
-    # Use the Bash shell regardless whether the GitHub Actions runner is ubuntu-latest, macos-latest, or windows-latest
     defaults:
       run:
         shell: bash
         working-directory: terraform/${{ matrix.provider }}
 
     steps:
-    # Checkout the repository to the GitHub Actions runner
     - name: Checkout
       uses: actions/checkout@v3
 
-    # Install the latest version of Terraform CLI and configure the Terraform CLI configuration file with a Terraform Cloud user API token
+    # Install the specific version of Terraform that the project support and
     - name: Setup Terraform
       uses: hashicorp/setup-terraform@v2
       with:
         terraform_version: ${{ env.TF_VERSION }}
         terraform_wrapper: false
 
-    # Initialize a new or existing Terraform working directory by creating initial files, loading any remote state, downloading modules, etc.
+    # Initialize each CSP Terraform working directory
+    # by creating initial files, downloading modules, etc.
     - name: Terraform Init
       run: terraform init
 
@@ -53,3 +51,23 @@ jobs:
     # Validate
     - name: Terraform Validate
       run: terraform validate
+
+  tftest:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    # Install the specific version of Terraform that the project support and
+    - name: Setup Terraform
+      uses: hashicorp/setup-terraform@v2
+      with:
+        terraform_version: ${{ env.TF_VERSION }}
+        terraform_wrapper: false
+
+    - name: Run tftests
+      run: |
+        mkdir -p ${{ env.TF_PLUGIN_CACHE_DIR }}
+        pip install -r ${{ env.TFTESTS_FOLDER }}/requirements.txt
+        pytest -vv -o log_cli=true -o log_cli_level=10 ${{ env.TFTESTS_FOLDER }}

.github/workflows/tools.yml

@@ -1,16 +1,20 @@
 name: Tools environment
-
+# Purpose of this workflow is to check that all binary the project
+# is recommending are installable and usable on openSUSE TW.
+# This workflow refer to th eDockerfile in the root of the repo.
 on:
   push:
     branches:
-      - "main"
+      - 'main'
   pull_request:
     paths:
-      - Dockerfile
-      - requirements.txt
-      - requirements.yml
-      - .github/workflows/tools.yml
-
+      - 'Dockerfile'
+      - 'requirements.txt'
+      - 'requirements.yml'
+      - '.github/workflows/tools.yml'
+      - 'terraform/azure/version.tf'
+      - 'terraform/aws/version.tf'
+      - 'terraform/gcp/version.tf'
 env:
   REGISTRY: ghcr.io
 

terraform/tests/conftest.py

@@ -0,0 +1,7 @@
+import os
+import pytest
+
+
+@pytest.fixture(scope='session')
+def fixtures_dir():
+    return os.path.join(os.path.dirname(os.path.abspath(__file__)), '..')

terraform/tests/requirements.txt

@@ -0,0 +1,2 @@
+pytest>=7.2
+tftest==1.8.5

terraform/tests/test_init.py

@@ -0,0 +1,9 @@
+import pytest
+import tftest
+
+
+@pytest.mark.parametrize("csp", ['azure', 'aws', 'gcp'])
+def test_init(fixtures_dir, csp):
+    tf = tftest.TerraformTest(csp, fixtures_dir)
+    init_out = tf.init(output=True)
+    assert 'Terraform has been successfully initialized' in init_out