Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Thunderclient Web API test request scripts #1373

Closed
5 tasks
entrotech opened this issue May 21, 2023 · 2 comments
Closed
5 tasks

Implement Thunderclient Web API test request scripts #1373

entrotech opened this issue May 21, 2023 · 2 comments
Labels
dev: tests level: medium priority: SHOULD HAVE role: back-end Node/Express Development Task size: 1pt Can be done in 4-6 hours system update Release Note: Shows as System Update

Comments

@entrotech
Copy link
Member

entrotech commented May 21, 2023

Overview

We want to be able to quickly and easily test that all the web API server endpoints are working properly. A good way to do this is to implement a test client application that exercises the endpoints. Thunderclient is a VSCode extension that allows you to easily script Web API requests and then run them and check the responses to verify that the endpoints are returning reasonable results.

Action Items

# User Test Accounts for Shared AWS Development Environment
# (Used by ThunderClient for API Endpoint testing)
USERTEST_EMAIL=usertest@dispostable.com
USERTEST_PASSWORD=LosAngelesDOT1!
ROLESTEST_EMAIL=rolestest@dispostable.com
ROLESTEST_PASSWORD=LosAngelesDOT1!
ADMINTEST_EMAIL=admintest@dispostable.com
ADMINTEST_PASSWORD=LosAngelesDOT1!
  • Implement a Thunderclient test that performs a login with each of the three test accounts
  • Implement a few more thunderclient tests that use one of these login requests, then test a protected endpoint and verify the results.
  • Systematically go through all the endpoints and create test requests for them. It might be good to exercise some of the endpoints with multiple requests including some with invalid requests to verify that the appropriate error responses occur. E.g., attempting to access a secured endpoint without first logging in should probably result in an HTTP 40* error code.

Resources/Instructions

@entrotech entrotech added level: medium dev: tests system update Release Note: Shows as System Update role: back-end Node/Express Development Task priority: SHOULD HAVE size: 1pt Can be done in 4-6 hours labels May 21, 2023
@entrotech
Copy link
Member Author

The Thunderclient extension is no longer free - the GitSync feature costs $4/developer/month. I did a search and could not find any other Web API test tools that were free and allowed you to keep the test scripts in the GitHub repo, so I'm closing this issue as infeasible.

@ExperimentsInHonesty ExperimentsInHonesty closed this as not planned Won't fix, can't repro, duplicate, stale Jul 8, 2023
@ExperimentsInHonesty ExperimentsInHonesty added this to New Issue Approval in Product Management via automation Jul 8, 2023
@ExperimentsInHonesty
Copy link
Member

I have added this decision to the wiki decision records
https://github.com/hackforla/tdm-calculator/wiki/DR:-Implement-Thunderclient-Web-API-test-request-scripts

@Biuwa Biuwa moved this from New Issue Approval to On Dev - not yet pushed to Prod in Product Management Jul 12, 2023
@Biuwa Biuwa moved this from On Dev - not yet pushed to Prod to Released in Product Management Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev: tests level: medium priority: SHOULD HAVE role: back-end Node/Express Development Task size: 1pt Can be done in 4-6 hours system update Release Note: Shows as System Update
Projects
Product Management
  
Released
Development

No branches or pull requests

2 participants