Skip to content

Commit

Permalink
Add prompting unit tests and deprecate more V1 stuff
Browse files Browse the repository at this point in the history 
Signed-off-by: Timothy Johnson <[email protected]>
  • Loading branch information
@t1m0thyj
t1m0thyj committed Aug 22, 2024
1 parent cad2e86 commit 96723b6
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 101 deletions.
215 changes: 115 additions & 100 deletions packages/imperative/src/cmd/__tests__/CommandProcessor.unit.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,11 @@ const FAKE_HELP_GENERATOR: IHelpGenerator = {
const ENV_VAR_PREFIX: string = "UNIT_TEST";

describe("Command Processor", () => {
beforeEach(() => {
// Mock read stdin
jest.spyOn(SharedOptions, "readStdinIfRequested").mockResolvedValueOnce(false);
});

// Restore everything after each test
afterEach(() => {
process.stdout.write = ORIGINAL_STDOUT_WRITE;
Expand Down Expand Up @@ -800,11 +805,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -845,11 +845,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -887,11 +882,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -938,11 +928,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -971,11 +956,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1012,11 +992,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1053,11 +1028,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1094,11 +1064,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1138,11 +1103,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1177,11 +1137,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1209,11 +1164,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: ["check", "for", "banana"],
Expand Down Expand Up @@ -1596,11 +1546,6 @@ describe("Command Processor", () => {
}
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

jest.spyOn(process, "chdir");
const mockConfigReload = jest.fn();
jest.spyOn(ImperativeConfig, "instance", "get").mockReturnValue({
Expand Down Expand Up @@ -1653,11 +1598,6 @@ describe("Command Processor", () => {
}
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

jest.spyOn(process, "chdir");
const mockConfigReload = jest.fn();
jest.spyOn(ImperativeConfig, "instance", "get").mockReturnValue({
Expand Down Expand Up @@ -1706,11 +1646,6 @@ describe("Command Processor", () => {
config: ImperativeConfig.instance.config
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

// return the "fake" args object with values from profile
const getOptValuesSpy = jest.spyOn(CliUtils, "getOptValuesFromConfig").mockReturnValueOnce({ color: "yellow" });

Expand Down Expand Up @@ -1741,11 +1676,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

// return the "fake" args object with values from profile
jest.spyOn(CliUtils, "getOptValuesFromConfig").mockReturnValueOnce({});

Expand Down Expand Up @@ -1776,11 +1706,6 @@ describe("Command Processor", () => {
config: ImperativeConfig.instance.config
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

// return the "fake" args object with values from profile
const getOptValuesSpy = jest.spyOn(CliUtils, "getOptValuesFromConfig").mockReturnValueOnce({ color: "yellow" });

Expand Down Expand Up @@ -1812,11 +1737,6 @@ describe("Command Processor", () => {
config: ImperativeConfig.instance.config
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

// return the "fake" args object with values from profile
const getOptValuesSpy = jest.spyOn(CliUtils, "getOptValuesFromConfig").mockReturnValueOnce({ color: "yellow" });

Expand Down Expand Up @@ -1849,11 +1769,6 @@ describe("Command Processor", () => {
config: ImperativeConfig.instance.config
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

// return the "fake" args object with values from profile
const getOptValuesSpy = jest.spyOn(CliUtils, "getOptValuesFromConfig").mockReturnValueOnce({ color: "yellow" });

Expand Down Expand Up @@ -1923,11 +1838,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: [],
Expand Down Expand Up @@ -1958,11 +1868,6 @@ describe("Command Processor", () => {
promptPhrase: "dummydummy"
});

// Mock read stdin
(SharedOptions.readStdinIfRequested as any) = jest.fn((args, response, type) => {
// Nothing to do
});

const parms: any = {
arguments: {
_: [],
Expand Down Expand Up @@ -2176,4 +2081,114 @@ describe("Command Processor", () => {
expect(preparedArgs.color).toBe("green");
});
});

describe("prompting", () => {
const invokeParms: any = {
arguments: {
_: ["check", "for", "banana"],
$0: "",
valid: true
},
silent: true
};
function buildProcessor(definition: ICommandDefinition): CommandProcessor {
return new CommandProcessor({
envVariablePrefix: ENV_VAR_PREFIX,
fullDefinition: SAMPLE_CMD_WITH_OPTS_AND_PROF,
definition,
helpGenerator: FAKE_HELP_GENERATOR,
rootCommandName: SAMPLE_ROOT_COMMAND,
commandLine: "",
promptPhrase: "please"
});
}

it("should prompt for missing positional with string type", async () => {
// Allocate the command processor
const processor = buildProcessor(SAMPLE_COMMAND_REAL_HANDLER_WITH_POS_OPT);

const promptMock = jest.fn().mockResolvedValue("yellow");
jest.spyOn(CommandResponse.prototype, "console", "get").mockReturnValueOnce({
prompt: promptMock
} as any);

invokeParms.arguments.color = "please";
const commandResponse: ICommandResponse = await processor.invoke(invokeParms);
expect(commandResponse).toBeDefined();
expect(promptMock).toHaveBeenCalledTimes(1);
expect(promptMock.mock.calls[0][0]).toContain(`Please enter "color"`);
expect(invokeParms.arguments.color).toBe("yellow");
});

it("should prompt for missing positional with array type", async () => {
// Allocate the command processor
const processor = buildProcessor({
...SAMPLE_COMMAND_REAL_HANDLER_WITH_POS_OPT,
positionals: [
{
name: "color",
type: "array",
description: "The banana colors.",
required: true
}
],
});

const promptMock = jest.fn().mockResolvedValue("yellow brown");
jest.spyOn(CommandResponse.prototype, "console", "get").mockReturnValueOnce({
prompt: promptMock
} as any);

invokeParms.arguments.color = ["please"];
const commandResponse: ICommandResponse = await processor.invoke(invokeParms);
expect(commandResponse).toBeDefined();
expect(promptMock).toHaveBeenCalledTimes(1);
expect(promptMock.mock.calls[0][0]).toContain(`Please enter "color"`);
expect(invokeParms.arguments.color).toEqual(["yellow", "brown"]);
});

it("should prompt for missing option with string type", async () => {
// Allocate the command processor
const processor = buildProcessor(SAMPLE_COMMAND_REAL_HANDLER_WITH_OPT);

const promptMock = jest.fn().mockResolvedValue("yellow");
jest.spyOn(CommandResponse.prototype, "console", "get").mockReturnValueOnce({
prompt: promptMock
} as any);

invokeParms.arguments.color = "please";
const commandResponse: ICommandResponse = await processor.invoke(invokeParms);
expect(commandResponse).toBeDefined();
expect(promptMock).toHaveBeenCalledTimes(1);
expect(promptMock.mock.calls[0][0]).toContain(`Please enter "color"`);
expect(invokeParms.arguments.color).toBe("yellow");
});

it("should prompt for missing option with array type", async () => {
// Allocate the command processor
const processor = buildProcessor({
...SAMPLE_COMMAND_REAL_HANDLER_WITH_OPT,
options: [
{
name: "color",
type: "array",
description: "The banana colors.",
required: true
}
],
});

const promptMock = jest.fn().mockResolvedValue("yellow brown");
jest.spyOn(CommandResponse.prototype, "console", "get").mockReturnValueOnce({
prompt: promptMock
} as any);

invokeParms.arguments.color = ["please"];
const commandResponse: ICommandResponse = await processor.invoke(invokeParms);
expect(commandResponse).toBeDefined();
expect(promptMock).toHaveBeenCalledTimes(1);
expect(promptMock.mock.calls[0][0]).toContain(`Please enter "color"`);
expect(invokeParms.arguments.color).toEqual(["yellow", "brown"]);
});
});
});
3 changes: 2 additions & 1 deletion packages/imperative/src/profiles/src/doc/config/IProfileTypeConfiguration.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export interface IProfileTypeConfiguration {
*
* @type {IProfileDependency[]}
* @memberof IProfileTypeConfiguration
* @deprecated
* @deprecated Only applies to V1 profiles. For team config, use nested profiles instead.
*/
dependencies?: IProfileDependency[];
/**
Expand All @@ -56,6 +56,7 @@ export interface IProfileTypeConfiguration {
*
* @type {string}
* @memberof IProfileTypeConfiguration
* @deprecated Only applies to V1 profiles. For team config, validate with JSON schema instead.
*/
validationPlanModule?: string;
}

0 comments on commit 96723b6

Please sign in to comment.