diff options
Diffstat (limited to 'src/routes.test.ts')
| -rw-r--r-- | src/routes.test.ts | 217 |
1 files changed, 171 insertions, 46 deletions
diff --git a/src/routes.test.ts b/src/routes.test.ts index b4979d6..3579011 100644 --- a/src/routes.test.ts +++ b/src/routes.test.ts @@ -1,4 +1,4 @@ -import _request from "supertest"; +import _request, { SuperTest, Test } from "supertest"; import express from "express"; import dotenv from "dotenv"; import fs from "fs"; @@ -8,9 +8,10 @@ dotenv.config(); process.env.UPLOAD_LIMIT = "40000"; -import { configOrError } from "./util/config"; +import { configOrError, persistTemplate } from "./util/config"; import routes from "./routes"; import Metadata from "./metadata"; +import { Template } from "./templates"; import { Db } from "mongodb"; import { badgen } from "badgen"; import { BranchNotFoundError } from "./errors"; @@ -22,28 +23,44 @@ type MetadataMockType = { createRepository: jest.Mock; }; -const mock = (headCommit: jest.Mock = jest.fn(() => new Promise(solv => solv("testcommit"))), updateBranch: jest.Mock = jest.fn(() => new Promise(solv => solv(true)))): MetadataMockType => ({ +const mock = ( + headCommit: jest.Mock = jest.fn( + () => new Promise(solv => solv("testcommit")) + ), + updateBranch: jest.Mock = jest.fn(() => new Promise(solv => solv(true))) +): MetadataMockType => ({ database: {} as Db, getHeadCommit: headCommit, updateBranch: updateBranch, createRepository: jest.fn() }); -const request = (mockMeta: MetadataMockType = mock()) => { +const request = (mockMeta: MetadataMockType = mock()): SuperTest<Test> => { const app = express(); app.use(routes(mockMeta as Metadata)); return _request(app); -} +}; const HOST_DIR = configOrError("HOST_DIR"); const TARGET_URL = process.env.TARGET_URL ?? "http://localhost:3000"; const TOKEN = process.env.TOKEN ?? ""; describe("templates", () => { - describe("GET /bash", () => { - it("should return the bash file containing tbe curl command", async () => { + it("should return the bash file containing the curl command", async () => { + await persistTemplate({ + inputFile: path.join( + __dirname, + "..", + "public", + "templates", + "bash.template" + ), + outputFile: path.join(HOST_DIR, "bash"), + context: { TARGET_URL } + } as Template); + const res = await request() .get("/bash") .expect(200); @@ -54,20 +71,69 @@ describe("templates", () => { describe("GET /", () => { it("should return the index HTML file containing the bash command", async () => { + await persistTemplate({ + inputFile: path.join( + __dirname, + "..", + "public", + "templates", + "index.html.template" + ), + outputFile: path.join(HOST_DIR, "index.html"), + context: { TARGET_URL } + } as Template); + const res = await request() .get("/") .expect("Content-Type", /html/) .expect(200); expect(res.text).toMatch(`bash <(curl -s ${TARGET_URL}/bash)`); - }) + }); }); }); -describe("Badges and reports", () => { +describe("Static files", () => { + const staticRoot = path.join(__dirname, "..", "public", "static"); + + it("should return favicon.ico at GET /favicon.ico", async () => { + const buffer = await fs.promises.readFile( + path.join(staticRoot, "favicon.ico") + ); + + await request() + .get("/favicon.ico") + .expect("Content-Type", /icon/) + .expect(buffer) + .expect(200); + }); + + it("should return index.css at GET /static/index.css", async () => { + const buffer = await fs.promises.readFile( + path.join(staticRoot, "index.css") + ); + + const res = await request() + .get("/static/index.css") + .expect(200); + expect(res.text).toEqual(buffer.toString("utf-8")); + }); +}); - const report_path = path.join(HOST_DIR, "testorg", "testrepo", "testbranch", "testcommit"); - const actual_report = path.join(__dirname, "..", "example_reports", "tarpaulin-report.html"); - const fake_badge = badgen({ +describe("Badges and reports", () => { + const reportPath = path.join( + HOST_DIR, + "testorg", + "testrepo", + "testbranch", + "testcommit" + ); + const actualReport = path.join( + __dirname, + "..", + "example_reports", + "tarpaulin-report.html" + ); + const fakeBadge = badgen({ label: "coverage", status: "120%", color: "#E1C" @@ -75,9 +141,12 @@ describe("Badges and reports", () => { beforeAll(async () => { // place test files on HOST_DIR - await fs.promises.mkdir(report_path, { recursive: true }); - await fs.promises.copyFile(actual_report, path.join(report_path, "index.html")); - await fs.promises.writeFile(path.join(report_path, "badge.svg"), fake_badge); + await fs.promises.mkdir(reportPath, { recursive: true }); + await fs.promises.copyFile( + actualReport, + path.join(reportPath, "index.html") + ); + await fs.promises.writeFile(path.join(reportPath, "badge.svg"), fakeBadge); }); describe("GET /v1/:org/:repo/:branch/:commit.html", () => { @@ -86,13 +155,15 @@ describe("Badges and reports", () => { .get("/v1/testorg/testrepo/testbranch/testcommit.html") .expect("Content-Type", /html/) .expect(200); - const buffer = await fs.promises.readFile(actual_report); + const buffer = await fs.promises.readFile(actualReport); expect(res.text).toEqual(buffer.toString("utf-8")); }); it("should return 404 if file does not exist", async () => { - await request().get("/v1/neorg/nerepo/nebranch/necommit.html").expect(404); + await request() + .get("/v1/neorg/nerepo/nebranch/necommit.html") + .expect(404); }); }); @@ -103,24 +174,32 @@ describe("Badges and reports", () => { .get("/v1/testorg/testrepo/testbranch.html") .expect("Content-Type", /html/) .expect(200); - const buffer = await fs.promises.readFile(actual_report); + const buffer = await fs.promises.readFile(actualReport); expect(mockMeta.getHeadCommit).toHaveBeenCalledTimes(1); expect(res.text).toEqual(buffer.toString("utf-8")); }); it("should return 404 if file does not exist", async () => { - await request().get("/v1/neorg/nerepo/nebranch.html").expect(404); + await request() + .get("/v1/neorg/nerepo/nebranch.html") + .expect(404); }); it("should return 404 if head commit not found", async () => { - const head = jest.fn(() => new Promise(solv => solv(new BranchNotFoundError()))); - await request(mock(head)).get("/v1/testorg/testrepo/testbranch.html").expect(404); + const head = jest.fn( + () => new Promise(solv => solv(new BranchNotFoundError())) + ); + await request(mock(head)) + .get("/v1/testorg/testrepo/testbranch.html") + .expect(404); }); it("should return 500 if promise is rejected", async () => { const head = jest.fn(() => new Promise((_, rej) => rej("fooey"))); - await request(mock(head)).get("/v1/testorg/testrepo/testbranch.html").expect(500); + await request(mock(head)) + .get("/v1/testorg/testrepo/testbranch.html") + .expect(500); }); }); @@ -131,11 +210,13 @@ describe("Badges and reports", () => { .expect("Content-Type", /svg/) .expect(200); - expect(res.body.toString("utf-8")).toEqual(fake_badge); + expect(res.body.toString("utf-8")).toEqual(fakeBadge); }); it("should return 404 if file does not exist", async () => { - await request().get("/v1/neorg/nerepo/nebranch/necommit.svg").expect(404); + await request() + .get("/v1/neorg/nerepo/nebranch/necommit.svg") + .expect(404); }); }); @@ -148,82 +229,124 @@ describe("Badges and reports", () => { .expect(200); expect(mockMeta.getHeadCommit).toHaveBeenCalledTimes(1); - expect(res.body.toString("utf-8")).toEqual(fake_badge); + expect(res.body.toString("utf-8")).toEqual(fakeBadge); }); it("should return 404 if file does not exist", async () => { - await request().get("/v1/neorg/nerepo/nebranch.svg").expect(404); + await request() + .get("/v1/neorg/nerepo/nebranch.svg") + .expect(404); }); it("should return 404 if head commit not found", async () => { - const head = jest.fn(() => new Promise(solv => solv(new BranchNotFoundError()))); - await request(mock(head)).get("/v1/testorg/testrepo/testbranch.svg").expect(404); + const head = jest.fn( + () => new Promise(solv => solv(new BranchNotFoundError())) + ); + await request(mock(head)) + .get("/v1/testorg/testrepo/testbranch.svg") + .expect(404); }); it("should return 500 if promise is rejected", async () => { const head = jest.fn(() => new Promise((_, rej) => rej("fooey"))); - await request(mock(head)).get("/v1/testorg/testrepo/testbranch.svg").expect(500); + await request(mock(head)) + .get("/v1/testorg/testrepo/testbranch.svg") + .expect(500); }); }); }); describe("Uploads", () => { - - const report_path = path.join(HOST_DIR, "testorg", "testrepo", "newthis", "newthat"); - const data = fs.promises.readFile(path.join(__dirname, "..", "example_reports", "tarpaulin-report.html")); + const reportPath = path.join( + HOST_DIR, + "testorg", + "testrepo", + "newthis", + "newthat" + ); + const data = fs.promises.readFile( + path.join(__dirname, "..", "example_reports", "tarpaulin-report.html") + ); beforeEach(async () => { - await fs.promises.rmdir(report_path).catch(() => { }); + try { + await fs.promises.rmdir(reportPath); + } catch (err) { + // ignore failures for rmdir + } }); describe("POST /v1/:org/:repo/:branch/:commit.html", () => { it("should upload the report and generate a badge", async () => { const mockMeta = mock(); await request(mockMeta) - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin`) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin` + ) .send(await data) .expect(200); - expect(mockMeta.updateBranch).toBeCalledWith({ organization: "testorg", repository: "testrepo", branch: "newthis", head: "newthat" }); + expect(mockMeta.updateBranch).toBeCalledWith({ + organization: "testorg", + repository: "testrepo", + branch: "newthis", + head: "newthat" + }); expect(mockMeta.updateBranch).toHaveBeenCalledTimes(1); - await fs.promises.access(path.join(report_path, "index.html"), fs.constants.R_OK); - await fs.promises.access(path.join(report_path, "badge.svg"), fs.constants.R_OK); + await fs.promises.access( + path.join(reportPath, "index.html"), + fs.constants.R_OK + ); + await fs.promises.access( + path.join(reportPath, "badge.svg"), + fs.constants.R_OK + ); }); it("should return 401 when token is not correct", async () => { await request() - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=wrong&format=tarpaulin`) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=wrong&format=tarpaulin` + ) .send(await data) .expect(401); }); it("should return 406 with an invalid format", async () => { await request() - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=pepperoni`) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=pepperoni` + ) .send(await data) .expect(406); }); it("should return 400 when request body is not the appropriate format", async () => { await request() - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin`) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin` + ) .send("This is not a file") .expect(400); }); it("should return 413 when request body is not the appropriate format", async () => { const file = await data; - const big_data = Buffer.concat([file, file]); + const bigData = Buffer.concat([file, file]); await request() - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin`) - .send(big_data) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin` + ) + .send(bigData) .expect(413); }); it("should return 500 when Metadata does not create branch", async () => { const update = jest.fn(() => new Promise(solv => solv(false))); await request(mock(jest.fn(), update)) - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin`) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin` + ) .send(await data) .expect(500); }); @@ -231,9 +354,11 @@ describe("Uploads", () => { it("should return 500 when promise chain is rejected", async () => { const update = jest.fn(() => new Promise((_, rej) => rej("fooey 2"))); await request(mock(jest.fn(), update)) - .post(`/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin`) + .post( + `/v1/testorg/testrepo/newthis/newthat.html?token=${TOKEN}&format=tarpaulin` + ) .send(await data) .expect(500); }); }); -});
\ No newline at end of file +}); |