@adobe/aio-cli-plugin-api-mesh 1.0.2-beta → 1.0.3-beta

package/README.md

@@ -47,6 +47,7 @@ aio config:set api-mesh.configPath <path_to_json_file>
 # Commands
 
 ```
+aio api-mesh:describe
 aio api-mesh:get meshId
 aio api-mesh:get meshId PATH_OF_FILE_TO_DOWNLOAD_INTO
 aio api-mesh:create PATH_OF_MESH_CONFIG_JSON_FILE

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"1.0.2-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.3-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:describe":{"id":"api-mesh:describe","description":"Get details of a mesh","pluginName":"@adobe/aio-cli-plugin-api-mesh","pluginType":"core","aliases":[],"flags":{},"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":{},"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"}]}}}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@adobe/aio-cli-plugin-api-mesh",
-	"version": "1.0.2-beta",
+	"version": "1.0.3-beta",
 	"publishConfig": {
 		"access": "public"
 	},

package/src/classes/SchemaServiceClient.js

@@ -25,6 +25,57 @@ class SchemaServiceClient {
 		this.apiKey = apiKey;
 	}
 
+	async describeMesh(organizationId, projectId, workspaceId) {
+		const config = {
+			method: 'get',
+			url: `${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/describe?API_KEY=${this.apiKey}`,
+			headers: {
+				'Authorization': `Bearer ${this.accessToken}`,
+				'x-request-id': global.requestId,
+			},
+		};
+
+		logger.info(
+			'Initiating GET %s',
+			`${this.devConsoleUrl}/organizations/${organizationId}/projects/${projectId}/workspaces/${workspaceId}/meshes/describe?API_KEY=${this.apiKey}`,
+		);
+
+		try {
+			const response = await axios(config);
+
+			logger.info('Response from GET %s', response.status);
+
+			if (response && response.status === 200) {
+				logger.info(`Mesh Config : ${objToString(response, ['data'])}`);
+
+				return response.data;
+			} else {
+				// Non 200 response received
+				logger.error(
+					`Something went wrong: ${objToString(
+						response,
+						['data'],
+						'Unable to get mesh',
+					)}. Received ${response.status} response instead of 200`,
+				);
+
+				throw new Error(
+					`Something went wrong: ${objToString(response, ['data'], 'Unable to get mesh')}`,
+				);
+			}
+		} catch (error) {
+			if (error.response.status === 400) {
+				// The request was made and the server responded with a 400 status code
+				logger.error('Mesh not found');
+
+				return null;
+			} else {
+				// The request was made and the server responded with a different status code
+				logger.error('Error while describing mesh');
+			}
+		}
+	}
+
 	async getMesh(organizationId, projectId, workspaceId, meshId) {
 		const config = {
 			method: 'get',

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

@@ -57,16 +57,15 @@ describe('create command tests', () => {
 		jest.restoreAllMocks();
 	});
 
-	test('create-mesh-missing-file', async () => {
+	test('should fail mesh id is missing', async () => {
 		expect.assertions(2);
 		const runResult = CreateCommand.run([]);
 		await expect(runResult instanceof Promise).toBeTruthy();
 		await expect(runResult).rejects.toEqual(
-			new Error(
-				'Unable to read the mesh configuration file provided. Please check the file and try again.',
-			),
+			new Error('Missing file path. Run aio api-mesh create --help for more info.'),
 		);
 	});
+
 	test('create-mesh-with-configuration', async () => {
 		expect.assertions(2);
 		const runResult = CreateCommand.run(['src/commands/__fixtures__/sample_mesh.json']);

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

@@ -67,20 +67,18 @@ describe('delete command tests', () => {
 		jest.restoreAllMocks();
 	});
 
-	test('delete-mesh-missing-meshId', async () => {
+	test('should fail if mesh id is missing', async () => {
 		const runResult = DeleteCommand.run([]);
 
 		return runResult.catch(err => {
 			expect(err).toHaveProperty(
 				'message',
-				expect.stringMatching(
-					/^Unable to delete mesh\. Please check the details and try again\. If the error persists please contact support\. RequestId: [a-z A-Z 0-9 -_]+/,
-				),
+				expect.stringMatching(/^Missing Mesh ID. Run aio api-mesh delete --help for more info/),
 			);
 		});
 	});
 
-	test('delete-mesh-with-meshId', async () => {
+	test('should delete if correct args are provided', async () => {
 		jest
 			.spyOn(SchemaServiceClient.prototype, 'deleteMesh')
 			.mockImplementation(() => Promise.resolve({}));

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

@@ -0,0 +1,79 @@
+/*
+Copyright 2021 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const mockConsoleCLIInstance = {};
+jest.mock('@adobe/aio-lib-env');
+jest.mock('@adobe/aio-cli-lib-console');
+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('@adobe/aio-lib-ims');
+
+const DescribeCommand = require('../describe');
+const { SchemaServiceClient } = require('../../../classes/SchemaServiceClient');
+
+describe('describe command tests', () => {
+	beforeEach(() => {
+		setDefaultMockConsoleCLI();
+	});
+
+	afterEach(() => {
+		jest.restoreAllMocks();
+	});
+
+	test('should error if wrong details are provided', async () => {
+		const runResult = DescribeCommand.run([]);
+
+		return runResult.catch(err => {
+			expect(err).toHaveProperty(
+				'message',
+				expect.stringMatching(
+					/^Unable to get mesh details\. Please check the details and try again\. If the error persists please contact support\. RequestId: [a-z A-Z 0-9 -_]+/,
+				),
+			);
+		});
+	});
+
+	test('should return meshId if correct details are provided', async () => {
+		const meshId = 'sample-mesh-id';
+		jest.spyOn(SchemaServiceClient.prototype, 'describeMesh').mockResolvedValue({ meshId });
+
+		const runResult = await DescribeCommand.run();
+
+		await expect(runResult).toEqual({ meshId });
+	});
+});

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

@@ -53,20 +53,18 @@ describe('get command tests', () => {
 		jest.restoreAllMocks();
 	});
 
-	test('get-mesh-missing-meshId', async () => {
+	test('should fail if mesh id is missing', async () => {
 		const runResult = GetCommand.run([]);
 
 		return runResult.catch(err => {
 			expect(err).toHaveProperty(
 				'message',
-				expect.stringMatching(
-					/^Unable to get mesh\. Please check the details and try again\. If the error persists please contact support\. RequestId: [a-z A-Z 0-9 -_]+/,
-				),
+				expect.stringMatching(/^Missing Mesh ID. Run aio api-mesh get --help for more info./),
 			);
 		});
 	});
 
-	test('get-mesh-with-meshId', async () => {
+	test('should pass if mesh id is provided', async () => {
 		jest.spyOn(SchemaServiceClient.prototype, 'getMesh').mockImplementation(meshId => mockGetMesh);
 		expect.assertions(1);
 		const meshId = 'sample_merchant';

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

@@ -66,9 +66,18 @@ describe('update command tests', () => {
 		jest.restoreAllMocks();
 	});
 
-	test('update-mesh-missing-meshId-file', async () => {
+	test('should fail if update file path is missing', async () => {
 		expect.assertions(2);
-		const runResult = UpdateCommand.run([]);
+		const runResult = UpdateCommand.run(['dummy_mesh_id']);
+		await expect(runResult instanceof Promise).toBeTruthy();
+		await expect(runResult).rejects.toEqual(
+			new Error('Missing required args. Run aio api-mesh update --help for more info.'),
+		);
+	});
+
+	test('should fail if dummy file path is provided', async () => {
+		expect.assertions(2);
+		const runResult = UpdateCommand.run(['dummy_mesh_id', 'dummy_file_path']);
 		await expect(runResult instanceof Promise).toBeTruthy();
 		await expect(runResult).rejects.toEqual(
 			new Error(
@@ -77,7 +86,7 @@ describe('update command tests', () => {
 		);
 	});
 
-	test('update-mesh-with-configuration', async () => {
+	test('should pass with valid args', async () => {
 		expect.assertions(2);
 		const runResult = UpdateCommand.run([
 			'sample_merchant',
@@ -87,7 +96,7 @@ describe('update command tests', () => {
 		await expect(runResult).resolves.toEqual(mockUpdateMesh);
 	});
 
-	test('should not delete if user prompt returns false', async () => {
+	test('should not update if user prompt returns false', async () => {
 		inquirer.createPromptModule.mockReturnValue(
 			jest.fn().mockResolvedValue({
 				res: false,

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

@@ -24,6 +24,12 @@ class CreateCommand extends Command {
 
 		const { args } = this.parse(CreateCommand);
 
+		if (!args.file) {
+			this.error('Missing file path. Run aio api-mesh create --help for more info.');
+
+			return;
+		}
+
 		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
 
 		let data;

package/src/commands/api-mesh/delete.js

@@ -26,6 +26,12 @@ class DeleteCommand extends Command {
 
 		const { args } = this.parse(DeleteCommand);
 
+		if (!args.meshId) {
+			this.error('Missing Mesh ID. Run aio api-mesh delete --help for more info.');
+
+			return;
+		}
+
 		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
 
 		const shouldContinue = await promptConfirm(

package/src/commands/api-mesh/describe.js

@@ -0,0 +1,61 @@
+/*
+Copyright 2021 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const { Command } = require('@oclif/command');
+const logger = require('../../classes/logger');
+const { initSdk, initRequestId } = require('../../helpers');
+
+require('dotenv').config();
+
+class DescribeCommand extends Command {
+	async run() {
+		await initRequestId();
+
+		logger.info(`RequestId: ${global.requestId}`);
+
+		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
+
+		try {
+			const meshDetails = await schemaServiceClient.describeMesh(imsOrgId, projectId, workspaceId);
+
+			if (meshDetails) {
+				const { meshId } = meshDetails;
+
+				if (meshId) {
+					this.log('Successfully retrieved mesh details \n');
+					this.log('Org ID: %s', imsOrgId);
+					this.log('Project ID: %s', projectId);
+					this.log('Workspace ID: %s', workspaceId);
+					this.log('Mesh ID: %s', meshId);
+
+					return meshDetails;
+				} else {
+					this.error(
+						`Unable to get mesh details. Please check the details and try again. RequestId: ${global.requestId}`,
+						{ exit: false },
+					);
+				}
+			} else {
+				throw new Error(`Unable to get mesh details`);
+			}
+		} catch (error) {
+			this.log(error.message);
+
+			this.error(
+				`Unable to get mesh details. Please check the details and try again. If the error persists please contact support. RequestId: ${global.requestId}`,
+			);
+		}
+	}
+}
+
+DescribeCommand.description = 'Get details of a mesh';
+
+module.exports = DescribeCommand;

package/src/commands/api-mesh/get.js

@@ -26,6 +26,12 @@ class GetCommand extends Command {
 
 		const { args } = this.parse(GetCommand);
 
+		if (!args.meshId) {
+			this.error('Missing Mesh ID. Run aio api-mesh get --help for more info.');
+
+			return;
+		}
+
 		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
 
 		try {

package/src/commands/api-mesh/update.js

@@ -25,6 +25,12 @@ class UpdateCommand extends Command {
 
 		const { args } = this.parse(UpdateCommand);
 
+		if (!args.meshId || !args.file) {
+			this.error('Missing required args. Run aio api-mesh update --help for more info.');
+
+			return;
+		}
+
 		const { schemaServiceClient, imsOrgId, projectId, workspaceId } = await initSdk();
 		let data;