Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); feat: add a project command menu to the TUI by notgitika · Pull Request #2143 · aws/agentcore-cli · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions src/components/Root.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -107,9 +107,15 @@ import { GatewayRuleScreen } from "../handlers/gateway/rule/screen.tsx";
import { GatewayRuleListScreen } from "../handlers/gateway/rule/list/screen.tsx";
import { GatewayRuleGetScreen } from "../handlers/gateway/rule/get/screen.tsx";
import { GatewayInvokeScreen } from "../handlers/gateway/invoke/screen.tsx";
import { ProjectScreen, ProjectCommandNotImplementedScreen } from "../handlers/project/screen.tsx";
import { RootScreen, HelpScreen } from "../handlers/screen.tsx";
import type { Context } from "../router";

// PROJECT_COMMANDS are the `agentcore project` subcommands that are listed in
// the menu but have no screen of their own yet. Each is routed explicitly so
// selecting it reports "not implemented" error
const PROJECT_COMMANDS = ["create", "add", "remove", "dev", "deploy", "status", "build"] as const;

export interface RootProps {
// path is the command path to the executing node (e.g. "/agentcore").
path: string;
Expand DownExpand Up@@ -736,6 +742,16 @@ export function Root({ path, ctx, core, queryClient }: RootProps) {
path="agentcore/identity/oauth2-credential-provider/get/:name/json"
element={<Oauth2CredentialProviderGetJsonScreen ctx={ctx} core={core} />}
/>
<Route path="agentcore/project" element={<ProjectScreen ctx={ctx} core={core} />} />
{PROJECT_COMMANDS.map((command) => (
<Route
key={command}
path={`agentcore/project/${command}`}
element={
<ProjectCommandNotImplementedScreen ctx={ctx} core={core} command={command} />
}
/>
))}
<Route path="*" element={<HelpScreen ctx={ctx} core={core} />} />
</Routes>
</MemoryRouter>
Expand Down
2 changes: 1 addition & 1 deletion src/handlers/index.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export function createRootHandler(core: Core, config: RootHandlerConfig): Router
root.handler(createGatewayHandler(core, io));
root.handler(createEvalHandler(core, io));
root.handler(createConfigHandler());
root.handler(createProjectHandler({ projectManager: core.projectManager, io }));
root.handler(createProjectHandler({ core, io }));

// Invoking with no subcommand launches the interactive TUI.
root.default(renderTui(core, io));
Expand Down
16 changes: 11 additions & 5 deletions src/handlers/project/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,8 @@ import { ContainerDevRunner } from "../../core/dev/container";
import { InspectorAssets } from "../../core/dev/inspectorAssets";
import { startOtelCollector } from "../../core/dev/otel/collector";
import { withProject } from "../../middleware";
import { renderTui } from "../../tui";
import type { Core } from "../types";
import { createCreateProjectHandler } from "./create";
import { createRemoveProjectHandler } from "./remove";
import { createDevProjectHandler } from "./dev";
Expand All@@ -16,16 +18,20 @@ import type { ProjectManager } from "./types";
import { createAddProjectResourceHandler } from "./add";

type ProjectHandlerConfig = {
projectManager: ProjectManager;
core: Core;
io: AppIO;
};

export function createProjectHandler(config: ProjectHandlerConfig): Router {
export function createProjectHandler({ core, io }: ProjectHandlerConfig): Router {
const projectManager: ProjectManager = core.projectManager;
const config = { projectManager, io };
const project = new Router("project", "manage an AgentCore project");

project.handler(
createCreateProjectHandler({ projectManager: config.projectManager, io: config.io }),
);
// Without a default, a bare `agentcore project` falls back to Commander's help
// and a usage exit code instead of the menu every sibling router opens.
project.default(renderTui(core, io));

project.handler(createCreateProjectHandler({ projectManager, io }));
project.handler(createAddProjectResourceHandler(config));
project.handler(
withProject({ projectManager: config.projectManager })(
Expand Down
158 changes: 158 additions & 0 deletions src/handlers/project/project.screen.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
import { test, expect, describe, afterEach } from "bun:test";
import {
renderScreen,
waitForText,
cleanupScreens,
createSilentLogger,
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
} from "../../testing";
import { renderTuiAt } from "../../tui";
import { InvalidEnvironmentError, NotImplementedError } from "../../errors";
import { compile, ValueContext } from "../../router";
import { ExitCode } from "../../runnable";
import { createRootHandler } from "../index";

afterEach(cleanupScreens);

// projectSubcommands reads the project group's children off the compiled
// Commander tree, so tests driven by it cover any subcommand added later.
function projectSubcommands(): string[] {
const root = compile(
createRootHandler(new TestCoreClient(), {
io: testIO().io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
}),
ValueContext.EmptyContext(),
);
const project = root.commands.find((command) => command.name() === "project")!;
// `help` is Commander's own, not one of ours.
return project.commands.map((command) => command.name()).filter((name) => name !== "help");
}

describe("project menu", () => {
test("lists every project subcommand", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "manage an AgentCore project");
const frame = r.lastFrame()!;
for (const command of projectSubcommands()) {
expect(frame).toContain(command);
}
r.unmount();
});

test("is reachable from the root menu", async () => {
const r = renderScreen("/agentcore");

await waitForText(r.lastFrame, "manage an AgentCore project");
await r.write("project");
await waitForText(r.lastFrame, "❯ project");
await r.press("return");

await waitForText(r.lastFrame, "agentcore → project");
expect(r.lastFrame()).toContain("create");
r.unmount();
});

test("esc returns to the root menu", async () => {
const r = renderScreen("/agentcore/project");

await waitForText(r.lastFrame, "agentcore → project");
await r.press("escape");

await waitForText(r.lastFrame, "the platform for production AI agents");
r.unmount();
});
});

describe("project subcommands without a screen", () => {
// renderTuiAt rather than renderScreen: ink-testing-library exposes no
// waitUntilExit, so it cannot observe the rejection under test.
//
// Reading the cases off the router also guards Root's hand-written
// PROJECT_COMMANDS: an unrouted subcommand hits the catch-all, which resolves
// instead of rejecting. Frames can't detect that — the catch-all exits before
// painting, so it and this screen both render empty.
test.each(projectSubcommands())(
"%s tears down the TUI with NotImplementedError",
async (command) => {
const { streams } = ttyTestIO();

const rendering = renderTuiAt(
`/agentcore/project/${command}`,
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
);

await expect(rendering).rejects.toThrow(NotImplementedError);
await expect(rendering).rejects.toThrow(`'agentcore project ${command}'`);
},
);

test("the error names the command to run instead", async () => {
const { streams } = ttyTestIO();

const caught: unknown = await renderTuiAt(
"/agentcore/project/deploy",
ValueContext.EmptyContext(),
new TestCoreClient(),
streams.io,
).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(NotImplementedError);
const error = caught as NotImplementedError;
expect(error.message).toContain("agentcore project deploy --help");
// Surfaces as a plain CLI failure, not a crash.
expect(error.exitCode).toBe(1);
});
});

describe("agentcore project (no subcommand)", () => {
// Exercises the real CLI entrypoint; the screen tests mount a path directly
// and so never caught the missing default handler.
//
// Asserts renderTui's TTY guard rather than a rendered frame: Ink only writes
// frames incrementally when interactive (`!isInCi && isTTY`), so asserting on
// frames here would pass locally and time out under CI. Reaching the guard at
// all proves the group routed to the TUI — Commander help neither throws nor
// touches stderr.
test("routes to the TUI rather than printing Commander help", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

const caught: unknown = await root.route(["node", "agentcore", "project"]).then(
() => undefined,
(error: unknown) => error,
);

expect(caught).toBeInstanceOf(InvalidEnvironmentError);
expect((caught as InvalidEnvironmentError).exitCode).toBe(ExitCode.USAGE);
expect(io.stdout()).toBe("");
});

test("prints help instead of the TUI under --json", async () => {
const io = testIO();
const root = createRootHandler(new TestCoreClient(), {
io: io.io,
logger: createSilentLogger(),
globalConfigAccessor: new TestGlobalConfigAccessor(),
});

await root.route(["node", "agentcore", "project", "--json"]);

expect(io.stdout()).toContain("Usage:");
expect(io.stdout()).toContain("create");
});
});
37 changes: 37 additions & 0 deletions src/handlers/project/screen.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import { useEffect } from "react";
import { useApp } from "ink";
import { RouterScreen } from "../../components/RouterScreen";
import { NotImplementedError } from "../../errors";
import type { ScreenProps } from "../types";

export function ProjectScreen(props: ScreenProps) {
return <RouterScreen {...props} path={["agentcore", "project"]} />;
}

export interface ProjectCommandNotImplementedScreenProps extends ScreenProps {
// command is the project subcommand the user selected, e.g. "deploy".
command: string;
}

// ProjectCommandNotImplementedScreen is the landing screen for a project
// subcommand that is listed in the menu but has no screen yet.
//
// exit(error) rejects the waitUntilExit() that renderTuiAt awaits, so the TUI
// tears down and the error takes the normal CLI path. Throwing during render
// would surface a React stack trace instead.
export function ProjectCommandNotImplementedScreen({
command,
}: ProjectCommandNotImplementedScreenProps) {
const { exit } = useApp();

useEffect(() => {
exit(
new NotImplementedError(
`'agentcore project ${command}' has no interactive screen yet; ` +
`run 'agentcore project ${command} --help' to use it from the command line`,
),
);
}, [exit, command]);

return null;
}
2 changes: 1 addition & 1 deletion src/testing/index.tsx
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
export { parse, stringify } from "./serialization";
export { fixtureFactories, fixtureFetch, isRecording, matchGolden, settle } from "./fixtures";
export { testIO, type TestIO } from "./testIO";
export { testIO, ttyTestIO, type TestIO, type TtyInput } from "./testIO";
export { tick, waitFor, WaitForTimeoutError } from "./timing";
export {
TestCoreClient,
Expand Down
29 changes: 29 additions & 0 deletions src/testing/testIO.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -53,3 +53,32 @@ export function testIO({ isTTY = false, stdin: stdinContent }: TestIOOptions = {
stderr: err.read,
};
}

// TtyInput is the writable stdin of a TTY TestIO: tests push raw key sequences
// into it to drive a mounted TUI.
export interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

// ttyTestIO builds a TestIO that Ink accepts as a real terminal: isTTY, the
// no-op stdin methods Ink calls when it takes over, and a window size (Ink needs
// columns/rows to lay out frames). For tests that mount the TUI through
// renderTui/renderTuiAt rather than ink-testing-library.
export function ttyTestIO(columns = 100, rows = 40): { streams: TestIO; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: columns },
rows: { configurable: true, value: rows },
});
return { streams, stdin };
}
24 changes: 1 addition & 23 deletions src/tui/tui.test.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,34 +7,12 @@ import {
TestCoreClient,
TestGlobalConfigAccessor,
testIO,
ttyTestIO,
tick,
waitFor,
} from "../testing";
import { ExitCode } from "../runnable";

interface TtyInput extends NodeJS.ReadStream {
write(chunk: string): boolean;
}

function ttyTestIO(): { streams: ReturnType<typeof testIO>; stdin: TtyInput } {
const streams = testIO({ isTTY: true });
const stdin = streams.io.stdin as TtyInput;
stdin.setRawMode = function () {
return this;
};
stdin.ref = function () {
return this;
};
stdin.unref = function () {
return this;
};
Object.defineProperties(streams.io.stdout, {
columns: { configurable: true, value: 100 },
rows: { configurable: true, value: 40 },
});
return { streams, stdin };
}

describe("renderJson", () => {
test("pretty-prints a value as indented JSON to the given writer", () => {
const lines: string[] = [];
Expand Down
Loading