{"id":29948363,"url":"https://github.com/up1/workshop-js-testing-202507","last_synced_at":"2026-04-13T13:01:56.369Z","repository":{"id":305920699,"uuid":"1024394499","full_name":"up1/workshop-js-testing-202507","owner":"up1","description":"Full stack testing workshop with JavaScript","archived":false,"fork":false,"pushed_at":"2025-07-25T10:38:56.000Z","size":673,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-03T08:23:05.247Z","etag":null,"topics":["jest","nodejs","pact","postman","rest-api"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/up1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-22T16:19:52.000Z","updated_at":"2025-07-25T10:38:59.000Z","dependencies_parsed_at":"2025-07-22T18:26:56.928Z","dependency_job_id":null,"html_url":"https://github.com/up1/workshop-js-testing-202507","commit_stats":null,"previous_names":["up1/workshop-js-testing-202507"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/up1/workshop-js-testing-202507","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/up1%2Fworkshop-js-testing-202507","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/up1%2Fworkshop-js-testing-202507/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/up1%2Fworkshop-js-testing-202507/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/up1%2Fworkshop-js-testing-202507/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/up1","download_url":"https://codeload.github.com/up1/workshop-js-testing-202507/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/up1%2Fworkshop-js-testing-202507/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31753551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-13T09:16:15.125Z","status":"ssl_error","status_checked_at":"2026-04-13T09:16:05.023Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jest","nodejs","pact","postman","rest-api"],"created_at":"2025-08-03T08:15:18.765Z","updated_at":"2026-04-13T13:01:56.361Z","avatar_url":"https://github.com/up1.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Workshop :: Full stack testing\n\n\n## 1. Provider :: User service\n* REST API\n* API Document with Swagger\n* API testing with Postman\n\n\n### 1.1 Start server\n```\n$cd user_service\n$npm install\n```\nGenerate [Swagger or OpenAPI](https://swagger.io/)\n* swagger_output.json\n\n```\n$npm run swagger-autogen\n```\n\nStart service\n```\n$npm start\n```\n\nSwagger or OpenAPI documentation\n* http://localhost:8081/docs\n\n\n### 1.2 API testing with Postman\n* External testing or Blackbox testing\n\nRun API testing with Postman and [newman](https://www.npmjs.com/package/newman)\n* [newman-reporter-htmlextra](https://www.npmjs.com/package/newman-reporter-htmlextra)\n```\n$npm install -g newman\n\n$cd newman\n$newman run user_service.postman_collection.json\n```\n\n### 1.3 API testing with [Supertest](https://www.npmjs.com/package/supertest) and [Jest](https://jestjs.io/)\n* Internal testing or White box testing\n\n```\n$npm run test:api\n```\nSee coverage report in file\n* `coverage/lcov-report/index.html`\n\n### 1.4 Working with Docker\n```\n$docker compose build user_service\n$docker compose up -d user_service\n$docker compose ps\n```\n\nSwagger or OpenAPI documentation\n* http://localhost:8081/docs\n\n## 2. Consumer :: Consumer A\n* REST API\n* Call API from User service\n\n\n### 2.1 Start server\n```\n$cd consumer_a\n$npm install\n```\n\nStart consumer A\n```\n$npm start\n```\n\nAccess to api\n* http://localhost:8082\n\nWorking with docker\n```\n$docker compose build consumer_a\n$docker compose up -d consumer_a\n$docker compose ps\n```\n\n\n\n### 2.2 API testing with Postman\n* External testing or Blackbox testing\n* Postman collection in folder `./postman`\n\n\n### 2.3 Try by yourself\n* Try to create a Swagger or OpenAPI documentation\n* Add API test with Supertest and Jest (Internal testing)\n* What are problems from testing ?\n\n## 3. Contract Testing\n* Consumer A ==\u003e User Service\n  * List of problems ?\n* Tools\n  * Postman\n  * [Pact](https://docs.pact.io/)\n  * [Pact Broker](https://docs.pact.io/pact_broker)\n\n### 3.1 Shared understanding between consumer and provider\n* API Specification\n* Request and Response\n* Success and failure cases\n* Message confirmation is called `Contract`\n  * HTTP protocol =\u003e HTTP request and response format\n  * Queue messaging =\u003e Message or Event format\n\n### [Contract test](https://pactflow.io/blog/contract-testing-using-json-schemas-and-open-api-part-1/)\n  * Collaboration\n  * Communication\n  * Specification\n  * Evolution\n\n### 3.2 Create Contract file\n* Register\n  * Call user service =\u003e POST /users\n    * Suucess case\n    * Failure case\n* Create test case to generate contract file\n  * `tests/contract_tests/user_service_specs.js`\n* Library :: [PactJS](https://github.com/pact-foundation/pact-js)\n\n```\n$cd consumer_a\n$npm install\n$npm run test:contract\n```\n\nPact's contract file created in folder `./pacts/`\n\n### 3.3 Publish pact's contract file to Pact Broker\n* Shared and monitor status of contracts\n* Centralized system\n\nInstall Pact Broker with Docker \n```\n$docker compose -f docker-compose-pact.yml up -d postgres\n$docker compose -f docker-compose-pact.yml up -d pact_broker\n$docker compose -f docker-compose-pact.yml ps\n```\n\nGo to Pact Broker UI\n* http://localhost:9292\n  * user=pact_workshop\n  * password=pact_workshop\n\nPublish with [Pact CLI](https://github.com/pact-foundation/pact-ruby-standalone/releases)\n```\n$pact-broker publish ./pacts --consumer-app-version=1.0.0 --branch=main --broker-base-url=http://pact-broker-server:9292 --broker-username pact_workshop --broker-password pact_workshop -v\n```\n\nPublish with Docker\n```\n$docker compose -f docker-compose-pact.yml up pact_broker_publish\n```\n\n### 3.4 When provider or User Service change !!\n* Must be check or verify all contracts by yourself\n\nVerify with [Pact CLI](https://github.com/pact-foundation/pact-ruby-standalone/releases)\n```\n$pact-provider-verifier --provider \"User Service\" --provider-base-url http://provider-server:8081 --pact-broker-base-url=http://pact-broker-server:9292 --broker-username pact_workshop --broker-password pact_workshop --wait 10 --publish-verification-results true --provider-app-version 1.0.0 --branch=main --wait 10\n```\n\nVerify with Docker\n```\n$docker compose -f docker-compose-pact.yml up pact_broker_verify\n```\n\n## 4. Try to create more consumers to call User service\n* Let's go !!\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fup1%2Fworkshop-js-testing-202507","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fup1%2Fworkshop-js-testing-202507","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fup1%2Fworkshop-js-testing-202507/lists"}