gateway-conformance.yml

name: Gateway Conformance

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  gateway-conformance:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        car-env: ["GRAPH_BACKEND=false", "GRAPH_BACKEND=true"]
    steps:
      # 1. Start the Kubo gateway
      - name: Setup Go
        uses: actions/setup-go@v3
        with:
          go-version: 1.19.x
      - uses: protocol/cache-go-action@v1

      - name: Install Kubo gateway from source
        #uses: ipfs/download-ipfs-distribution-action@v1
        run: |
          go install github.com/ipfs/kubo/cmd/ipfs@73552dfd9c6f73fdab887c4d2e99cf7e848a3c23
      - name: Start Kubo gateway
        uses: ipfs/start-ipfs-daemon-action@v1

      # 2. Download the gateway-conformance fixtures
      - name: Download gateway-conformance fixtures
        uses: ipfs/gateway-conformance/.github/actions/extract-fixtures@v0.3
        with:
          output: fixtures

      # 3. Populate the Kubo gateway with the gateway-conformance fixtures
      - name: Import fixtures
        run: |
          # Import car files
          find ./fixtures -name '*.car' -exec ipfs dag import --pin-roots=false --offline {} \;

          # 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 --offline "/ipns/$key" "$record"
          done

          # Import dnslink records
          # the IPFS_NS_MAP env will be used by the daemon
          export IPFS_NS_MAP=$(cat "./fixtures/dnslinks.json" | jq -r '.subdomains | to_entries | map("\(.key).example.com:\(.value)") | join(",")')
          export IPFS_NS_MAP="$(cat "./fixtures/dnslinks.json" | jq -r '.domains | to_entries | map("\(.key):\(.value)") | join(",")'),${IPFS_NS_MAP}"
          echo "IPFS_NS_MAP=${IPFS_NS_MAP}" >> $GITHUB_ENV

      # 4. Build the bifrost-gateway
      - name: Checkout bifrost-gateway
        uses: actions/checkout@v3
        with:
          path: bifrost-gateway
      - name: Build bifrost-gateway
        run: go build
        working-directory: bifrost-gateway

      # 5. Start the bifrost-gateway
      - name: Start bifrost-gateway
        env:
          PROXY_GATEWAY_URL: http://127.0.0.1:8080
          KUBO_RPC_URL: http://127.0.0.1:5001
          GATEWAY_CONFORMANCE_TEST: true
        run: |
          # NOTE: we export car-env this way ON PURPOSE, to have full key=value
          # present on PR status instead of just true/false without context
          export ${{ matrix.car-env }}

          # run gw
          ./bifrost-gateway &
        working-directory: bifrost-gateway

      # 6. Run the gateway-conformance tests
      - name: Run gateway-conformance tests
        uses: ipfs/gateway-conformance/.github/actions/test@v0.3
        with:
          gateway-url: http://127.0.0.1:8081
          json: output.json
          xml: output.xml
          html: output.html
          markdown: output.md
          specs: +trustless-gateway,+path-gateway,+subdomain-gateway,+dnslink-gateway,+redirects-file
          # use below to skip specific test if needed
          # args: -skip 'TestFooBr/GET_response_for_something'
          #
          # only-if-cached: bifrost-gateway does not guarantee local cache, we will adjust upstream test (which was Kubo-specific)
          # for now disabling these test cases
          args: -skip 'TestGatewayCache/.*_for_/ipfs/_with_only-if-cached_succeeds_when_in_local_datastore'

      # 7. Upload the results
      - name: Upload MD summary
        if: failure() || success()
        run: cat output.md >> $GITHUB_STEP_SUMMARY
      - name: Upload HTML report
        if: failure() || success()
        uses: actions/upload-artifact@v3
        with:
          name: gateway-conformance.html
          path: output.html
      - name: Upload JSON report
        if: failure() || success()
        uses: actions/upload-artifact@v3
        with:
          name: gateway-conformance.json
          path: output.json