Draft for running integration tests

Author: lenkan

.github/workflows/main.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ macOS-latest, ubuntu-latest]
+        os: [macOS-latest, ubuntu-latest]
 
     steps:
       - name: Checkout repo
@@ -39,3 +39,22 @@ jobs:
         uses: codecov/codecov-action@v3
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  test:
+    name: Run integration test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+        with:
+          node-version: '18.12.1'
+          cache: 'npm'
+      - name: install deps
+        run: |
+          npm ci
+      - name: Start dependencies
+        run: docker compose up deps
+      - name: Run integration test
+        run: npm run test:integration

docker-compose.yaml

@@ -0,0 +1,56 @@
+services:
+  vlei-server:
+    image: lenkan/vlei
+    command: ["vLEI-server", "-s", "./schema/acdc", "-c", "./samples/acdc/", "-o", "./samples/oobis/"]
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:7723/oobi/EBfdlu8R27Fbx-ehrqwImnK-8Cm79sqbAQ4MmvEAYqao"]
+      interval: 2s
+      timeout: 3s
+      retries: 5
+      start_period: 2s
+    ports:
+      - 7723:7723
+
+  keria:
+    image: lenkan/keria
+    environment:
+      - KERI_AGENT_CORS=1
+      - KERI_URL=http://keria:3902
+    volumes:
+      - ./images/keria/entrypoint.sh:/keria/entrypoint.sh
+    entrypoint: /keria/entrypoint.sh
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3902/spec.yaml"]
+      interval: 2s
+      timeout: 3s
+      retries: 5
+      start_period: 2s
+    ports:
+      - 3901:3901
+      - 3902:3902
+      - 3903:3903
+
+  witness-demo:
+    image: lenkan/keri-witness-demo
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:5642/oobi"]
+      interval: 2s
+      timeout: 3s
+      retries: 5
+      start_period: 2s
+    ports:
+    - 5642:5642
+    - 5643:5643
+    - 5644:5644
+  
+  deps:
+    image: alpine
+    command: ["echo", "Dependencies running"]
+    depends_on:
+      vlei-server:
+        condition: service_healthy
+      keria:
+        condition: service_healthy
+      witness-demo:
+        condition: service_healthy
+

images/keria/entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+keri_url=${KERI_URL:-"http://127.0.0.1:3902"}
+timestamp=$(date -In | sed s/,000000000/.000000/g)
+config_dir="/keria/config"
+config_file="$config_dir/keri/cf/agent.json"
+
+mkdir -p "$config_dir/keri/cf"
+
+cat > "$config_file" <<EOF
+{
+  "keria": {
+    "dt": "$timestamp",
+    "curls": ["$keri_url"]
+  }
+}
+EOF
+
+cat $config_file
+
+keria start --config-dir "$config_dir" --config-file agent --name agent

package.json

@@ -18,10 +18,11 @@
     "start": "npm run build:esm -- --watch",
     "build:cjs": "esbuild src/index.ts --bundle --outfile=dist/signify-ts.cjs --platform=neutral --format=cjs --sourcemap --packages=external",
     "build:esm": "esbuild src/index.ts --bundle --outfile=dist/signify-ts.mjs --platform=neutral --format=esm --sourcemap --packages=external",
-    "build:types": "tsc --declaration --outDir dist",
+    "build:types": "tsc -p tsconfig.build.json",
     "build": "npm run build:cjs && npm run build:esm && npm run build:types",
-    "test": "jest",
-    "lint": "npx eslint src test examples/integration-scripts examples/scripts",
+    "test": "jest test/",
+    "test:integration": "jest test-integration/",
+    "lint": "npx eslint src test test-integration examples/integration-scripts examples/scripts",
     "prepare": "npm run build",
     "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose",
     "pretty": "prettier --config .prettierrc 'src/**/*.ts' 'test/**/*.ts' 'examples/**/*.ts' --write"

src/keri/app/coring.ts

@@ -88,6 +88,27 @@ export class Operations {
         let res = await this.client.fetch(path, method, data);
         return await res.json();
     }
+
+    async wait(name: string, timeout?: number): Promise<any> {
+        const now = Date.now();
+        let op = await this.get(name);
+
+        while (!op['done']) {
+            op = await this.get(name);
+            if (op['done']) {
+                return op;
+            }
+
+            const elapsed = Date.now() - now;
+            if (timeout !== undefined && elapsed > timeout) {
+                throw new Error(
+                    `Operation '${op.name}' time out after ${elapsed} ms`
+                );
+            }
+
+            await new Promise((resolve) => setTimeout(resolve, 1000));
+        }
+    }
 }
 
 /**

test-integration/single-issuer-holder.test.ts

@@ -0,0 +1,84 @@
+import assert from 'assert';
+import signify from '../src/index.ts';
+import {
+    admitCredential,
+    connect,
+    createIdentifier,
+    createRegistry,
+    getAgentOobi,
+    issueCredential,
+    resolveOobi,
+    wait,
+    waitForNotification,
+} from './test-utils.ts';
+
+const URL = 'http://127.0.0.1:3901';
+const BOOT_URL = 'http://127.0.0.1:3903';
+const SCHEMA_SAID = 'EBfdlu8R27Fbx-ehrqwImnK-8Cm79sqbAQ4MmvEAYqao';
+const WITNESS_AIDS: string[] = []; // ['BBilc4-L3tFUnfM_wJr4S4OJanAv_VmF_dJNN6vkf2Ha'];
+const SCHEMA_OOBI =
+    'http://vlei-server:7723/oobi/EBfdlu8R27Fbx-ehrqwImnK-8Cm79sqbAQ4MmvEAYqao';
+
+test(
+    'Single issuer holder',
+    async () => {
+        await signify.ready();
+        const issuerClient = await connect(URL, BOOT_URL);
+        const holderClient = await connect(URL, BOOT_URL);
+
+        await issuerClient.state();
+        await holderClient.state();
+
+        // Create two identifiers, one for each client
+        const issuerPrefix = await createIdentifier(
+            issuerClient,
+            'issuer',
+            WITNESS_AIDS
+        );
+        const holderPrefix = await createIdentifier(
+            holderClient,
+            'holder',
+            WITNESS_AIDS
+        );
+
+        // Exchange OOBIs
+        const issuerOobi = await getAgentOobi(issuerClient, 'issuer');
+        const holderOobi = await getAgentOobi(holderClient, 'holder');
+        await resolveOobi(issuerClient, holderOobi, 'holder');
+        await resolveOobi(issuerClient, SCHEMA_OOBI, 'schema');
+        await resolveOobi(holderClient, issuerOobi, 'issuer');
+        await resolveOobi(holderClient, SCHEMA_OOBI, 'schema');
+
+        await createRegistry(issuerClient, 'issuer', 'vLEI');
+
+        const registires = await issuerClient.registries().list('issuer');
+        await issueCredential(issuerClient, 'issuer', {
+            registry: registires[0].regk,
+            schema: SCHEMA_SAID,
+            recipient: holderPrefix,
+            data: {
+                LEI: '5493001KJTIIGC8Y1R17',
+            },
+        });
+
+        const grantNotification = await waitForNotification(
+            holderClient,
+            '/exn/ipex/grant'
+        );
+
+        await admitCredential(
+            holderClient,
+            'holder',
+            grantNotification.a.d!,
+            issuerPrefix
+        );
+
+        await holderClient.notifications().mark(grantNotification.i);
+
+        await wait(async () => {
+            const creds = await holderClient.credentials().list();
+            assert(creds.length >= 1);
+        });
+    },
+    1000 * 60 * 5
+);