From c3b166bd8f383184128c1c28719bc34173a9b5f7 Mon Sep 17 00:00:00 2001 From: Louis Lam Date: Wed, 27 Dec 2023 19:31:17 +0800 Subject: [PATCH] WIP --- test/backend-test/README.md | 11 +- test/backend-test/test-general.js | 273 ++++++++++++++++++++ test/backend-test/test-uptime-calculator.js | 18 +- test/backend-test/util.js | 22 ++ 4 files changed, 300 insertions(+), 24 deletions(-) create mode 100644 test/backend-test/test-general.js create mode 100644 test/backend-test/util.js diff --git a/test/backend-test/README.md b/test/backend-test/README.md index 5686fae78..9a0e9b3fb 100644 --- a/test/backend-test/README.md +++ b/test/backend-test/README.md @@ -7,16 +7,7 @@ Create a test file in this directory with the name `*.js`. ## Template ```js -const semver = require("semver"); -let test; -const nodeVersion = process.versions.node; -if (semver.satisfies(nodeVersion, ">= 18")) { - test = require("node:test"); -} else { - test = require("test"); -} - -const assert = require("node:assert"); +const { assert, test, describe, it } = require("./util"); test("Test name", async (t) => { assert.strictEqual(1, 1); diff --git a/test/backend-test/test-general.js b/test/backend-test/test-general.js new file mode 100644 index 000000000..2d004934e --- /dev/null +++ b/test/backend-test/test-general.js @@ -0,0 +1,273 @@ +const { assert, describe, it } = require("./util"); +const { DOWN, log } = require("../../src/util"); +const utilServer = require("../../server/util-server"); +const Discord = require("../../server/notification-providers/discord"); +const { UptimeKumaServer } = require("../../server/uptime-kuma-server"); +const Database = require("../../server/database"); +const { Settings } = require("../../server/settings"); +const fs = require("fs"); + +describe("Test parseCertificateInfo", () => { + it("should handle undefined", async () => { + const parseCertificateInfo = utilServer.__getPrivateFunction("parseCertificateInfo"); + const info = parseCertificateInfo(undefined); + assert.strictEqual(info, undefined); + }, 5000); + + it("should handle normal cert chain", async () => { + const parseCertificateInfo = utilServer.__getPrivateFunction("parseCertificateInfo"); + + const chain1 = { + fingerprint: "CF:2C:F3:6A:FE:6B:10:EC:44:77:C8:95:BB:96:2E:06:1F:0E:15:DA", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain2 = { + fingerprint: "A0:31:C4:67:82:E6:E6:C6:62:C2:C8:7C:76:DA:9A:A6:2C:CA:BD:8E", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain3 = { + fingerprint: "5F:B7:EE:06:33:E2:59:DB:AD:0C:4C:9A:E6:D3:8F:1A:61:C7:DC:25", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + chain1.issuerCertificate = chain2; + chain2.issuerCertificate = chain3; + chain3.issuerCertificate = chain3; + + const info = parseCertificateInfo(chain1); + assert.strictEqual(chain1, info); + }, 5000); + + it("should handle cert chain with strange circle", async () => { + const parseCertificateInfo = utilServer.__getPrivateFunction("parseCertificateInfo"); + + const chain1 = { + fingerprint: "CF:2C:F3:6A:FE:6B:10:EC:44:77:C8:95:BB:96:2E:06:1F:0E:15:DA", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain2 = { + fingerprint: "A0:31:C4:67:82:E6:E6:C6:62:C2:C8:7C:76:DA:9A:A6:2C:CA:BD:8E", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain3 = { + fingerprint: "5F:B7:EE:06:33:E2:59:DB:AD:0C:4C:9A:E6:D3:8F:1A:61:C7:DC:25", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain4 = { + fingerprint: "haha", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + chain1.issuerCertificate = chain2; + chain2.issuerCertificate = chain3; + chain3.issuerCertificate = chain4; + chain4.issuerCertificate = chain2; + + const info = parseCertificateInfo(chain1); + assert.strictEqual(chain1, info); + }, 5000); + + it("should handle cert chain with last undefined (should be happen in real, but just in case)", async () => { + const parseCertificateInfo = utilServer.__getPrivateFunction("parseCertificateInfo"); + + const chain1 = { + fingerprint: "CF:2C:F3:6A:FE:6B:10:EC:44:77:C8:95:BB:96:2E:06:1F:0E:15:DA", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain2 = { + fingerprint: "A0:31:C4:67:82:E6:E6:C6:62:C2:C8:7C:76:DA:9A:A6:2C:CA:BD:8E", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain3 = { + fingerprint: "5F:B7:EE:06:33:E2:59:DB:AD:0C:4C:9A:E6:D3:8F:1A:61:C7:DC:25", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + const chain4 = { + fingerprint: "haha", + valid_from: "Oct 22 12:00:00 2013 GMT", + valid_to: "Oct 22 12:00:00 2028 GMT", + subjectaltname: "DNS:www.example.org, DNS:example.com, DNS:example.edu, DNS:example.net, DNS:example.org, DNS:www.example.com, DNS:www.example.edu, DNS:www.example.net", + }; + + chain1.issuerCertificate = chain2; + chain2.issuerCertificate = chain3; + chain3.issuerCertificate = chain4; + chain4.issuerCertificate = undefined; + + const info = parseCertificateInfo(chain1); + assert.strictEqual(chain1, info); + }, 5000); +}); + +describe("Test reset-password", () => { + it("should able to run", async () => { + await require("../../extra/reset-password").main(); + }, 120000); +}); + +describe("Test Discord Notification Provider", () => { + const hostname = "discord.com"; + const port = 1337; + + const sendNotification = async (hostname, port, type) => { + const discordProvider = new Discord(); + + // TODO + // axios.post.mockResolvedValue({}); + + await discordProvider.send( + { + discordUsername: "Uptime Kuma", + discordWebhookUrl: "https://discord.com", + }, + "test message", + { + type, + hostname, + port, + }, + { + status: DOWN, + } + ); + }; + + it("should send hostname for ping monitors", async () => { + await sendNotification(hostname, null, "ping"); + // TODO + // assert.strictEqual(axios.post.mock.lastCall[1].embeds[0].fields[1].value, hostname); + }); + + // TODO + //it.each([ "dns", "port", "steam" ])("should send hostname for %p monitors", async (type) => { + // await sendNotification(hostname, port, type); + // TODO + // expect(axios.post.mock.lastCall[1].embeds[0].fields[1].value).toBe(`${hostname}:${port}`); + //}); +}); + +describe("The function filterAndJoin", () => { + it("should join and array of strings to one string", () => { + const result = utilServer.filterAndJoin([ "one", "two", "three" ]); + assert.strictEqual(result, "onetwothree"); + }); + + it("should join strings using a given connector", () => { + const result = utilServer.filterAndJoin([ "one", "two", "three" ], "-"); + assert.strictEqual(result, "one-two-three"); + }); + + it("should filter null, undefined and empty strings before joining", () => { + const result = utilServer.filterAndJoin([ undefined, "", "three" ], "--"); + assert.strictEqual(result, "three"); + }); + + it("should return an empty string if all parts are filtered out", () => { + const result = utilServer.filterAndJoin([ undefined, "", "" ], "--"); + assert.strictEqual(result, ""); + }); +}); + +// TODO: Move to e2e for simplicity? +describe("Test uptimeKumaServer.getClientIP()", () => { + it("should able to get a correct client IP", async () => { + return; + const fakeSocket = { + client: { + conn: { + remoteAddress: "192.168.10.10", + request: { + headers: { + } + } + } + } + }; + const server = Object.create(UptimeKumaServer.prototype); + let ip = await server.getClientIP(fakeSocket); + + await Settings.set("trustProxy", false); + assert.strictEqual(await Settings.get("trustProxy"), false); + + assert.strictEqual(ip, "192.168.10.10"); + + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "10.10.10.10"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "192.168.10.10"); + + fakeSocket.client.conn.request.headers["x-real-ip"] = "20.20.20.20"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "192.168.10.10"); + + await Settings.set("trustProxy", true); + assert.strictEqual(await Settings.get("trustProxy"), true); + + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "10.10.10.10"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "10.10.10.10"); + + // x-real-ip + delete fakeSocket.client.conn.request.headers["x-forwarded-for"]; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "20.20.20.20"); + + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "2001:db8:85a3:8d3:1319:8a2e:370:7348"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "2001:db8:85a3:8d3:1319:8a2e:370:7348"); + + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "203.0.113.195"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "203.0.113.195"); + + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "203.0.113.195, 2001:db8:85a3:8d3:1319:8a2e:370:7348"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "203.0.113.195"); + + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "203.0.113.195,2001:db8:85a3:8d3:1319:8a2e:370:7348,150.172.238.178"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "203.0.113.195"); + + // Elements are comma-separated, with optional whitespace surrounding the commas. + fakeSocket.client.conn.request.headers["x-forwarded-for"] = "203.0.113.195 , 2001:db8:85a3:8d3:1319:8a2e:370:7348,150.172.238.178"; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "203.0.113.195"); + + fakeSocket.client.conn.remoteAddress = "2001:db8::1"; + fakeSocket.client.conn.request.headers = {}; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "2001:db8::1"); + + fakeSocket.client.conn.remoteAddress = "::ffff:127.0.0.1"; + fakeSocket.client.conn.request.headers = {}; + ip = await server.getClientIP(fakeSocket); + assert.strictEqual(ip, "127.0.0.1"); + }, 120000); +}); diff --git a/test/backend-test/test-uptime-calculator.js b/test/backend-test/test-uptime-calculator.js index b4ccc3123..9e1c73461 100644 --- a/test/backend-test/test-uptime-calculator.js +++ b/test/backend-test/test-uptime-calculator.js @@ -1,14 +1,4 @@ -const semver = require("semver"); -let test; -const nodeVersion = process.versions.node; -// Node.js version >= 18 -if (semver.satisfies(nodeVersion, ">= 18")) { - test = require("node:test"); -} else { - test = require("test"); -} - -const assert = require("node:assert"); +const { assert, test } = require("./util"); const { UptimeCalculator } = require("../../server/uptime-calculator"); const dayjs = require("dayjs"); const { UP, DOWN, PENDING, MAINTENANCE } = require("../../src/util"); @@ -368,9 +358,9 @@ function memoryUsage() { } test("Worst case", async (t) => { - - // Disable on GitHub Actions, as it is not stable on it - if (process.env.GITHUB_ACTIONS) { + // Change to true if you want to run this test + let disable = true; + if (disable) { return; } diff --git a/test/backend-test/util.js b/test/backend-test/util.js new file mode 100644 index 000000000..e1c95c79d --- /dev/null +++ b/test/backend-test/util.js @@ -0,0 +1,22 @@ +const semver = require("semver"); +let test; +const nodeVersion = process.versions.node; +// Node.js version >= 18 +if (semver.satisfies(nodeVersion, ">= 18")) { + test = require("node:test"); +} else { + test = require("test"); +} + +const assert = require("node:assert"); +const describe = test.describe; +const it = test.it; +const mock = test.mock; + +module.exports = { + test, + assert, + describe, + it, + mock, +};