Skip to content

Commit

Permalink
Added readme for tests folder
Browse files Browse the repository at this point in the history
  • Loading branch information
droberts-ctrlo committed Oct 26, 2023
1 parent 942edb7 commit 6f629e7
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/frontend/test/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Test folder
This folder contains stubs and/or copies of functionality used within the system. It is felt that (at this time), this is a "necessary" thing for unit testing - this is here because Jest (the JS unit testing framework) uses Babel behind the scenes; the `/src/frontend/lib` directory is ignored by Babel - when this ignore is removed (in order for components to build properly on testing) the JS _does not build_ - as such, the stubs and copies were created with the relevant mapping being put in place within the Jest config.
This will change once unit testing of components (i.e. regression testing) is implemented and the config will be updated as required to use Jest environments. It was felt that at this point, rather than edit files that are integral to the running of the site, copies were the safer option.

0 comments on commit 6f629e7

Please sign in to comment.