feat(apps-backend, tooling-ci): Add e2e tests to apps backend

.github/workflows/apps_backend_deploy.yml

@@ -62,6 +62,8 @@ jobs:
         id: deploy_url
         if: ${{ inputs.isProd == false }}
         run: echo "DEPLOY_URL=$(cat vercel_output.txt | awk 'END{print}')" >> $GITHUB_OUTPUT
+      - name: E2E tests for deployed URL
+        run: pnpm --filter apps-backend test:e2e
       - name: Comment on pull request
         if: ${{ inputs.isProd == false }}
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # pin@v7

apps/apps-backend/jest-e2e.json

@@ -0,0 +1,13 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": "./",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  },
+  "testEnvironment": "node",
+  "moduleNameMapper": {
+    "^src/(.*)$": "<rootDir>/dist/$1",
+    "^@iota/core/(.*)$": "<rootDir>/dist/core/src/$1"
+  }
+}

apps/apps-backend/package.json

@@ -6,8 +6,9 @@
         "format": "prettier --write \"src/**/*.ts\"",
         "dev": "nest start --watch",
         "debug": "nest start --debug --watch",
-        "preview": "pnpm run build && node dist/main",
-        "lint": "eslint --max-warnings=0 \"{src,apps,libs,test}/**/*.ts\""
+        "preview": "pnpm run build && node dist/apps-backend/src/main",
+        "lint": "eslint --max-warnings=0 \"{src,apps,libs,test}/**/*.ts\"",
+        "test:e2e": "jest --config ./jest-e2e.json"
     },
     "dependencies": {
         "@iota/core": "workspace:*",

apps/apps-backend/src/app.module.ts

@@ -11,6 +11,7 @@ import { FeaturesModule } from './features/features.module';
 import { MonitorNetworkModule } from './monitor-network/monitor-network.module';
 import { PricesModule } from './prices/prices.module';
 import { RestrictedModule } from './restricted/restricted.module';
+import { HealthModule } from './health/health.module';
 
 @Module({
     imports: [
@@ -30,6 +31,7 @@ import { RestrictedModule } from './restricted/restricted.module';
             ttl: 3600,
             max: 100,
         }),
+        HealthModule,
     ],
 })
 export class AppModule {}

apps/apps-backend/src/health/health.controller.ts

@@ -0,0 +1,12 @@
+// Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import { Controller, Get } from '@nestjs/common';
+
+@Controller('health')
+export class HealthController {
+    @Get()
+    check() {
+        return { status: 'ok' };
+    }
+}

apps/apps-backend/src/health/health.module.ts

@@ -0,0 +1,10 @@
+// Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import { Module } from '@nestjs/common';
+import { HealthController } from './health.controller';
+
+@Module({
+    controllers: [HealthController],
+})
+export class HealthModule {}

apps/apps-backend/test/health.e2e-spec.ts

@@ -0,0 +1,34 @@
+// Copyright (c) 2024 IOTA Stiftung
+// SPDX-License-Identifier: Apache-2.0
+
+import { Test, TestingModule } from '@nestjs/testing';
+import { INestApplication } from '@nestjs/common';
+import * as request from 'supertest';
+import { AppModule } from '../src/app.module';
+
+describe('Health Check (e2e)', () => {
+    let app: INestApplication;
+
+    beforeAll(async () => {
+        const moduleFixture: TestingModule = await Test.createTestingModule({
+            imports: [AppModule],
+        }).compile();
+
+        app = moduleFixture.createNestApplication();
+        await app.init();
+    });
+
+    afterAll(async () => {
+        await app.close();
+    });
+
+    it('/health (GET)', async () => {
+        const DEPLOYED_URL = process.env.DEPLOYED_URL || null;
+
+        if (DEPLOYED_URL) {
+            await request(DEPLOYED_URL).get('/health').expect(200).expect({ status: 'ok' });
+        } else {
+            await request(app.getHttpServer()).get('/health').expect(200).expect({ status: 'ok' });
+        }
+    });
+});