Create unit tests for validation

[zachclark-ccpo]

Overview

Using jest to test the business logic of the API endpoints.
Moved all of the validation to utils/validation.ts, each microservice will use these validation fns.
npm test output:

zclark@EDC-H6K8BH2:~/test-kyle-pr/atat-web-api/applications/portfolioDrafts$ npm test

> [email protected] test
> jest --config=jest.config.js

 PASS  test/requestbody.test.ts
  Testing validation of request body
    ✓ should return true because request body is present (2 ms)
    ✓ should return false because request body is empty JSON (1 ms)
    ✓ should return false when body is empty object (1 ms)
    ✓ should return false because request body is an empty String (1 ms)
    ✓ should return false because request body is empty whitespace String
    ✓ should return false because request body is null
    ✓ should return false because request body JSON is invalid (2 ms)
    ✓ should return true because request body JSON is valid
  Validation tests for createPortfolioStep function
    ✓ should map body to portfolioStep object
    ✓ should fail to map body to portfolioStep object due to missing attribute (2 ms)
    ✓ should fail to map body to portfolioStep object because request body is null
  Testing validation of path parameter
    ✓ should return false because path parameter is an empty string (1 ms)
    ✓ should return true because path parameter is a valid string (1 ms)
    ✓ should return false because path parameter is undefined (1 ms)

---------------|---------|----------|---------|---------|-------------------
File           | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
---------------|---------|----------|---------|---------|-------------------
All files      |     100 |      100 |     100 |     100 |                   
 validation.ts |     100 |      100 |     100 |     100 |                   
---------------|---------|----------|---------|---------|-------------------
Test Suites: 1 passed, 1 total
Tests:       14 passed, 14 total
Snapshots:   0 total
Time:        2.934 s, estimated 3 s
Ran all test suites.

TODO

• Ensure all files are being collected with code coverage (Im certain that some of the fns outside of validation.ts).
• Split up tests into smaller files
• Fix lerna errors

[kylelaker-ccpo]

This is may be the wrong use of a type guard. It does accomplish the goals we have and it does in fact assert that the input is a string. But it fails to capture the additional restrictions imposed within the body.

[kylelaker-ccpo]

If this isn't set, we need to totally abort. We can't work with a default value. This would be an unexpected infrastructure issue. We probably want a helper that does something like:

if (!process.env.ATAT_TABLE_NAME) {
  throw new Error("Oh no! The table name isn't set.")
}

of course with a better message and maybe a subclass of Error? But this really is an exceptional case that should never happen and if it does, we need to return a 500 response with a really good log message ASAP.

[sonarcloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
1 Security Hotspot
2 Code Smells

0.0% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint