Running Tests

Our current CI doesn't do anything interesting.

A good CI pipeline typically includes:

Unit tests
Integration tests
Styling checks
Linting checks
Security checks
Any other kind of automated test

If any of the tests fail, the build is considered "broken" and the developer is notified (in our case by GitHub) so they can fix it.

Assignment

The Notely repo has, gasp, zero unit tests! In this course we're going to use the vitest testing framework, it's very popular and easy to setup.

Install Vitest:

npm install -D vitest

Add the "test": "vitest --run" to our package.json in the "scripts" object, it should look something like this:

  "scripts": {
    "test": "vitest --run"
  },

Write some tests for the getAPIKey function in the src/api/auth.ts file. I'd recommend keeping your tests in a tests directory in src, but you can technically put them anywhere as long as the file ends in .test.ts. Here's an example of the structure, but I recommend looking at the vitest docs for more info on how to test what you want to:

import { describe, expect, test } from "vitest";

const person = {
  isActive: true,
  age: 32,
};

describe("person", () => {
  test("person is defined", () => {
    expect(person).toBeDefined();
  });

  test("is active", () => {
    expect(person.isActive).toBeTruthy();
  });
});

Make sure your tests work:

npm run test

Run and submit the CLI tests from the root of your repo.