test-action-build-html.yml

---
name: test - action/build-html
on:
  push:
    branches: [main]
    paths:
      - .test/**
      - .github/workflows/test-action-build-html.yml
      - actions/ansible-docs-build-html/**
  pull_request:
    paths:
      - .test/**
      - .github/workflows/test-action-build-html.yml
      - actions/ansible-docs-build-html/**
  # Run once per week (Tuesday at 04:00 UTC)
  schedule:
    - cron: '0 4 * * 2'

jobs:
  tests:
    name: Simple tests
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1  # v7.0.1
        with:
          persist-credentials: false

      - name: Simple 1 invoke - no copy, no artifact
        id: simple1
        uses: $/actions/ansible-docs-build-html
        with:
          build-script: .test/simple-build/build.sh
          build-html: .test/simple-build/build/html
          artifact-upload: false

      - name: Simple 1 - Download artifacts
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333  # v8.0.2
        id: simple1-artifact
        with:
          path: .artifacts/simple1

      - name: Simple 1 - assert
        shell: python
        env:
          EXPECTED_HASH: ${{ hashFiles('.test/simple-build/src') }}
          OUTPUT_HASH: ${{ steps.simple1.outputs.hash }}
          OUTPUT_BUILD_HTML: ${{ steps.simple1.outputs.build-html }}
          ARTIFACT_HASH: ${{ hashFiles(steps.simple1-artifact.outputs.download-path) }}
        run: |
          import os

          expected_hash = os.environ['EXPECTED_HASH']
          output_hash = os.environ['OUTPUT_HASH']
          output_build_html = os.environ['OUTPUT_BUILD_HTML']
          artifact_hash = os.environ['ARTIFACT_HASH']

          assert output_build_html == '.test/simple-build/build/html'
          assert output_hash == expected_hash
          assert artifact_hash != output_hash

      - name: Simple 2 invoke - with copy, no artifact
        id: simple2
        uses: $/actions/ansible-docs-build-html
        with:
          build-script: .test/simple-build/build.sh
          build-html: .test/simple-build/build/html
          copy-build: .copies/simple2/html
          artifact-upload: false

      - name: Simple 2 - Download artifacts
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333  # v8.0.2
        id: simple2-artifact
        with:
          path: .artifacts/simple2

      - name: Simple 2 - assert
        shell: python
        env:
          expected_hash: ${{ hashFiles('.test/simple-build/src') }}
          output_hash: ${{ steps.simple2.outputs.hash }}
          output_build_html: ${{ steps.simple2.outputs.build-html }}
          artifact_hash: ${{ hashFiles(steps.simple2-artifact.outputs.download-path) }}
          original_build_hash: ${{ hashFiles('.test/simple-build/build/html') }}
        run: |
          import os

          expected_hash = os.environ['expected_hash']
          output_hash = os.environ['output_hash']
          output_build_html = os.environ['output_build_html']
          artifact_hash = os.environ['artifact_hash']
          original_build_hash = os.environ['original_build_hash']

          assert output_build_html == '.copies/simple2/html'
          assert output_hash == expected_hash
          assert output_hash == original_build_hash
          assert artifact_hash != output_hash

      - name: Simple 3 invoke - no copy, with artifact
        id: simple3
        uses: $/actions/ansible-docs-build-html
        with:
          build-script: .test/simple-build/build.sh
          build-html: .test/simple-build/build/html
          artifact-retention-days: 1
          artifact-name: tests-simple3

      - name: Simple 3 - Download artifacts
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333  # v8.0.2
        id: simple3-artifact
        with:
          name: ${{ steps.simple3.outputs.artifact-name }}
          path: .artifacts/simple3

      - name: Simple 3 - assert
        shell: python
        env:
          expected_hash: ${{ hashFiles('.test/simple-build/src') }}
          output_hash: ${{ steps.simple3.outputs.hash }}
          output_build_html: ${{ steps.simple3.outputs.build-html }}
          artifact_hash: ${{ hashFiles(steps.simple3-artifact.outputs.download-path) }}
        run: |
          import os

          expected_hash = os.environ['expected_hash']
          output_hash = os.environ['output_hash']
          output_build_html = os.environ['output_build_html']
          artifact_hash = os.environ['artifact_hash']

          assert output_build_html == '.test/simple-build/build/html'
          assert output_hash == expected_hash
          assert artifact_hash == output_hash

      - name: Simple 3 - bash asserts
        env:
          ARTIFACTS_URL: ${{ steps.simple3.outputs.artifact-url }}
          DOWNLOAD_PATH: ${{ steps.simple3-artifact.outputs.download-path }}
        run: |
          set -eu

          # this URL only goes to the run page, not to an individual artifact
          # so all we're really checking here is that it's a valid URL that's accessible
          wget "${ARTIFACTS_URL}"

          # ensure that the html directory is not present in the downloaded artifact
          test ! -d "${DOWNLOAD_PATH}/html"

      - name: Simple 4 invoke - with copy, with artifact
        id: simple4
        uses: $/actions/ansible-docs-build-html
        with:
          build-script: .test/simple-build/build.sh
          build-html: .test/simple-build/build/html
          copy-build: .copies/simple4/html
          artifact-retention-days: 1
          artifact-name: tests-simple4

      - name: Simple 4 - Download artifacts
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333  # v8.0.2
        id: simple4-artifact
        with:
          name: ${{ steps.simple4.outputs.artifact-name }}
          path: .artifacts/simple4

      - name: Simple 4 - assert
        shell: python
        env:
          expected_hash: ${{ hashFiles('.test/simple-build/src') }}
          output_hash: ${{ steps.simple4.outputs.hash }}
          output_build_html: ${{ steps.simple4.outputs.build-html }}
          artifact_hash: ${{ hashFiles(steps.simple4-artifact.outputs.download-path) }}
          original_build_hash: ${{ hashFiles('.test/simple-build/build/html') }}
        run: |
          import os

          expected_hash = os.environ['expected_hash']
          output_hash = os.environ['output_hash']
          output_build_html = os.environ['output_build_html']
          artifact_hash = os.environ['artifact_hash']
          original_build_hash = os.environ['original_build_hash']

          assert output_build_html == '.copies/simple4/html'
          assert output_hash == expected_hash
          assert output_hash == original_build_hash
          assert artifact_hash == output_hash

      - name: Simple 4 - bash asserts
        env:
          ARTIFACTS_URL: ${{ steps.simple4.outputs.artifact-url }}
          DOWNLOAD_PATH: ${{ steps.simple4-artifact.outputs.download-path }}
        run: |
          set -eu

          # this URL only goes to the run page, not to an individual artifact
          # so all we're really checking here is that it's a valid URL that's accessible
          wget "${ARTIFACTS_URL}"

          # ensure that the html directory is not present in the downloaded artifact
          test ! -d "${DOWNLOAD_PATH}/html"

      - name: Simple 5 invoke - with copy, with artifact, trailing slash in input
        id: simple5
        uses: $/actions/ansible-docs-build-html
        with:
          build-script: .test/simple-build/build.sh
          build-html: .test/simple-build/build/html/
          copy-build: .copies/simple5/html/
          artifact-retention-days: 1
          artifact-name: tests-simple5

      - name: Simple 5 - Download artifacts
        uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333  # v8.0.2
        id: simple5-artifact
        with:
          name: ${{ steps.simple5.outputs.artifact-name }}
          path: .artifacts/simple5

      - name: Simple 5 - assert
        shell: python
        env:
          expected_hash: ${{ hashFiles('.test/simple-build/src') }}
          output_hash: ${{ steps.simple5.outputs.hash }}
          output_build_html: ${{ steps.simple5.outputs.build-html }}
          artifact_hash: ${{ hashFiles(steps.simple5-artifact.outputs.download-path) }}
          original_build_hash: ${{ hashFiles('.test/simple-build/build/html/') }}
        run: |
          import os

          expected_hash = os.environ['expected_hash']
          output_hash = os.environ['output_hash']
          output_build_html = os.environ['output_build_html']
          artifact_hash = os.environ['artifact_hash']
          original_build_hash = os.environ['original_build_hash']

          assert output_build_html == '.copies/simple5/html/'
          assert output_hash == expected_hash
          assert output_hash == original_build_hash
          assert artifact_hash == output_hash

      - name: Simple 5 - bash asserts
        env:
          ARTIFACTS_URL: ${{ steps.simple5.outputs.artifact-url }}
          DOWNLOAD_PATH: ${{ steps.simple5-artifact.outputs.download-path }}
        run: |
          set -eu

          # this URL only goes to the run page, not to an individual artifact
          # so all we're really checking here is that it's a valid URL that's accessible
          wget "${ARTIFACTS_URL}"

          # ensure that the html directory is not present in the downloaded artifact
          test ! -d "${DOWNLOAD_PATH}/html"