Add e2e test

.github/workflows/test.yml

@@ -27,3 +27,5 @@ jobs:
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Test
         run: yarn test
+      - name: E2E Test
+        run: yarn e2e-test

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint",
+        "editorconfig.editorconfig"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always",
+  },
+  "javascript.format.enable": false
+}

babel.config.json

@@ -1,3 +1,13 @@
 {
-  "presets": ["@babel/preset-typescript"]
-}
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": "current"
+        }
+      }
+    ],
+    "@babel/preset-typescript"
+  ]
+}

docker/tests/README.md

@@ -0,0 +1,25 @@
+# Container End to End Tests
+
+- Run with `yarn run e2e-test`
+
+### Prequisites
+
+1. Install testcontainers: `yarn add -D testcontainers`
+
+2. Docker daemon running
+    - If using WSL and Docker Desktop, requires these steps:
+        1. Expose the Docker for Windows daemon on tcp port 2375 without TLS.
+    (Right-click the Docker Desktop icon on the task bar > Change Settings).
+        2. edit `/etc/docker` and add the following:
+        ```json
+            {"hosts": [
+                "tcp://0.0.0.0:2375",
+                "unix:///var/run/docker.sock"
+            ]}
+        ```
+
+        3. Set the DOCKER_HOST environment variable inside the WSL shell to tcp://localhost:2375. It is recommended to add this to your ~/.bashrc file, so it’s available every time you open your terminal: `export DOCKER_HOST=tcp://localhost:2375`
+            - https://java.testcontainers.org/supported_docker_environment/windows/#windows-subsystem-for-linux-wsl
+            - https://stackoverflow.com/questions/63416280/how-to-expose-docker-tcp-socket-on-wsl2-wsl-installed-docker-not-docker-deskt
+        - Debug with: `DEBUG=testcontainers* DOCKER_HOST=unix:///var/run/docker.sock yarn run e2e-test`
+            - https://node.testcontainers.org/configuration/#logs

docker/tests/container-util.ts

@@ -0,0 +1,96 @@
+import { writeFile } from 'fs/promises';
+import { GenericContainer, Wait } from 'testcontainers';
+
+
+/**
+ * Build an `actual-server` container from the root build context.
+ * Expose container port 5006 and wait until the Listening on... log message.
+ */
+export async function ActualServerBuild(buildContext = './'): Promise<GenericContainer> {
+  const newContainer = await GenericContainer
+    .fromDockerfile(buildContext)
+    .build();
+
+  return newContainer
+    .withExposedPorts(5006)
+    .withWaitStrategy(Wait.forLogMessage(/Listening on.*/))
+}
+
+/**
+ * Start a `caddy` instance with a generated Caddyfile.
+ *
+ * https://actualbudget.org/docs/config/reverse-proxies/#caddy
+ */
+export async function startCaddyContainer(actualServerPort: number):
+  Promise<import('testcontainers').StartedTestContainer> {
+  if (typeof actualServerPort !== 'number') throw Error("actualServerPort must be number!");
+
+  // write Caddyfile to disk for copying
+  const source = './Caddyfile';
+  const testCaddyfileContents = 'http://localhost {\n\tencode gzip zstd\n' +
+    '\treverse_proxy actual_server:' + actualServerPort.toString() + '\n}\n';
+  await writeFile(source, testCaddyfileContents);
+
+  const caddyContainer = new GenericContainer('caddy:latest')
+    .withCopyFilesToContainer([{ source, target: '/etc/caddyContainer/Caddyfile' }])
+    .withExposedPorts(80)
+    .withWaitStrategy(Wait.forListeningPorts());
+
+  return caddyContainer.start();
+}
+
+// services:\
+export async function startTraefikContainer(actualServerPort: number) {
+  // write Caddyfile to disk for copying
+  const source = './traefik.yaml';
+  const testTraeFikYamlContents = `
+  logLevel: "DEBUG"
+  entryPoints:
+    web:
+      address: ":80"
+
+  providers:
+    docker: {}
+  `;
+  await writeFile(source, testTraeFikYamlContents);
+
+  const traefikContainer = new GenericContainer("traefik:latest")
+    .withExposedPorts(80)
+    .withCopyFilesToContainer([{ source, target: "/etc/traefik/traefik.yaml" }])
+    .withBindMounts([{ source: "/var/run/docker.sock", target: "/var/run/docker.sock" }])
+    .withWaitStrategy(Wait.forHealthCheck())
+
+
+  return traefikContainer.start();
+}
+
+/**
+ * Start an `actual-server` from the root build context, using port 5006.
+ */
+// export async function startActualContainerWithTraefik(buildContext = './') {
+//   const newContainer = await GenericContainer
+//     .fromDockerfile(buildContext)
+//     .build();
+
+//   return newContainer
+//     .withExposedPorts(5006)
+//     .withWaitStrategy(Wait.forLogMessage(/Listening on.*/))
+//     .start();
+// }
+//   traefik:
+//     image: traefik:latest
+//     restart: unless-stopped
+//     ports:
+//       - "80:80"
+//     volumes:
+//       - "./traefik.yaml:/etc/traefik/traefik.yaml"
+//       - "./traefik/data:/data"
+//       - "/var/run/docker.sock:/var/run/docker.sock"
+
+//   actual-server:
+//     image: actualbudget/actual-server:latest-alpine
+//     restart: unless-stopped
+//     labels:
+
+//     volumes:
+//       - ./actual-data:/data

docker/tests/reverse-proxies.test.ts

@@ -0,0 +1,115 @@
+import { unlink } from 'fs/promises';
+import request from 'supertest';
+import { ActualServerBuild, startTraefikContainer } from './container-util.ts';
+import { StartedTestContainer } from 'testcontainers';
+
+
+// increase if docker build times out
+const CONTAINER_START_TIMEOUT_SECONDS = 90;
+// convert to milliseconds
+const CONTAINER_START_TIMEOUT_MS = CONTAINER_START_TIMEOUT_SECONDS * 1000;
+
+const ACTUAL_SERVER_DEFAULT_PORT = 5006;
+
+// describe('Actual Server with Caddy', () => {
+//   let actualServerContainer;
+//   let caddyContainer;
+
+//   beforeAll(async () => {
+//     actualServerContainer = await startActualContainer();
+//     caddyContainer = await startCaddyContainer(
+//       actualServerContainer.getMappedPort(ACTUAL_SERVER_DEFAULT_PORT),
+//     );
+//   }, CONTAINER_START_TIMEOUT_MS);
+
+//   it('should allow login', async () => {
+//     const hostname = caddyContainer.getHost();
+//     const port = caddyContainer.getMappedPort(80);
+//     const caddyHost = `${hostname}:${port}`;
+//     // console.log('Caddy host: ' + caddyHost);
+
+//     const caddyRequest = request(caddyHost);
+
+//     caddyRequest.get('/').then(res => {
+//       expect(res.statusCode).toBe(200)
+//     });
+//   });
+
+//   afterAll(async () => {
+//     if (caddyContainer) await caddyContainer.stop();
+//     if (actualServerContainer) await actualServerContainer.stop();
+
+//     // Delete Caddyfile from disk, if it exists
+//     await unlink('./Caddyfile').catch((_err) => {
+//       // don't care about ENOENT
+//       return;
+//     });
+//   });
+// });
+
+describe('Actual Server with Traefik', () => {
+  let actualServer: StartedTestContainer;
+  let traefik: StartedTestContainer;
+
+  beforeAll(async () => {
+    const builtActualServer = await ActualServerBuild();
+    actualServer = await builtActualServer
+      .withLabels({
+        "traefik.http.routers.actual-server.entrypoints": "web",
+      }).start()
+
+    traefik = await startTraefikContainer(actualServer.getMappedPort(ACTUAL_SERVER_DEFAULT_PORT));
+  }, CONTAINER_START_TIMEOUT_MS);
+
+  it('should return info', async () => {
+    const hostname = traefik.getHost();
+    const port = traefik.getMappedPort(80);
+    const hostConnectionString = `http://${hostname}:${port}`;
+
+    request(hostConnectionString)
+      .get('/info')
+      .then(res => {
+        // console.log(res);
+        expect(res.statusCode).toBe(200)
+      });
+
+  });
+
+  afterAll(async () => {
+    if (actualServer) await actualServer.stop();
+    if (traefik) await traefik.stop();
+
+    // Delete traefik.yml from disk, if it exists
+    await unlink('./traefik.yaml').catch((_err) => {
+      // don't care about ENOENT
+      return;
+    });
+  });
+});
+
+describe('Actual Server by itself', () => {
+  let actualServer: StartedTestContainer;
+
+  beforeAll(async () => {
+    const builtActualServer = await ActualServerBuild();
+    actualServer = await builtActualServer.start()
+  }, CONTAINER_START_TIMEOUT_MS);
+
+  it('should return info', async () => {
+    const hostname = actualServer.getHost();
+    const port = actualServer.getMappedPort(ACTUAL_SERVER_DEFAULT_PORT);
+    const hostConnectionString = `http://${hostname}:${port}`;
+
+    request(hostConnectionString)
+      .get('/info')
+      .then(res => {
+        // console.log(res);
+        expect(res.statusCode).toBe(200)
+      });
+
+  });
+
+  afterAll(async () => {
+    if (actualServer) await actualServer.stop();
+  });
+});

jest.config.json

@@ -1,7 +1,7 @@
 {
   "globalSetup": "./jest.global-setup.js",
   "globalTeardown": "./jest.global-teardown.js",
-  "testPathIgnorePatterns": ["dist", "/node_modules/", "/build/"],
+  "testPathIgnorePatterns": ["dist", "/node_modules/", "/build/", "/docker/"],
   "roots": ["<rootDir>"],
   "moduleFileExtensions": ["ts", "js", "json"],
   "testEnvironment": "node",

package.json

@@ -9,7 +9,8 @@
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
     "build": "tsc",
-    "test": "NODE_ENV=test NODE_OPTIONS='--experimental-vm-modules --trace-warnings' jest  --coverage",
+    "e2e-test": "yarn cross-env DEBUG='testcontainers:containers' NODE_ENV=test NODE_OPTIONS='--experimental-vm-modules --no-warnings=ExperimentalWarning --trace-warnings' jest ./docker/tests --detectOpenHandles --forceExit --config {}",
+    "test": "yarn cross-env NODE_ENV=test NODE_OPTIONS='--experimental-vm-modules --no-warnings=ExperimentalWarning --trace-warnings' jest --coverage",
     "db:migrate": "NODE_ENV=development node src/run-migrations.js up",
     "db:downgrade": "NODE_ENV=development node src/run-migrations.js down",
     "db:test-migrate": "NODE_ENV=test node src/run-migrations.js up",
@@ -40,7 +41,11 @@
     "winston": "^3.14.2"
   },
   "devDependencies": {
-    "@babel/preset-typescript": "^7.20.2",
+    "@babel/core": "^7.24.9",
+    "@babel/preset-env": "^7.25.0",
+    "@babel/preset-typescript": "^7.24.7",
+    "@types/babel__core": "^7",
+    "@types/babel__preset-env": "^7",
     "@types/bcrypt": "^5.0.2",
     "@types/better-sqlite3": "^7.6.7",
     "@types/cors": "^2.8.13",
@@ -52,11 +57,14 @@
     "@types/uuid": "^9.0.0",
     "@typescript-eslint/eslint-plugin": "^5.51.0",
     "@typescript-eslint/parser": "^5.51.0",
+    "babel-jest": "^29.7.0",
+    "cross-env": "^7.0.3",
     "eslint": "^8.33.0",
     "eslint-plugin-prettier": "^4.2.1",
     "jest": "^29.3.1",
     "prettier": "^2.8.3",
     "supertest": "^6.3.1",
+    "testcontainers": "^10.10.4",
     "typescript": "^4.9.5"
   },
   "engines": {

tsconfig.json

@@ -4,6 +4,8 @@
     // DOM for URL global in Node 16+
     "lib": ["ES2021"],
     "allowSyntheticDefaultImports": true,
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
     "esModuleInterop": true,
     "experimentalDecorators": true,
     "resolveJsonModule": true,