@adobe/aio-cli-plugin-api-mesh 1.0.1-beta → 1.0.4-beta

package/README.md

@@ -24,12 +24,30 @@ $ aio discover -i
 Install project dependencies. `npm install`
 
 ```
-aio plugins:link commerce-gateway/tenant
+aio plugins:link api-mesh
 ```
 
 ### Configuration
 
-create a config.json file with the following parameters
+The plugin comes out of the box with configurations for stage and prod. The plugin by default connects to PROD dev console. To connect to STAGE instead:
+
+1. Clear your config before switching the env
+
+```
+aio config clear
+```
+
+2. Switch to stage environment
+
+```
+aio config set cli.env stage
+```
+
+#### Custom Configuration
+
+If you want to have custom configuration instead, please follow the steps below:
+
+1. create a config.json file with the following parameters
 
 ```
 {
@@ -38,7 +56,7 @@ create a config.json file with the following parameters
 }
 ```
 
-Perform the following command to update the configuration
+2. Perform the following command to update the configuration
 
 ```
 aio config:set api-mesh.configPath <path_to_json_file>
@@ -47,9 +65,14 @@ aio config:set api-mesh.configPath <path_to_json_file>
 # Commands
 
 ```
-aio api-mesh:get meshId
-aio api-mesh:get meshId PATH_OF_FILE_TO_DOWNLOAD_INTO
+aio api-mesh:describe
+aio api-mesh:get
+aio api-mesh:get PATH_OF_FILE_TO_DOWNLOAD_INTO
 aio api-mesh:create PATH_OF_MESH_CONFIG_JSON_FILE
-aio api-mesh:update meshId PATH_OF_MESH_CONFIG_JSON_FILE
-aio api-mesh:delete meshId
+aio api-mesh:update PATH_OF_MESH_CONFIG_JSON_FILE
+aio api-mesh:delete
 ```
+
+All commands support `-i` or `--ignoreCache` flag that will force the CLI to ignore the cached Org, Project and Workspace details and prompt the user to select new options just for that action.
+
+Create, Update and Delete support `-c` or `--autoConfirmAction` flag that will not prompt the user for action confirmation mostly used for testing or scaffolding where user prompt can not be handled. This flag is only to be used in certain situations.

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.1-beta","commands":{"PLUGINNAME":{"id":"PLUGINNAME","description":"Your description here","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio PLUGINNAME:some_command"],"flags":{"someflag":{"name":"someflag","type":"option","char":"f","description":"this is some flag"}},"args":[]},"api-mesh:create":{"id":"api-mesh:create","description":"Create a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"file"}]},"api-mesh:delete":{"id":"api-mesh:delete","description":"Delete the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"}]},"api-mesh:get":{"id":"api-mesh:get","description":"Get the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"},{"name":"file"}]},"api-mesh:update":{"id":"api-mesh:update","description":"Update a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"meshId"},{"name":"file"}]}}}
+{"version":"1.0.4-beta","commands":{"PLUGINNAME":{"id":"PLUGINNAME","description":"Your description here","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"examples":["$ aio PLUGINNAME:some_command"],"flags":{"someflag":{"name":"someflag","type":"option","char":"f","description":"this is some flag"}},"args":[]},"api-mesh:create":{"id":"api-mesh:create","description":"Create a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false}},"args":[{"name":"file"}]},"api-mesh:delete":{"id":"api-mesh:delete","description":"Delete the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false}},"args":[]},"api-mesh:describe":{"id":"api-mesh:describe","description":"Get details of a mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false}},"args":[]},"api-mesh:get":{"id":"api-mesh:get","description":"Get the config of a given mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false}},"args":[{"name":"file"}]},"api-mesh:update":{"id":"api-mesh:update","description":"Update a mesh with the given config.","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{"ignoreCache":{"name":"ignoreCache","type":"boolean","char":"i","description":"Ignore cache and force manual org -> project -> workspace selection","allowNo":false},"autoConfirmAction":{"name":"autoConfirmAction","type":"boolean","char":"c","description":"Auto confirm action prompt. CLI will not check for user approval before executing the action.","allowNo":false}},"args":[{"name":"file"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@adobe/aio-cli-plugin-api-mesh",
-	"version": "1.0.1-beta",
+	"version": "1.0.4-beta",
 	"publishConfig": {
 		"access": "public"
 	},
@@ -12,9 +12,11 @@
 		"@adobe/aio-lib-ims": "^5.0.1",
 		"@oclif/command": "^1.6.1",
 		"@oclif/config": "^1.15.1",
+		"@oclif/core": "^1.14.1",
 		"@oclif/errors": "^1.1.2",
 		"axios": "^0.23.0",
 		"dotenv": "^16.0.1",
+		"inquirer": "^8.2.4",
 		"pino": "^7.9.2",
 		"pino-pretty": "^7.6.0",
 		"uuid": "^8.3.2"

package/src/commands/api-mesh/__tests__/create.test.js

@@ -12,65 +12,477 @@ governing permissions and limitations under the License.
 
 const mockConsoleCLIInstance = {};
 
-jest.mock('@adobe/aio-lib-env');
-jest.mock('@adobe/aio-cli-lib-console');
+const CreateCommand = require('../create');
+const sampleCreateMeshConfig = require('../../__fixtures__/sample_mesh.json');
+const { initSdk, initRequestId, promptConfirm } = require('../../../helpers');
+const {
+	createMesh,
+	createAPIMeshCredentials,
+	subscribeCredentialToMeshService,
+} = require('../../../lib/devConsole');
 
-const orgs = [{ id: '1234', code: 'CODE1234@AdobeOrg', name: 'ORG01', type: 'entp' }];
 const selectedOrg = { id: '1234', code: 'CODE1234@AdobeOrg', name: 'ORG01', type: 'entp' };
 
-const projects = [{ id: '5678', title: 'Project01' }];
 const selectedProject = { id: '5678', title: 'Project01' };
 
-const workspaces = [{ id: '123456789', title: 'Workspace01' }];
 const selectedWorkspace = { id: '123456789', title: 'Workspace01' };
 
-function setDefaultMockConsoleCLI() {
-	mockConsoleCLIInstance.getToken = jest.fn().mockReturnValue('test_token');
-	mockConsoleCLIInstance.getCliEnv = jest.fn().mockReturnValue('prod');
-
-	mockConsoleCLIInstance.getOrganizations = jest.fn().mockResolvedValue(orgs);
-	mockConsoleCLIInstance.promptForSelectOrganization = jest.fn().mockResolvedValue(selectedOrg);
-
-	mockConsoleCLIInstance.getProjects = jest.fn().mockResolvedValue(projects);
-	mockConsoleCLIInstance.promptForSelectProject = jest.fn().mockResolvedValue(selectedProject);
-
-	mockConsoleCLIInstance.getWorkspaces = jest.fn().mockResolvedValue(workspaces);
-	mockConsoleCLIInstance.promptForSelectWorkspace = jest.fn().mockResolvedValue(selectedWorkspace);
-}
 jest.mock('@adobe/aio-cli-lib-console', () => ({
 	init: jest.fn().mockResolvedValue(mockConsoleCLIInstance),
 	cleanStdOut: jest.fn(),
 }));
+
+jest.mock('axios');
 jest.mock('@adobe/aio-lib-ims');
-const CreateCommand = require('../create');
-const { SchemaServiceClient } = require('../../../classes/SchemaServiceClient');
-const mockCreateMesh = require('../../__fixtures__/sample_mesh.json');
+jest.mock('@adobe/aio-lib-env');
+jest.mock('@adobe/aio-cli-lib-console');
+jest.mock('../../../helpers', () => ({
+	initSdk: jest.fn().mockResolvedValue({}),
+	initRequestId: jest.fn().mockResolvedValue({}),
+	promptConfirm: jest.fn().mockResolvedValue(true),
+}));
+jest.mock('../../../lib/devConsole');
+
+let logSpy = null;
+let errorLogSpy = null;
+
+let parseSpy = null;
+
+const mockIgnoreCacheFlag = Promise.resolve(true);
+const mockAutoApproveAction = Promise.resolve(false);
 
 describe('create command tests', () => {
 	beforeEach(() => {
-		setDefaultMockConsoleCLI();
-		const response = mockCreateMesh;
-		jest.spyOn(SchemaServiceClient.prototype, 'createMesh').mockImplementation(data => response);
+		initSdk.mockResolvedValue({
+			imsOrgId: selectedOrg.id,
+			projectId: selectedProject.id,
+			workspaceId: selectedWorkspace.id,
+		});
+
+		global.requestId = 'dummy_request_id';
+
+		logSpy = jest.spyOn(CreateCommand.prototype, 'log');
+		errorLogSpy = jest.spyOn(CreateCommand.prototype, 'error');
+
+		createMesh.mockResolvedValue({
+			meshId: 'dummy_mesh_id',
+			meshConfig: sampleCreateMeshConfig.meshConfig,
+		});
+		createAPIMeshCredentials.mockResolvedValue({
+			apiKey: 'dummy_api_key',
+			id: 'dummy_id',
+		});
+		subscribeCredentialToMeshService.mockResolvedValue(['dummy_service']);
+
+		parseSpy = jest.spyOn(CreateCommand.prototype, 'parse');
+		parseSpy.mockResolvedValue({
+			args: { file: 'src/commands/__fixtures__/sample_mesh.json' },
+			flags: {
+				ignoreCache: mockIgnoreCacheFlag,
+				autoConfirmAction: mockAutoApproveAction,
+			},
+		});
 	});
 
 	afterEach(() => {
 		jest.restoreAllMocks();
 	});
 
-	test('create-mesh-missing-file', async () => {
-		expect.assertions(2);
-		const runResult = CreateCommand.run([]);
-		await expect(runResult instanceof Promise).toBeTruthy();
+	test('snapshot create command description', () => {
+		expect(CreateCommand.description).toMatchInlineSnapshot(
+			`"Create a mesh with the given config."`,
+		);
+		expect(CreateCommand.args).toMatchInlineSnapshot(`
+		Array [
+		  Object {
+		    "name": "file",
+		  },
+		]
+	`);
+		expect(CreateCommand.flags).toMatchInlineSnapshot(`
+		Object {
+		  "autoConfirmAction": Object {
+		    "allowNo": false,
+		    "char": "c",
+		    "default": false,
+		    "description": "Auto confirm action prompt. CLI will not check for user approval before executing the action.",
+		    "parse": [Function],
+		    "type": "boolean",
+		  },
+		  "ignoreCache": Object {
+		    "allowNo": false,
+		    "char": "i",
+		    "default": false,
+		    "description": "Ignore cache and force manual org -> project -> workspace selection",
+		    "parse": [Function],
+		    "type": "boolean",
+		  },
+		}
+	`);
+		expect(CreateCommand.aliases).toMatchInlineSnapshot(`Array []`);
+	});
+
+	test('should fail if mesh config file arg is missing', async () => {
+		parseSpy.mockResolvedValueOnce({
+			args: {},
+			flags: {
+				ignoreCache: mockIgnoreCacheFlag,
+				autoConfirmAction: mockAutoApproveAction,
+			},
+		});
+		const runResult = CreateCommand.run();
+
+		await expect(runResult).rejects.toEqual(
+			new Error('Missing file path. Run aio api-mesh create --help for more info.'),
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`Array []`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Missing file path. Run aio api-mesh create --help for more info.",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if mesh file is invalid', async () => {
+		parseSpy.mockResolvedValueOnce({
+			args: { file: 'dummy_file_path' },
+			flags: {
+				ignoreCache: mockIgnoreCacheFlag,
+				autoConfirmAction: mockAutoApproveAction,
+			},
+		});
+		const runResult = CreateCommand.run();
+
 		await expect(runResult).rejects.toEqual(
 			new Error(
 				'Unable to read the mesh configuration file provided. Please check the file and try again.',
 			),
 		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "ENOENT: no such file or directory, open 'dummy_file_path'",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Unable to read the mesh configuration file provided. Please check the file and try again.",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if create mesh api has failed', async () => {
+		createMesh.mockRejectedValueOnce(new Error('create mesh api failed'));
+
+		const runResult = CreateCommand.run();
+
+		await expect(runResult).rejects.toEqual(
+			new Error(
+				'Unable to create a mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id',
+			),
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "create mesh api failed",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Unable to create a mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id",
+		  ],
+		]
+	`);
+	});
+
+	test('should fail if create api credential api has failed', async () => {
+		createAPIMeshCredentials.mockRejectedValueOnce(new Error('create api credential api failed'));
+
+		const runResult = CreateCommand.run();
+
+		await expect(runResult).rejects.toEqual(
+			new Error(
+				'Unable to create a mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id',
+			),
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Successfully created mesh %s",
+		    "dummy_mesh_id",
+		  ],
+		  Array [
+		    "{
+		  \\"meshId\\": \\"dummy_mesh_id\\",
+		  \\"meshConfig\\": {
+		    \\"sources\\": [
+		      {
+		        \\"name\\": \\"<api_name>\\",
+		        \\"handler\\": {
+		          \\"graphql\\": {
+		            \\"endpoint\\": \\"<gql_endpoint>\\"
+		          }
+		        }
+		      }
+		    ]
+		  }
+		}",
+		  ],
+		  Array [
+		    "create api credential api failed",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Unable to create a mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id",
+		  ],
+		]
+	`);
 	});
-	test('create-mesh-with-configuration', async () => {
-		expect.assertions(2);
-		const runResult = CreateCommand.run(['src/commands/__fixtures__/sample_mesh.json']);
-		await expect(runResult instanceof Promise).toBeTruthy();
-		await expect(runResult).resolves.toEqual(mockCreateMesh);
+
+	test('should fail if subscribe credential to mesh service api has failed', async () => {
+		subscribeCredentialToMeshService.mockRejectedValueOnce(
+			new Error('subscribe credential to mesh service api failed'),
+		);
+
+		const runResult = CreateCommand.run();
+
+		await expect(runResult).rejects.toEqual(
+			new Error(
+				'Unable to create a mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id',
+			),
+		);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Successfully created mesh %s",
+		    "dummy_mesh_id",
+		  ],
+		  Array [
+		    "{
+		  \\"meshId\\": \\"dummy_mesh_id\\",
+		  \\"meshConfig\\": {
+		    \\"sources\\": [
+		      {
+		        \\"name\\": \\"<api_name>\\",
+		        \\"handler\\": {
+		          \\"graphql\\": {
+		            \\"endpoint\\": \\"<gql_endpoint>\\"
+		          }
+		        }
+		      }
+		    ]
+		  }
+		}",
+		  ],
+		  Array [
+		    "Successfully created API Key %s",
+		    "dummy_api_key",
+		  ],
+		  Array [
+		    "subscribe credential to mesh service api failed",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Unable to create a mesh. Please check the mesh configuration file and try again. If the error persists please contact support. RequestId: dummy_request_id",
+		  ],
+		]
+	`);
+	});
+
+	test('should create if a valid mesh config file is provided', async () => {
+		const runResult = await CreateCommand.run();
+
+		expect(initRequestId).toHaveBeenCalled();
+		expect(createMesh.mock.calls[0]).toMatchInlineSnapshot(`
+		Array [
+		  "1234",
+		  "5678",
+		  "123456789",
+		  Object {
+		    "meshConfig": Object {
+		      "sources": Array [
+		        Object {
+		          "handler": Object {
+		            "graphql": Object {
+		              "endpoint": "<gql_endpoint>",
+		            },
+		          },
+		          "name": "<api_name>",
+		        },
+		      ],
+		    },
+		  },
+		]
+	`);
+		expect(createAPIMeshCredentials.mock.calls[0]).toMatchInlineSnapshot(`
+		Array [
+		  "1234",
+		  "5678",
+		  "123456789",
+		]
+	`);
+		expect(subscribeCredentialToMeshService.mock.calls[0]).toMatchInlineSnapshot(`
+		Array [
+		  "1234",
+		  "5678",
+		  "123456789",
+		  "dummy_id",
+		]
+	`);
+		expect(runResult).toMatchInlineSnapshot(`
+		Object {
+		  "adobeIdIntegrationsForWorkspace": Object {
+		    "apiKey": "dummy_api_key",
+		    "id": "dummy_id",
+		  },
+		  "mesh": Object {
+		    "meshConfig": Object {
+		      "sources": Array [
+		        Object {
+		          "handler": Object {
+		            "graphql": Object {
+		              "endpoint": "<gql_endpoint>",
+		            },
+		          },
+		          "name": "<api_name>",
+		        },
+		      ],
+		    },
+		    "meshId": "dummy_mesh_id",
+		  },
+		  "sdkList": Array [
+		    "dummy_service",
+		  ],
+		}
+	`);
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Successfully created mesh %s",
+		    "dummy_mesh_id",
+		  ],
+		  Array [
+		    "{
+		  \\"meshId\\": \\"dummy_mesh_id\\",
+		  \\"meshConfig\\": {
+		    \\"sources\\": [
+		      {
+		        \\"name\\": \\"<api_name>\\",
+		        \\"handler\\": {
+		          \\"graphql\\": {
+		            \\"endpoint\\": \\"<gql_endpoint>\\"
+		          }
+		        }
+		      }
+		    ]
+		  }
+		}",
+		  ],
+		  Array [
+		    "Successfully created API Key %s",
+		    "dummy_api_key",
+		  ],
+		  Array [
+		    "Successfully subscribed API Key %s to API Mesh service",
+		    "dummy_api_key",
+		  ],
+		  Array [
+		    "Mesh Endpoint: %s
+		",
+		    "https://graph.adobe.io/api/dummy_mesh_id/graphql?api_key=dummy_api_key",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`Array []`);
+	});
+
+	test('should not ask for confirmation if autoConfirmAction is provided', async () => {
+		parseSpy.mockResolvedValueOnce({
+			args: { file: 'src/commands/__fixtures__/sample_mesh.json' },
+			flags: {
+				ignoreCache: mockIgnoreCacheFlag,
+				autoConfirmAction: Promise.resolve(true),
+			},
+		});
+
+		await CreateCommand.run();
+
+		expect(initRequestId).toHaveBeenCalled();
+		expect(promptConfirm).not.toHaveBeenCalled();
+		expect(initSdk).toHaveBeenCalledWith({
+			ignoreCache: true,
+		});
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Successfully created mesh %s",
+		    "dummy_mesh_id",
+		  ],
+		  Array [
+		    "{
+		  \\"meshId\\": \\"dummy_mesh_id\\",
+		  \\"meshConfig\\": {
+		    \\"sources\\": [
+		      {
+		        \\"name\\": \\"<api_name>\\",
+		        \\"handler\\": {
+		          \\"graphql\\": {
+		            \\"endpoint\\": \\"<gql_endpoint>\\"
+		          }
+		        }
+		      }
+		    ]
+		  }
+		}",
+		  ],
+		  Array [
+		    "Successfully created API Key %s",
+		    "dummy_api_key",
+		  ],
+		  Array [
+		    "Successfully subscribed API Key %s to API Mesh service",
+		    "dummy_api_key",
+		  ],
+		  Array [
+		    "Mesh Endpoint: %s
+		",
+		    "https://graph.adobe.io/api/dummy_mesh_id/graphql?api_key=dummy_api_key",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`Array []`);
+	});
+
+	test('should stop creation if user declines confirmation', async () => {
+		promptConfirm.mockResolvedValueOnce(false);
+
+		await CreateCommand.run();
+
+		expect(initRequestId).toHaveBeenCalled();
+		expect(promptConfirm).toHaveBeenCalled();
+		expect(initSdk).toHaveBeenCalledWith({
+			ignoreCache: true,
+		});
+		expect(logSpy.mock.calls).toMatchInlineSnapshot(`
+		Array [
+		  Array [
+		    "Create cancelled",
+		  ],
+		]
+	`);
+		expect(errorLogSpy.mock.calls).toMatchInlineSnapshot(`Array []`);
 	});
 });