@ipfs-shipyard/pinning-service-compliance

pinning-service-compliance

The compliance test suite for IPFS Pinning Service API Spec

Getting started

Run the compliance checker against a service:

npx -p @ipfs-shipyard/pinning-service-compliance -- pinning-service-compliance -s <pinning_service_endpoint> <auth_token>

Development

Set up your environment variables

cp .env-copy .env

Then replace all variables with the appropriate endpoints and tokens

Run the script

npm install
npm run build

node dist/src/index.js -s $API_ENDPOINT $ACCESS_TOKEN
 # or
node dist/src/index.js -s $API_ENDPOINT1 $ACCESS_TOKEN1 -s $API_ENDPOINT2 $ACCESS_TOKEN2

General architecture of the compliance checker

What is a Compliance Check?

A compliance check consists of:

1. An API call
2. A Payload
3. An expected response
4. A summary

Testing a github action

Use https://github.com/nektos/act like so:

act --container-architecture linux/amd64 -W .github/workflows/build-and-publish-reports.yml -v -s PINATA_API_ENDPOINT -s PINATA_API_TOKEN -s WEB3_API_ENDPOINT -s WEB3_API_TOKEN -s ESTUARY_API_ENDPOINT -s ESTUARY_API_TOKEN -s NFT_API_ENDPOINT -s NFT_API_TOKEN -r

Changelog

0.0.2 (2022-04-21)

Bug Fixes

• devcontainer sees pinning-service-client (c7a6dbb)
• don't clobber docs dir (4f460da)
• exit with error code on failure (7f972c8)
• serviceAndToken option doesn't block other scripts (d2e3764)
• setup does not generate joi spec json files (5a7ce1d)

Features

• add CodeQL GH action (664207c)
• add npm bin to devcontainer PATH (365c142)
• add pagination check (in progress) (63b9114)
• Check add+delete pin compliance (300d3ed), closes #7
• check compliance for adding pin (5a4bcf4), closes #5
• Check replacement of pin (bdead5a), closes #8
• compliance check infrastructure (7aa5663)
• default output is more readable (0933690)
• delete all pins (069f7cf), closes #4
• finish pagination compliance check (79df589), closes #6
• finishing up pagination test (1b8a2f7)
• handle rate-limiting in middleware (b7a2c98)
• lplaceholder checks run via listr (bbb1f81)
• output reports to markdown files (a0343c1)
• page publish action uses matrix strategy (e4ad6c8)