Add per-test description and conditional skipping

Author: jzvikart

.github/workflows/integrationTests.yaml

@@ -47,9 +47,4 @@ jobs:
               env:
                   OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
               run: |
-                  if [ -z "$OPENAI_API_KEY" ]; then
-                    echo "Skipping integration tests due to missing required API keys"
-                    exit 1
-                  else
-                    pnpm run integrationTests
-                  fi
+                  pnpm run integrationTests

tests/test1.mjs

@@ -6,28 +6,19 @@ import {
     runIntegrationTest,
 } from "./testLibrary.mjs";
 
-// Validation function to check required environment variables
-async function validateEnvironment(requiredVars) {
-    const missing = requiredVars.filter(varName => !process.env[varName]);
-    if (missing.length > 0) {
-        throw new Error(`Required environment variables not set: ${missing.join(', ')}\nPlease set these variables before running the tests.`);
-    }
-    return true;
-}
 
 async function helloTrump() {
     const reply = await send("Hi");
-
     assert(reply.length > 0, "Response should not be empty");
     const response = reply[0];
     assert(response.text, "Response should have text property");
     assert(response.text.length > 10, `Response should be longer than 10 characters, is ${reply.length}`);
-
 }
+helloTrump.description = "Hello Trump";
+helloTrump.skipIf = !process.env.OPENAI_API_KEY;
 
-async function coinbaseCommerceChargeTest() {
-    await validateEnvironment(['COINBASE_COMMERCE_KEY']);
 
+async function coinbaseCommerceChargeTest() {
     const chargeDescription = "Exclusive digital artwork collection";
     const chargeRequest = `Create a charge for $100 USD for Digital Art NFT with description '${chargeDescription}'`;
     const response = await send(chargeRequest);
@@ -106,8 +97,15 @@ async function coinbaseCommerceChargeTest() {
     assert.equal(chargeData.data.hosted_url, createdChargeUrl, "Hosted URLs should match");
     assert.equal(chargeData.data.description, chargeDescription, "Charge description should match")
 }
+coinbaseCommerceChargeTest.description = "Coinbase Charge";
+coinbaseCommerceChargeTest.skipIf = !process.env.OPENAI_API_KEY || !process.env.COINBASE_COMMERCE_KEY;
+
+
 
-const testSuite = [helloTrump, coinbaseCommerceChargeTest]; // Add tests here
+const testSuite = [
+    helloTrump,
+    coinbaseCommerceChargeTest,
+];
 try {
     for (const test of testSuite) await runIntegrationTest(test);
 } catch (error) {

tests/testLibrary.mjs

@@ -112,15 +112,22 @@ async function send(message) {
 }
 
 async function runIntegrationTest(fn) {
-    const proc = await startAgent();
-    try {
-        await fn();
-        log("✓ Test passed");
-    } catch (error) {
-        log("✗ Test failed");
-        logError(error);
-    } finally {
-        await stopAgent(proc);
+    const skip = fn.hasOwnProperty("skipIf") ? fn.skipIf : false;
+    const description = fn.description ?? "unnamed";
+    if (skip) {
+        log(fn.description ? `Skipping test ${fn.description}...` : "Skipping test...");
+    } else {
+        log(fn.description ? `Running test ${fn.description}...` : "Running test...");
+        const proc = await startAgent();
+        try {
+            await fn();
+            log(fn.description ? `✓ Test ${fn.description} passed` : "✓ Test passed");
+        } catch (error) {
+            log(fn.description ? `✗ Test ${fn.description} failed` : "✗ Test failed");
+            logError(error);
+        } finally {
+            await stopAgent(proc);
+        }
     }
 }
 
@@ -137,4 +144,4 @@ export {
     log,
     logError,
     sleep
-}
+}