Skip to content

Commit

Permalink
Auto assign port for testing server
Browse files Browse the repository at this point in the history
  • Loading branch information
nazarhussain committed Feb 6, 2024
1 parent a73adb8 commit b49ce0b
Show file tree
Hide file tree
Showing 12 changed files with 71 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {getRoutes} from "../../../../src/beacon/server/beacon.js";
import {runGenericServerTest} from "../../../utils/genericServerTest.js";
import {testData} from "../testData/beacon.js";

describe.sequential("beacon / beacon", () => {
describe("beacon / beacon", () => {
runGenericServerTest<Api, ReqTypes>(
// eslint-disable-next-line @typescript-eslint/naming-convention
createChainForkConfig({...defaultChainConfig, ALTAIR_FORK_EPOCH: 1, BELLATRIX_FORK_EPOCH: 2}),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {testData} from "../testData/config.js";

/* eslint-disable @typescript-eslint/naming-convention */

describe.sequential("beacon / config", () => {
describe("beacon / config", () => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);

it("Serialize Partial Spec object", () => {
Expand Down
24 changes: 18 additions & 6 deletions packages/api/test/unit/beacon/genericServerTest/debug.test.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {describe, it, expect, MockInstance} from "vitest";
import {describe, it, expect, MockInstance, beforeAll, afterAll} from "vitest";
import {toHexString} from "@chainsafe/ssz";
import {FastifyInstance} from "fastify";
import {ssz} from "@lodestar/types";
import {config} from "@lodestar/config/default";
import {Api, ReqTypes, routesData} from "../../../../src/beacon/routes/debug.js";
Expand All @@ -11,19 +12,30 @@ import {registerRoute} from "../../../../src/utils/server/registerRoute.js";
import {HttpClient} from "../../../../src/utils/client/httpClient.js";
import {testData} from "../testData/debug.js";

describe.sequential(
describe(
"beacon / debug",
() => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);

// Get state by SSZ

describe("getState() in SSZ format", () => {
const {baseUrl, server} = getTestServer();
const mockApi = getMockApi<Api>(routesData);
for (const route of Object.values(getRoutes(config, mockApi))) {
registerRoute(server, route);
}
let baseUrl: string;
let server: FastifyInstance;

beforeAll(async () => {
const res = getTestServer();
server = res.server;
for (const route of Object.values(getRoutes(config, mockApi))) {
registerRoute(server, route);
}
baseUrl = await res.start();
});

afterAll(async () => {
if (server !== undefined) await server.close();
});

for (const method of ["getState" as const, "getStateV2" as const]) {
it(method, async () => {
Expand Down
23 changes: 18 additions & 5 deletions packages/api/test/unit/beacon/genericServerTest/events.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import {describe, it, expect, beforeEach, afterEach} from "vitest";
import {describe, it, expect, beforeEach, afterEach, beforeAll, afterAll} from "vitest";
import {FastifyInstance} from "fastify";
import {sleep} from "@lodestar/utils";
import {Api, routesData, EventType, BeaconEvent} from "../../../../src/beacon/routes/events.js";
import {getClient} from "../../../../src/beacon/client/events.js";
Expand All @@ -8,11 +9,23 @@ import {getMockApi, getTestServer} from "../../../utils/utils.js";
import {eventTestData} from "../testData/events.js";

describe("beacon / events", () => {
const {baseUrl, server} = getTestServer();
const mockApi = getMockApi<Api>(routesData);
for (const route of Object.values(getRoutes(mockApi))) {
registerRoute(server, route);
}
let server: FastifyInstance;
let baseUrl: string;

beforeAll(async () => {
const res = getTestServer();
server = res.server;
for (const route of Object.values(getRoutes(mockApi))) {
registerRoute(server, route);
}

baseUrl = await res.start();
});

afterAll(async () => {
if (server !== undefined) await server.close();
});

let controller: AbortController;
beforeEach(() => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ import {getRoutes} from "../../../../src/beacon/server/lightclient.js";
import {runGenericServerTest} from "../../../utils/genericServerTest.js";
import {testData} from "../testData/lightclient.js";

describe.sequential("beacon / lightclient", () => {
describe("beacon / lightclient", () => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);
});
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ import {getRoutes} from "../../../../src/beacon/server/node.js";
import {runGenericServerTest} from "../../../utils/genericServerTest.js";
import {testData} from "../testData/node.js";

describe.sequential("beacon / node", () => {
describe("beacon / node", () => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);
});
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ import {getRoutes} from "../../../../src/beacon/server/proof.js";
import {runGenericServerTest} from "../../../utils/genericServerTest.js";
import {testData} from "../testData/proofs.js";

describe.sequential("beacon / proofs", () => {
describe("beacon / proofs", () => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);
});
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {getRoutes} from "../../../../src/beacon/server/validator.js";
import {runGenericServerTest} from "../../../utils/genericServerTest.js";
import {testData} from "../testData/validator.js";

describe.sequential("beacon / validator", () => {
describe("beacon / validator", () => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);

// TODO: Extra tests to implement maybe
Expand Down
2 changes: 1 addition & 1 deletion packages/api/test/unit/builder/builder.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {getRoutes} from "../../../src/builder/server/index.js";
import {runGenericServerTest} from "../../utils/genericServerTest.js";
import {testData} from "./testData.js";

describe.sequential("builder", () => {
describe("builder", () => {
runGenericServerTest<Api, ReqTypes>(
createChainForkConfig({
...defaultChainConfig,
Expand Down
2 changes: 1 addition & 1 deletion packages/api/test/unit/keymanager/keymanager.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ import {getRoutes} from "../../../src/keymanager/server/index.js";
import {runGenericServerTest} from "../../utils/genericServerTest.js";
import {testData} from "./testData.js";

describe.sequential("keymanager", () => {
describe("keymanager", () => {
runGenericServerTest<Api, ReqTypes>(config, getClient, getRoutes, testData);
});
28 changes: 21 additions & 7 deletions packages/api/test/utils/genericServerTest.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import {it, expect, MockInstance, describe} from "vitest";
import {it, expect, MockInstance, describe, beforeAll, afterAll} from "vitest";
import {FastifyInstance} from "fastify";
import {ChainForkConfig} from "@lodestar/config";
import {ReqGeneric, Resolves} from "../../src/utils/index.js";
import {FetchOpts, HttpClient, IHttpClient} from "../../src/utils/client/index.js";
Expand Down Expand Up @@ -28,14 +29,27 @@ export function runGenericServerTest<
testCases: GenericServerTestCases<Api>
): void {
const mockApi = getMockApi<Api>(testCases);
const {baseUrl, server} = getTestServer();
let server: FastifyInstance;

const httpClient = new HttpClientSpy({baseUrl});
const client = getClient(config, httpClient);
let client: Api;
let httpClient: HttpClientSpy;

for (const route of Object.values(getRoutes(config, mockApi))) {
registerRoute(server, route);
}
beforeAll(async () => {
const res = getTestServer();
server = res.server;

for (const route of Object.values(getRoutes(config, mockApi))) {
registerRoute(server, route);
}

const baseUrl = await res.start();
httpClient = new HttpClientSpy({baseUrl});
client = getClient(config, httpClient);
});

afterAll(async () => {
if (server !== undefined) await server.close();
});

describe("run generic server tests", () => {
it.each(Object.keys(testCases))("%s", async (key) => {
Expand Down
20 changes: 6 additions & 14 deletions packages/api/test/utils/utils.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
import {beforeAll, afterAll, MockedObject, vi} from "vitest";
import {MockedObject, vi} from "vitest";
import qs from "qs";
import fastify, {FastifyInstance} from "fastify";
import {mapValues} from "@lodestar/utils";
import {ServerApi} from "../../src/interfaces.js";

export function getTestServer(): {baseUrl: string; server: FastifyInstance} {
const port = Math.floor(Math.random() * (65535 - 49152)) + 49152;
const baseUrl = `http://localhost:${port}`;

export function getTestServer(): {server: FastifyInstance; start: () => Promise<string>} {
const server = fastify({
ajv: {customOptions: {coerceTypes: "array"}},
querystringParser: (str) => qs.parse(str, {comma: true, parseArrays: false}),
Expand All @@ -19,23 +16,18 @@ export function getTestServer(): {baseUrl: string; server: FastifyInstance} {
done();
});

beforeAll(async () => {
await new Promise((resolve, reject) => {
server.listen({port}, function (err, address) {
const start = (): Promise<string> =>
new Promise<string>((resolve, reject) => {
server.listen({port: 0}, function (err, address) {
if (err !== null && err != undefined) {
reject(err);
} else {
resolve(address);
}
});
});
});

afterAll(async () => {
await server.close();
});

return {baseUrl, server};
return {start, server};
}

export function getMockApi<Api extends Record<string, any>>(
Expand Down

0 comments on commit b49ce0b

Please sign in to comment.