Archived
1
0

Import utils as a group in tests

This should simplify testing new utils a bit.
This commit is contained in:
Asher 2021-06-25 12:15:12 -05:00
parent ba0364a522
commit add55ecd62
No known key found for this signature in database
GPG Key ID: D63C1EF81242354A
2 changed files with 74 additions and 95 deletions

View File

@ -1,14 +1,4 @@
import { import * as util from "../../../src/node/util"
hash,
isHashMatch,
handlePasswordValidation,
PasswordMethod,
getPasswordMethod,
hashLegacy,
isHashLegacyMatch,
isCookieValid,
sanitizeString,
} from "../../../src/node/util"
describe("getEnvPaths", () => { describe("getEnvPaths", () => {
describe("on darwin", () => { describe("on darwin", () => {
@ -161,7 +151,7 @@ describe("getEnvPaths", () => {
describe("hash", () => { describe("hash", () => {
it("should return a hash of the string passed in", async () => { it("should return a hash of the string passed in", async () => {
const plainTextPassword = "mySecretPassword123" const plainTextPassword = "mySecretPassword123"
const hashed = await hash(plainTextPassword) const hashed = await util.hash(plainTextPassword)
expect(hashed).not.toBe(plainTextPassword) expect(hashed).not.toBe(plainTextPassword)
}) })
}) })
@ -169,32 +159,32 @@ describe("hash", () => {
describe("isHashMatch", () => { describe("isHashMatch", () => {
it("should return true if the password matches the hash", async () => { it("should return true if the password matches the hash", async () => {
const password = "codeserver1234" const password = "codeserver1234"
const _hash = await hash(password) const _hash = await util.hash(password)
const actual = await isHashMatch(password, _hash) const actual = await util.isHashMatch(password, _hash)
expect(actual).toBe(true) expect(actual).toBe(true)
}) })
it("should return false if the password does not match the hash", async () => { it("should return false if the password does not match the hash", async () => {
const password = "password123" const password = "password123"
const _hash = await hash(password) const _hash = await util.hash(password)
const actual = await isHashMatch("otherPassword123", _hash) const actual = await util.isHashMatch("otherPassword123", _hash)
expect(actual).toBe(false) expect(actual).toBe(false)
}) })
it("should return true with actual hash", async () => { it("should return true with actual hash", async () => {
const password = "password123" const password = "password123"
const _hash = "$argon2i$v=19$m=4096,t=3,p=1$EAoczTxVki21JDfIZpTUxg$rkXgyrW4RDGoDYrxBFD4H2DlSMEhP4h+Api1hXnGnFY" const _hash = "$argon2i$v=19$m=4096,t=3,p=1$EAoczTxVki21JDfIZpTUxg$rkXgyrW4RDGoDYrxBFD4H2DlSMEhP4h+Api1hXnGnFY"
const actual = await isHashMatch(password, _hash) const actual = await util.isHashMatch(password, _hash)
expect(actual).toBe(true) expect(actual).toBe(true)
}) })
it("should return false if the password is empty", async () => { it("should return false if the password is empty", async () => {
const password = "" const password = ""
const _hash = "$argon2i$v=19$m=4096,t=3,p=1$EAoczTxVki21JDfIZpTUxg$rkXgyrW4RDGoDYrxBFD4H2DlSMEhP4h+Api1hXnGnFY" const _hash = "$argon2i$v=19$m=4096,t=3,p=1$EAoczTxVki21JDfIZpTUxg$rkXgyrW4RDGoDYrxBFD4H2DlSMEhP4h+Api1hXnGnFY"
const actual = await isHashMatch(password, _hash) const actual = await util.isHashMatch(password, _hash)
expect(actual).toBe(false) expect(actual).toBe(false)
}) })
it("should return false if the hash is empty", async () => { it("should return false if the hash is empty", async () => {
const password = "hellowpasssword" const password = "hellowpasssword"
const _hash = "" const _hash = ""
const actual = await isHashMatch(password, _hash) const actual = await util.isHashMatch(password, _hash)
expect(actual).toBe(false) expect(actual).toBe(false)
}) })
}) })
@ -202,7 +192,7 @@ describe("isHashMatch", () => {
describe("hashLegacy", () => { describe("hashLegacy", () => {
it("should return a hash of the string passed in", () => { it("should return a hash of the string passed in", () => {
const plainTextPassword = "mySecretPassword123" const plainTextPassword = "mySecretPassword123"
const hashed = hashLegacy(plainTextPassword) const hashed = util.hashLegacy(plainTextPassword)
expect(hashed).not.toBe(plainTextPassword) expect(hashed).not.toBe(plainTextPassword)
}) })
}) })
@ -210,40 +200,40 @@ describe("hashLegacy", () => {
describe("isHashLegacyMatch", () => { describe("isHashLegacyMatch", () => {
it("should return true if is match", () => { it("should return true if is match", () => {
const password = "password123" const password = "password123"
const _hash = hashLegacy(password) const _hash = util.hashLegacy(password)
expect(isHashLegacyMatch(password, _hash)).toBe(true) expect(util.isHashLegacyMatch(password, _hash)).toBe(true)
}) })
it("should return false if is match", () => { it("should return false if is match", () => {
const password = "password123" const password = "password123"
const _hash = hashLegacy(password) const _hash = util.hashLegacy(password)
expect(isHashLegacyMatch("otherPassword123", _hash)).toBe(false) expect(util.isHashLegacyMatch("otherPassword123", _hash)).toBe(false)
}) })
it("should return true if hashed from command line", () => { it("should return true if hashed from command line", () => {
const password = "password123" const password = "password123"
// Hashed using printf "password123" | sha256sum | cut -d' ' -f1 // Hashed using printf "password123" | sha256sum | cut -d' ' -f1
const _hash = "ef92b778bafe771e89245b89ecbc08a44a4e166c06659911881f383d4473e94f" const _hash = "ef92b778bafe771e89245b89ecbc08a44a4e166c06659911881f383d4473e94f"
expect(isHashLegacyMatch(password, _hash)).toBe(true) expect(util.isHashLegacyMatch(password, _hash)).toBe(true)
}) })
}) })
describe("getPasswordMethod", () => { describe("getPasswordMethod", () => {
it("should return PLAIN_TEXT for no hashed password", () => { it("should return PLAIN_TEXT for no hashed password", () => {
const hashedPassword = undefined const hashedPassword = undefined
const passwordMethod = getPasswordMethod(hashedPassword) const passwordMethod = util.getPasswordMethod(hashedPassword)
const expected: PasswordMethod = "PLAIN_TEXT" const expected: util.PasswordMethod = "PLAIN_TEXT"
expect(passwordMethod).toEqual(expected) expect(passwordMethod).toEqual(expected)
}) })
it("should return ARGON2 for password with 'argon2'", () => { it("should return ARGON2 for password with 'argon2'", () => {
const hashedPassword = const hashedPassword =
"$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY" "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY"
const passwordMethod = getPasswordMethod(hashedPassword) const passwordMethod = util.getPasswordMethod(hashedPassword)
const expected: PasswordMethod = "ARGON2" const expected: util.PasswordMethod = "ARGON2"
expect(passwordMethod).toEqual(expected) expect(passwordMethod).toEqual(expected)
}) })
it("should return SHA256 for password with legacy hash", () => { it("should return SHA256 for password with legacy hash", () => {
const hashedPassword = "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af" const hashedPassword = "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af"
const passwordMethod = getPasswordMethod(hashedPassword) const passwordMethod = util.getPasswordMethod(hashedPassword)
const expected: PasswordMethod = "SHA256" const expected: util.PasswordMethod = "SHA256"
expect(passwordMethod).toEqual(expected) expect(passwordMethod).toEqual(expected)
}) })
}) })
@ -251,63 +241,63 @@ describe("getPasswordMethod", () => {
describe("handlePasswordValidation", () => { describe("handlePasswordValidation", () => {
it("should return true with a hashedPassword for a PLAIN_TEXT password", async () => { it("should return true with a hashedPassword for a PLAIN_TEXT password", async () => {
const p = "password" const p = "password"
const passwordValidation = await handlePasswordValidation({ const passwordValidation = await util.handlePasswordValidation({
passwordMethod: "PLAIN_TEXT", passwordMethod: "PLAIN_TEXT",
passwordFromRequestBody: p, passwordFromRequestBody: p,
passwordFromArgs: p, passwordFromArgs: p,
hashedPasswordFromArgs: undefined, hashedPasswordFromArgs: undefined,
}) })
const matchesHash = await isHashMatch(p, passwordValidation.hashedPassword) const matchesHash = await util.isHashMatch(p, passwordValidation.hashedPassword)
expect(passwordValidation.isPasswordValid).toBe(true) expect(passwordValidation.isPasswordValid).toBe(true)
expect(matchesHash).toBe(true) expect(matchesHash).toBe(true)
}) })
it("should return false when PLAIN_TEXT password doesn't match args", async () => { it("should return false when PLAIN_TEXT password doesn't match args", async () => {
const p = "password" const p = "password"
const passwordValidation = await handlePasswordValidation({ const passwordValidation = await util.handlePasswordValidation({
passwordMethod: "PLAIN_TEXT", passwordMethod: "PLAIN_TEXT",
passwordFromRequestBody: "password1", passwordFromRequestBody: "password1",
passwordFromArgs: p, passwordFromArgs: p,
hashedPasswordFromArgs: undefined, hashedPasswordFromArgs: undefined,
}) })
const matchesHash = await isHashMatch(p, passwordValidation.hashedPassword) const matchesHash = await util.isHashMatch(p, passwordValidation.hashedPassword)
expect(passwordValidation.isPasswordValid).toBe(false) expect(passwordValidation.isPasswordValid).toBe(false)
expect(matchesHash).toBe(false) expect(matchesHash).toBe(false)
}) })
it("should return true with a hashedPassword for a SHA256 password", async () => { it("should return true with a hashedPassword for a SHA256 password", async () => {
const p = "helloworld" const p = "helloworld"
const passwordValidation = await handlePasswordValidation({ const passwordValidation = await util.handlePasswordValidation({
passwordMethod: "SHA256", passwordMethod: "SHA256",
passwordFromRequestBody: p, passwordFromRequestBody: p,
passwordFromArgs: undefined, passwordFromArgs: undefined,
hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af", hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af",
}) })
const matchesHash = isHashLegacyMatch(p, passwordValidation.hashedPassword) const matchesHash = util.isHashLegacyMatch(p, passwordValidation.hashedPassword)
expect(passwordValidation.isPasswordValid).toBe(true) expect(passwordValidation.isPasswordValid).toBe(true)
expect(matchesHash).toBe(true) expect(matchesHash).toBe(true)
}) })
it("should return false when SHA256 password doesn't match hash", async () => { it("should return false when SHA256 password doesn't match hash", async () => {
const p = "helloworld1" const p = "helloworld1"
const passwordValidation = await handlePasswordValidation({ const passwordValidation = await util.handlePasswordValidation({
passwordMethod: "SHA256", passwordMethod: "SHA256",
passwordFromRequestBody: p, passwordFromRequestBody: p,
passwordFromArgs: undefined, passwordFromArgs: undefined,
hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af", hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af",
}) })
const matchesHash = isHashLegacyMatch(p, passwordValidation.hashedPassword) const matchesHash = util.isHashLegacyMatch(p, passwordValidation.hashedPassword)
expect(passwordValidation.isPasswordValid).toBe(false) expect(passwordValidation.isPasswordValid).toBe(false)
expect(matchesHash).toBe(false) expect(matchesHash).toBe(false)
}) })
it("should return true with a hashedPassword for a ARGON2 password", async () => { it("should return true with a hashedPassword for a ARGON2 password", async () => {
const p = "password" const p = "password"
const passwordValidation = await handlePasswordValidation({ const passwordValidation = await util.handlePasswordValidation({
passwordMethod: "ARGON2", passwordMethod: "ARGON2",
passwordFromRequestBody: p, passwordFromRequestBody: p,
passwordFromArgs: undefined, passwordFromArgs: undefined,
@ -315,14 +305,14 @@ describe("handlePasswordValidation", () => {
"$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY", "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY",
}) })
const matchesHash = await isHashMatch(p, passwordValidation.hashedPassword) const matchesHash = await util.isHashMatch(p, passwordValidation.hashedPassword)
expect(passwordValidation.isPasswordValid).toBe(true) expect(passwordValidation.isPasswordValid).toBe(true)
expect(matchesHash).toBe(true) expect(matchesHash).toBe(true)
}) })
it("should return false when ARGON2 password doesn't match hash", async () => { it("should return false when ARGON2 password doesn't match hash", async () => {
const p = "password1" const p = "password1"
const passwordValidation = await handlePasswordValidation({ const passwordValidation = await util.handlePasswordValidation({
passwordMethod: "ARGON2", passwordMethod: "ARGON2",
passwordFromRequestBody: p, passwordFromRequestBody: p,
passwordFromArgs: undefined, passwordFromArgs: undefined,
@ -330,7 +320,7 @@ describe("handlePasswordValidation", () => {
"$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY", "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY",
}) })
const matchesHash = await isHashMatch(p, passwordValidation.hashedPassword) const matchesHash = await util.isHashMatch(p, passwordValidation.hashedPassword)
expect(passwordValidation.isPasswordValid).toBe(false) expect(passwordValidation.isPasswordValid).toBe(false)
expect(matchesHash).toBe(false) expect(matchesHash).toBe(false)
@ -339,7 +329,7 @@ describe("handlePasswordValidation", () => {
describe("isCookieValid", () => { describe("isCookieValid", () => {
it("should be valid if hashed-password for SHA256 matches cookie.key", async () => { it("should be valid if hashed-password for SHA256 matches cookie.key", async () => {
const isValid = await isCookieValid({ const isValid = await util.isCookieValid({
passwordMethod: "SHA256", passwordMethod: "SHA256",
cookieKey: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af", cookieKey: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af",
hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af", hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af",
@ -348,7 +338,7 @@ describe("isCookieValid", () => {
expect(isValid).toBe(true) expect(isValid).toBe(true)
}) })
it("should be invalid if hashed-password for SHA256 does not match cookie.key", async () => { it("should be invalid if hashed-password for SHA256 does not match cookie.key", async () => {
const isValid = await isCookieValid({ const isValid = await util.isCookieValid({
passwordMethod: "SHA256", passwordMethod: "SHA256",
cookieKey: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb9442bb6f8f8f07af", cookieKey: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb9442bb6f8f8f07af",
hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af", hashedPasswordFromArgs: "936a185caaa266bb9cbe981e9e05cb78cd732b0b3280eb944412bb6f8f8f07af",
@ -357,7 +347,7 @@ describe("isCookieValid", () => {
expect(isValid).toBe(false) expect(isValid).toBe(false)
}) })
it("should be valid if hashed-password for ARGON2 matches cookie.key", async () => { it("should be valid if hashed-password for ARGON2 matches cookie.key", async () => {
const isValid = await isCookieValid({ const isValid = await util.isCookieValid({
passwordMethod: "ARGON2", passwordMethod: "ARGON2",
cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY", cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY",
hashedPasswordFromArgs: hashedPasswordFromArgs:
@ -367,7 +357,7 @@ describe("isCookieValid", () => {
expect(isValid).toBe(true) expect(isValid).toBe(true)
}) })
it("should be invalid if hashed-password for ARGON2 does not match cookie.key", async () => { it("should be invalid if hashed-password for ARGON2 does not match cookie.key", async () => {
const isValid = await isCookieValid({ const isValid = await util.isCookieValid({
passwordMethod: "ARGON2", passwordMethod: "ARGON2",
cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9H", cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9H",
hashedPasswordFromArgs: hashedPasswordFromArgs:
@ -377,7 +367,7 @@ describe("isCookieValid", () => {
expect(isValid).toBe(false) expect(isValid).toBe(false)
}) })
it("should be valid if password for PLAIN_TEXT matches cookie.key", async () => { it("should be valid if password for PLAIN_TEXT matches cookie.key", async () => {
const isValid = await isCookieValid({ const isValid = await util.isCookieValid({
passwordMethod: "PLAIN_TEXT", passwordMethod: "PLAIN_TEXT",
cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY", cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9HYY",
passwordFromArgs: "password", passwordFromArgs: "password",
@ -386,7 +376,7 @@ describe("isCookieValid", () => {
expect(isValid).toBe(true) expect(isValid).toBe(true)
}) })
it("should be invalid if hashed-password for PLAIN_TEXT does not match cookie.key", async () => { it("should be invalid if hashed-password for PLAIN_TEXT does not match cookie.key", async () => {
const isValid = await isCookieValid({ const isValid = await util.isCookieValid({
passwordMethod: "PLAIN_TEXT", passwordMethod: "PLAIN_TEXT",
cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9H", cookieKey: "$argon2i$v=19$m=4096,t=3,p=1$0qR/o+0t00hsbJFQCKSfdQ$oFcM4rL6o+B7oxpuA4qlXubypbBPsf+8L531U7P9H",
passwordFromArgs: "password1234", passwordFromArgs: "password1234",
@ -398,12 +388,12 @@ describe("isCookieValid", () => {
describe("sanitizeString", () => { describe("sanitizeString", () => {
it("should return an empty string if passed a type other than a string", () => { it("should return an empty string if passed a type other than a string", () => {
expect(sanitizeString({} as string)).toBe("") expect(util.sanitizeString({} as string)).toBe("")
}) })
it("should trim whitespace", () => { it("should trim whitespace", () => {
expect(sanitizeString(" hello ")).toBe("hello") expect(util.sanitizeString(" hello ")).toBe("hello")
}) })
it("should always return an empty string", () => { it("should always return an empty string", () => {
expect(sanitizeString(" ")).toBe("") expect(util.sanitizeString(" ")).toBe("")
}) })
}) })

View File

@ -1,16 +1,5 @@
import { JSDOM } from "jsdom" import { JSDOM } from "jsdom"
import { import * as util from "../../src/common/util"
arrayify,
generateUuid,
getFirstString,
getOptions,
logError,
plural,
resolveBase,
split,
trimSlashes,
normalize,
} from "../../src/common/util"
import { createLoggerMock } from "../utils/helpers" import { createLoggerMock } from "../utils/helpers"
const dom = new JSDOM() const dom = new JSDOM()
@ -21,67 +10,67 @@ export type LocationLike = Pick<Location, "pathname" | "origin">
describe("util", () => { describe("util", () => {
describe("normalize", () => { describe("normalize", () => {
it("should remove multiple slashes", () => { it("should remove multiple slashes", () => {
expect(normalize("//foo//bar//baz///mumble")).toBe("/foo/bar/baz/mumble") expect(util.normalize("//foo//bar//baz///mumble")).toBe("/foo/bar/baz/mumble")
}) })
it("should remove trailing slashes", () => { it("should remove trailing slashes", () => {
expect(normalize("qux///")).toBe("qux") expect(util.normalize("qux///")).toBe("qux")
}) })
it("should preserve trailing slash if it exists", () => { it("should preserve trailing slash if it exists", () => {
expect(normalize("qux///", true)).toBe("qux/") expect(util.normalize("qux///", true)).toBe("qux/")
expect(normalize("qux", true)).toBe("qux") expect(util.normalize("qux", true)).toBe("qux")
}) })
}) })
describe("split", () => { describe("split", () => {
it("should split at a comma", () => { it("should split at a comma", () => {
expect(split("Hello,world", ",")).toStrictEqual(["Hello", "world"]) expect(util.split("Hello,world", ",")).toStrictEqual(["Hello", "world"])
}) })
it("shouldn't split if the delimiter doesn't exist", () => { it("shouldn't split if the delimiter doesn't exist", () => {
expect(split("Hello world", ",")).toStrictEqual(["Hello world", ""]) expect(util.split("Hello world", ",")).toStrictEqual(["Hello world", ""])
}) })
}) })
describe("plural", () => { describe("plural", () => {
it("should add an s if count is greater than 1", () => { it("should add an s if count is greater than 1", () => {
expect(plural(2, "dog")).toBe("dogs") expect(util.plural(2, "dog")).toBe("dogs")
}) })
it("should NOT add an s if the count is 1", () => { it("should NOT add an s if the count is 1", () => {
expect(plural(1, "dog")).toBe("dog") expect(util.plural(1, "dog")).toBe("dog")
}) })
}) })
describe("generateUuid", () => { describe("generateUuid", () => {
it("should generate a unique uuid", () => { it("should generate a unique uuid", () => {
const uuid = generateUuid() const uuid = util.generateUuid()
const uuid2 = generateUuid() const uuid2 = util.generateUuid()
expect(uuid).toHaveLength(24) expect(uuid).toHaveLength(24)
expect(typeof uuid).toBe("string") expect(typeof uuid).toBe("string")
expect(uuid).not.toBe(uuid2) expect(uuid).not.toBe(uuid2)
}) })
it("should generate a uuid of a specific length", () => { it("should generate a uuid of a specific length", () => {
const uuid = generateUuid(10) const uuid = util.generateUuid(10)
expect(uuid).toHaveLength(10) expect(uuid).toHaveLength(10)
}) })
}) })
describe("trimSlashes", () => { describe("trimSlashes", () => {
it("should remove leading slashes", () => { it("should remove leading slashes", () => {
expect(trimSlashes("/hello-world")).toBe("hello-world") expect(util.trimSlashes("/hello-world")).toBe("hello-world")
}) })
it("should remove trailing slashes", () => { it("should remove trailing slashes", () => {
expect(trimSlashes("hello-world/")).toBe("hello-world") expect(util.trimSlashes("hello-world/")).toBe("hello-world")
}) })
it("should remove both leading and trailing slashes", () => { it("should remove both leading and trailing slashes", () => {
expect(trimSlashes("/hello-world/")).toBe("hello-world") expect(util.trimSlashes("/hello-world/")).toBe("hello-world")
}) })
it("should remove multiple leading and trailing slashes", () => { it("should remove multiple leading and trailing slashes", () => {
expect(trimSlashes("///hello-world////")).toBe("hello-world") expect(util.trimSlashes("///hello-world////")).toBe("hello-world")
}) })
}) })
@ -101,23 +90,23 @@ describe("util", () => {
}) })
it("should resolve a base", () => { it("should resolve a base", () => {
expect(resolveBase("localhost:8080")).toBe("/localhost:8080") expect(util.resolveBase("localhost:8080")).toBe("/localhost:8080")
}) })
it("should resolve a base with a forward slash at the beginning", () => { it("should resolve a base with a forward slash at the beginning", () => {
expect(resolveBase("/localhost:8080")).toBe("/localhost:8080") expect(util.resolveBase("/localhost:8080")).toBe("/localhost:8080")
}) })
it("should resolve a base with query params", () => { it("should resolve a base with query params", () => {
expect(resolveBase("localhost:8080?folder=hello-world")).toBe("/localhost:8080") expect(util.resolveBase("localhost:8080?folder=hello-world")).toBe("/localhost:8080")
}) })
it("should resolve a base with a path", () => { it("should resolve a base with a path", () => {
expect(resolveBase("localhost:8080/hello/world")).toBe("/localhost:8080/hello/world") expect(util.resolveBase("localhost:8080/hello/world")).toBe("/localhost:8080/hello/world")
}) })
it("should resolve a base to an empty string when not provided", () => { it("should resolve a base to an empty string when not provided", () => {
expect(resolveBase()).toBe("") expect(util.resolveBase()).toBe("")
}) })
}) })
@ -142,7 +131,7 @@ describe("util", () => {
}) })
it("should return options with base and cssStaticBase even if it doesn't exist", () => { it("should return options with base and cssStaticBase even if it doesn't exist", () => {
expect(getOptions()).toStrictEqual({ expect(util.getOptions()).toStrictEqual({
base: "", base: "",
csStaticBase: "", csStaticBase: "",
}) })
@ -162,7 +151,7 @@ describe("util", () => {
// it returns the element // it returns the element
spy.mockImplementation(() => mockElement) spy.mockImplementation(() => mockElement)
expect(getOptions()).toStrictEqual({ expect(util.getOptions()).toStrictEqual({
base: "", base: "",
csStaticBase: "/static/development/Users/jp/Dev/code-server", csStaticBase: "/static/development/Users/jp/Dev/code-server",
disableTelemetry: false, disableTelemetry: false,
@ -179,7 +168,7 @@ describe("util", () => {
// spreads the original options // spreads the original options
// then parses the queryOpts // then parses the queryOpts
location.search = '?options={"logLevel":2}' location.search = '?options={"logLevel":2}'
expect(getOptions()).toStrictEqual({ expect(util.getOptions()).toStrictEqual({
base: "", base: "",
csStaticBase: "", csStaticBase: "",
logLevel: 2, logLevel: 2,
@ -189,12 +178,12 @@ describe("util", () => {
describe("arrayify", () => { describe("arrayify", () => {
it("should return value it's already an array", () => { it("should return value it's already an array", () => {
expect(arrayify(["hello", "world"])).toStrictEqual(["hello", "world"]) expect(util.arrayify(["hello", "world"])).toStrictEqual(["hello", "world"])
}) })
it("should wrap the value in an array if not an array", () => { it("should wrap the value in an array if not an array", () => {
expect( expect(
arrayify({ util.arrayify({
name: "Coder", name: "Coder",
version: "3.8", version: "3.8",
}), }),
@ -202,21 +191,21 @@ describe("util", () => {
}) })
it("should return an empty array if the value is undefined", () => { it("should return an empty array if the value is undefined", () => {
expect(arrayify(undefined)).toStrictEqual([]) expect(util.arrayify(undefined)).toStrictEqual([])
}) })
}) })
describe("getFirstString", () => { describe("getFirstString", () => {
it("should return the string if passed a string", () => { it("should return the string if passed a string", () => {
expect(getFirstString("Hello world!")).toBe("Hello world!") expect(util.getFirstString("Hello world!")).toBe("Hello world!")
}) })
it("should get the first string from an array", () => { it("should get the first string from an array", () => {
expect(getFirstString(["Hello", "World"])).toBe("Hello") expect(util.getFirstString(["Hello", "World"])).toBe("Hello")
}) })
it("should return undefined if the value isn't an array or a string", () => { it("should return undefined if the value isn't an array or a string", () => {
expect(getFirstString({ name: "Coder" })).toBe(undefined) expect(util.getFirstString({ name: "Coder" })).toBe(undefined)
}) })
}) })
@ -235,14 +224,14 @@ describe("util", () => {
const message = "You don't have access to that folder." const message = "You don't have access to that folder."
const error = new Error(message) const error = new Error(message)
logError(loggerModule.logger, "ui", error) util.logError(loggerModule.logger, "ui", error)
expect(loggerModule.logger.error).toHaveBeenCalled() expect(loggerModule.logger.error).toHaveBeenCalled()
expect(loggerModule.logger.error).toHaveBeenCalledWith(`ui: ${error.message} ${error.stack}`) expect(loggerModule.logger.error).toHaveBeenCalledWith(`ui: ${error.message} ${error.stack}`)
}) })
it("should log an error, even if not an instance of error", () => { it("should log an error, even if not an instance of error", () => {
logError(loggerModule.logger, "api", "oh no") util.logError(loggerModule.logger, "api", "oh no")
expect(loggerModule.logger.error).toHaveBeenCalled() expect(loggerModule.logger.error).toHaveBeenCalled()
expect(loggerModule.logger.error).toHaveBeenCalledWith("api: oh no") expect(loggerModule.logger.error).toHaveBeenCalledWith("api: oh no")