chore: Add smoke test

.github/workflows/e2e-test.yaml → .github/workflows/e2e-tests.yaml

@@ -1,11 +1,12 @@
-name: "E2E Test"
+name: e2e tests
+
 on:
   workflow_dispatch:
   schedule:
     - cron: 0 22 * * *
 
 jobs:
-  e2e-test:
+  e2e-tests:
     strategy:
       fail-fast: false
       matrix:
@@ -16,10 +17,10 @@ jobs:
         include:
           - environment: production
             secret-name: AI_CORE_PRODUCTION
-    name: "Build and Test"
+    name: 'Build and Test'
     runs-on: ubuntu-latest
     steps:
-      - name: "Checkout repository"
+      - name: 'Checkout repository'
         uses: actions/checkout@v4
       - uses: pnpm/action-setup@v3
         with:
@@ -37,7 +38,7 @@ jobs:
           echo "AICORE_SERVICE_KEY='$AICORE_SERVICE_KEY'" > tests/e2e-tests/.env
           url=$(echo "$AICORE_SERVICE_KEY" | jq -r '.serviceurls.AI_API_URL' | sed 's|^https://||')
           echo "Using AI Core ${{ matrix.environment }} instance on $url"
-      - name: "Check Sample App Starts Up"
+      - name: 'Check Sample App Starts Up'
         working-directory: ./sample-code
         run: |
           pnpm run local &
@@ -51,9 +52,9 @@ jobs:
             fi
           done
           wget -qO- -S --content-on-error localhost:8080
-      - name: "Execute E2E Tests"
+      - name: 'Execute E2E Tests'
         run: pnpm test:e2e
-      - name: "Slack Notification"
+      - name: 'Slack Notification'
         if: failure()
         uses: slackapi/[email protected]
         with:

.github/workflows/fosstars.yml

@@ -1,4 +1,5 @@
 name: 'Fosstars (Security)'
+
 on:
   workflow_dispatch:
   schedule:

.github/workflows/smoke-test.yml

@@ -0,0 +1,32 @@
+name: smoke test
+
+on:
+  pull_request: ~
+  workflow_dispatch:
+  schedule:
+    - cron: 0 22 * * *
+
+jobs:
+  smoke-test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v3
+        with:
+          version: ${{ vars.PNPM_VERSION }}
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ vars.DEFAULT_NODE_VERSION }}
+          cache: 'pnpm'
+      - run: pnpm i --frozen-lockfile
+      - uses: vchrisb/setup-cf@v0
+        with:
+          api: ${{ vars.CF_API_URL }}
+          username: ${{ secrets.CF_USER }}
+          password: ${{ secrets.CF_PASSWORD }}
+          org: ${{ vars.CF_ORG }}
+          space: ${{ vars.CF_SPACE }}
+      - run: cf push
+        working-directory: tests/smoke-test
+      - name: smoke test
+        run: pnpm test:smoke

.gitignore

@@ -54,3 +54,4 @@ build/Release
 # VS Code
 .vscode
 /pnpm-publish-summary.json
+/tests/smoke-test/deployment

package.json

@@ -11,14 +11,18 @@
     "postinstall": "pnpm compile",
     "compile": "pnpm -r -w=false run compile",
     "test:unit": "pnpm -r -F=./packages/** test",
-    "test:type": "pnpm -F=@sap-ai-sdk/type-tests test",
-    "test:e2e": "pnpm -F=@sap-ai-sdk/e2e-tests test",
+    "test:type": "pnpm type-tests test",
+    "test:e2e": "pnpm e2e-tests test",
+    "test:smoke": "pnpm smoke-test test",
     "lint": "pnpm -r run lint",
     "lint:fix": "pnpm -r run lint:fix",
     "generate": "pnpm -r run generate",
     "ai-core": "pnpm -F=@sap-ai-sdk/ai-core",
     "gen-ai-hub": "pnpm -F=@sap-ai-sdk/gen-ai-hub",
-    "core": "pnpm -F=@sap-ai-sdk/core"
+    "core": "pnpm -F=@sap-ai-sdk/core",
+    "e2e-tests": "pnpm -F=@sap-ai-sdk/e2e-tests",
+    "type-tests": "pnpm -F=@sap-ai-sdk/type-tests",
+    "smoke-test": "pnpm -F=@sap-ai-sdk/smoke-test"
   },
   "devDependencies": {
     "@changesets/cli": "^2.27.7",

pnpm-workspace.yaml

@@ -3,11 +3,7 @@ packages:
   - 'packages/ai-core'
   - 'packages/gen-ai-hub'
   - 'packages/core'
-  # sample code
   - 'sample-code'
-  # e2e tests
   - 'tests/e2e-tests'
-  # type tests
   - 'tests/type-tests'
-  # exclude packages that are inside test directories
-
+  - 'tests/smoke-test'

sample-code/src/orchestration.ts

@@ -0,0 +1,23 @@
+import {
+  type CompletionPostResponse,
+  GenAiHubClient
+} from '@sap-ai-sdk/gen-ai-hub';
+
+/**
+ * Ask GPT about the capital of France.
+ * @returns The answer from the orchestration service in Gen AI Hub.
+ */
+export function orchestrationCompletion(): Promise<CompletionPostResponse> {
+  const genAiHubClient = new GenAiHubClient();
+
+  return genAiHubClient.chatCompletion({
+    deploymentConfiguration: { deploymentId: 'db1d64d9f06be467' },
+    llmConfig: {
+      model_name: 'gpt-4-32k',
+      model_params: {}
+    },
+    prompt: {
+      template: [{ role: 'user', content: 'What is the capital of France?' }]
+    }
+  });
+}

sample-code/src/server.ts

@@ -1,6 +1,7 @@
 /* eslint-disable no-console */
 import express from 'express';
 import { chatCompletion, computeEmbedding } from './aiservice.js';
+import { orchestrationCompletion } from './orchestration.js';
 
 const app = express();
 const port = 8080;
@@ -35,8 +36,15 @@ app.get('/embedding', async (req, res) => {
   }
 });
 
-app.get('/orchestration', (req, res) => {
-  res.status(418).send('Not implemented 🛠️');
+app.get('/orchestration', async (req, res) => {
+  try {
+    res.send(await orchestrationCompletion());
+  } catch (error: any) {
+    console.error(error);
+    res
+      .status(500)
+      .send('Yikes, vibes are off apparently 😬 -> ' + error.message);
+  }
 });
 
 app.listen(port, () => {

tests/smoke-test/.cfignore

@@ -0,0 +1,4 @@
+coverage/
+jest.config.mjs
+tsconfig.json
+.env

tests/smoke-test/jest.config.mjs

@@ -0,0 +1,5 @@
+import config from '../../jest.config.mjs';
+export default {
+  ...config,
+  displayName: 'smoke-test',
+};

tests/smoke-test/manifest.yml

@@ -0,0 +1,10 @@
+applications:
+  - name: smoke-test-app
+    path: .
+    memory: 256M
+    buildpacks:
+      - nodejs_buildpack
+    services:
+      - default_aicore
+    routes:
+      - route: 'smoke-test-app.cfapps.eu12-001.hana.ondemand.com'