@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:

Disclaimer: It is recommended to use an auth_token separate from your production/live services. The compliance checks will do their best not to corrupt any existing pins you have, but consistent tests without consistent data is challenging.

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

Development

Run the script

npm ci
npm run build

npm start -- -s $API_ENDPOINT $ACCESS_TOKEN
 # or multiple endpoints
npm start -- -s $API_ENDPOINT1 $ACCESS_TOKEN1 -s $API_ENDPOINT2 $ACCESS_TOKEN2

Debugging

To debug problems, you should use the -d flag, and the dev-start script:

npm run dev-start -- -s $API_ENDPOINT $ACCESS_TOKEN

FAQ

What is a Compliance Check?

A compliance check consists of:

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

How to avoid typing secrets by hand?

To avoid setting secrets by hand:

cp .env-copy .env

Then replace all variables with the appropriate endpoints and tokens

Changelog

1.1.2 (2022-08-18)

Trivial Changes

• deps-dev: bump aegir from 37.3.0 to 37.5.1 (#169) (0e40dc2)
• deps-dev: bump ipfs-core-types from 0.11.0 to 0.11.1 (#133) (b3edb0e)
• deps-dev: bump typescript from 4.7.3 to 4.7.4 (#122) (f01bf0a)
• deps: bump ipfs-core from 0.15.2 to 0.15.4 (#136) (59bbcb0)
• deps: bump ipfs-http-client from 57.0.1 to 57.0.3 (#137) (bf56cdd)
• deps: bump multiformats from 9.6.5 to 9.7.1 (#156) (6469dc7)
• deps: bump p-queue from 7.2.0 to 7.3.0 (#175) (3b2939c)
• deps: bump winston from 3.7.2 to 3.8.1 (#147) (ba4da8a)