Merge pull request 'sonarQ test on PR' (#1) from dev into main

Reviewed-on: #1

.gitea/workflows/sonar.yml

@@ -1,4 +1,3 @@
-
 name: SonarQube Analysis
 
 on:
@@ -124,7 +123,7 @@ jobs:
           echo "SCAN_TOKEN=${SCAN_TOKEN}" >> "$GITHUB_ENV"
       - name: Install dependencies and test
         run: |
-          npm ci
+          npm install
           npm run test:cov
 
       - name: SonarQube analysis

.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+npm-debug.log*
+.env
+.DS_Store

Dockerfile

@@ -0,0 +1,30 @@
+# ---- Build stage ----
+FROM node:20-alpine AS build
+WORKDIR /app
+
+COPY package.json ./
+RUN npm install
+
+COPY tsconfig.json ./
+COPY src/ ./src/
+RUN npm run build && npm prune --omit=dev
+
+# ---- Runtime stage ----
+FROM node:20-alpine
+WORKDIR /app
+
+RUN addgroup -S appgroup && adduser -S appuser -G appgroup
+
+COPY --from=build /app/dist ./dist
+COPY --from=build /app/node_modules ./node_modules
+COPY package.json ./
+
+RUN chown -R appuser:appgroup /app
+USER appuser
+
+EXPOSE 3000
+
+HEALTHCHECK --interval=30s --timeout=5s --start-period=20s --retries=3 \
+    CMD wget -qO- http://localhost:3000/health | grep -q 'UP' || exit 1
+
+CMD ["node", "--require", "./dist/tracing.js", "dist/main"]

README.md

@@ -1,4 +1,4 @@
-# sonar-test-nest4
+# sonar-test-nest4 v2
 
 > **System-of-Record branch** — application code lives on `dev`.
 

k6/configmap.yaml

@@ -0,0 +1,53 @@
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: k6-test-sonar-test-nest4
+  namespace: dev
+  labels:
+    app: sonar-test-nest4
+    app.kubernetes.io/managed-by: backstage
+    app.kubernetes.io/component: load-testing
+data:
+  K6_OUT: opentelemetry
+  K6_OTEL_GRPC_EXPORTER_INSECURE: 'true'
+  K6_OTEL_GRPC_EXPORTER_ENDPOINT: otel-collector.monitoring.svc.cluster.local:4317
+  K6_OTEL_METRIC_PREFIX: k6_
+  K6_OTEL_FLUSH_INTERVAL: '1000'
+  K6_OTEL_EXPORT_INTERVAL: '5000'
+  K6_OTEL_SERVICE_NAME: k6-sonar-test-nest4
+  load-test.js: "import http from 'k6/http';\nimport { check, sleep, group } from\
+    \ 'k6';\n\nconst vus = parseInt(__ENV.TEST_VUS || '10');\nconst duration = __ENV.TEST_DURATION\
+    \ || '30s';\nconst targetUrl = __ENV.TARGET_URL || 'http://sonar-test-nest4.dev.svc.cluster.local:3000';\n\
+    \nexport const options = {\n  scenarios: {\n    load_test: {\n      executor:\
+    \ 'ramping-vus',\n      startVUs: 0,\n      stages: [\n        { duration: '10s',\
+    \ target: vus },\n        { duration: duration, target: vus },\n        { duration:\
+    \ '5s', target: 0 },\n      ],\n    },\n  },\n  thresholds: {\n    http_req_duration:\
+    \ ['p(95)<500'],\n    http_req_failed: ['rate<0.01'],\n  },\n};\n\nhttp.setResponseCallback(http.expectedStatuses({\
+    \ min: 200, max: 399 }));\n\nexport default function () {\n  group('Health API',\
+    \ () => {\n    const res = http.get(`${targetUrl}/health`);\n    check(res, {\n\
+    \      'status is 200': (r) => r.status === 200,\n      'response time < 500ms':\
+    \ (r) => r.timings.duration < 500,\n    });\n  });\n\n  sleep(0.5);\n\n  group('Items\
+    \ API', () => {\n    const resGetAll = http.get(`${targetUrl}/api/items`);\n \
+    \   check(resGetAll, {\n      'status is 200': (r) => r.status === 200,\n    \
+    \  'response time < 500ms': (r) => r.timings.duration < 500,\n      'body contains\
+    \ items': (r) => Array.isArray(JSON.parse(r.body)),\n    });\n\n    const resCreate\
+    \ = http.post(\n      `${targetUrl}/api/items`,\n      JSON.stringify({ name:\
+    \ 'Test Item', description: 'A test description' }),\n      { headers: { 'Content-Type':\
+    \ 'application/json' } }\n    );\n    check(resCreate, {\n      'status is 201':\
+    \ (r) => r.status === 201,\n      'response time < 500ms': (r) => r.timings.duration\
+    \ < 500,\n      'body contains id': (r) => JSON.parse(r.body).id !== undefined,\n\
+    \    });\n\n    const itemId = JSON.parse(resCreate.body).id;\n\n    const resGetOne\
+    \ = http.get(`${targetUrl}/api/items/${itemId}`);\n    check(resGetOne, {\n  \
+    \    'status is 200': (r) => r.status === 200,\n      'response time < 500ms':\
+    \ (r) => r.timings.duration < 500,\n      'body contains correct item': (r) =>\
+    \ JSON.parse(r.body).id === itemId,\n    });\n\n    const resUpdate = http.put(\n\
+    \      `${targetUrl}/api/items/${itemId}`,\n      JSON.stringify({ name: 'Updated\
+    \ Item', description: 'Updated description' }),\n      { headers: { 'Content-Type':\
+    \ 'application/json' } }\n    );\n    check(resUpdate, {\n      'status is 200':\
+    \ (r) => r.status === 200,\n      'response time < 500ms': (r) => r.timings.duration\
+    \ < 500,\n      'body contains updated item': (r) => JSON.parse(r.body).name ===\
+    \ 'Updated Item',\n    });\n\n    const resDelete = http.del(`${targetUrl}/api/items/${itemId}`);\n\
+    \    check(resDelete, {\n      'status is 200': (r) => r.status === 200,\n   \
+    \   'response time < 500ms': (r) => r.timings.duration < 500,\n      'body confirms\
+    \ deletion': (r) => JSON.parse(r.body).deleted === itemId,\n    });\n  });\n\n\
+    \  sleep(0.5);\n}"

k6/load-test.js

@@ -0,0 +1,87 @@
+import http from 'k6/http';
+import { check, sleep, group } from 'k6';
+
+const vus = parseInt(__ENV.TEST_VUS || '10');
+const duration = __ENV.TEST_DURATION || '30s';
+const targetUrl = __ENV.TARGET_URL || 'http://sonar-test-nest4.dev.svc.cluster.local:3000';
+
+export const options = {
+  scenarios: {
+    load_test: {
+      executor: 'ramping-vus',
+      startVUs: 0,
+      stages: [
+        { duration: '10s', target: vus },
+        { duration: duration, target: vus },
+        { duration: '5s', target: 0 },
+      ],
+    },
+  },
+  thresholds: {
+    http_req_duration: ['p(95)<500'],
+    http_req_failed: ['rate<0.01'],
+  },
+};
+
+http.setResponseCallback(http.expectedStatuses({ min: 200, max: 399 }));
+
+export default function () {
+  group('Health API', () => {
+    const res = http.get(`${targetUrl}/health`);
+    check(res, {
+      'status is 200': (r) => r.status === 200,
+      'response time < 500ms': (r) => r.timings.duration < 500,
+    });
+  });
+
+  sleep(0.5);
+
+  group('Items API', () => {
+    const resGetAll = http.get(`${targetUrl}/api/items`);
+    check(resGetAll, {
+      'status is 200': (r) => r.status === 200,
+      'response time < 500ms': (r) => r.timings.duration < 500,
+      'body contains items': (r) => Array.isArray(JSON.parse(r.body)),
+    });
+
+    const resCreate = http.post(
+      `${targetUrl}/api/items`,
+      JSON.stringify({ name: 'Test Item', description: 'A test description' }),
+      { headers: { 'Content-Type': 'application/json' } }
+    );
+    check(resCreate, {
+      'status is 201': (r) => r.status === 201,
+      'response time < 500ms': (r) => r.timings.duration < 500,
+      'body contains id': (r) => JSON.parse(r.body).id !== undefined,
+    });
+
+    const itemId = JSON.parse(resCreate.body).id;
+
+    const resGetOne = http.get(`${targetUrl}/api/items/${itemId}`);
+    check(resGetOne, {
+      'status is 200': (r) => r.status === 200,
+      'response time < 500ms': (r) => r.timings.duration < 500,
+      'body contains correct item': (r) => JSON.parse(r.body).id === itemId,
+    });
+
+    const resUpdate = http.put(
+      `${targetUrl}/api/items/${itemId}`,
+      JSON.stringify({ name: 'Updated Item', description: 'Updated description' }),
+      { headers: { 'Content-Type': 'application/json' } }
+    );
+    check(resUpdate, {
+      'status is 200': (r) => r.status === 200,
+      'response time < 500ms': (r) => r.timings.duration < 500,
+      'body contains updated item': (r) => JSON.parse(r.body).name === 'Updated Item',
+    });
+
+    const resDelete = http.del(`${targetUrl}/api/items/${itemId}`);
+    check(resDelete, {
+      'status is 200': (r) => r.status === 200,
+      'response time < 500ms': (r) => r.timings.duration < 500,
+      'body confirms deletion': (r) => JSON.parse(r.body).deleted === itemId,
+    });
+  });
+
+  sleep(0.5);
+}

k6/testrun.yaml

@@ -0,0 +1,24 @@
+apiVersion: k6.io/v1alpha1
+kind: TestRun
+metadata:
+  name: k6-sonar-test-nest4
+  namespace: dev
+  labels:
+    app: sonar-test-nest4
+    backstage.io/component: sonar-test-nest4
+    app.kubernetes.io/managed-by: backstage
+    app.kubernetes.io/component: load-testing
+spec:
+  parallelism: 1
+  script:
+    configMap:
+      name: k6-test-sonar-test-nest4
+      file: load-test.js
+  runner:
+    image: grafana/k6:latest
+    envFrom:
+    - configMapRef:
+        name: k6-test-sonar-test-nest4
+    env:
+    - name: K6_OTEL_SERVICE_NAME
+      value: k6-sonar-test-nest4

package.json

@@ -0,0 +1,44 @@
+{
+  "name": "sonar-test-nest4",
+  "version": "0.1.0",
+  "description": "sonar-test-nest4",
+  "scripts": {
+    "build": "nest build",
+    "start": "node dist/main",
+    "start:dev": "nest start --watch",
+    "test": "jest",
+    "test:cov": "jest --coverage"
+  },
+  "dependencies": {
+    "@nestjs/common": "^10.3.8",
+    "@nestjs/core": "^10.3.8",
+    "@nestjs/platform-express": "^10.3.8",
+    "@nestjs/terminus": "^10.2.3",
+    "@willsoto/nestjs-prometheus": "^6.0.1",
+    "prom-client": "^15.1.3",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.1",
+    "@opentelemetry/sdk-node": "^0.52.0",
+    "@opentelemetry/auto-instrumentations-node": "^0.47.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.52.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.52.0"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.3.2",
+    "@nestjs/testing": "^10.3.8",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.11",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.3",
+    "typescript": "^5.4.5"
+  },
+  "jest": {
+    "moduleFileExtensions": ["js","json","ts"],
+    "rootDir": "src",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": { "^.+\\.(t|j)s$": "ts-jest" },
+    "testEnvironment": "node",
+    "coverageDirectory": "coverage",
+    "coverageReporters": ["lcov", "text-summary"]
+  }
+}

src/app.module.ts

@@ -0,0 +1,15 @@
+import { Module } from '@nestjs/common';
+import { TerminusModule } from '@nestjs/terminus';
+import { PrometheusModule } from '@willsoto/nestjs-prometheus';
+import { ItemsModule } from './items/items.module';
+import { HealthController } from './health.controller';
+
+@Module({
+  imports: [
+    TerminusModule,
+    PrometheusModule.register({ path: '/metrics' }),
+    ItemsModule,
+  ],
+  controllers: [HealthController],
+})
+export class AppModule {}

src/health.controller.ts

@@ -0,0 +1,13 @@
+import { Controller, Get } from '@nestjs/common';
+import { HealthCheck, HealthCheckService } from '@nestjs/terminus';
+
+@Controller('health')
+export class HealthController {
+  constructor(private health: HealthCheckService) {}
+
+  @Get()
+  @HealthCheck()
+  check() {
+    return this.health.check([]);
+  }
+}

src/items/items.controller.ts

@@ -0,0 +1,48 @@
+import {
+  Body,
+  Controller,
+  Delete,
+  Get,
+  HttpCode,
+  Param,
+  ParseIntPipe,
+  Post,
+  Put,
+} from '@nestjs/common';
+import { ItemsService } from './items.service';
+
+class CreateItemDto {
+  name: string;
+  description?: string;
+}
+
+@Controller('api/items')
+export class ItemsController {
+  constructor(private readonly items: ItemsService) {}
+
+  @Get()
+  findAll() {
+    return this.items.findAll();
+  }
+
+  @Post()
+  @HttpCode(201)
+  create(@Body() dto: CreateItemDto) {
+    return this.items.create(dto.name, dto.description);
+  }
+
+  @Get(':id')
+  findOne(@Param('id', ParseIntPipe) id: number) {
+    return this.items.findOne(id);
+  }
+
+  @Put(':id')
+  update(@Param('id', ParseIntPipe) id: number, @Body() dto: CreateItemDto) {
+    return this.items.update(id, dto.name, dto.description);
+  }
+
+  @Delete(':id')
+  remove(@Param('id', ParseIntPipe) id: number) {
+    return this.items.remove(id);
+  }
+}

src/items/items.module.ts

@@ -0,0 +1,9 @@
+import { Module } from '@nestjs/common';
+import { ItemsController } from './items.controller';
+import { ItemsService } from './items.service';
+
+@Module({
+  controllers: [ItemsController],
+  providers: [ItemsService],
+})
+export class ItemsModule {}

src/items/items.service.spec.ts

@@ -0,0 +1,19 @@
+import { Test, TestingModule } from '@nestjs/testing';
+import { ItemsService } from './items.service';
+
+describe('ItemsService', () => {
+  let service: ItemsService;
+
+  beforeEach(async () => {
+    const module: TestingModule = await Test.createTestingModule({
+      providers: [ItemsService],
+    }).compile();
+    service = module.get<ItemsService>(ItemsService);
+  });
+
+  it('creates and retrieves an item', () => {
+    const item = service.create('Widget', 'A test widget');
+    expect(item.id).toBe(1);
+    expect(service.findOne(1).name).toBe('Widget');
+  });
+});

src/items/items.service.ts

@@ -0,0 +1,45 @@
+import { Injectable, NotFoundException } from '@nestjs/common';
+
+export interface Item {
+  id: number;
+  name: string;
+  description: string;
+}
+
+@Injectable()
+export class ItemsService {
+  private readonly store = new Map<number, Item>();
+  private counter = 1;
+
+  findAll(): Item[] {
+    return [...this.store.values()];
+  }
+
+  create(name: string, description = ''): Item {
+    const item: Item = { id: this.counter++, name, description };
+    this.store.set(item.id, item);
+    return item;
+  }
+
+  findOne(id: number): Item {
+    const item = this.store.get(id);
+    if (!item) throw new NotFoundException(`Item ${id} not found`);
+    return item;
+  }
+
+  update(id: number, name?: string, description?: string): Item {
+    const item = this.findOne(id);
+    const updated: Item = {
+      id,
+      name: name ?? item.name,
+      description: description ?? item.description,
+    };
+    this.store.set(id, updated);
+    return updated;
+  }
+
+  remove(id: number): { deleted: number } {
+    this.store.delete(id);
+    return { deleted: id };
+  }
+}

src/main.ts

@@ -0,0 +1,9 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  await app.listen(process.env.PORT ?? 3000);
+  console.log(`sonar-test-nest4 listening on :${process.env.PORT ?? 3000}`);
+}
+bootstrap();

src/tracing.ts

@@ -0,0 +1,19 @@
+// OTel SDK bootstrap — loaded via --require ./dist/tracing.js before the app.
+// Auto-configures from OTEL_* env vars set in score.yaml / Humanitec.
+// No-ops gracefully when OTEL_EXPORTER_OTLP_ENDPOINT is absent (local dev).
+import { NodeSDK } from '@opentelemetry/sdk-node';
+import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
+
+const endpoint = process.env.OTEL_EXPORTER_OTLP_ENDPOINT;
+if (endpoint) {
+  const sdk = new NodeSDK({
+    instrumentations: [
+      getNodeAutoInstrumentations({
+        '@opentelemetry/instrumentation-fs': { enabled: false },
+      }),
+    ],
+  });
+
+  sdk.start();
+  process.on('SIGTERM', () => sdk.shutdown().finally(() => process.exit(0)));
+}

tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": false
+  }
+}