From 4c139b716648ff773b2f7ccfe9319bbb07eda2de Mon Sep 17 00:00:00 2001 From: Manuel Astudillo Date: Wed, 18 Sep 2024 15:26:44 +0200 Subject: [PATCH] test: fix lazy let's encrypt tests --- lib/proxy.ts | 6 +- test/letsencrypt_certificates.spec.ts | 60 ++++++++++- test/letsencrypt_lazy_certificates.spec.ts | 110 --------------------- 3 files changed, 62 insertions(+), 114 deletions(-) delete mode 100644 test/letsencrypt_lazy_certificates.spec.ts diff --git a/lib/proxy.ts b/lib/proxy.ts index 543f7d7..6362a34 100755 --- a/lib/proxy.ts +++ b/lib/proxy.ts @@ -774,6 +774,9 @@ export class Redbird { } async close() { + this.proxy.close(); + this.agent && this.agent.destroy(); + // Clear any renewal timers if (this.certs) { Object.keys(this.certs).forEach((domain) => { @@ -788,11 +791,10 @@ export class Redbird { this.letsencryptServer?.close(); await Promise.all( - [this.proxy, this.server, this.httpsServer] + [this.server, this.httpsServer] .filter((s) => s) .map((server) => new Promise((resolve) => server.close(resolve))) ); - this.agent && this.agent.destroy(); } // diff --git a/test/letsencrypt_certificates.spec.ts b/test/letsencrypt_certificates.spec.ts index b103201..22f7753 100644 --- a/test/letsencrypt_certificates.spec.ts +++ b/test/letsencrypt_certificates.spec.ts @@ -85,6 +85,8 @@ function makeHttpsRequest(options) { }); } +const responseMessage = 'Hello from target server' + describe('Redbird Lets Encrypt SSL Certificate Generation', () => { let proxy: Redbird; let targetServer: Server; @@ -94,7 +96,7 @@ describe('Redbird Lets Encrypt SSL Certificate Generation', () => { // Start a simple HTTP server to act as the backend target targetServer = http.createServer((req, res) => { res.writeHead(200, { 'Content-Type': 'text/plain' }); - res.end('Hello from target server'); + res.end(responseMessage); }); await new Promise((resolve) => { @@ -156,7 +158,7 @@ describe('Redbird Lets Encrypt SSL Certificate Generation', () => { const response = await makeHttpsRequest(options); expect(response.status).toBe(200); - expect(response.data).toBe('Hello from target server'); + expect(response.data).toBe(responseMessage); }); it('should renew SSL certificates that are halfway to expire', async () => { @@ -232,4 +234,58 @@ describe('Redbird Lets Encrypt SSL Certificate Generation', () => { // Restore real timers vi.useRealTimers(); }); + + it('should not request certificates immediately for lazy loaded domains', async () => { + // Reset mocks + getCertificatesMock.mockClear(); + + // Simulate registering a domain with lazy loading enabled + await proxy.register('https://lazy.example.com', `http://localhost:${TEST_PORT}`, { + ssl: { + letsencrypt: { + email: 'email@example.com', + production: false, + lazy: true, + }, + }, + }); + + // Check that certificates were not requested during registration + expect(getCertificatesMock).not.toHaveBeenCalled(); + }); + + it('should request and cache certificates on first HTTPS request for lazy certificates', async () => { + // Reset mocks + getCertificatesMock.mockClear(); + + // Make an HTTPS request to trigger lazy loading of certificates + const options = { + hostname: 'localhost', + port: 8443, + path: '/', + method: 'GET', + headers: { Host: 'lazy.example.com' }, // Required for virtual hosts + rejectUnauthorized: false, // Accept self-signed certificates + }; + + const response = await new Promise<{ statusCode: number; data: string }>((resolve, reject) => { + const req = https.request(options, (res) => { + let data = ''; + res.on('data', (chunk) => { + data += chunk; + }); + res.on('end', () => { + resolve({ statusCode: res.statusCode || 0, data }); + }); + }); + req.on('error', reject); + req.end(); + }); + + expect(response.statusCode).toBe(200); + expect(response.data).toBe(responseMessage); + + // Ensure that certificates are now loaded + expect(getCertificatesMock).toHaveBeenCalled(); + }); }); diff --git a/test/letsencrypt_lazy_certificates.spec.ts b/test/letsencrypt_lazy_certificates.spec.ts deleted file mode 100644 index db2d0d1..0000000 --- a/test/letsencrypt_lazy_certificates.spec.ts +++ /dev/null @@ -1,110 +0,0 @@ -import { describe, it, expect, beforeAll, afterAll, vi } from 'vitest'; -import http, { createServer } from 'http'; -import { Redbird } from '../lib/proxy'; // Adjust the path as necessary -import https from 'https'; -import { certificate, key } from './fixtures'; - -const TEST_PORT = 3030; -// Mock the letsencrypt module -vi.mock('../lib/letsencrypt', () => ({ - getCertificates: vi.fn().mockImplementation(async () => ({ - privkey: key, - cert: certificate, - chain: 'chain', - expiresAt: Date.now() + 90 * 24 * 3600 * 1000, // Certificate valid for 90 days - })), - init: vi.fn(), -})); - -// Import the mocked getCertificates function -import { getCertificates } from '../lib/letsencrypt'; // Path should match the module being mocked -const mockedGetCertificates = vi.mocked(getCertificates); - -// Setup and teardown the proxy and HTTP server -describe('Lazy SSL Certificate Handling', () => { - let server: http.Server; - let proxy: Redbird; - - beforeAll(async () => { - // Create an HTTP server that the proxy will use - server = createServer((req, res) => { - res.writeHead(200); - res.end('Hello, world!'); - }); - await new Promise((resolve) => server.listen(TEST_PORT, resolve)); - - // Setup Redbird proxy - proxy = new Redbird({ - port: 8080, - ssl: { - port: 8443, // This is the SSL port the proxy will use for HTTPS - }, - letsencrypt: { - path: '/path/to/certs', // Ensure this is configured as expected - port: 9999, // ACME challenges port - }, - }); - }); - - afterAll(async () => { - await proxy.close(); - console.log('Closing server'); - await new Promise((resolve) => server.close(() => resolve())); - console.log('Server closed'); - vi.restoreAllMocks(); - }); - - it('should not request certificates immediately for lazy loaded domains', async () => { - // Reset mocks - mockedGetCertificates.mockClear(); - - // Simulate registering a domain with lazy loading enabled - await proxy.register('https://lazy.example.com', `http://localhost:${TEST_PORT}`, { - ssl: { - letsencrypt: { - email: 'email@example.com', - production: false, - lazy: true, - }, - }, - }); - - // Check that certificates were not requested during registration - expect(mockedGetCertificates).not.toHaveBeenCalled(); - }); - - it('should request and cache certificates on first HTTPS request', async () => { - // Reset mocks - mockedGetCertificates.mockClear(); - - // Make an HTTPS request to trigger lazy loading of certificates - const options = { - hostname: 'localhost', - port: 8443, - path: '/', - method: 'GET', - headers: { Host: 'lazy.example.com' }, // Required for virtual hosts - rejectUnauthorized: false, // Accept self-signed certificates - }; - - const response = await new Promise<{ statusCode: number; data: string }>((resolve, reject) => { - const req = https.request(options, (res) => { - let data = ''; - res.on('data', (chunk) => { - data += chunk; - }); - res.on('end', () => { - resolve({ statusCode: res.statusCode || 0, data }); - }); - }); - req.on('error', reject); - req.end(); - }); - - expect(response.statusCode).toBe(200); - expect(response.data).toBe('Hello, world!'); - - // Ensure that certificates are now loaded - expect(mockedGetCertificates).toHaveBeenCalled(); - }); -});