From cb5ab48d4886a92a99b54c8591e6ce67d2476f84 Mon Sep 17 00:00:00 2001 From: Joe Previte Date: Wed, 5 May 2021 16:38:54 -0700 Subject: [PATCH] fix: coveragePathIgnorePatterns to /out We were accidentally ignoring `node/routes` because we had "out" instead of "/out" in `coveragePathIgnorePatterns` which caused us to not collect coverage for those files. Now we do. --- package.json | 2 +- test/unit/constants.test.ts | 158 ++++++++++++++---------------------- 2 files changed, 60 insertions(+), 100 deletions(-) diff --git a/package.json b/package.json index 300b49e51..1a51759be 100644 --- a/package.json +++ b/package.json @@ -142,7 +142,7 @@ "clover" ], "coveragePathIgnorePatterns": [ - "out" + "/out" ], "coverageThreshold": { "global": { diff --git a/test/unit/constants.test.ts b/test/unit/constants.test.ts index f8980f2b1..d7d3c66be 100644 --- a/test/unit/constants.test.ts +++ b/test/unit/constants.test.ts @@ -6,126 +6,86 @@ import { loggerModule } from "../utils/helpers" jest.mock("@coder/logger", () => require("../utils/helpers").loggerModule) describe("constants", () => { - describe("getPackageJson", () => { + beforeAll(() => { + jest.clearAllMocks() + jest.resetModules() + }) + describe("with package.json defined", () => { const { getPackageJson } = require("../../src/node/constants") - afterEach(() => { - jest.clearAllMocks() + let mockPackageJson = { + name: "mock-code-server", + description: "Run VS Code on a remote server.", + repository: "https://github.com/cdr/code-server", + version: "1.0.0", + commit: "f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b", + } + let version = "" + let commit = "" + + beforeEach(() => { + jest.mock("../../package.json", () => mockPackageJson, { virtual: true }) + commit = require("../../src/node/constants").commit + version = require("../../src/node/constants").version }) afterAll(() => { - jest.restoreAllMocks() + jest.clearAllMocks() jest.resetModules() }) - it("should log a warning if package.json not found", () => { - const expectedErrorMessage = "Cannot find module './package.json' from 'src/node/constants.ts'" - - getPackageJson("./package.json") - - expect(loggerModule.logger.warn).toHaveBeenCalled() - expect(loggerModule.logger.warn).toHaveBeenCalledWith(expectedErrorMessage) + it("should provide the commit", () => { + expect(commit).toBe("f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b") }) - it("should find the package.json", () => { - // the function calls require from src/node/constants - // so to get the root package.json we need to use ../../ - const packageJson = getPackageJson("../../package.json") - expect(Object.keys(packageJson).length).toBeGreaterThan(0) - expect(packageJson.name).toBe("code-server") - expect(packageJson.description).toBe("Run VS Code on a remote server.") - expect(packageJson.repository).toBe("https://github.com/cdr/code-server") + it("should return the package.json version", () => { + expect(version).toBe(mockPackageJson.version) }) - }) - describe("version", () => { - describe("with package.json.version defined", () => { - let mockPackageJson = { - name: "mock-code-server", - version: "1.0.0", - } - let version = "" - beforeEach(() => { - jest.mock("../../package.json", () => mockPackageJson, { virtual: true }) - version = require("../../src/node/constants").version + describe("getPackageJson", () => { + it("should log a warning if package.json not found", () => { + const expectedErrorMessage = "Cannot find module './package.json' from 'src/node/constants.ts'" + + getPackageJson("./package.json") + + expect(loggerModule.logger.warn).toHaveBeenCalled() + expect(loggerModule.logger.warn).toHaveBeenCalledWith(expectedErrorMessage) }) - afterEach(() => { - jest.resetAllMocks() - jest.resetModules() - }) - - it("should return the package.json version", () => { - // Source: https://gist.github.com/jhorsman/62eeea161a13b80e39f5249281e17c39#gistcomment-2896416 - const validSemVar = new RegExp("^(0|[1-9]d*).(0|[1-9]d*).(0|[1-9]d*)") - const isValidSemVar = validSemVar.test(version) - expect(version).not.toBe(null) - expect(isValidSemVar).toBe(true) - expect(version).toBe("1.0.0") - }) - }) - describe("with package.json.version missing", () => { - let mockPackageJson = { - name: "mock-code-server", - } - let version = "" - - beforeEach(() => { - jest.mock("../../package.json", () => mockPackageJson, { virtual: true }) - version = require("../../src/node/constants").version - }) - - afterEach(() => { - jest.resetAllMocks() - jest.resetModules() - }) - - it("should return 'development'", () => { - expect(version).toBe("development") + it("should find the package.json", () => { + // the function calls require from src/node/constants + // so to get the root package.json we need to use ../../ + const packageJson = getPackageJson("../../package.json") + expect(Object.keys(packageJson).length).toBeGreaterThan(0) + expect(packageJson.name).toBe("mock-code-server") + expect(packageJson.description).toBe("Run VS Code on a remote server.") + expect(packageJson.repository).toBe("https://github.com/cdr/code-server") }) }) }) - describe("commit", () => { - describe("with package.json.commit defined", () => { - let mockPackageJson = { - name: "mock-code-server", - commit: "f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b", - } - let commit = "" - beforeEach(() => { - jest.mock("../../package.json", () => mockPackageJson, { virtual: true }) - commit = require("../../src/node/constants").commit - }) + describe("with incomplete package.json", () => { + let mockPackageJson = { + name: "mock-code-server", + } + let version = "" + let commit = "" - afterEach(() => { - jest.resetAllMocks() - jest.resetModules() - }) - - it("should return the package.json.commit", () => { - // Source: https://gist.github.com/jhorsman/62eeea161a13b80e39f5249281e17c39#gistcomment-2896416 - expect(commit).toBe("f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b") - }) + beforeEach(() => { + jest.mock("../../package.json", () => mockPackageJson, { virtual: true }) + version = require("../../src/node/constants").version + commit = require("../../src/node/constants").commit }) - describe("with package.json.commit missing", () => { - let mockPackageJson = { - name: "mock-code-server", - } - let commit = "" - beforeEach(() => { - jest.mock("../../package.json", () => mockPackageJson, { virtual: true }) - commit = require("../../src/node/constants").commit - }) + afterEach(() => { + jest.clearAllMocks() + jest.resetModules() + }) - afterEach(() => { - jest.resetAllMocks() - jest.resetModules() - }) - - it("should return 'development'", () => { - expect(commit).toBe("development") - }) + it("version should return 'development'", () => { + expect(version).toBe("development") + }) + it("commit should return 'development'", () => { + expect(commit).toBe("development") }) }) })