[studio] router test coverage #1326

agdb_studio/.eslintrc.cjs

@@ -1,6 +1,4 @@
 /* eslint-env node */
-require("@rushstack/eslint-patch/modern-module-resolution");
-
 module.exports = {
     root: true,
     extends: [

agdb_studio/package.json

@@ -30,6 +30,7 @@
         "@types/jsdom": "^21.1.7",
         "@types/node": "^20.14.12",
         "@vitejs/plugin-vue": "^5.1.0",
+        "@vitest/coverage-istanbul": "^2.1.3",
         "@vitest/coverage-v8": "^2.0.4",
         "@vue/eslint-config-prettier": "^9.0.0",
         "@vue/eslint-config-typescript": "^13.0.0",

agdb_studio/src/router/index.ts

@@ -1,25 +1,3 @@
-import { createRouter, createWebHistory } from "vue-router";
-import { createRoutes } from "./routes";
-import { isLoggedIn, logout } from "@/services/auth.service";
-
-const router = createRouter({
-    history: createWebHistory(import.meta.env.BASE_URL),
-    routes: createRoutes(),
-});
-
-router.beforeEach((to, from, next) => {
-    if (isLoggedIn()) {
-        if (to.name === "login") {
-            logout();
-        }
-        next();
-    } else {
-        if (to.name !== "login") {
-            next({ name: "login" });
-        } else {
-            next();
-        }
-    }
-});
+import router from "./router";
 
 export default router;

agdb_studio/src/router/router.spec.ts

@@ -0,0 +1,42 @@
+import { describe, it, expect, beforeEach } from "vitest";
+import router from "@/router/router";
+
+const { isLoggedInMock, logoutMock } = vi.hoisted(() => {
+    return { isLoggedInMock: vi.fn(), logoutMock: vi.fn() };
+});
+
+vi.mock("@/services/auth.service", () => {
+    return {
+        isLoggedIn: isLoggedInMock,
+        logout: logoutMock,
+    };
+});
+
+describe("router", () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    it("redirects to login if not logged in", async () => {
+        isLoggedInMock.mockReturnValue(false);
+
+        await router.push("/");
+
+        expect(router.currentRoute.value.name).toBe("login");
+    });
+    it("navigates to home if logged in", async () => {
+        isLoggedInMock.mockReturnValue(true);
+
+        await router.push("/");
+
+        expect(router.currentRoute.value.name).toBe("home");
+    });
+    it("logout if logged in and navigates to login", async () => {
+        isLoggedInMock.mockReturnValue(true);
+
+        await router.push("/login");
+
+        expect(router.currentRoute.value.name).toBe("login");
+        expect(logoutMock).toHaveBeenCalled();
+    });
+});

agdb_studio/src/router/router.ts

@@ -0,0 +1,36 @@
+import {
+    createRouter,
+    createWebHistory,
+    type NavigationGuardNext,
+    type RouteLocationNormalizedGeneric,
+} from "vue-router";
+import { createRoutes } from "./routes";
+import { isLoggedIn, logout } from "@/services/auth.service";
+
+const router = createRouter({
+    history: createWebHistory(import.meta.env.BASE_URL),
+    routes: createRoutes(),
+});
+
+export const beforeEach = (
+    to: RouteLocationNormalizedGeneric,
+    from: RouteLocationNormalizedGeneric,
+    next: NavigationGuardNext,
+) => {
+    if (isLoggedIn()) {
+        if (to.name === "login") {
+            logout();
+        }
+        next();
+    } else {
+        if (to.name !== "login") {
+            next({ name: "login" });
+        } else {
+            next();
+        }
+    }
+};
+
+router.beforeEach(beforeEach);
+
+export default router;

agdb_studio/src/router/routes.spec.ts

@@ -0,0 +1,49 @@
+import { describe, it, expect, beforeEach } from "vitest";
+import { createRouter, createWebHistory } from "vue-router";
+import { mount } from "@vue/test-utils";
+import { createRoutes } from "@/router/routes";
+import HomeView from "@/views/HomeView.vue";
+import AboutView from "@/views/HomeView.vue";
+import LoginView from "@/views/LoginView.vue";
+import App from "@/App.vue";
+
+const setupTest = async (path: string) => {
+    const router = createRouter({
+        history: createWebHistory(),
+        routes: createRoutes(),
+    });
+    router.push(path);
+    await router.isReady();
+    const wrapper = mount(App, {
+        global: {
+            plugins: [router],
+        },
+    });
+    return { router, wrapper };
+};
+
+describe("router", () => {
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    it("renders a default route", async () => {
+        const { wrapper } = await setupTest("/");
+
+        expect(wrapper.findComponent(HomeView).exists()).toBe(true);
+    });
+
+    it("renders the about route", async () => {
+        const { wrapper, router } = await setupTest("/");
+        router.push("/about");
+        await router.isReady();
+
+        expect(wrapper.findComponent(AboutView).exists()).toBe(true);
+    });
+
+    it("renders the login route", async () => {
+        const { wrapper } = await setupTest("/login");
+
+        expect(wrapper.findComponent(LoginView).exists()).toBe(true);
+    });
+});

agdb_studio/tsconfig.vitest.json

@@ -3,7 +3,7 @@
     "exclude": [],
     "compilerOptions": {
         "lib": [],
-        "types": ["node", "jsdom"],
+        "types": ["node", "jsdom", "vitest/globals"],
         "paths": {
             "@/*": ["./src/*"]
         }

agdb_studio/vitest.config.mts

@@ -0,0 +1,37 @@
+// import { fileURLToPath } from "node:url";
+import {
+    mergeConfig,
+    defineConfig,
+    configDefaults,
+    coverageConfigDefaults,
+} from "vitest/config";
+import viteConfig from "./vite.config.mjs";
+import path from "path";
+
+export default mergeConfig(
+    viteConfig,
+    defineConfig({
+        test: {
+            environment: "jsdom",
+            exclude: [...configDefaults.exclude, "e2e/*"],
+            root: path.resolve(__dirname, "."),
+            // root: fileURLToPath(new URL("./", import.meta.url)),
+            coverage: {
+                provider: "istanbul",
+                all: true,
+                exclude: [
+                    ...coverageConfigDefaults.exclude,
+                    "e2e/*",
+                    "*.config.*",
+                ],
+            },
+            setupFiles: ["./vitest.setup.ts"],
+            globals: true,
+        },
+        resolve: {
+            alias: {
+                "@": path.resolve(__dirname, "./src"),
+            },
+        },
+    }),
+);

agdb_studio/vitest.setup.ts

@@ -0,0 +1,25 @@
+import { vi } from "vitest";
+import { AgdbApi } from "agdb_api";
+
+const client = vi.fn().mockResolvedValue({
+    login: vi.fn().mockResolvedValue("token"),
+    logout: vi.fn().mockResolvedValue(undefined),
+    set_token: vi.fn(),
+    get_token: vi.fn(),
+    reset_token: vi.fn(),
+    interceptors: {
+        request: {
+            use: vi.fn(),
+        },
+        response: {
+            use: vi.fn(),
+        },
+    },
+}) as unknown as AgdbApi.AgdbApiClient;
+vi.mock("agdb_api", () => {
+    return {
+        AgdbApi: {
+            client,
+        },
+    };
+});