Creates Test Plan for Running Integration Tests on Server API Endpoints #1493

agosmou · 2023-10-26T22:22:41Z

Fixes #1400

Overview of Added Features

Integration Testing Plan, i.e. the Environment used for testing the TDM Server
CI for Testing
Accounts Endpoints Tests

What changes did you make?

Added Test Plan for use in running integration tests on the TDM Server:
- Added 'Jest' to run tests
- Implemented node library 'testcontainers' to create a docker container for an instance of a test MS SQL Server database
- Added the integration tests to the TDM CI pipeline so they run on every pull request to the 'develop' branch
Added integration tests for the 'accounts' endpoints that test the functional requirements of the user managemnet workflow as well as edge cases
Updated the Test Wiki to include documentation on the new Test Plan and instructions to add future tests

Why did you make the changes (we will use this info to test)?

Reliable Testing: Integrated 'Jest' and 'testcontainers' to add robust testing reflecting our production setup
Enhanced CI/CD: Integration tests in TDM CI pipeline prevent PRs that merge breaking changes
User Workflow Quality: Added tests for 'accounts' endpoints to ensure user management workflow meets functional requirements and handles edge cases.

References

Jest

Jest Documentation
Setting up files to be used before each test
Jest Config

Supertest

Supertest Documentation

Testcontainers

Testcontainers Documentation
Testcontainers for node
I had to handroll our own implementation, but there is a formal module coming out soon that I used as reference

SendGrid (Mocked for Testing)

Sendgrid API docs
Sendgrid mocked using jest

Flyway Migrations

Source Code observed to use in flyway config to disable reports when testing

Suggested Order for File Review (root directory would be server)

Environment Variables
0. .example.env

Setting up a containerized db with application code
1a. utils/mssql-container-setup.js
1b. db/flyway-config.js
1c. global-setup/global-setup.js
1d. global-setup/global-teardown.js

Server refactors and setup for use as an instance on tests
2a. server.js
2b. utils/server-setup.js
2c. local-setup/setup-after-env.js

Testing configs and script
3a. jest.config.js
3b. package.json

Accounts tests
4. __tests__/account.test.js

Setting up github actions
5. .github/workflows/tdm-server-tests.yml

Discovery Notes

WebAPI endpoints Testing Feature Requirements:

Maintainable
Scalable
Reliable

Considered Implementations:

Postman/Hoppscotch
- Pros: It seemed like a good option to use a GUI for testing. Postman's user management and pricing is uncertain as well as it does not allow for more than 3 people to share a testing repo, but Hoppscotch does so I was exploring Hoppscotch as this is a project worked on by many devs and eventually LADOT. Hoppscotch also allows you to put your test suites into a json file that can be run using their CLI.
- Cons: Hoppscotch still had some development left to do to include features like taking variables from one test, e.g. token, and applying them to another test. This was limiting.
Bash script with Curl commands
- I tried this but it became a massive file that was difficult to update and interpret
Jest with a local db spun up by user
- This seemed like a good option because It would work for testing in the CI pipeline as well, but relying on the dev to spin up their own container and db added a layer of friction when trying to incentivize testing. Additionally our use of stored procedures needed to be considered for the testing db platform.
Jest with Testcontainers library so db is integrated
- This felt the most maintainable, reliable, and scalable - Everything is integrated into application code and dependencies are stable. It is build to easily add further tests without having to juggle other considerations.

…into 1400-ag-accounts-api-tests

… tests

…into 1400-ag-accounts-api-tests

agosmou

Added comments to files to explain

agosmou · 2023-10-26T22:41:13Z

APItests.json

OBSOLETE - This was a script to test using Hoppscotch

agosmou · 2023-10-26T22:42:05Z

server/.env-example

renamed file

agosmou · 2023-10-26T22:43:39Z

server/.example.env

+# APPLICATIONINSIGHTS_CONNECTION_STRING=
+
+###############################################################
+##      Testing (Comment out ALL the above variables)        ##


renamed file with better naming convention and updated the .env file layout so that users can test locally by simply commenting out the development variables and un-commenting the testing variables.

I will have to add an updated .env file to the google drive upon accepted changes

agosmou · 2023-10-26T22:44:37Z

server/__tests__/account.test.js

+  await teardownServer();
+});
+
+beforeEach(() => {


This mocks the sendgrid function call on the sendgrid client to avoid costs incurred from calling 3rd party API's

Documentation used to produce this sendgrid mock:

I had to mock the sendgrid API because they dont have a test key. If I used their SandboxMode, it would only validate the data structure of the request so I wouldnt be able to intercept the request and grab the token for the email confirmation on the integration tests

References

Sendgrid API docs

This is where the 202 response code comes from

Sendgrid mocked using jest

agosmou · 2023-10-26T22:47:14Z

server/__tests__/account.test.js

+  teardownServer
+} = require("../_jest-setup_/utils/server-setup");
+
+let server;


the supertest library allows you to pass a real server instance. I chose to do this to mimic production more closely.

This is an optional pattern and you are able to avoid instantiating the server - supertest will use an in-memory representation. Simply remove the setupServer(); function call.

agosmou · 2023-10-26T22:57:10Z

server/db/flyway-config.js

@@ -28,7 +28,8 @@ module.exports = function () {
      sqlMigrationSuffixes: ".sql",
      baselineOnMigrate: true,
      baselineVersion: "0002", // Do not change this baseline version number
-      baselineDescription: "setup_db_baseline_data_as_of_07012020"
+      baselineDescription: "setup_db_baseline_data_as_of_07012020",
+      reportEnabled: process.env.TEST_ENV ? false : true


Running the flyway migrations creates a multi-thousand line report - this code prevents this from happening during testing but preserves this function during development and production environments

agosmou · 2023-10-26T22:57:43Z

server/jest.config.js

configurations for jest

agosmou · 2023-10-26T22:58:47Z

server/package.json

This adds supertest, jest, and testcontainers. These are popular libraries that are well maintained with stable dependencies.

agosmou · 2023-10-26T22:59:57Z

server/package.json

@@ -9,7 +9,7 @@
  "main": "server.js",
  "scripts": {
    "precommit": "lint-staged",
-    "test": "jest --passWithNoTests",
+    "test": "jest --runInBand --passWithNoTests --forceExit",


"--runInBand" is added to run the test files sequentially rather than in parallel because they are sharing a database instance.

"--forceExit" is a measure to force jest to exit in the case there is a server that is hanging up from being improperly closed.

agosmou · 2023-10-26T23:01:28Z

server/server.js

@@ -75,6 +75,8 @@ app.use((err, req, res) => {

 app.use(errorHandler);

-app.listen(port, () => console.log(`Server running on port ${port}`));
+if (process.env.TEST_ENV !== "true") {


Added a minor conditional to be able to instantiate the server, i.e. set them up and tear them down. Development environments and production environments will have a falsy conditional; thus, be unaffected.

this was a necessary change to be able run multiple test suites with a real server.

agosmou · 2023-10-26T23:14:17Z

I tried to keep commits atomic, but there was A LOT of refactoring; hence, the large amount of commits. We can squash and merge to condense this.

agosmou · 2023-10-26T23:30:23Z

Wiki is linked on comment above. Do review for further info and provide feedback as this is the "source of truth" to keep the test plan readable, maintainable, and scalable.

agosmou · 2023-10-26T23:39:30Z

@entrotech
I shared the .env for this file on the shared drive so you can use it in your local environment when reviewing.

alternatively you can grab the env variables from the github actions file - just make sure all other variables in your .env are commented out!

agosmou · 2023-10-30T16:42:44Z

@entrotech

The below should facilitate interpretation of code

Suggested Order for File Review (root directory would be server):

Environment Variables
0. .example.env

Setting up a containerized db with application code
1a. utils/mssql-container-setup.js
1b. db/flyway-config.js
1c. global-setup/global-setup.js
1d. global-setup/global-teardown.js

Server refactors and setup for use as an instance on tests
2a. server.js
2b. utils/server-setup.js
2c. local-setup/setup-after-env.js

Testing configs and script
3a. jest.config.js
3b. package.json

Accounts tests
4. __tests__/account.test.js

Setting up github actions
5. .github/workflows/tdm-server-tests.yml

agosmou added 30 commits September 19, 2023 01:03

adds tests for account endpoints

6c8bd33

Merge branch 'develop' of https://github.com/hackforla/tdm-calculator …

9a38856

…into 1400-ag-accounts-api-tests

pushing WIP branch - not working yet

a2c8ee7

fixes testcontainers environment and is now functional

66f1dc6

creates setup configuration for test database in container

5b8efa6

adds mock for sendgrid and organizes .env

34538d8

Merge branch 'develop' of https://github.com/hackforla/tdm-calculator …

a9ef7b4

…into 1400-ag-accounts-api-tests

adds api endpoint blackbox tests - logout test is not passing yet

9f5e596

fixes logout test and adds comment

e0ff2a8

adds functionality to start and close server for each test suite

1a3fd93

working test suite

d0dc0b7

adds notes to readME and comments in jest setup

4435b4f

organizes jest config in codebase

7922153

removes bloat comments in code

2cbd941

renames jest setup directory and files

57d551f

refactors jest test environment setup

60b6425

refactors to restore original code with standard env variables

07abca5

edits the example env file

f74e5bf

refactors to provide server setup and teardown to use on api endpoint…

0b02b6b

… tests

refactors host port on container setup to use environment variable

347f539

adds github action to include tests on CI pipeline

fb3fcc2

adjust test file naming conventions and minor edits to setup files

f751ff3

organizes files into folders for maintainability

d4b9bef

refactors for maintainability and readability

2a82ee5

refactors tests

e14cf90

minor refactors and linting

3407be0

linting

9febb94

resolving merge conflict

d45e2e4

Merge branch 'develop' of https://github.com/hackforla/tdm-calculator …

d315c4e

…into 1400-ag-accounts-api-tests

resolves merge conflict

0b39c02

fixes lerna issues on branch

0425165

agosmou self-assigned this Oct 26, 2023

agosmou added this to the 02 - Security milestone Oct 26, 2023

agosmou commented Oct 26, 2023

View reviewed changes

agosmou marked this pull request as ready for review October 26, 2023 23:31

agosmou requested a review from entrotech October 26, 2023 23:31

agosmou mentioned this pull request Oct 26, 2023

Adds end-to-end feature for archiving and deleting user accounts #1449

Merged

entrotech merged commit a77887d into develop Nov 2, 2023
1 check passed

agosmou deleted the 1400-ag-accounts-api-tests branch November 11, 2023 21:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Creates Test Plan for Running Integration Tests on Server API Endpoints #1493

Creates Test Plan for Running Integration Tests on Server API Endpoints #1493

agosmou commented Oct 26, 2023 •

edited

Loading

agosmou left a comment

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou Oct 26, 2023

agosmou commented Oct 26, 2023

agosmou commented Oct 26, 2023 •

edited

Loading

agosmou commented Oct 26, 2023

agosmou commented Oct 30, 2023

Creates Test Plan for Running Integration Tests on Server API Endpoints #1493

Creates Test Plan for Running Integration Tests on Server API Endpoints #1493

Conversation

agosmou commented Oct 26, 2023 • edited Loading

Overview of Added Features

What changes did you make?

Why did you make the changes (we will use this info to test)?

References

Suggested Order for File Review (root directory would be server)

Discovery Notes

Considered Implementations:

agosmou left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agosmou commented Oct 26, 2023

agosmou commented Oct 26, 2023 • edited Loading

agosmou commented Oct 26, 2023

agosmou commented Oct 30, 2023

agosmou commented Oct 26, 2023 •

edited

Loading

agosmou commented Oct 26, 2023 •

edited

Loading