Skip to content

Conversation

LogicalGuy77
Copy link
Contributor

Description

This PR adds comprehensive testing documentation to the Models Web Application, making it easier for contributors to understand and work with the testing infrastructure.

Changes

New Documentation
TEST.md: Complete guide covering the application's testing strategy

  • Unit testing with Jest
  • Unit testing with Karma/Jasmine (legacy)
  • End-to-End testing with Cypress
  • API mocking strategies
  • Test organization and naming conventions
  • Commands for running tests

Updated Documentation

README.md: Added "Documentation" section with link to the Testing Guide

Signed-off-by: Harshit Nayan <[email protected]>
Copy link
Contributor

@Griffin-Sullivan Griffin-Sullivan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good just a few comments

The Models Web Application employs a multi-layered testing strategy:

- **Unit Tests**: Testing individual components, services, and utility functions in isolation
- **E2E Tests**: Testing complete user workflows from end-to-end with mocked backend APIs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also link to the test you wrote in manifests if you think it's helpful

### Primary Testing Stack

- **[Jest](https://jestjs.io/)** - Fast unit testing framework with excellent TypeScript support
- **[Karma](https://karma-runner.github.io/)** + **[Jasmine](https://jasmine.github.io/)** - Traditional Angular testing setup (legacy)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would mention this is deprecated

- **Reproducibility** - Consistent test data
- **Error testing** - Easy simulation of error scenarios

### Test Coverage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this section. It would likely be forgotten when someone adds or edits the tests and then it's more maintenance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants