test: add unit tests (NASA-AMMOS#44)

- Add initial unit testing framework via Vitest
- Reorganize e2e tests in their own folder
- Reorganize package.json scripts to distinguish between e2e tests and unit tests
- Update testing documentation

Author: camargo

.github/workflows/test.yml

@@ -44,16 +44,24 @@ jobs:
         run: npm ci
       - name: Build (UI)
         run: npm run build
-      - name: Install Playwright Dependencies (Test)
+      - name: Install Playwright Dependencies (Test - e2e)
         run: npx playwright install chromium --with-deps
-      - name: Test
-        run: npm test
-      - name: Upload Results (Test)
+      - name: Test (e2e)
+        run: npm run test:e2e
+      - name: Test (unit)
+        run: npm run test:unit
+      - name: Upload Results (Test - e2e)
         if: always()
         uses: actions/upload-artifact@v3
         with:
           name: 🎭 Playwright Run Results
-          path: test-results
+          path: e2e-test-results
+      - name: Upload Results (Test - unit)
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: ⚡ Vitest Run Results
+          path: unit-test-results
       - name: Print Logs for Services (Aerie)
         if: always()
         run: docker compose -f docker-compose-test.yml logs -t

.gitignore

@@ -1,7 +1,8 @@
 .DS_Store
 build
 node_modules
-test-results
+e2e-test-results
+unit-test-results
 /.svelte-kit
 /package
 /static/version.json

docs/TESTING.md

@@ -1,19 +1,21 @@
 # Testing
 
-This document describes the testing development workflow. Tests in this repo are tested using the [Playwright](https://playwright.dev/) testing library.
+This document describes the testing development workflow. End-to-end tests are run using the [Playwright](https://playwright.dev/) testing library. Unit tests are run using the [Vitest](https://vitest.dev/) library.
 
-All tests assume a production build of the project is available:
+## End-to-end
+
+All end-to-end tests assume a production build of the project is available:
 
 ```sh
 npm run build
 ```
 
-All tests also assume all Aerie services are running and available on `localhost`. See the example [docker-compose-test.yml](../docker-compose-test.yml) for an example of how to run the complete Aerie system. Notice we disable authentication for simplicity when running our end-to-end tests. You can reference the [Aerie deployment documentation](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment) for more detailed deployment information.
+All end-to-end tests also assume all Aerie services are running and available on `localhost`. See the example [docker-compose-test.yml](../docker-compose-test.yml) for an example of how to run the complete Aerie system. Notice we disable authentication for simplicity when running our end-to-end tests. You can reference the [Aerie deployment documentation](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment) for more detailed deployment information.
 
-To execute tests normally (i.e. not in debug mode), use the following command:
+To execute end-to-end tests normally (i.e. not in debug mode), use the following command:
 
 ```sh
-npm test
+npm run test:e2e
 ```
 
 If this is your first time running the tests you may need to install the Playwright browser drivers:
@@ -24,19 +26,27 @@ npx playwright install
 
 If something fails read the Playwright error carefully as it usually describes a quick fix. You can also look for the error in the [Playwright GitHub Issues](https://github.com/microsoft/playwright/issues) if you need more help.
 
-## Debug
+### Debug
 
 The debug test script runs the [Playwright inspector](https://playwright.dev/docs/inspector), which runs in headed debug mode so you can step through tests and watch them as they execute.
 
 ```sh
-npm run test:debug
+npm run test:e2e:debug
 ```
 
-## Codegen
+### Codegen
 
 The codegen test script runs the [Playwright test generator](https://playwright.dev/docs/codegen), which automatically generates [locators](https://playwright.dev/docs/locators) as you click elements on the page. It can greatly save test development time. The generator requires an instance of the application already running to select against.
 
 ```sh
-npm run test:dev     # Starts aerie-ui
-npm run test:codegen # Starts codegen
+npm run test:e2e:dev     # Starts aerie-ui
+npm run test:e2e:codegen # Starts codegen
+```
+
+## Unit
+
+To execute unit tests use the following command:
+
+```sh
+npm run test:unit
 ```