RUN-4085 Generate Inventory with SSH password authentication #421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

ltamaster merged 46 commits into main from inventory_with_auth

Jan 26, 2026

functional-test/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,181 @@
+    # Functional Tests for Ansible Plugin
+    This directory contains functional tests for the Rundeck Ansible plugin using Testcontainers and Docker.
+    ## Prerequisites
+    - Docker (Docker Desktop or Rancher Desktop)
+    - Java 11 or later
+    - Gradle 7.2 or later
+    ## Docker Configuration
+    The functional tests use Testcontainers to spin up Docker containers for Rundeck and SSH nodes. Depending on your Docker setup, you may need to configure the Docker socket path.
+    ### Option 1: Using ~/.testcontainers.properties (Recommended)
+    Create a file at `~/.testcontainers.properties` with the following content:
+    **For Rancher Desktop on macOS:**
+    ```properties
+    docker.host=unix:///Users/<your-username>/.rd/docker.sock
+    ```
+    **For Docker Desktop on macOS/Linux:**
+    ```properties
+    docker.host=unix:///var/run/docker.sock
+    ```
+    **For Windows with Docker Desktop:**
+    ```properties
+    docker.host=tcp://localhost:2375
+    ```
+    ### Option 2: Modify build.gradle
+    Edit `functional-test/build.gradle` and update the `docker.host` paths on lines 52-53:
+    ```gradle
+    systemProperty('docker.host', "unix:///path/to/your/docker.sock")
+    environment 'DOCKER_HOST', 'unix:///path/to/your/docker.sock'
+    ```
+    ## Running the Tests
+    ### Run All Functional Tests
+    ```bash
+    ./gradlew :functional-test:functionalTest
+    ```
+    ### Run Specific Test Suite
+    ```bash
+    # Multi-node authentication tests
+    ./gradlew :functional-test:functionalTest --tests "*MultiNodeAuthSpec*"
+    # Basic integration tests
+    ./gradlew :functional-test:functionalTest --tests "*BasicIntegrationSpec*"
+    # Plugin group tests
+    ./gradlew :functional-test:functionalTest --tests "*PluginGroupIntegrationSpec*"
+    ```
+    ## Test Suites
+    ### MultiNodeAuthSpec
+    Tests the multi-node authentication feature where each node can have its own password stored in Rundeck's key storage.
+    **Tests:**
+    - `test ansible playbook with multi-node authentication` - Verifies Ansible playbooks execute across multiple nodes with per-node credentials
+    - `test multi-node authentication with different passwords` - Tests script execution on multiple nodes with different passwords
+    - `test nodes are accessible with different credentials` - Validates node registration and discovery
+    - `test passwords with special characters are properly escaped` - Verifies YAML escaping for special characters in passwords
+    **Test Environment:**
+    - 3 SSH nodes (ssh-node, ssh-node-2, ssh-node-3)
+    - Each node has a different password, including special characters
+    - Tests both WorkflowStep (Ansible playbooks) and NodeStep (scripts) execution
+    ### BasicIntegrationSpec
+    Basic integration tests for the Ansible plugin functionality.
+    ### PluginGroupIntegrationSpec
+    Tests for plugin group configuration and execution.
+    ## Test Structure
+    ```
+    functional-test/
+    ├── build.gradle                          # Test configuration
+    ├── README.md                             # This file
+    └── src/
+        └── test/
+            ├── groovy/functional/            # Test specifications
+            │   ├── MultiNodeAuthSpec.groovy
+            │   ├── BasicIntegrationSpec.groovy
+            │   └── PluginGroupIntegrationSpec.groovy
+            └── resources/
+                ├── docker/                   # Docker compose and configs
+                │   ├── docker-compose.yml
+                │   ├── ansible-multi-node-auth/  # Multi-node test configs
+                │   ├── keys/                     # SSH keys for tests
+                │   ├── node/                     # SSH node Docker configs
+                │   └── rundeck/                  # Rundeck Docker configs
+                └── project-import/           # Rundeck project definitions
+                    └── ansible-multi-node-auth/
+                        └── rundeck-ansible-multi-node-auth/
+                            ├── files/etc/project.properties
+                            └── jobs/*.xml
+    ```
+    ## Troubleshooting
+    ### Tests Fail with "Could not find Docker socket"
+    **Problem:** Testcontainers cannot locate the Docker socket.
+    **Solution:**
+. Verify Docker is running: `docker ps`
+. Check your Docker socket path:
+       - Rancher Desktop: `ls -la ~/.rd/docker.sock`
+       - Docker Desktop: `ls -la /var/run/docker.sock`
+. Update `~/.testcontainers.properties` or `build.gradle` with the correct path
+    ### Tests Timeout or Hang
+    **Problem:** Tests take too long or appear to hang.
+    **Solution:**
+. Check Docker container status: `docker ps -a`
+. Check Docker logs: `docker logs <container-id>`
+. Increase test timeout in build.gradle if needed
+. Ensure sufficient Docker resources (memory/CPU)
+    ### Port Conflicts
+    **Problem:** Tests fail with "port already in use" errors.
+    **Solution:**
+. Check for running containers: `docker ps`
+. Stop conflicting containers: `docker stop <container-name>`
+. Clean up: `docker-compose down` in the docker directory
+    ### Platform Mismatch Warnings (Apple Silicon)
+    **Problem:** Warnings about platform mismatch (linux/amd64 vs linux/arm64).
+    **Solution:** These warnings are expected on Apple Silicon Macs and can be safely ignored. Docker will use Rosetta 2 for emulation.
+    ## Test Reports
+    After running tests, view the HTML report at:
+    ```
+    functional-test/build/reports/tests/functionalTest/index.html
+    ```
+    ## Adding New Tests
+. Create a new Spock specification in `src/test/groovy/functional/`
+. Extend `BaseTestConfiguration` for common test utilities
+. Add any required Docker configs to `src/test/resources/docker/`
+. Add project imports to `src/test/resources/project-import/`
+. Follow existing test patterns for consistency
+    ## Multi-Node Authentication Feature
+    The multi-node authentication feature allows running Ansible playbooks across multiple nodes where each node has its own password stored in Rundeck's key storage.
+    **How it works:**
+. Enable at project level: `project.ansible-generate-inventory-nodes-auth=true`
+. Store per-node passwords in Key Storage with paths specified in node attributes
+. Plugin generates `group_vars/all.yaml` with vault-encrypted passwords
+. Ansible uses host-specific credentials from group_vars
+    **Requirements:**
+    - Must use Ansible Playbook **Workflow Steps** (not Node Steps); the multi-node authentication logic and inventory generation are only implemented for the Workflow Step variant of the plugin and are not executed for Node Steps, so enabling `project.ansible-generate-inventory-nodes-auth` while using Node Steps will not apply per-node credentials. This limitation exists because Node Steps run independently on each target node and do not share the global inventory context that the multi-node authentication feature relies on.
+    - Node attributes must include `ansible-ssh-password-storage-path` for each node
+    - Passwords are automatically encrypted using Ansible Vault
+    - Supports special characters with proper YAML escaping
+    See `MultiNodeAuthSpec.groovy` for comprehensive test examples.

functional-test/build.gradle

-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,20 @@ dependencies { @@
     tasks.register('functionalTest', Test) {
         useJUnitPlatform()
-        systemProperty('RUNDECK_TEST_IMAGE', "rundeck/rundeck:5.1.1")
+        // Rundeck test image version
+        // Minimum supported Rundeck version for this plugin: 5.1.1 (see main README/changelog).
+        // Functional tests intentionally run against a newer version, Rundeck 5.18.0, to validate
+        // compatibility with current releases. When raising the minimum supported version, update
+        // this test image tag in tandem.
+        systemProperty('RUNDECK_TEST_IMAGE', "rundeck/rundeck:5.18.0")
+        // Docker configuration for Testcontainers
+        // For Rancher Desktop on macOS: Use /Users/<username>/.rd/docker.sock
+        // For Docker Desktop on macOS: Use /var/run/docker.sock
+        // For Linux: Use /var/run/docker.sock
+        // You can also configure this via ~/.testcontainers.properties (see functional-test/README.md)
         description = "Run Ansible integration tests"
     }
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

RUN-4085 Generate Inventory with SSH password authentication #421

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!