Add component tests for collection

.github/actions/build-collection/action.yaml

@@ -12,15 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: build-collection
-description: Builds the collection
+name: "Build collection"
+description: "Builds collection"
 
 runs:
   using: composite
   steps:
-    - name: Download certificate
+    - name: "Download certificate"
       shell: bash
       run: mkdir -p $FILES_DIR && wget https://ca.dynatrace.com/dt-root.cert.pem -P $FILES_DIR
-    - name: Build the collection
+    - name: "Build the collection"
       shell: bash
       run: ansible-galaxy collection build . -vvv

.github/actions/publish-to-ansible-galaxy/action.yaml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: publish-to-ansible-galaxy
+name: "Publish to Ansible Galaxy"
 description: Publish to Ansible Galaxy
 
 inputs:
@@ -23,6 +23,6 @@ inputs:
 runs:
   using: composite
   steps:
-    - name: Publish the Ansible collection
+    - name: "Publish the Ansible collection"
       shell: bash
       run: ansible-galaxy collection publish dynatrace-oneagent* --token ${{ inputs.ansible-galaxy-api-token }}

.github/actions/run-component-tests/action.yaml

@@ -0,0 +1,42 @@
+# Copyright 2024 Dynatrace LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: "Run component tests"
+description: "Runs component tests"
+
+runs:
+  using: composite
+  steps:
+    - name: "Prepare Python environment"
+      shell: bash
+      run: |
+        python -m venv venv
+        source venv/bin/activate
+        pip install -r roles/oneagent/tests/requirements.txt
+
+    - name: "Install the collection"
+      shell: bash
+      run: sudo bash -c "source venv/bin/activate && ansible-galaxy collection install -vvv dynatrace-oneagent*"
+
+    - name: "Run component tests"
+      shell: bash
+      run: sudo bash -c "source venv/bin/activate && pytest roles/oneagent/tests --linux_x86=localhost"
+
+    - name: "Upload logs"
+      uses: actions/upload-artifact@v4
+      if: ${{ always() }}
+      with:
+        name: component-tests-${{ github.sha }}
+        retention-days: 1
+        path: test_dir/logs

.github/actions/run-tests/action.yaml → .github/actions/run-sanity-tests/action.yaml

@@ -12,15 +12,16 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: run-tests
-description: Runs the tests
+name: run-sanity-tests
+description: "Runs sanity tests"
 
 runs:
   using: composite
   steps:
-    - name: Install the collection
+    - name: "Install the collection"
       shell: bash
-      run: ansible-galaxy collection install dynatrace-oneagent*
-    - name: Run sanity test
+      run: ansible-galaxy collection install -vvv dynatrace-oneagent*
+
+    - name: "Run sanity test"
       shell: bash
       run: pushd ~/.ansible/collections/ansible_collections/dynatrace/oneagent && ansible-test sanity && popd

.github/actions/set-environment-variables/action.yaml

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Set environment variables
-description: Set environment variables required for other actions
+name: "Set environment variables"
+description: "Set environment variables required for other actions"
 
 runs:
   using: composite
   steps:
-    - name: Set environment variables
+    - name: "Set environment variables"
       shell: bash
       run: printf "FILES_DIR=roles/oneagent/files\n" >> $GITHUB_ENV

.github/actions/setup-build-environment/action.yaml

@@ -12,15 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: setup-build-environment
-description: Prepares build environment
+name: "Prepare build environment"
+description: "Prepares build environment"
 
 runs:
   using: composite
   steps:
     - uses: actions/setup-python@v5
       with:
         python-version: '3.10'
-    - name: Install dependencies
+    - name: "Install dependencies"
       shell: bash
       run: pip install ansible

.github/actions/update-version/action.yaml

@@ -12,35 +12,35 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: update-version
-description: Update version
+name: "Update version"
+description: "Updates version"
 
 runs:
   using: composite
   steps:
-    - name: Get latest tag
+    - name: "Get latest tag"
       shell: bash
       run: printf "LATEST_TAG=%s\n" "$(git describe --tags --abbrev=0 --always)" >> $GITHUB_ENV
 
-    - name: Extract version
+    - name: "Extract version"
       shell: bash
       run: |
         latestTag="${{ env.LATEST_TAG }}"
         printf "LATEST_VERSION=%s\n" "${latestTag#v}" >> $GITHUB_ENV
 
-    - name: Update galaxy.yml version
+    - name: "Update galaxy.yml version"
       shell: bash
       run: |
         latestVersion="${{ env.LATEST_VERSION }}"
         sed -i "s/version: .*/version: ${latestVersion}/" galaxy.yml
 
-    - name: Configure git
+    - name: "Configure git"
       shell: bash
       run: |
         git config --global user.name "github-actions[bot]"
         git config --global user.email "github-actions[bot]@users.noreply.github.com"
 
-    - name: Commit and push changes
+    - name: "Commit and push changes"
       shell: bash
       run: |
         git checkout master

.github/actions/upload-collection/action.yaml

@@ -12,13 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: upload-collection
+name: "Upload collection"
 description: Uploads the collection locally
 
 runs:
   using: composite
   steps:
-    - name: Publish artifact
+    - name: "Publish artifact"
       uses: actions/upload-artifact@v4
       with:
         name: dynatrace-oneagent-${{ github.sha }}

.github/workflows/build-and-test.yaml

@@ -12,12 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Build and test
+name: "Build and test"
 on:
   pull_request:
-    branches: [ "*" ]
-  push:
-    branches: [ "*" ]
   workflow_dispatch:
   workflow_call:
 
@@ -35,5 +32,7 @@ jobs:
         uses: ./.github/actions/setup-build-environment
       - name: Build the collection
         uses: ./.github/actions/build-collection
-      - name: Run tests
-        uses: ./.github/actions/run-tests
+      - name: Run sanity tests
+        uses: ./.github/actions/run-sanity-tests
+      - name: Run component tests
+        uses: ./.github/actions/run-component-tests

.github/workflows/build-test-and-publish.yaml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Build, test and publish
+name: "Build, test and publish"
 on:
   push:
     tags:
@@ -33,8 +33,10 @@ jobs:
         uses: ./.github/actions/setup-build-environment
       - name: Build the collection
         uses: ./.github/actions/build-collection
-      - name: Run tests
-        uses: ./.github/actions/run-tests
+      - name: Run sanity tests
+        uses: ./.github/actions/run-sanity-tests
+      - name: Run component tests
+        uses: ./.github/actions/run-component-tests
       - name: Publish to Ansible Galaxy
         uses: ./.github/actions/publish-to-ansible-galaxy
         with:

.github/workflows/build-test-and-upload.yaml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-name: Build, test and upload
+name: "Build, test and upload"
 on:
   push:
     branches: [ "master" ]

.gitignore

@@ -1 +1,31 @@
-dynatrace-oneagent-*
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Flask
+instance/
+.webassets-cache
+
+# Ansible
+*.retry
+dynatrace-oneagent-*.tar.gz
+
+# JetBrains IDE
+.idea
+
+# Tests working directory
+**/test_dir/

.pre-commit-config.yaml

@@ -1,9 +1,8 @@
 ---
-
 repos:
   - repo: https://github.com/ansible/ansible-lint
     rev: v24.2.2
     hooks:
       - id: ansible-lint
         pass_filenames: false
-        args: ['--exclude', 'roles/oneagent/examples']
+        args: ['--exclude', 'roles/oneagent/examples', 'tests/component/resources/ansible/oneagent.yml']

CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to this project will be documented in this file.
 
 - Added parameter `--restart-service` parameter, once OneAgent configuration is performed
 - Fixed problem with `Invalid version string` during collection install
+- Added parameter `oneagent_verify_signature` controlling signature verification step
+- Removed `oneagent_validate_certs` parameter
 
 ## [1.1.0] - 2021-10-06
 

galaxy.yml

@@ -15,3 +15,6 @@ tags:
   - deployment
 repository: https://github.com/Dynatrace/Dynatrace-OneAgent-Ansible
 documentation: https://docs.dynatrace.com/docs/setup-and-configuration/dynatrace-oneagent/deployment-orchestration/ansible
+build_ignore:
+  - roles/oneagent/tests
+  - roles/oneagent/examples

requirements.txt

@@ -1,2 +1,2 @@
 ansible >= 2.15.0
-pywinrm >= 0.4.1 ; sys_platform == 'win32'
+pywinrm >= 0.4.3

roles/oneagent/README.md

@@ -52,7 +52,7 @@ The following variables are available in `defaults/main/` and can be overridden:
 | `oneagent_preserve_installer` | `false` | Preserve installers on secondary machines after deployment.
 | `oneagent_package_state` | `present` | OneAgent package state; use `present` or `latest` to make sure it's installed, or `absent` in order to uninstall.
 | `oneagent_reboot_host` | `false` | Reboot the secondary machine after OneAgent installation
-| `oneagent_validate_certs` | `true` | If set to `false`, allows to download OneAgent from a server with insecure SSL certificate (expired, self-signed, etc).
+| `oneagent_verify_signature` | `true` | Verifies installer's signature (available only on AIX/Linux platforms)
 | `oneagent_reboot_timeout` | `3600` | Set the timeout for rebooting secondary machine in seconds
 
 For more information, see customize OneAgent installation documentation for [Linux], [Windows], and [AIX].

roles/oneagent/defaults/main.yml

@@ -28,8 +28,11 @@ oneagent_preserve_installer: false
 # Set the need of rebooting machine after installation
 oneagent_reboot_host: false
 
-# Set the need of validating certs during installer download
-oneagent_validate_certs: true
+# Set the need of verifying the installer signature
+oneagent_verify_signature: true
 
 # Set the timeout for platform reboot
 oneagent_reboot_timeout: 3600
+
+# Set CA certificate download url
+oneagent_ca_cert_download_url: https://ca.dynatrace.com/dt-root.cert.pem

roles/oneagent/tasks/cleanup/cleanup-windows.yml

@@ -1,5 +1,5 @@
 ---
 - name: Remove leftover installer
-  win_file:
+  ansible.windows.win_file:
     path: "{{ oneagent_installer_path }}"
     state: absent