feat: add example + test GHA

Author: gberenice

Diff for: .github/workflows/test.yaml

@@ -0,0 +1,43 @@
+name: OpenTofu Test
+
+on:
+  push:
+    branches:
+      - main
+      - feature/int-1001/initial-version
+  pull_request:
+
+permissions:
+  actions: read
+  checks: write
+  contents: read
+  id-token: write
+  pull-requests: read
+
+jobs:
+  tofu-test:
+    name: OpenTofu Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Aqua Cache
+        uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        if: ${{ !github.event.act }} # Don't enable the cache step if we're using act for testing
+        with:
+          path: ~/.local/share/aquaproj-aqua
+          key: v1-aqua-installer-${{runner.os}}-${{runner.arch}}-${{hashFiles('aqua.yaml')}}
+          restore-keys: |
+            v1-aqua-installer-${{runner.os}}-${{runner.arch}}-
+
+      - name: Install Aqua
+        uses: aquaproj/aqua-installer@5e54e5cee8a95ee2ce7c04cb993da6dfad13e59c # v3.2.1
+        with:
+          aqua_version: v2.48.1
+
+      - name: Aqua Install
+        shell: bash
+        run: aqua install --tags tofu
+
+      - run: tofu init
+      - run: tofu test

Diff for: .gitignore

@@ -17,10 +17,6 @@
 *.draft
 *~
 
-# Build Harness https://github.com/cloudposse/build-harness
-**/.build-harness
-**/build-harness
-
 # Log files
 *.log
 

Diff for: .trunk/trunk.yaml

@@ -2,12 +2,12 @@
 # To learn more about the format of this file, see https://docs.trunk.io/reference/trunk-yaml
 version: 0.1
 cli:
-  version: 1.22.11
+  version: 1.22.12
 # Trunk provides extensibility via plugins. (https://docs.trunk.io/plugins)
 plugins:
   sources:
     - id: trunk
-      ref: v1.6.7
+      ref: v1.6.8
       uri: https://github.com/trunk-io/plugins
 # Many linters and tools depend on runtimes - configure them here. (https://docs.trunk.io/runtimes)
 runtimes:
@@ -20,15 +20,16 @@ lint:
     # Incompatible with some Terraform features: https://github.com/tenable/terrascan/issues/1331
     - terrascan
   enabled:
+    - [email protected]
     - [email protected]
     - [email protected]
-    - [email protected].394
+    - [email protected].405
     - git-diff-check
     - [email protected]
     - [email protected]
     - [email protected]
     - [email protected]
-    - [email protected].20
+    - [email protected].23
     - [email protected]
   ignore:
     - linters: [tofu]

Diff for: README.md

@@ -24,7 +24,7 @@ This Terraform module manages GitHub teams and their memberships within an organ
 2. Organization admin access.
 3. GitHub provider configuration with appropriate permissions.
 
-### Basic Example
+### Example
 
 ```hcl
 module "github_teams" {
@@ -60,45 +60,6 @@ module "github_teams" {
 }
 ```
 
-### Advanced Example with All Features
-
-```hcl
-module "github_teams" {
-  source  = "masterpointio/teams/github"
-  version = "X.X.X"
-
-  github_organization = "example-org"
-
-  teams = {
-    "platform-engineers" = {
-      name        = "Platform Engineers"
-      description = "Team responsible for platform infrastructure"
-      privacy     = "closed"
-      members = [
-        {
-          username = "lead-engineer"
-          role     = "maintainer"
-        }
-      ]
-      review_request_delegation = {
-        algorithm    = "ROUND_ROBIN"
-        member_count = 2
-        notify       = true
-      }
-    }
-  }
-
-  repository_collaborators = {
-    "example-org/repo1" = [
-      {
-        username                    = "external-contributor"
-        permission                  = "maintain"
-      }
-    ]
-  }
-}
-```
-
 ### Input Variables
 
 | Name                     | Description                                              | Type        | Required |

Diff for: aqua.yaml

@@ -8,8 +8,8 @@
 #   - all
 registries:
   - type: standard
-    ref: v4.210.0 # renovate: depName=aquaproj/aqua-registry
+    ref: v4.346.0 # renovate: depName=aquaproj/aqua-registry
 packages:
-  - name: terraform-docs/terraform-docs@v0.19.0
-  - name: hashicorp/terraform@v1.9.3
-  - name: opentofu/opentofu@v1.8.0
+  - name: terraform-docs/terraform-docs@v0.20.0
+  - name: hashicorp/terraform@v1.11.4
+  - name: opentofu/opentofu@v1.9.0

Diff for: examples/complete/main.tf

@@ -1 +1,42 @@
-# complete.tf
+module "github_teams" {
+  source  = "masterpointio/teams/github"
+  version = "0.1.0"
+
+  github_organization = "example-org"
+
+  teams = {
+    "platform-engineers" = {
+      name        = "Platform Engineers"
+      description = "Team responsible for platform infrastructure"
+      privacy     = "closed"
+      members = [
+        {
+          username = "lead-engineer"
+          role     = "maintainer"
+        },
+        {
+          username = "senior-engineer"
+          role     = "member"
+        },
+        {
+          username = "junior-engineer"
+          role     = "member"
+        }
+      ]
+      review_request_delegation = {
+        algorithm    = "ROUND_ROBIN"
+        member_count = 2
+        notify       = true
+      }
+    }
+  }
+
+  repository_collaborators = {
+    "example-org/repo1" = [
+      {
+        username   = "external-contributor"
+        permission = "maintain"
+      }
+    ]
+  }
+}

Diff for: examples/complete/outputs.tf

@@ -0,0 +1,10 @@
+terraform {
+  required_version = "~> 1.7"
+
+  required_providers {
+    random = {
+      source  = "integrations/github"
+      version = "~> 6.0"
+    }
+  }
+}

Diff for: examples/complete/variables.tf

@@ -1,3 +1,10 @@
+# Note: This test file uses OpenTofu-specific test syntax.
+# It is not compatible with Terraform due to differences in the testing framework.
+# Key differences:
+# - OpenTofu does not support source in mock_provider
+# - OpenTofu only allows overriding computed fields
+# - OpenTofu has different mock data handling
+
 mock_provider "github" {
   alias = "mock"
 }
@@ -134,44 +141,3 @@ run "validate_repository_collaborators" {
     error_message = "Phoebe should have maintain permission on repo2"
   }
 }
-
-run "validate_outputs" {
-  command = plan
-
-  providers = {
-    github = github.mock
-  }
-
-  # Test team outputs
-  assert {
-    condition     = output.teams["developers"].name == "Developers"
-    error_message = "Team output should contain correct name"
-  }
-
-  assert {
-    condition     = output.teams["platform-engineers"].privacy == "closed"
-    error_message = "Team output should contain correct privacy setting"
-  }
-
-  # Test team membership outputs
-  assert {
-    condition     = output.team_memberships["developers:rachel"].role == "maintainer"
-    error_message = "Team membership output should contain correct role"
-  }
-
-  assert {
-    condition     = output.team_memberships["developers:ross"].role == "member"
-    error_message = "Team membership output should contain correct role"
-  }
-
-  # Test repository collaborator outputs
-  assert {
-    condition     = output.repository_collaborators["example-org/repo1:monica"].permission == "admin"
-    error_message = "Repository collaborator output should contain correct permission"
-  }
-
-  assert {
-    condition     = output.repository_collaborators["example-org/repo2:phoebe"].permission == "maintain"
-    error_message = "Repository collaborator output should contain correct permission"
-  }
-}