feat(testing): add test for constants "version" and commit

This commit is contained in:
Joe Previte 2021-05-04 16:55:09 -07:00
parent af5a1c9861
commit 027106a5e1
No known key found for this signature in database
GPG Key ID: 2C91590C6B742C24

View File

@ -1,5 +1,4 @@
import * as fs from "fs" import * as fs from "fs"
import { commit, getPackageJson, version } from "../../src/node/constants"
import { tmpdir } from "../../test/utils/constants" import { tmpdir } from "../../test/utils/constants"
import { loggerModule } from "../utils/helpers" import { loggerModule } from "../utils/helpers"
@ -8,12 +7,14 @@ jest.mock("@coder/logger", () => require("../utils/helpers").loggerModule)
describe("constants", () => { describe("constants", () => {
describe("getPackageJson", () => { describe("getPackageJson", () => {
const { getPackageJson } = require("../../src/node/constants")
afterEach(() => { afterEach(() => {
jest.clearAllMocks() jest.clearAllMocks()
}) })
afterAll(() => { afterAll(() => {
jest.restoreAllMocks() jest.restoreAllMocks()
jest.resetModules()
}) })
it("should log a warning if package.json not found", () => { it("should log a warning if package.json not found", () => {
@ -36,22 +37,97 @@ describe("constants", () => {
}) })
}) })
describe("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
})
afterEach(() => {
jest.resetAllMocks()
jest.resetModules()
})
it("should return the package.json version", () => { it("should return the package.json version", () => {
// Source: https://gist.github.com/jhorsman/62eeea161a13b80e39f5249281e17c39#gistcomment-2896416 // 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 validSemVar = new RegExp("^(0|[1-9]d*).(0|[1-9]d*).(0|[1-9]d*)")
const isValidSemVar = validSemVar.test(version) const isValidSemVar = validSemVar.test(version)
expect(version).not.toBe(null) expect(version).not.toBe(null)
expect(isValidSemVar).toBe(true) 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")
})
})
})
describe("commit", () => { describe("commit", () => {
it("should return 'development' if commit is undefined", () => { describe("with package.json.commit defined", () => {
// In development, the commit is not stored in our package.json let mockPackageJson = {
// But when we build code-server and release it, it is name: "mock-code-server",
commit: "f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b",
}
let commit = ""
beforeEach(() => {
jest.mock("../../package.json", () => mockPackageJson, { virtual: true })
commit = require("../../src/node/constants").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")
})
})
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.resetAllMocks()
jest.resetModules()
})
it("should return 'development'", () => {
expect(commit).toBe("development") expect(commit).toBe("development")
}) })
}) })
})
}) })
describe("test constants", () => { describe("test constants", () => {