agentapi module

Author: hugodutka

registry/coder/modules/agentapi/README.md

@@ -0,0 +1,54 @@
+---
+display_name: AgentAPI
+description: Building block for modules that need to run an agentapi server
+icon: ../../../../.icons/coder.svg
+maintainer_github: coder
+verified: true
+tags: [internal]
+---
+
+# AgentAPI
+
+The AgentAPI module is a building block for modules that need to run an agentapi server. It is intended primarily for internal use by Coder to create modules compatible with Tasks.
+
+We do not recommend using this module directly. Instead, please consider using one of our [Tasks-compatible AI agent modules](https://registry.coder.com/modules?search=tag%3Atasks).
+
+```tf
+module "agentapi" {
+  source  = "registry.coder.com/coder/agentapi/coder"
+  version = "1.0.0"
+
+  agent_id             = var.agent_id
+  web_app_slug         = local.app_slug
+  web_app_order        = var.order
+  web_app_group        = var.group
+  web_app_icon         = var.icon
+  web_app_display_name = "Goose"
+  cli_app_slug         = "goose-cli"
+  cli_app_display_name = "Goose CLI"
+  module_dir_name      = local.module_dir_name
+  install_agentapi     = var.install_agentapi
+  pre_install_script   = var.pre_install_script
+  post_install_script  = var.post_install_script
+  start_script         = local.start_script
+  install_script       = <<-EOT
+    #!/bin/bash
+    set -o errexit
+    set -o pipefail
+
+    echo -n '${base64encode(local.install_script)}' | base64 -d > /tmp/install.sh
+    chmod +x /tmp/install.sh
+
+    ARG_PROVIDER='${var.goose_provider}' \
+    ARG_MODEL='${var.goose_model}' \
+    ARG_GOOSE_CONFIG="$(echo -n '${base64encode(local.combined_extensions)}' | base64 -d)" \
+    ARG_INSTALL='${var.install_goose}' \
+    ARG_GOOSE_VERSION='${var.goose_version}' \
+    /tmp/install.sh
+  EOT
+}
+```
+
+## For module developers
+
+For a complete example of how to use this module, see the [goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf).

registry/coder/modules/agentapi/main.test.ts

@@ -0,0 +1,151 @@
+import {
+  test,
+  afterEach,
+  expect,
+  describe,
+  setDefaultTimeout,
+  beforeAll,
+} from "bun:test";
+import { execContainer, readFileContainer, runTerraformInit } from "~test";
+import {
+  loadTestFile,
+  writeExecutable,
+  setup as setupUtil,
+  execModuleScript,
+  expectAgentAPIStarted,
+} from "./test-util";
+
+let cleanupFunctions: (() => Promise<void>)[] = [];
+
+const registerCleanup = (cleanup: () => Promise<void>) => {
+  cleanupFunctions.push(cleanup);
+};
+
+// Cleanup logic depends on the fact that bun's built-in test runner
+// runs tests sequentially.
+// https://bun.sh/docs/test/discovery#execution-order
+// Weird things would happen if tried to run tests in parallel.
+// One test could clean up resources that another test was still using.
+afterEach(async () => {
+  // reverse the cleanup functions so that they are run in the correct order
+  const cleanupFnsCopy = cleanupFunctions.slice().reverse();
+  cleanupFunctions = [];
+  for (const cleanup of cleanupFnsCopy) {
+    try {
+      await cleanup();
+    } catch (error) {
+      console.error("Error during cleanup:", error);
+    }
+  }
+});
+
+interface SetupProps {
+  skipAgentAPIMock?: boolean;
+  moduleVariables?: Record<string, string>;
+}
+
+const moduleDirName = ".agentapi-module";
+
+const setup = async (props?: SetupProps): Promise<{ id: string }> => {
+  const projectDir = "/home/coder/project";
+  const { id } = await setupUtil({
+    moduleVariables: {
+      experiment_report_tasks: "true",
+      install_agentapi: props?.skipAgentAPIMock ? "true" : "false",
+      web_app_display_name: "AgentAPI Web",
+      web_app_slug: "agentapi-web",
+      web_app_icon: "/icon/coder.svg",
+      cli_app_display_name: "AgentAPI CLI",
+      cli_app_slug: "agentapi-cli",
+      agentapi_version: "latest",
+      module_dir_name: moduleDirName,
+      start_script: await loadTestFile(import.meta.dir, "agentapi-start.sh"),
+      folder: projectDir,
+      ...props?.moduleVariables,
+    },
+    registerCleanup,
+    projectDir,
+    skipAgentAPIMock: props?.skipAgentAPIMock,
+    moduleDir: import.meta.dir,
+  });
+  await writeExecutable({
+    containerId: id,
+    filePath: "/usr/bin/aiagent",
+    content: await loadTestFile(import.meta.dir, "ai-agent-mock.js"),
+  });
+  return { id };
+};
+
+// increase the default timeout to 60 seconds
+setDefaultTimeout(60 * 1000);
+
+// we don't run these tests in CI because they take too long and make network
+// calls. they are dedicated for local development.
+describe("agentapi", async () => {
+  beforeAll(async () => {
+    await runTerraformInit(import.meta.dir);
+  });
+
+  test("happy-path", async () => {
+    const { id } = await setup();
+
+    await execModuleScript(id);
+
+    await expectAgentAPIStarted(id);
+  });
+
+  test("custom-port", async () => {
+    const { id } = await setup({
+      moduleVariables: {
+        agentapi_port: "3827",
+      },
+    });
+    await execModuleScript(id);
+    await expectAgentAPIStarted(id, 3827);
+  });
+
+  test("pre-post-install-scripts", async () => {
+    const { id } = await setup({
+      moduleVariables: {
+        pre_install_script: `#!/bin/bash\necho "pre-install"`,
+        install_script: `#!/bin/bash\necho "install"`,
+        post_install_script: `#!/bin/bash\necho "post-install"`,
+      },
+    });
+
+    await execModuleScript(id);
+    await expectAgentAPIStarted(id);
+
+    const preInstallLog = await readFileContainer(
+      id,
+      `/home/coder/${moduleDirName}/pre_install.log`,
+    );
+    const installLog = await readFileContainer(
+      id,
+      `/home/coder/${moduleDirName}/install.log`,
+    );
+    const postInstallLog = await readFileContainer(
+      id,
+      `/home/coder/${moduleDirName}/post_install.log`,
+    );
+
+    expect(preInstallLog).toContain("pre-install");
+    expect(installLog).toContain("install");
+    expect(postInstallLog).toContain("post-install");
+  });
+
+  test("install-agentapi", async () => {
+    const { id } = await setup({ skipAgentAPIMock: true });
+
+    const respModuleScript = await execModuleScript(id);
+    expect(respModuleScript.exitCode).toBe(0);
+
+    await expectAgentAPIStarted(id);
+    const respAgentAPI = await execContainer(id, [
+      "bash",
+      "-c",
+      "agentapi --version",
+    ]);
+    expect(respAgentAPI.exitCode).toBe(0);
+  });
+});