Merge pull request #4 from GoodOldJack12/main

CI and small fixes

Author: alvarosimon

.github/workflows/ci.yaml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        check:
+          - name: local-module-check
+            run: ./tests/local-module-check.test.sh
+          - name: fmt-check
+            run: ./tests/tofu-fmt.test.sh
+
+    name: ${{ matrix.check.name }}
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: opentofu/setup-opentofu@v1
+        with:
+          tofu_version: "1.11.0"
+
+      - run: tofu version
+      - run: chmod +x tests/*.sh
+      - run: ${{ matrix.check.run }}

.gitignore

@@ -1,2 +1,4 @@
 .terraform/
 .terraform.lock.*
+*.tfstate
+*.tfstate.*

examples/multiple-vms/main.tf

@@ -1,6 +1,6 @@
 # Router definition
 module "router" {
-  source  = "hpcugent/vsc/opennebula//submodules/router"
+  source  = "hpcugent/opennebula/vsc//modules/router"
   version = "0.0.3"
   #VM Which we can ssh to by default
   access_vm = module.Main.router_access
@@ -16,7 +16,7 @@ module "router" {
   }
 }
 module "Main" {
-  source            = "hpcugent/vsc/opennebula"
+  source            = "hpcugent/opennebula/vsc"
   version           = "0.0.3"
   vm_name           = "MultipleExampleMain"
   image_name        = "Rocky 9"
@@ -25,7 +25,7 @@ module "Main" {
   firewall_services = ["http"] # Automatically allows ports 80 & 443
 }
 module "Secondary" {
-  source            = "hpcugent/vsc/opennebula"
+  source            = "hpcugent/opennebula/vsc"
   version           = "0.0.3"
   vm_name           = "MultipleExampleSecondary"
   image_name        = "Ubuntu 24.04"

examples/simple-server/main.tf

@@ -1,12 +1,12 @@
 # Router definition
 module "router" {
-  source  = "hpcugent/vsc/opennebula//submodules/router"
+  source  = "hpcugent/opennebula/vsc//modules/router"
   version = "0.0.3"
   # VM Which we can ssh to by default
   access_vm = module.SimpleVM.router_access
 }
 module "SimpleVM" {
-  source     = "hpcugent/vsc/opennebula"
+  source     = "hpcugent/opennebula/vsc"
   version    = "0.0.3"
   vm_name    = "SimpleExample"
   image_name = "Rocky 9"

examples/webserver/main.tf

@@ -1,6 +1,6 @@
 # Router definition
 module "router" {
-  source  = "hpcugent/vsc/opennebula//submodules/router"
+  source  = "hpcugent/opennebula/vsc//modules/router"
   version = "0.0.3"
   #VM Which we can ssh to by default
   access_vm = module.WebServer.router_access
@@ -14,7 +14,7 @@ module "router" {
   }
 }
 module "WebServer" {
-  source            = "hpcugent/vsc/opennebula"
+  source            = "hpcugent/opennebula/vsc"
   version           = "0.0.3"
   vm_name           = "WebExample"
   image_name        = "Rocky 9"

examples/windows/main.tf

@@ -1,12 +1,12 @@
 # Router definition
 module "router" {
-  source  = "hpcugent/vsc/opennebula//submodules/router"
+  source  = "hpcugent/opennebula/vsc//modules/router"
   version = "0.0.3"
   #VM Which we can ssh/rdp to by default
   access_vm = module.vsc-opennebula.router_access
 }
 module "vsc-opennebula" {
-  source        = "hpcugent/vsc/opennebula"
+  source        = "hpcugent/opennebula/vsc"
   version       = "0.0.3"
   vm_name       = "JonTest"
   image_name    = "Windows 11"

fixup-examples.sh

@@ -10,12 +10,14 @@ if [[ "$MODE" != "remote" && "$MODE" != "local" ]]; then
 fi
 
 LOCAL_BASE='"../../"'
-REMOTE_BASE='"hpcugent/vsc/opennebula"'
+REMOTE_BASE='"hpcugent/opennebula/vsc"'
 LOCAL_ROUTER_BASE='"../../modules/router"'
-REMOTE_ROUTER_BASE='"hpcugent/vsc/opennebula//submodules/router"'
+REMOTE_ROUTER_BASE='"hpcugent/opennebula/vsc//modules/router"'
 VERSION='0.0.3'
 
-find "$ROOT_DIR/examples" -type f -name 'main.tf' -print0 |
+find "$ROOT_DIR/examples" \
+  -type d -name '.terraform' -prune -o \
+  -type f -name 'main.tf' -print0 |
 while IFS= read -r -d '' file; do
     if [[ "$MODE" == "remote" ]]; then
         sed -i \

modules/router/variables.tf

@@ -30,10 +30,5 @@ variable "port_forwards" {
     )
     error_message = "External port must be 80, 443, or between ${local.ugent_port_range.min} and ${local.ugent_port_range.max}."
   }
-  description = <<-EOF
-  List of port forwarding rules.
-  internal_ip (optional) default: access_vm IP
-  internal_port (optional) default: external_port
-  external_port (required) MUST be between 51001 and 59999 OR port 80/443
-EOF
+  description = "List of port forwarding rules."
 }

tests/local-module-check.test.sh

@@ -1,4 +1,6 @@
 #!/bin/bash
+: "${ROOT_DIR:=$(pwd)}"
+
 if [[ -f "common.sh" ]];then
     source common.sh
 elif [[ -d tests ]];then

tests/runAll.sh

@@ -5,7 +5,7 @@ TEST_SCRIPTS=(
   "./module-tofu.test.sh"
   "./examples-tofu.test.sh"
   "./tofu-fmt.test.sh"
-  #"./local-module-check.test.sh"
+  "./local-module-check.test.sh" # This one should always be last
 )
 
 # Array to hold exit codes
@@ -17,7 +17,6 @@ for script in "${TEST_SCRIPTS[@]}"; do
   EXIT_CODES+=($?)  # store exit code
   echo ""
 done
-
 # Check if any failed
 FAILED=()
 for i in "${!TEST_SCRIPTS[@]}"; do