@adobe/aio-cli-plugin-api-mesh 2.2.0 → 2.3.0

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

@@ -0,0 +1,168 @@
+/*
+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, Flags } = require('@oclif/core');
+const resolve = require('path').resolve;
+
+const { promptConfirm, promptSelect, runCliCommand } = require('../../helpers');
+const { getAppRootDir } = require('../../utils');
+
+const fs = require('fs/promises');
+
+class InitCommand extends Command {
+	static summary = 'Initiate API Mesh workspace';
+	static description =
+		'This command will create a workspace where you can organise your API mesh configuration and other files';
+
+	static args = [
+		{
+			name: 'projectName',
+			required: true,
+			description: 'Project name',
+		},
+	];
+
+	static flags = {
+		path: Flags.string({
+			char: 'p',
+			summary: 'workspace path',
+			default: '.',
+		}),
+		packageManager: Flags.string({
+			char: 'm',
+			summary: 'select yarn or npm for package management',
+			options: ['npm', 'yarn'],
+		}),
+		git: Flags.string({
+			char: 'g',
+			summary: 'Should the workspace be initiated as a git project.',
+			options: ['y', 'n'],
+		}),
+	};
+
+	static enableJsonFlag = true;
+
+	static examples = [
+		{
+			description: 'API mesh workspace init',
+			command: 'aio api-mesh init commerce-mesh',
+		},
+		{
+			description: 'API mesh workspace init with flags',
+			command:
+				'aio api-mesh init commerce-mesh --path ./mesh_projects/test_mesh --git y --packageManager yarn',
+		},
+	];
+
+	async createPackageJson(templatePath, filePath, projectTitle = 'api-mesh-starter') {
+		const template = await fs.readFile(templatePath, 'utf8');
+
+		const pkgJSON = { ...JSON.parse(template), name: projectTitle };
+
+		await fs.writeFile(filePath, JSON.stringify(pkgJSON, null, 2), 'utf8', { mode: 'w' });
+	}
+
+	async run() {
+		const { args, flags } = await this.parse(InitCommand);
+		const gitFlagOptions = {
+			y: true,
+			n: false,
+		};
+
+		let absolutePath = resolve(flags.path);
+		let shouldCreateGit = gitFlagOptions[flags.git];
+		let packageManagerChoice = flags.packageManager;
+		const packageJsonTemplate = `${getAppRootDir()}/src/templates/package.json`;
+		const shouldCreateWorkspace = await promptConfirm(
+			`Do you want to create the workspace in ${absolutePath}`,
+		);
+
+		if (shouldCreateWorkspace) {
+			if (shouldCreateGit === undefined) {
+				shouldCreateGit = await promptConfirm(`Do you want to initiate git in your workspace?`);
+			}
+
+			if (packageManagerChoice === undefined) {
+				packageManagerChoice = await promptSelect(`Select a package manager`, [
+					{ name: 'npm', value: 'npm' },
+					{ name: 'yarn', value: 'yarn' },
+				]);
+			}
+
+			try {
+				await fs.access(absolutePath);
+				if (
+					!(await promptConfirm(
+						'The directory is not empty. Do you want to create a sub directory with project name',
+					))
+				) {
+					return;
+				}
+				absolutePath += '/' + args.projectName;
+			} catch (err) {
+				// No action needed
+			}
+
+			this.log(`Creating workspace in ${absolutePath}`);
+
+			try {
+				await fs.mkdir(absolutePath);
+			} catch (error) {
+				this.error(`Could not create directory ${error.message}`);
+			}
+
+			if (shouldCreateGit) {
+				this.log('Initiating git in workspace');
+				try {
+					await runCliCommand('git init', absolutePath);
+
+					const gitIgnoreTemplate = `${getAppRootDir()}/src/templates/gitignore`;
+
+					await fs.writeFile(`${absolutePath}/.gitignore`, gitIgnoreTemplate, 'utf8', {
+						mode: 'w',
+					});
+				} catch (error) {
+					this.error(error);
+				}
+			}
+
+			await fs.writeFile(`${absolutePath}/.env`, '', 'utf8', { mode: 'w' });
+
+			this.log(`Installing dependencies`);
+
+			await this.createPackageJson(
+				packageJsonTemplate,
+				`${absolutePath}/package.json`,
+				args.projectName,
+			);
+
+			if (packageManagerChoice === 'npm') {
+				try {
+					await runCliCommand(`npm install`, absolutePath);
+				} catch (error) {
+					this.error(error);
+				}
+			}
+
+			if (packageManagerChoice === 'yarn') {
+				try {
+					await runCliCommand(`yarn install`, absolutePath);
+				} catch (error) {
+					this.error(error);
+				}
+			}
+
+			this.log('Local workspace created successfully');
+		}
+	}
+}
+
+module.exports = InitCommand;

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

@@ -122,7 +122,7 @@ describe('source:get command tests', () => {
 		const version = '1.1.1';
 		await GetCommand.run([`-s=${name}@${version}`]).catch(err => {
 			expect(err.message).toContain(
-				chalk.red(`The version \"1.1.1\" for source name \"test-01\" doesn't exist.`),
+				chalk.red(`The version "1.1.1" for source name "test-01" doesn't exist.`),
 			);
 		});
 	});

package/src/commands/api-mesh/source/__tests__/install.test.js

@@ -104,9 +104,9 @@ describe('source:install command tests', () => {
 	});
 	test('Check executing with invalid file parameter', async () => {
 		await InstallCommand.run(['test-03', '-f=notexist.json']).catch(err => {
-			expect(err.message).toEqual(
+			expect(err.message).toContain(
 				`Something went wrong trying to read the variables file.` +
-					`\nENOENT: no such file or directory, open 'notexist.json'`,
+					`\nENOENT: no such file or directory`,
 			);
 		});
 	});

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

@@ -10,15 +10,19 @@ governing permissions and limitations under the License.
 */
 
 const { Command } = require('@oclif/command');
-const { readFile } = require('fs/promises');
 
 const logger = require('../../classes/logger');
-const { initSdk, initRequestId, promptConfirm } = require('../../helpers');
-const { ignoreCacheFlag, autoConfirmActionFlag, envFileFlag } = require('../../utils');
+const { initSdk, initRequestId, promptConfirm, importFiles } = require('../../helpers');
+const {
+	ignoreCacheFlag,
+	autoConfirmActionFlag,
+	envFileFlag,
+	checkPlaceholders,
+	readFileContents,
+	validateAndInterpolateMesh,
+	getFilesInMeshConfig,
+} = require('../../utils');
 const { getMeshId, updateMesh } = require('../../lib/devConsole');
-const meshInterpolation = require('../../meshInterpolation');
-
-const dotenv = require('dotenv');
 
 class UpdateCommand extends Command {
 	static args = [{ name: 'file' }];
@@ -43,27 +47,16 @@ class UpdateCommand extends Command {
 
 		const ignoreCache = await flags.ignoreCache;
 		const autoConfirmAction = await flags.autoConfirmAction;
-		const envFilePath=await flags.env;
+		const envFilePath = await flags.env;
 
 		const { imsOrgId, projectId, workspaceId } = await initSdk({
 			ignoreCache,
 		});
 
-		let inputMeshData;
-
 		//Input the mesh data from the input file
-		try {
-			inputMeshData = await readFile(args.file, 'utf8');
-		} catch (error) {
-			logger.error(error);
-
-			this.log(error.message);
-			this.error(
-				'Unable to read the mesh configuration file provided. Please check the file and try again.',
-			);
-		}
+		let inputMeshData = await readFileContents(args.file, this, 'mesh');
 
-		let meshId;
+		let meshId = null;
 
 		try {
 			meshId = await getMeshId(imsOrgId, projectId, workspaceId);
@@ -75,61 +68,36 @@ class UpdateCommand extends Command {
 
 		let data;
 
-		if (envFilePath) {
-			let envFileContent;
-
-			//Read the environment file
+		if (checkPlaceholders(inputMeshData)) {
+			this.log('The provided mesh contains placeholders. Starting mesh interpolation process.');
+			data = await validateAndInterpolateMesh(inputMeshData, envFilePath, this);
+		} else {
 			try {
-				envFileContent = await readFile(envFilePath, 'utf8');
-			} catch (error) {
-				this.log(error.message);
-				this.error('Unable to read the env file provided. Please check the file and try again.');
+				data = JSON.parse(inputMeshData);
+			} catch (err) {
+				this.log(err.message);
+				this.error('Input mesh file is not a valid JSON. Please check the file provided.');
 			}
+		}
 
-			//Validate the env file
-			const envFileValidity = meshInterpolation.validateEnvFileFormat(envFileContent);
-			if (envFileValidity.valid) {
-				//load env file into the process.env object
-				meshInterpolation.clearEnv();
-
-				//Added env at start of each environment variable
-				const envObj = { env: dotenv.config({ path: envFilePath }).parsed };
-
-				let {
-					interpolationStatus,
-					missingKeys,
-					interpolatedMeshData,
-				} = await meshInterpolation.interpolateMesh(inputMeshData, envObj);
-
-				//De-duplicate the missing keys array
-				missingKeys = missingKeys.filter(function (item, index, inputArray) {
-					return inputArray.indexOf(item) == index;
-				});
+		let filesList = [];
 
-				if (interpolationStatus == 'failed') {
-					this.error(
-						'The mesh file cannot be interpolated due to missing keys : ' + missingKeys.toString(),
-					);
-				}
+		try {
+			filesList = getFilesInMeshConfig(data, args.file);
+		} catch (err) {
+			this.log(err.message);
+			this.error('Input mesh config is not valid.');
+		}
 
-				try {
-					data = JSON.parse(interpolatedMeshData);
-				} catch (err) {
-					this.log(err.message);
-					this.log(interpolatedMeshData);
-					this.error(
-						'Interpolated mesh is not a valid JSON. Please check the generated json file.',
-					);
-				}
-			} else {
-				this.error(`Issue in ${envFilePath} file - ` + envFileValidity.error);
-			}
-		} else {
+		// if local files are present, import them in files array in meshConfig
+		if (filesList.length) {
 			try {
-				data = JSON.parse(inputMeshData);
+				data = await importFiles(data, filesList, args.file, flags.autoConfirmAction);
 			} catch (err) {
 				this.log(err.message);
-				this.error('Input mesh file is not a valid JSON. Please check the input file provided.');
+				this.error(
+					'Unable to import the files in the mesh config. Please check the file and try again.',
+				);
 			}
 		}