Test sanitise

Author: markgoddard

.github/workflows/multinode.yml

@@ -5,6 +5,7 @@
 
 name: Multinode
 on:
+  push:
   workflow_call:
     inputs:
       multinode_name:
@@ -85,7 +86,7 @@ on:
 jobs:
   multinode:
     name: Multinode
-    runs-on: arc-skc-aio-runner
+    runs-on: ubuntu-latest
     environment: Leafcloud
     permissions: {}
     timeout-minutes: 2880
@@ -94,276 +95,25 @@ jobs:
       KAYOBE_ENVIRONMENT: ci-multinode
       KAYOBE_VAULT_PASSWORD: ${{ secrets.KAYOBE_VAULT_PASSWORD_CI_MULTINODE }}
     steps:
-      - name: Fail if previous version is not defined
-        run: |
-          echo "StackHPC Kayobe Configuration previous version must be defined for upgrades"
-          exit 1
-        if: ${{ inputs.upgrade && inputs.stackhpc_kayobe_config_previous_version == '' }}
-
-      - name: Fail if no SSH key is provided for break_on
-        run: |
-          echo "break_on is set to ${{ inputs.break_on }} but an SSH public key has not been provided"
-          exit 1
-        if: ${{ inputs.break_on != 'never' && inputs.ssh_key == '' }}
-
-      - name: Install Package
-        uses: ConorMacBride/install-package@main
+      - name: Create some files
+        run: |
+          mkdir -p logs/dir logs/colon:dir 'logs/angle<dir' logs/colon:dir/colon:dir2
+          touch logs/{file,colon:file}
+          touch logs/dir/{file,colon:file}
+          touch logs/colon:dir/{file,colon:file}
+          touch logs/'angle<dir'/{file,colon:file}
+          touch logs/colon:dir/colon:dir2/{file,colon:file}
+
+      # GitHub Actions does not accept filenames with certain characters, and
+      # fails the upload-artifact action if any exist.  The tmux log file
+      # contains a colon, as do previous Tempest results directories.
+      - name: Sanitise artifact filenames
+        # FIXME: 1.1.0
+        uses: stackhpc/stackhpc-openstack-gh-workflows/sanitise-artifact-filenames@sanitise-artifact-filenames
         with:
-          apt: git unzip nodejs python3-pip python3-venv rsync
-
-      # If testing upgrade, checkout previous release, otherwise checkout current branch
-      - name: Checkout ${{ inputs.upgrade && 'previous release' || 'current' }} config
-        uses: actions/checkout@v4
-        with:
-          repository: stackhpc/stackhpc-kayobe-config
-          ref: ${{ inputs.upgrade && inputs.stackhpc_kayobe_config_previous_version || inputs.stackhpc_kayobe_config_version }}
-
-      - name: Checkout terraform-kayobe-multinode
-        uses: actions/checkout@v4
-        with:
-          repository: stackhpc/terraform-kayobe-multinode
-          ref: ${{ inputs.terraform_kayobe_multinode_version }}
-          path: terraform-kayobe-multinode
-
-      - name: Make sure dockerd is running and test Docker
-        run: |
-          docker ps
-
-      - name: Output image tag
-        id: image_tag
-        run: |
-          echo image_tag=$(grep stackhpc_${{ inputs.os_distribution }}_$(sed s/-/_/ <(echo "${{ inputs.os_release }}"))_overcloud_host_image_version: etc/kayobe/pulp-host-image-versions.yml | awk '{print $2}') >> $GITHUB_OUTPUT
-
-      # Use the image override if set, otherwise use overcloud-os_distribution-os_release-tag
-      - name: Output image name
-        id: image_name
-        run: |
-          if [ -z "${{ inputs.multinode_image_override }}" ]; then
-            echo image_name=overcloud-${{ inputs.os_distribution }}-${{ inputs.os_release }}-${{ steps.image_tag.outputs.image_tag }} >> $GITHUB_OUTPUT
-          else
-            echo image_name=${{ inputs.multinode_image_override }} >> $GITHUB_OUTPUT
-          fi
-
-      - name: Install terraform
-        uses: hashicorp/setup-terraform@v2
-        with:
-          terraform_wrapper: false
-
-      - name: Setup Ansible
-        run: |
-          python3 -m venv venv &&
-          source venv/bin/activate &&
-          pip install -U pip &&
-          pip install ansible &&
-          mkdir -p ansible/{collections,roles} &&
-          ansible-galaxy role install -r ansible/requirements.yml -p ansible/roles &&
-          ansible-galaxy collection install -r ansible/requirements.yml -p ansible/collections
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Generate a VXLAN VNI
-        id: vxlan_vni
-        run: |
-          # There is an undocumented restriction limiting us to a max VNI of
-          # 100,000.
-          max_vni=100000
-          timestamp=$(date +%s)
-          vni=$(((timestamp % max_vni) + 1))
-          echo vxlan_vni=$vni >> $GITHUB_OUTPUT
-
-      - name: Generate SSH keypair
-        run: ssh-keygen -f id_rsa -N ''
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      # NOTE: In Ansible 2.10 and lower the synchronize module used in the
-      # ansible/fetch-logs.yml playbook does not respect SSH connection
-      # variables. This may result in Permission Denied issues if using an SSH
-      # key that is not in ~/.ssh.
-      - name: Copy SSH keypair to .ssh/
-        run: |
-          install -d ~/.ssh -m 700 &&
-          cp id_rsa* ~/.ssh/
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Generate clouds.yaml
-        run: |
-          cat << EOF > clouds.yaml
-          ${{ secrets.CLOUDS_YAML }}
-          EOF
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Generate terraform.tfvars
-        run: |
-          cat << EOF > terraform.tfvars
-
-          prefix = "${{ env.MULTINODE_NAME }}"
-
-          ansible_control_vm_flavor = "${{ env.MULTINODE_ANSIBLE_CONTROL_VM_FLAVOR }}"
-          ansible_control_vm_name   = "ansible-control"
-          ansible_control_disk_size = 100
-
-          seed_vm_flavor = "${{ env.MULTINODE_SEED_VM_FLAVOR }}"
-          seed_disk_size = 100
-
-          multinode_flavor     = "${{ env.MULTINODE_FLAVOR }}"
-          multinode_image      = "${{ env.MULTINODE_IMAGE }}"
-          multinode_keypair    = "${{ env.MULTINODE_NAME }}"
-          multinode_vm_network = "${{ env.MULTINODE_NETWORK }}"
-          multinode_vm_subnet  = "${{ env.MULTINODE_SUBNET }}"
-          compute_count        = "${{ env.MULTINODE_COMPUTE_COUNT }}"
-          controller_count     = "${{ env.MULTINODE_CONTROLLER_COUNT }}"
-          compute_disk_size    = 100
-          controller_disk_size = 100
-
-          ssh_public_key = "id_rsa.pub"
-          ssh_user       = "${{ env.SSH_USERNAME }}"
-
-          storage_count     = "${{ env.MULTINODE_STORAGE_COUNT }}"
-          storage_flavor    = "${{ env.MULTINODE_STORAGE_FLAVOR }}"
-          storage_disk_size = 100
-
-          deploy_wazuh       = false
-          infra_vm_flavor    = "${{ env.MULTINODE_INFRA_VM_FLAVOR }}"
-          infra_vm_disk_size = 100
-          EOF
-
-          if [[ "${{ inputs.ssh_key }}" != "" ]]; then
-            cat << EOF >> terraform.tfvars
-          add_ansible_control_fip = true
-          ansible_control_fip_pool = "${{ env.MULTINODE_FIP_POOL }}"
-          EOF
-          fi
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        env:
-          MULTINODE_NAME: "${{ inputs.multinode_name }}"
-          MULTINODE_ANSIBLE_CONTROL_VM_FLAVOR: ${{ vars.multinode_ansible_control_vm_flavor }} # en1.xsmall
-          MULTINODE_SEED_VM_FLAVOR: ${{ vars.multinode_seed_vm_flavor }} # en1.xsmall
-          MULTINODE_INFRA_VM_FLAVOR: ${{ vars.multinode_infra_vm_flavor }} # en1.xsmall
-          MULTINODE_FLAVOR: ${{ vars.multinode_flavor }} # en1.large
-          MULTINODE_STORAGE_FLAVOR: ${{ vars.multinode_storage_flavor }} # en1.medium
-          MULTINODE_COMPUTE_COUNT: "${{ inputs.multinode_compute_count }}"
-          MULTINODE_CONTROLLER_COUNT: "${{ inputs.multinode_controller_count }}"
-          MULTINODE_STORAGE_COUNT: "${{ inputs.multinode_storage_count }}"
-          MULTINODE_IMAGE: ${{ steps.image_name.outputs.image_name }}
-          MULTINODE_NETWORK: ${{ vars.multinode_network }}
-          MULTINODE_SUBNET: ${{ vars.multinode_subnet }}
-          MULTINODE_FIP_POOL: ${{ vars.multinode_fip_pool }}
-          SSH_USERNAME: "${{ inputs.ssh_username }}"
-
-      - name: Initialise terraform
-        run: terraform init
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Validate terraform
-        id: tf_validate
-        run: terraform validate
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Configure Ansible
-        run: |
-          echo '${{ env.KAYOBE_VAULT_PASSWORD }}' > vault-pw
-
-          cat << EOF >> ansible/vars/defaults.yml
-          kayobe_config_version: ${{ inputs.upgrade && inputs.stackhpc_kayobe_config_previous_version || inputs.stackhpc_kayobe_config_version }}
-          ssh_key_path: ${{ github.workspace }}/terraform-kayobe-multinode/id_rsa
-          vxlan_vni: ${{ steps.vxlan_vni.outputs.vxlan_vni }}
-          vault_password_path: ${{ github.workspace }}/terraform-kayobe-multinode/vault-pw
-          kayobe_config_custom:
-            - path: zz-multinode.yml
-              block: |
-                os_distribution: ${{ env.OS_DISTRIBUTION }}
-                os_release: "${{ env.OS_RELEASE }}"
-                kolla_enable_ovn: ${{ env.ENABLE_OVN }}
-          EOF
-
-          if [[ "${{ env.SSH_KEY }}" != "" ]]; then
-            cat << EOF >> ansible/vars/defaults.yml
-          extra_ssh_public_keys:
-            - "${{ env.SSH_KEY }}"
-          EOF
-          fi
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        env:
-          ENABLE_OVN: ${{ inputs.neutron_plugin == 'ovn' }}
-          OS_DISTRIBUTION: ${{ inputs.os_distribution }}
-          OS_RELEASE: ${{ inputs.os_release }}
-          SSH_KEY: ${{ inputs.ssh_key }}
-
-      - name: Terraform Plan
-        run: terraform plan -input=false
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        env:
-          OS_CLOUD: ${{ vars.OS_CLOUD }}
-          OS_APPLICATION_CREDENTIAL_ID: ${{ secrets.OS_APPLICATION_CREDENTIAL_ID }}
-          OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.OS_APPLICATION_CREDENTIAL_SECRET }}
-
-      - name: Terraform Apply
-        run: |
-          for attempt in $(seq 3); do
-              if terraform apply -auto-approve -input=false; then
-                  echo "Created infrastructure on attempt $attempt"
-                  exit 0
-              fi
-              echo "Failed to create infrastructure on attempt $attempt"
-              sleep 60
-          done
-          echo "Failed to create infrastructure after $attempt attempts"
-          exit 1
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        env:
-          OS_CLOUD: ${{ vars.OS_CLOUD }}
-          OS_APPLICATION_CREDENTIAL_ID: ${{ secrets.OS_APPLICATION_CREDENTIAL_ID }}
-          OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.OS_APPLICATION_CREDENTIAL_SECRET }}
-
-      - name: Configure Ansible control host
-        id: config_ach
-        run: |
-          source venv/bin/activate &&
-          ansible-playbook -v -i ansible/inventory.yml ansible/configure-hosts.yml
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Deploy OpenStack
-        run: |
-          source venv/bin/activate &&
-          ansible-playbook -v -i ansible/inventory.yml ansible/deploy-openstack.yml
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-
-      - name: Upgrade Ansible control host
-        run: |
-          source venv/bin/activate &&
-          ansible-playbook -v -i ansible/inventory.yml ansible/deploy-openstack-config.yml -e upgrade=true -e kayobe_config_version=${{ inputs.stackhpc_kayobe_config_version }}
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        if: inputs.upgrade
-
-      - name: Upgrade OpenStack
-        run: |
-          source venv/bin/activate &&
-          ansible-playbook -v -i ansible/inventory.yml ansible/deploy-openstack.yml -e multinode_command=upgrade_overcloud
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        if: inputs.upgrade
-
-      - name: Run Tempest tests
-        run: |
-          source venv/bin/activate &&
-          ansible-playbook -v -i ansible/inventory.yml ansible/deploy-openstack.yml -e multinode_command=run_tempest
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        if: inputs.upgrade
-
-      - name: Download deployment logs
-        run: |
-          mkdir -p ${{ github.workspace }}/logs &&
-          source venv/bin/activate &&
-          ansible-playbook -v -i ansible/inventory.yml ansible/fetch-logs.yml -e fetch_logs_dest=${{ github.workspace }}/logs
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        if: ${{ always() && steps.config_ach.outcome == 'success' }}
-
-      # NOTE: The tmux log rename is due to GitHub Actions not accepting files with a colon as artifacts.
-      - name: Fix up deployment log filename
-        run: |
-          if [[ -f ${{ github.workspace }}/logs/tmux.kayobe:0.log ]]; then
-            mv ${{ github.workspace }}/logs/tmux.kayobe:0.log ${{ github.workspace }}/logs/tmux.kayobe.log
-          fi
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        if: ${{ always() && steps.config_ach.outcome == 'success' }}
+          path: |
+            ${{ github.workspace }}/logs/
+        #if: ${{ always() && steps.config_ach.outcome == 'success' }}
 
       - name: Upload test result artifacts
         id: upload-results
@@ -372,68 +122,3 @@ jobs:
           name: test-results-multinode-${{ inputs.os_distribution }}-${{ inputs.os_release }}-${{ inputs.neutron_plugin }}${{ inputs.upgrade && '-upgrade' || '' }}
           path: |
             ${{ github.workspace }}/logs/
-        if: ${{ always() && steps.config_ach.outcome == 'success' }}
-
-      - name: Send message to Slack via Workflow Builder
-        uses: slackapi/slack-github-action@v1.26.0
-        with:
-          payload: |
-            {
-              "channel-id": "${{ env.SLACK_CHANNEL_ID }}",
-              "inputs": "${{ env.INPUTS }}",
-              "message": "${{ env.MESSAGE }}",
-              "results-url": "${{ env.RESULTS_URL }}",
-              "workflow-url": "${{ env.WORKFLOW_URL }}"
-            }
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-          # #release-train-alerts
-          SLACK_CHANNEL_ID: C03B28HRP53
-          INPUTS: >-
-            name: ${{ inputs.multinode_name }}\n
-            controllers: ${{ inputs.multinode_controller_count }}\n
-            computes: ${{ inputs.multinode_compute_count }}\n
-            storage: ${{ inputs.multinode_storage_count }}\n
-            os_distribution: ${{ inputs.os_distribution }}\n
-            os_release: ${{ inputs.os_release }}\n
-            ssh_username: ${{ inputs.ssh_username }}\n
-            neutron_plugin: ${{ inputs.neutron_plugin }}\n
-            stackhpc_kayobe_config_version: ${{ inputs.stackhpc_kayobe_config_version }}\n
-            stackhpc_kayobe_config_previous_version: ${{ inputs.stackhpc_kayobe_config_previous_version }}\n
-            terraform_kayobe_multinode_version: ${{ inputs.terraform_kayobe_multinode_version }}\n
-            upgrade: ${{ inputs.upgrade }}\n
-          MESSAGE: "Multinode workflow failed :sob:"
-          RESULTS_URL: "${{ steps.upload-results.outputs.artifact-url || 'N/A' }}"
-          WORKFLOW_URL: "${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
-        if: ${{ failure() && inputs.enable_slack_alert }}
-
-      - name: Break on failure
-        run: |
-          sleep ${{ inputs.break_duration }}m
-        if: ${{ failure() && steps.config_ach.outcome == 'success' && contains(fromJSON('["failure", "always"]'), inputs.break_on) }}
-
-      - name: Break on success
-        run: |
-          sleep ${{ inputs.break_duration }}m
-        if: ${{ steps.config_ach.outcome == 'success' && contains(fromJSON('["success", "always"]'), inputs.break_on) }}
-
-      - name: Destroy
-        run: |
-          for attempt in $(seq 5); do
-              if terraform destroy -auto-approve -input=false -lock-timeout=200s; then
-                  echo "Destroyed infrastructure on attempt $attempt"
-                  exit 0
-              fi
-              echo "Failed to destroy infrastructure on attempt $attempt"
-              sleep 120
-          done
-          echo "Failed to destroy infrastructure after $attempt attempts"
-          echo "Forcefully destroying infrastructure"
-          terraform destroy -auto-approve -input=false -lock=false
-          exit 1
-        working-directory: ${{ github.workspace }}/terraform-kayobe-multinode
-        env:
-          OS_CLOUD: ${{ vars.OS_CLOUD }}
-          OS_APPLICATION_CREDENTIAL_ID: ${{ secrets.OS_APPLICATION_CREDENTIAL_ID }}
-          OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.OS_APPLICATION_CREDENTIAL_SECRET }}
-        if: always() && steps.tf_validate.outcome == 'success'

sanitise-artifact-filenames/action.yml

@@ -11,4 +11,5 @@ runs:
   using: composite
   steps:
     - name: Sanitise filenames for GitHub Actions artifacts
-      run: python3 sanitise-artifact-filenames.py ${{ inputs.path }}
+      shell: bash
+      run: python3 ${{ github.action_path }}/sanitise-artifact-filenames.py ${{ inputs.path }}