code-server/test/constants.test.ts

// Note: we need to import logger from the root
// because this is the logger used in logError in ../src/common/util
// import { logger } from "../node_modules/@coder/logger"
import { commit, getPackageJson, version } from "../src/node/constants"
import { loggerModule } from "./helpers"

describe("constants", () => {
  describe("getPackageJson", () => {
    // let spy: jest.SpyInstance

    beforeEach(() => {
      // spy = jest.spyOn(logger, "warn")
      jest.mock("@coder/logger", () => loggerModule)
    })

    afterEach(() => {
      jest.clearAllMocks()
    })

    afterAll(() => {
      jest.restoreAllMocks()
    })

    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(spy).toHaveBeenCalled()
      // expect(spy).toHaveBeenCalledWith(expectedErrorMessage)
      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("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("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
      expect(commit).toBe("development")
    })
  })
})