Release v0.9.0 (#206) #581
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Gateway Conformance | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| paths-ignore: | |
| - '**/*.md' | |
| env: | |
| GATEWAY_CONFORMANCE_TEST: true # rainbow preset for conformance testing | |
| KUBO_VER: 'v0.30.0' # kubo daemon used as no-libp2p-remote-* backend | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| test: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| backend: ["libp2p-bitswap", "remote-block-gw", "remote-car-gw"] | |
| steps: | |
| # 1. Start the Kubo gateway | |
| - name: Install Kubo | |
| uses: ipfs/download-ipfs-distribution-action@v1 | |
| with: | |
| name: kubo | |
| version: "${{ env.KUBO_VER }}" | |
| - name: Setup kubo config | |
| run: | | |
| ipfs init --profile=test | |
| ipfs config Addresses.Gateway "/ip4/127.0.0.1/tcp/8080" | |
| ipfs config Addresses.API "/ip4/127.0.0.1/tcp/5001" | |
| ipfs config --json Gateway.ExposeRoutingAPI true | |
| ipfs config Routing.Type "autoclient" | |
| # 2. Download the gateway-conformance fixtures | |
| - name: Download gateway-conformance fixtures | |
| uses: ipfs/gateway-conformance/.github/actions/[email protected] | |
| with: | |
| output: fixtures | |
| # 3. Populate the Kubo node 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 "/ipns/$key" "$record" | |
| done | |
| # Import dnslink records | |
| # the IPFS_NS_MAP env will be used by the daemon | |
| echo "IPFS_NS_MAP=$(cat ./fixtures/dnslinks.IPFS_NS_MAP)" >> $GITHUB_ENV | |
| - name: Start Kubo gateway | |
| uses: ipfs/start-ipfs-daemon-action@v1 | |
| # 4. Build rainbow | |
| - name: Setup Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: 1.23.x | |
| - name: Checkout rainbow | |
| uses: actions/checkout@v4 | |
| with: | |
| path: rainbow | |
| - name: Build rainbow | |
| run: go build | |
| working-directory: rainbow | |
| # 5. Start rainbow variant | |
| - name: Start rainbow (libp2p and bitswap) | |
| if: ${{ matrix.backend == 'libp2p-bitswap' }} | |
| env: | |
| RAINBOW_DHT_ROUTING: off | |
| RAINBOW_HTTP_ROUTERS: http://127.0.0.1:8080 | |
| run: | | |
| # set up peering with kubo to ensure fixtures can be found fast | |
| kuboNodeMultiaddr=$(ipfs --api=/ip4/127.0.0.1/tcp/5001 swarm addrs local --id | head -n 1) | |
| ./rainbow --peering=$kuboNodeMultiaddr & | |
| working-directory: rainbow | |
| # 5. Start rainbow variant | |
| - name: Start rainbow (no libp2p, remote block gateway) | |
| if: ${{ matrix.backend == 'remote-block-gw' }} | |
| env: | |
| RAINBOW_REMOTE_BACKENDS: http://127.0.0.1:8080 | |
| RAINBOW_REMOTE_BACKENDS_MODE: block | |
| RAINBOW_REMOTE_BACKENDS_IPNS: true | |
| RAINBOW_LIBP2P: false | |
| RAINBOW_BITSWAP: false | |
| RAINBOW_DHT_ROUTING: off | |
| RAINBOW_HTTP_ROUTERS: http://127.0.0.1:8080 | |
| run: | | |
| ./rainbow & | |
| working-directory: rainbow | |
| # | |
| # 5. Start rainbow variant | |
| - name: Start rainbow (no libp2p, remote car gateway) | |
| if: ${{ matrix.backend == 'remote-car-gw' }} | |
| env: | |
| RAINBOW_REMOTE_BACKENDS: http://127.0.0.1:8080 | |
| RAINBOW_REMOTE_BACKENDS_MODE: car | |
| RAINBOW_REMOTE_BACKENDS_IPNS: true | |
| RAINBOW_LIBP2P: false | |
| RAINBOW_BITSWAP: false | |
| RAINBOW_DHT_ROUTING: off | |
| RAINBOW_HTTP_ROUTERS: http://127.0.0.1:8080 | |
| run: | | |
| ./rainbow & | |
| working-directory: rainbow | |
| # 6. Run the gateway-conformance tests | |
| - name: Run gateway-conformance tests | |
| uses: ipfs/gateway-conformance/.github/actions/[email protected] | |
| with: | |
| gateway-url: http://127.0.0.1:8090 | |
| subdomain-url: http://example.com:8090 | |
| 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: rainbow does not guarantee local cache, we will adjust upstream test (which was Kubo-specific) | |
| # for now disabling these test cases | |
| args: -skip 'TestGatewayCache/.*_with_only-if-cached_succeeds_when_in_local_datastore' | |
| json: output.json | |
| xml: output.xml | |
| html: output.html | |
| markdown: output.md | |
| # 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@v4 | |
| with: | |
| name: ${{ matrix.backend }}_gateway-conformance.html | |
| path: output.html | |
| - name: Upload JSON report | |
| if: failure() || success() | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{ matrix.backend }}_gateway-conformance.json | |
| path: output.json |