feat: Add AI Core e2e tests (#128)

* init

* Added e2e tests

* increase timeout

* changes to error msg

* use native approach

* remove unused deps

* small changes

* create utils

* separate tests

* update libs

* fix lint issues

* whoops

tests/e2e-tests/package.json

@@ -25,6 +25,8 @@
     "lint:fix": "eslint . --fix && prettier . --config ../../.prettierrc --ignore-path ../../.prettierignore -w --log-level error"
   },
   "devDependencies": {
+    "@types/async-retry": "^1.4.8",
+    "async-retry": "^1.3.3",
     "dotenv": "^16.4.5"
   }
 }

tests/e2e-tests/src/deployment-api.test.ts

@@ -0,0 +1,146 @@
+import retry from 'async-retry';
+import {
+  AiDeployment,
+  AiDeploymentList,
+  DeploymentApi
+} from '@sap-ai-sdk/ai-api';
+import { loadEnv } from './utils/load-env.js';
+import { resourceGroup } from './utils/ai-api-utils.js';
+
+loadEnv();
+
+describe('DeploymentApi', () => {
+  let createdDeploymentId: string | undefined;
+  let initialState: AiDeploymentList | undefined;
+
+  beforeAll(async () => {
+    const queryResponse = await DeploymentApi.deploymentQuery(
+      {},
+      { 'AI-Resource-Group': resourceGroup }
+    ).execute();
+    expect(queryResponse).toBeDefined();
+    initialState = queryResponse;
+  });
+
+  it('should create a deployment and wait for it to run', async () => {
+    const createResponse = await DeploymentApi.deploymentCreate(
+      { configurationId: '54cc966d-8bc1-44ab-a9dc-658d59ef205d' },
+      { 'AI-Resource-Group': resourceGroup }
+    ).execute();
+
+    expect(createResponse).toEqual(
+      expect.objectContaining({
+        message: 'Deployment scheduled.',
+        id: expect.anything()
+      })
+    );
+
+    const runningDeployment = await waitForDeploymentToReachStatus(
+      createResponse.id,
+      'RUNNING'
+    );
+
+    expect(runningDeployment).toEqual(
+      expect.objectContaining({
+        status: 'RUNNING',
+        deploymentUrl: expect.any(String)
+      })
+    );
+
+    createdDeploymentId = runningDeployment.id;
+  }, 180000);
+
+  it('should modify the deployment to stop it', async () => {
+    const deploymentId = getDeploymentId(createdDeploymentId);
+
+    const modifyResponse = await DeploymentApi.deploymentModify(
+      deploymentId,
+      { targetStatus: 'STOPPED' },
+      { 'AI-Resource-Group': resourceGroup }
+    ).execute();
+
+    expect(modifyResponse).toEqual(
+      expect.objectContaining({
+        message: 'Deployment modification scheduled'
+      })
+    );
+
+    const stoppedDeployment = await waitForDeploymentToReachStatus(
+      deploymentId,
+      'STOPPED'
+    );
+
+    expect(stoppedDeployment).toEqual(
+      expect.objectContaining({
+        status: 'STOPPED'
+      })
+    );
+  }, 180000);
+
+  it('should delete the deployment', async () => {
+    const deploymentId = getDeploymentId(createdDeploymentId);
+    const deleteResponse = await DeploymentApi.deploymentDelete(deploymentId, {
+      'AI-Resource-Group': resourceGroup
+    }).execute();
+
+    expect(deleteResponse).toEqual(
+      expect.objectContaining({
+        message: 'Deletion scheduled'
+      })
+    );
+  });
+
+  afterAll(async () => {
+    getDeploymentId(createdDeploymentId);
+    // Wait for deletion to complete
+    await new Promise(r => setTimeout(r, 15000));
+    const queryResponse = await DeploymentApi.deploymentQuery(
+      {},
+      { 'AI-Resource-Group': resourceGroup }
+    ).execute();
+    expect(queryResponse).toBeDefined();
+
+    const sanitizedInitialState = sanitizedState(initialState);
+    const sanitizedEndState = sanitizedState(queryResponse);
+    expect(sanitizedEndState).toStrictEqual(sanitizedInitialState);
+  }, 30000);
+});
+
+const sanitizedState = (state: AiDeploymentList | undefined) => ({
+  ...state,
+  resources: state?.resources.map(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    ({ modifiedAt, ...rest }) => rest
+  )
+});
+
+function getDeploymentId(id: string | undefined): string {
+  if (id === undefined) {
+    throw new Error('deploymentId is not defined.');
+  }
+  return id;
+}
+
+async function waitForDeploymentToReachStatus(
+  deploymentId: string,
+  targetStatus: 'RUNNING' | 'STOPPED'
+): Promise<AiDeployment> {
+  return retry(
+    async () => {
+      const deploymentDetail = await DeploymentApi.deploymentGet(
+        deploymentId,
+        {},
+        { 'AI-Resource-Group': resourceGroup }
+      ).execute();
+
+      if (deploymentDetail.status === targetStatus) {
+        return deploymentDetail;
+      }
+      throw new Error(`Deployment has not yet reached ${targetStatus} status.`);
+    },
+    {
+      retries: 30,
+      minTimeout: 5000
+    }
+  );
+}

tests/e2e-tests/src/foundation-models.test.ts

@@ -1,12 +1,7 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-import dotenv from 'dotenv';
 import { chatCompletion, computeEmbedding } from '@sap-ai-sdk/sample-code';
+import { loadEnv } from './utils/load-env.js';
 
-// Pick .env file from root directory
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-dotenv.config({ path: path.resolve(__dirname, '../.env') });
+loadEnv();
 
 describe('Azure OpenAI Foundation Model Access', () => {
   it('should complete a chat', async () => {

tests/e2e-tests/src/orchestration.test.ts

@@ -1,12 +1,7 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-import dotenv from 'dotenv';
 import { OrchestrationClient } from '@sap-ai-sdk/orchestration';
+import { loadEnv } from './utils/load-env.js';
 
-// Pick .env file from e2e root directory
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-dotenv.config({ path: path.resolve(__dirname, '../.env') });
+loadEnv();
 
 describe('orchestration', () => {
   it('should complete a chat', async () => {

tests/e2e-tests/src/scenario-api.test.ts

@@ -0,0 +1,19 @@
+import { ScenarioApi } from '@sap-ai-sdk/ai-api';
+import { loadEnv } from './utils/load-env.js';
+import { resourceGroup } from './utils/ai-api-utils.js';
+
+loadEnv();
+
+describe('ScenarioApi', () => {
+  it('should get list of available scenarios', async () => {
+    const scenarios = await ScenarioApi.scenarioQuery({
+      'AI-Resource-Group': resourceGroup
+    }).execute();
+
+    expect(scenarios).toBeDefined();
+    const foundationModel = scenarios.resources.find(
+      scenario => scenario.id === 'foundation-models'
+    );
+    expect(foundationModel).toBeDefined();
+  });
+});

tests/e2e-tests/src/utils/ai-api-utils.ts

@@ -0,0 +1,4 @@
+/**
+ * @internal
+ */
+export const resourceGroup = 'ai-sdk-js-e2e';

tests/e2e-tests/src/utils/load-env.ts

@@ -0,0 +1,13 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+import dotenv from 'dotenv';
+
+/**
+ * @internal
+ */
+export const loadEnv = (): void => {
+  // Pick .env file from e2e root directory
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+};