Platform-specific grouping of tests for `npm test`

[CMCDragonkai]

Specification

It would be ideal that upon running npm test or npm run test that it would execute all general tests, and then detect which platform we are on, and run platform-specific tests.

This would require the ability to "tag" certain tests to only be performed for platform specific group. Tagging would allow us to set the os.platform(), os.arch() and other arbitrary tags to be required.

Seems like there are 3 general solutions:

1. Using jest-group-runner - this relies on comment annotations, and it seems to be file-specific
2. Using separate directories and testing for platform requirements in a the shell - this is complicated by the fact that windows doesn't have the same shell
3. Using conditional test functions - this requires creating some conditional utility functions, and this becomes specific a single test function, perhaps conditional describe can also be used

Additional context

• https://stackoverflow.com/questions/50171932/run-jest-test-suites-in-groups

Tasks

1. ...
2. ...
3. ...

[CMCDragonkai]

Any sort of npm test load balancing will be affected by this too. So ideally nominal testing should be preferred, but due to the startup overhead of mac and windows, load balancing will be necessary for PK. It appears it is possible with a custom jest scheduler.

[CMCDragonkai]

@emmacasolin relevant for the NAT testing in PK.

[CMCDragonkai]

The most cross-platform way to do this is conditional test or describe. Where it checks the os.platform() before running the tests.

But I wonder what happens if a test file doesn't have any tests at all (because the condition was no for all tests in that file). It would be preferable that jest does not consider this an error.

[CMCDragonkai]

When restarting on MatrixAI/Polykey#357, please investigate this @emmacasolin and spec out the tasks.

[CMCDragonkai]

Here it is @emmacasolin I thought I wrote an issue already.

[CMCDragonkai]

This was superseded by MatrixAI/Polykey#380, and it was in fact done using describeIf and testIf, that is conditional testing. However these 2 utilities are not in TS-demo-lib. TS-demo-lib doesn't actually need it atm.

We are not using any sort of group runner atm. If we do need to in the future, prefer using directories instead. It's just more stable and involves less infrastructure. Any selection of directories should be done through a scripts/somescript.js that is executed through an npm script.