test-kubo-e2e.yml

name: Test Kubo (e2e)

on:
  workflow_dispatch:
  push:
    branches:
      - main
  pull_request:

jobs:
  test:
    runs-on: 'ubuntu-latest'
    strategy:
      fail-fast: false
      matrix:
        target: ['latest', 'master']
    defaults:
      run:
        shell: bash
    steps:
      - name: Setup Go
        uses: actions/setup-go@v4
        with:
          go-version: 1.20.4
      - uses: actions/checkout@v3
        with:
          path: 'gateway-conformance'
      - name: Extract fixtures
        uses: ./gateway-conformance/.github/actions/extract-fixtures
        with:
          output: fixtures
      - run: go install github.com/ipfs/kubo/cmd/ipfs@${{ matrix.target }}
        shell: bash
        env:
          GOPROXY: direct
      - name: Configure Kubo Gateway
        run: |
          ipfs init;
          source ./gateway-conformance/kubo-config.example.sh "$(pwd)/fixtures"
          echo "IPFS_NS_MAP=${IPFS_NS_MAP}" >> $GITHUB_ENV
        # note: the IPFS_NS_MAP set above will be passed the daemon
      - uses: ipfs/start-ipfs-daemon-action@v1
        with:
          args: '--offline'
          wait-for-addrs: false
      - name: Provision Kubo Gateway
        run: |
          # Import car files
          cars=$(find ./fixtures -name '*.car')
          for car in $cars
          do
              ipfs dag import --pin-roots=false --stats "$car"
          done

          # Import ipns records
          records=$(find ./fixtures -name '*.ipns-record')
          for record in $records
          do
              key=$(basename -s .ipns-record "$record" | cut -d'_' -f1)
              ipfs routing put --allow-offline "/ipns/$key" "$record"
          done
      - name: Run the tests
        uses: ./gateway-conformance/.github/actions/test
        with:
          gateway-url: http://127.0.0.1:8080
          subdomain-url: http://example.com
          json: output.json
          xml: output.xml
          html: output.html
          markdown: output.md
          accept-test-failure: true
      - name: Set summary
        if: (failure() || success()) && github.event.pull_request
        run: cat ./output.md >> $GITHUB_STEP_SUMMARY
      - name: Prepare Comment
        if: (failure() || success()) && github.event.pull_request
        env:
          TARGET: ${{ matrix.target }}
        run: |
          echo "Results against Kubo ${{ matrix.target }}:" > comment.md

          # Strip everything after the results table
          cat output.md | sed '/Failures\/Errors/,$d' >> comment.md

          cat >> comment.md <<EOF
            Check the action's summary for the full results.
          EOF
      - name: Find latest comment
        uses: peter-evans/find-comment@a54c31d7fa095754bfef525c0c8e5e5674c4b4b1 # v2.4.0
        id: find-comment
        with:
          issue-number: ${{ github.event.pull_request.number }}
          body-includes: "Results against Kubo ${{ matrix.target }}"
      - name: Create comment
        uses: peter-evans/create-or-update-comment@c6c9a1a66007646a28c153e2a8580a5bad27bcfa # v3.0.2
        with:
          issue-number: ${{ github.event.pull_request.number }}
          comment-id: ${{ steps.find-comment.outputs.comment-id }}
          edit-mode: replace
          body-path: comment.md
      - name: Upload one-page HTML report
        if: (failure() || success())
        uses: actions/upload-artifact@v3
        with:
          name: conformance-${{ matrix.target }}.html
          path: ./output.html