feat(tests): Added tests for the tfe block

hashicorp/tfe/outputs.tf

@@ -6,3 +6,6 @@ output "workspace" {
   value = tfe_workspace.workload
 }
 
+output "workspace_variables" {
+  value = local.tfc_variables
+}

hashicorp/tfe/tfe_variable.tf

@@ -8,3 +8,20 @@ resource "tfe_variable" "workload" {
   hcl          = try(each.value.hcl, false)
   sensitive    = try(each.value.sensitive, false)
 }
+
+data "tfe_variables" "workload" {
+  workspace_id = tfe_workspace.workload.id
+  depends_on   = [tfe_variable.workload]
+}
+
+
+locals {
+  #Restructure the output so it's possible to create terraform tests
+  tfc_variables = { for v in data.tfe_variables.workload.variables : v.name => {
+    category  = v.category
+    hcl       = v.hcl
+    id        = v.id
+    sensitive = v.sensitive
+    value     = v.value
+  } }
+}

hashicorp/tfe/variables.tf

@@ -24,6 +24,7 @@ variable "workspace_env_vars" {
     value       = string
     category    = string
     description = string
+    sensitive   = optional(bool)
   }))
   default = null
 }

role_definitions.tf

@@ -3,7 +3,7 @@ resource "azurerm_role_definition" "user_created" {
   role_definition_id = each.value.role_definition_id
   name               = each.value.name
   description        = each.value.description
-  scope              = each.value.scope
+  scope              = each.value.scope == null ? "/subscriptions/${data.azurerm_client_config.current.subscription_id}" : each.value.scope
   assignable_scopes  = each.value.assignable_scopes
   dynamic "permissions" {
     for_each = each.value.permissions == null ? [] : [1]

test/README.md

@@ -49,6 +49,8 @@ This folder contains all tests for the Terraform Station module. The aim is to s
     terraform destroy
     ```
 
+6. **Tips**
+   You can also test each module separately by running `terraform plan -target module.module_you_want_to_test`
 
 ## Testing Approach for New Features in the Station Module
 

tests/README.md

@@ -0,0 +1,138 @@
+# Terraform Station Tests
+
+## Overview
+
+This folder contains all tests for the Terraform Station module. The aim is to simplify the development and testing process for contributors.
+
+## How It Works
+
+1. **Terraform Cloud (TFC) Project Creation**: The tests are dependent on an existing TFC project so this should be created using the `setup-fte-project` module. This project's name should match the value set in the `TF_VARtfc_tfc_project_name` environment variable. It's recommended to use a name like `station-tests`.
+
+2. **Workspace and Resource Creation**: For each test (files ending with `tftest.hcl`), a new workspace is created, and the defined Azure and/or Entra ID resources are provisioned.
+
+## Prerequisites
+
+- Azure CLI installed and configured
+- Terraform CLI installed
+- Access to a Terraform Cloud account and an Azure subscription
+
+## How to Run Tests
+
+1. **Login to Azure and Terraform**:
+    ```bash
+    az login --tenant YourTenantIdHere
+    terraform login
+    ```
+
+2. **Initialize Terraform**:
+    ```bash
+    terraform init
+    ```
+
+3. **Set Environment Variables**:
+   Replace empty strings with your TFC organization name.
+    ```bash
+    export TFE_ORGANIZATION=""
+    export TF_VAR_tfc_organization_name=""
+    ```
+
+4. **Starting the tests**:
+    ```bash
+    terraform test #This will run all the tests
+    terraform test -filter=tests/tfe.tftest.hcl #This will only run the tests for the tfe block
+    ```
+
+## Testing Approach for New Features in the Station Module
+
+When adding new features to the Station module, it's crucial to validate their functionality. Contributors should create tests that encompass at least two fundamental configurations:
+
+1. **Minimal Configuration**: Focus on the core functionality of the feature by using only the essential parameters. This configuration aims to verify that the feature works with the bare minimum setup.
+
+2. **Maximum Configuration**: Expand the test to include all possible parameters. This approach is designed to showcase the feature's full capabilities and ensures compatibility with a wide range of options and settings.
+
+### Additional Configurations
+
+- **Scenario-Specific Tests**: If the feature includes multiple optional values that cannot all be used simultaneously or has different modes of operation, create additional test configurations to cover these scenarios. 
+- **Combination Tests**: For features with parameters that interact in complex ways, design tests that combine these parameters in various forms. This helps in understanding the interactions and dependencies between different options.
+
+### Example Test Case Structure
+
+Add your required providers:
+```hcl
+provider "tfe" {}
+provider "azurerm" {
+  features {}
+}
+provider "azuread" {
+
+}
+```
+Call the module like how you would use it but inside a variables block
+
+```hcl
+variables {
+  tfe = {
+    project_name                         = "name_matching_the_project_in_the_setup_block"
+    organization_name                    = "Your_tfc_org_name"
+    workspace_name                       = "tfe_test"
+    workspace_description                = "Workspace description"
+  }
+
+  # Call you new_feature module
+  new_feature = {
+    # Minimal Configuration Example
+    minimal = {
+      required_param = "basic_value"
+    },
+
+    # Maximum Configuration Example
+    maximum = {
+      required_param = "value"
+      optional_param1 = "advanced_value1"
+      optional_param2 = "advanced_value2"
+      ...
+    },
+
+    # Additional Scenario-Specific Configurations
+    scenario_specific = {
+      ...
+    }
+  }
+}
+```
+Call the setup module that will create a test project for us in TFC. Ensure the project name is unique to the test your creating
+
+```hcl
+run "setup_create_tfc_test_project" {
+  variables {
+    project_name      = "tests_new_feature"
+    organization_name = "Your_tfc_org_name"
+  }
+  module {
+    source = "./tests/setup-tfe-project"
+  }
+}
+``````
+Create multiple `assert` or `expect_failures` blocks to validate that the required resources where created with the values we provided in the variable block.
+
+```hcl
+run "test_new_feature" {
+
+  module {
+    source = "./"
+  }
+
+  assert {
+    condition     = module.new_feature.name == "Name you set in the variables block"
+    error_message = "Some error message explaining why it failed"
+  }
+
+  assert {
+    condition     = module.new_feature.someValue == true
+    error_message = "Some error message explaining why it failed"
+  }
+
+}
+
+```
+Use this structure as a template when adding tests for new functionalities to ensure both basic and advanced use cases are covered.

tests/setup-tfe-project/main.tf

@@ -0,0 +1,7 @@
+data "tfe_organization" "test" {
+  name = var.tfc_organization_name
+}
+
+resource "tfe_project" "test" {
+  name = var.tfc_project_name
+}

tests/setup-tfe-project/variables.tf

@@ -0,0 +1,9 @@
+variable "tfc_organization_name" {
+  type        = string
+  description = "The name of the Terraform Cloud organization to use"
+}
+
+variable "tfc_project_name" {
+  type        = string
+  description = "The name of the Terraform Cloud project to create"
+}