feat(kernel-test): Test ocap-url endowment

Author: grypez

packages/kernel-test/src/ocap-url.test.ts

@@ -0,0 +1,38 @@
+import { makeSQLKernelDatabase } from '@metamask/kernel-store/sqlite/nodejs';
+import { waitUntilQuiescent } from '@metamask/kernel-utils';
+import { describe, expect, it } from 'vitest';
+
+import {
+  extractTestLogs,
+  getBundleSpec,
+  makeKernel,
+  makeTestLogger,
+} from './utils.ts';
+
+describe('ocap-url', () => {
+  it('user-code can make an ocap url', async () => {
+    const { logger, entries } = makeTestLogger();
+    const database = await makeSQLKernelDatabase({});
+    const kernel = await makeKernel(database, true, logger);
+    const vatIds = ['v1'];
+    const vat = await kernel.launchSubcluster({
+      bootstrap: 'alice',
+      vats: {
+        alice: {
+          bundleSpec: getBundleSpec('ocap-url'),
+          parameters: {},
+        },
+      },
+    });
+    expect(vat).toBeDefined();
+    const vats = kernel.getVatIds();
+    expect(vats).toStrictEqual(vatIds);
+
+    await waitUntilQuiescent();
+    const vatLogs = vatIds.map((vatId) => extractTestLogs(entries, vatId));
+    expect(vatLogs).toStrictEqual([
+      // This is a placeholder for the actual ocap url.
+      [expect.stringContaining(`Alice's ocap url: ocap://o+`)],
+    ]);
+  });
+});

packages/kernel-test/src/vats/ocap-url.js

@@ -0,0 +1,31 @@
+import { E } from '@endo/eventual-send';
+import { Far } from '@endo/marshal';
+
+/**
+ * Build function for vats that will run various tests.
+ *
+ * @param {object} vatPowers - Special powers granted to this vat.
+ * @param {object} vatPowers.logger - The logger for this vat.
+ * @returns {*} The root object for the new vat.
+ */
+export function buildRootObject({ logger }) {
+  const { log } = logger.subLogger({ tags: ['test'] });
+  let contact;
+  return Far('root', {
+    async bootstrap({ alice }) {
+      contact = Far('contact', {
+        // An external actor can send a message to Alice by following an
+        // ocap url like "ocap://.../contact?whoAmI=Bob&message=Hello".
+        contact: (whoAmI, message) => E(alice).contact(whoAmI, message),
+      });
+      const ocapUrl = E(alice).makeContactUrl();
+      log(`Alice's ocap url: ${await ocapUrl}`);
+    },
+    // `makeOcapUrl` is an endowment available in global scope.
+    // eslint-disable-next-line no-undef
+    makeContactUrl: () => makeOcapUrl(contact),
+    async contact(sender = 'unknown', message = 'hello') {
+      log(`contact from ${sender}: ${message}`);
+    },
+  });
+}