feat: add command stubs

mdonnalley · mdonnalley · commit 3f942b22aed7 · 2024-11-26T09:58:48.000-07:00
diff --git a/messages/agent.generate.test.md b/messages/agent.generate.test.md
@@ -0,0 +1,19 @@
+# summary
+
+Summary of a command.
+
+# description
+
+More information about a command. Don't repeat the summary.
+
+# flags.name.summary
+
+Description of a flag.
+
+# flags.name.description
+
+More information about a flag. Don't repeat the summary.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>
diff --git a/messages/agent.test.cancel.md b/messages/agent.test.cancel.md
@@ -6,7 +6,7 @@ Cancel a running test for an Agent.
 
 Cancel a running test for an Agent, providing the AiEvaluation ID.
 
-# flags.id.summary
+# flags.job-id.summary
 
 The AiEvaluation ID.
 
diff --git a/messages/agent.test.results.md b/messages/agent.test.results.md
@@ -0,0 +1,19 @@
+# summary
+
+Summary of a command.
+
+# description
+
+More information about a command. Don't repeat the summary.
+
+# flags.name.summary
+
+Description of a flag.
+
+# flags.name.description
+
+More information about a flag. Don't repeat the summary.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>
diff --git a/messages/agent.test.resume.md b/messages/agent.test.resume.md
@@ -0,0 +1,19 @@
+# summary
+
+Summary of a command.
+
+# description
+
+More information about a command. Don't repeat the summary.
+
+# flags.name.summary
+
+Description of a flag.
+
+# flags.name.description
+
+More information about a flag. Don't repeat the summary.
+
+# examples
+
+- <%= config.bin %> <%= command.id %>
diff --git a/package.json b/package.json
@@ -11,9 +11,9 @@
     "@oclif/core": "^4",
     "@oclif/multi-stage-output": "^0.7.12",
     "@salesforce/agents": "^0.1.4",
-    "@salesforce/core": "^8.5.2",
+    "@salesforce/core": "^8.8.0",
     "@salesforce/kit": "^3.2.1",
-    "@salesforce/sf-plugins-core": "^12",
+    "@salesforce/sf-plugins-core": "^12.1.0",
     "ansis": "^3.3.2"
   },
   "devDependencies": {
@@ -60,7 +60,16 @@
     ],
     "topics": {
       "agent": {
-        "description": "Commands to work with agents."
+        "description": "Commands to work with agents.",
+        "external": true,
+        "subtopics": {
+          "test": {
+            "external": true
+          },
+          "generate": {
+            "external": true
+          }
+        }
       }
     },
     "flexibleTaxonomy": true
diff --git a/schemas/agent-create.json b/schemas/agent-create.json
@@ -12,10 +12,8 @@
           "type": "string"
         }
       },
-      "required": [
-        "isSuccess"
-      ],
+      "required": ["isSuccess"],
       "additionalProperties": false
     }
   }
-}
+}
diff --git a/schemas/agent-generate-spec.json b/schemas/agent-generate-spec.json
@@ -15,10 +15,8 @@
           "type": "string"
         }
       },
-      "required": [
-        "isSuccess"
-      ],
+      "required": ["isSuccess"],
       "additionalProperties": false
     }
   }
-}
+}
diff --git a/schemas/agent-test-cancel.json b/schemas/agent-test-cancel.json
@@ -18,11 +18,8 @@
           "type": "string"
         }
       },
-      "required": [
-        "jobId",
-        "success"
-      ],
+      "required": ["jobId", "success"],
       "additionalProperties": false
     }
   }
-}
+}
diff --git a/schemas/agent-test-run.json b/schemas/agent-test-run.json
@@ -18,11 +18,8 @@
           "type": "string"
         }
       },
-      "required": [
-        "jobId",
-        "success"
-      ],
+      "required": ["jobId", "success"],
       "additionalProperties": false
     }
   }
-}
+}
diff --git a/src/commands/agent/generate/test.ts b/src/commands/agent/generate/test.ts
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.generate.test');
+
+export type AgentGenerateTestResult = {
+  path: string;
+};
+
+export default class AgentGenerateTest extends SfCommand<AgentGenerateTestResult> {
+  public static readonly summary = messages.getMessage('summary');
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessages('examples');
+
+  public static readonly flags = {
+    name: Flags.string({
+      summary: messages.getMessage('flags.name.summary'),
+      description: messages.getMessage('flags.name.description'),
+      char: 'n',
+      required: false,
+    }),
+  };
+
+  public async run(): Promise<AgentGenerateTestResult> {
+    const { flags } = await this.parse(AgentGenerateTest);
+
+    const name = flags.name ?? 'world';
+    this.log(`hello ${name} from src/commands/agent/generate/test.ts`);
+    return {
+      path: 'src/commands/agent/generate/test.ts',
+    };
+  }
+}
diff --git a/src/commands/agent/test/cancel.ts b/src/commands/agent/test/cancel.ts
@@ -28,7 +28,7 @@ export default class AgentTestCancel extends SfCommand<AgentTestCancelResult> {
     'job-id': Flags.string({
       char: 'i',
       required: true,
-      summary: messages.getMessage('flags.id.summary'),
+      summary: messages.getMessage('flags.job-id.summary'),
     }),
     'use-most-recent': Flags.boolean({
       char: 'r',
diff --git a/src/commands/agent/test/results.ts b/src/commands/agent/test/results.ts
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.test.results');
+
+export type AgentTestResultsResult = {
+  path: string;
+};
+
+export default class AgentTestResults extends SfCommand<AgentTestResultsResult> {
+  public static readonly summary = messages.getMessage('summary');
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessages('examples');
+
+  public static readonly flags = {
+    name: Flags.string({
+      summary: messages.getMessage('flags.name.summary'),
+      description: messages.getMessage('flags.name.description'),
+      char: 'n',
+      required: false,
+    }),
+  };
+
+  public async run(): Promise<AgentTestResultsResult> {
+    const { flags } = await this.parse(AgentTestResults);
+
+    const name = flags.name ?? 'world';
+    this.log(`hello ${name} from src/commands/agent/test/results.ts`);
+    return {
+      path: 'src/commands/agent/test/results.ts',
+    };
+  }
+}
diff --git a/src/commands/agent/test/resume.ts b/src/commands/agent/test/resume.ts
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
+const messages = Messages.loadMessages('@salesforce/plugin-agent', 'agent.test.resume');
+
+export type AgentTestResumeResult = {
+  path: string;
+};
+
+export default class AgentTestResume extends SfCommand<AgentTestResumeResult> {
+  public static readonly summary = messages.getMessage('summary');
+  public static readonly description = messages.getMessage('description');
+  public static readonly examples = messages.getMessages('examples');
+
+  public static readonly flags = {
+    name: Flags.string({
+      summary: messages.getMessage('flags.name.summary'),
+      description: messages.getMessage('flags.name.description'),
+      char: 'n',
+      required: false,
+    }),
+  };
+
+  public async run(): Promise<AgentTestResumeResult> {
+    const { flags } = await this.parse(AgentTestResume);
+
+    const name = flags.name ?? 'world';
+    this.log(`hello ${name} from src/commands/agent/test/resume.ts`);
+    return {
+      path: 'src/commands/agent/test/resume.ts',
+    };
+  }
+}
diff --git a/src/commands/agent/test/run.ts b/src/commands/agent/test/run.ts
@@ -32,7 +32,8 @@ export default class AgentTestRun extends SfCommand<AgentTestRunResult> {
   public static readonly flags = {
     'target-org': Flags.requiredOrg(),
     'api-version': Flags.orgApiVersion(),
-    // AiEvalDefinitionVersion.Id -- This should really be "test-name"
+    // This should probably be "test-name"
+    // Is it `AiEvaluationDefinition_My_first_test_v1`? or `"My first test v1"`? or `My_first_test_v1`?
     id: Flags.string({
       char: 'i',
       required: true,
@@ -62,6 +63,7 @@ export default class AgentTestRun extends SfCommand<AgentTestRunResult> {
     // Future flags:
     //   suites [array of suite names]
     //   verbose [boolean]
+    //   fail-fast [boolean]
   };
 
   public async run(): Promise<AgentTestRunResult> {
@@ -104,15 +106,18 @@ export default class AgentTestRun extends SfCommand<AgentTestRunResult> {
         if (isTimeoutError(e)) {
           mso.stop('async');
           this.log(`Client timed out after ${flags.wait.minutes} minutes.`);
-          this.log(`Run ${colorize('dim', `sf agent test result --id ${response.id}`)} to check status and results.`);
+          this.log(
+            `Run ${colorize('dim', `sf agent test resume --id ${response.id}`)} to resuming watching this test.`
+          );
         } else {
           mso.error();
           throw e;
         }
       }
     } else {
+      // TODO: cache jobId in TTL cache so we can use it for resume
       mso.stop();
-      this.log(`Run ${colorize('dim', `sf agent test result --id ${response.id}`)} to check status and results.`);
+      this.log(`Run ${colorize('dim', `sf agent test resume --id ${response.id}`)} to resuming watching this test.`);
     }
 
     mso.stop();
diff --git a/test/commands/agent/generate/test.nut.ts b/test/commands/agent/generate/test.nut.ts
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2023, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { execCmd, TestSession } from '@salesforce/cli-plugins-testkit';
+import { expect } from 'chai';
+
+describe('agent generate test NUTs', () => {
+  let session: TestSession;
+
+  before(async () => {
+    session = await TestSession.create({ devhubAuthStrategy: 'NONE' });
+  });
+
+  after(async () => {
+    await session?.clean();
+  });
+
+  it('should display provided name', () => {
+    const name = 'World';
+    const command = `agent generate test --name ${name}`;
+    const output = execCmd(command, { ensureExitCode: 0 }).shellOutput.stdout;
+    expect(output).to.contain(name);
+  });
+});
diff --git a/test/commands/agent/generate/test.test.ts b/test/commands/agent/generate/test.test.ts
diff --git a/test/commands/agent/test/results.nut.ts b/test/commands/agent/test/results.nut.ts
diff --git a/test/commands/agent/test/results.test.ts b/test/commands/agent/test/results.test.ts
diff --git a/test/commands/agent/test/resume.nut.ts b/test/commands/agent/test/resume.nut.ts
diff --git a/test/commands/agent/test/resume.test.ts b/test/commands/agent/test/resume.test.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,8 @@`
`12`	`12`	`"type": "string"`
`13`	`13`	`}`
`14`	`14`	`},`
`15`		`- "required": [`
`16`		`- "isSuccess"`
`17`		`- ],`
	`15`	`+ "required": ["isSuccess"],`
`18`	`16`	`"additionalProperties": false`
`19`	`17`	`}`
`20`	`18`	`}`
`21`		`-}`
	`19`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,8 @@`
`15`	`15`	`"type": "string"`
`16`	`16`	`}`
`17`	`17`	`},`
`18`		`- "required": [`
`19`		`- "isSuccess"`
`20`		`- ],`
	`18`	`+ "required": ["isSuccess"],`
`21`	`19`	`"additionalProperties": false`
`22`	`20`	`}`
`23`	`21`	`}`
`24`		`-}`
	`22`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -18,11 +18,8 @@`
`18`	`18`	`"type": "string"`
`19`	`19`	`}`
`20`	`20`	`},`
`21`		`- "required": [`
`22`		`- "jobId",`
`23`		`- "success"`
`24`		`- ],`
	`21`	`+ "required": ["jobId", "success"],`
`25`	`22`	`"additionalProperties": false`
`26`	`23`	`}`
`27`	`24`	`}`
`28`		`-}`
	`25`	`+}`