FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(testing): add test for src/node/constants.ts by jsjoeio · Pull Request #3290 · coder/code-server · GitHub

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .json  (1) .ts  (1) All 2 file types selected
Only manifest files
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
2 changes: 1 addition & 1 deletion package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@
"clover"
],
"coveragePathIgnorePatterns": [
"out"
"/out"
],
"coverageThreshold": {
"global": {
Expand Down
98 changes: 67 additions & 31 deletions test/unit/constants.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
@@ -1,54 +1,90 @@
import * as fs from "fs"
import { commit, getPackageJson, version } from "../../src/node/constants"
import { tmpdir } from "../../test/utils/constants"
import { loggerModule } from "../utils/helpers"

// jest.mock is hoisted above the imports so we must use `require` here.
jest.mock("@coder/logger", () => require("../utils/helpers").loggerModule)

describe("constants", () => {
describe("getPackageJson", () => {
afterEach(() => {
jest.clearAllMocks()
beforeAll(() => {
jest.clearAllMocks()
jest.resetModules()
})
describe("with package.json defined", () => {
const { getPackageJson } = require("../../src/node/constants")
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")
it("should provide the commit", () => {
expect(commit).toBe("f6b2be2838f4afb217c2fd8f03eafedd8d55ef9b")
})

expect(loggerModule.logger.warn).toHaveBeenCalled()
expect(loggerModule.logger.warn).toHaveBeenCalledWith(expectedErrorMessage)
it("should return the package.json version", () => {
expect(version).toBe(mockPackageJson.version)
})

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")
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)
})

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("version", () => {
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)

describe("with incomplete package.json", () => {
let mockPackageJson = {
name: "mock-code-server",
}
let version = ""
let commit = ""

beforeEach(() => {
jest.mock("../../package.json", () => mockPackageJson, { virtual: true })
version = require("../../src/node/constants").version
commit = require("../../src/node/constants").commit
})
})

describe("commit", () => {
it("should return 'development' if commit is undefined", () => {
// In development, the commit is not stored in our package.json
// But when we build code-server and release it, it is
afterEach(() => {
jest.clearAllMocks()
jest.resetModules()
})

it("version should return 'development'", () => {
expect(version).toBe("development")
})
it("commit should return 'development'", () => {
expect(commit).toBe("development")
})
})
Expand Down

Back | FazBrowse Home | New Git URL