tests/README.md

Table of Contents

• Summary
• How to use
  • Initialize the Client Config
  • Run API-Tester (test http API)
  • Run Playwright (test puter-js API with browser environment)
  • Run Vitest (test puter-js API with node environment)

Summary

End-to-end tests for puter-js and http API.

How to use

Initialize the Client Config

1. Start a backend server:

   npm start
   

2. Copy example-client-config.yaml and edit the auth_token field. (auth_token can be obtained by logging in on the webpage and typing puter.authToken in Developer Tools's console)

   cp ./tests/example-client-config.yaml ./tests/client-config.yaml
   

Run API-Tester (test http API)

node ./tests/api-tester/apitest.js --unit --stop-on-failure

Run Playwright (test puter-js API with browser environment)

cd ./tests/playwright
npm install
npx playwright install --with-deps
npx playwright test

Run Vitest (test puter-js API with node environment)

npm run test:puterjs-api