projects (#318)

* projects crud + rename helper + pip projectId filter

* update cli docs

* add last_updated to project output

* valid openapi.json

* fix typo + move id to wide display option

* update version

Author: yaroslav-codefresh

docs/index.js

@@ -19,6 +19,7 @@ const categoriesOrder = {
     'operate on resources' : 32,
     pipelines : 40,
     'pipelines v2 (beta)' : 42,
+    projects : 45,
     builds: 50,
     contexts : 70 ,
     images : 80 ,

lib/interface/cli/commands/composition/create.cmd.js

@@ -1,7 +1,7 @@
 const Command = require('../../Command');
 const CFError = require('cf-errors');
 const _ = require('lodash');
-const { prepareKeyValueCompostionFromCLIEnvOption } = require('../../helpers/general');
+const { prepareKeyValueObjectsFromCLIEnvOption } = require('../../helpers/general');
 const createRoot = require('../root/create.cmd');
 const { crudFilenameOption } = require('../../helpers/general');
 const { sdk } = require('../../../../logic');
@@ -47,7 +47,7 @@ const command = new Command({
     handler: async (argv) => {
         const data = argv.filename || {
             name: argv.name,
-            vars: prepareKeyValueCompostionFromCLIEnvOption(argv.variable),
+            vars: prepareKeyValueObjectsFromCLIEnvOption(argv.variable),
             yamlJson: argv['compose-file'],
             isAdvanced: argv.advanced,
         };

lib/interface/cli/commands/composition/replace.cmd.js

@@ -4,7 +4,7 @@ const _ = require('lodash');
 const replaceRoot = require('../root/replace.cmd');
 const { crudFilenameOption } = require('../../helpers/general');
 const { sdk } = require('../../../../logic');
-const { prepareKeyValueCompostionFromCLIEnvOption } = require('../../helpers/general');
+const { prepareKeyValueObjectsFromCLIEnvOption } = require('../../helpers/general');
 
 
 const command = new Command({
@@ -46,7 +46,7 @@ const command = new Command({
     handler: async (argv) => {
         const data = argv.filename || {
             name: argv.name,
-            vars: prepareKeyValueCompostionFromCLIEnvOption(argv.variable),
+            vars: prepareKeyValueObjectsFromCLIEnvOption(argv.variable),
             yamlJson: argv['compose-file'],
             isAdvanced: argv.advanced,
         };

lib/interface/cli/commands/pipeline/get.cmd.js

@@ -32,6 +32,12 @@ const command = new Command({
             .option('name', {
                 describe: 'Filter pipelines by name',
             })
+            .option('project-id', {
+                describe: 'Filter pipelines by project id',
+            })
+            .option('project', {
+                describe: 'Filter pipelines by project name',
+            })
             .option('label', {
                 describe: 'Filter by a label',
                 alias: 'l',
@@ -47,7 +53,7 @@ const command = new Command({
             });
     },
     handler: async (argv) => {
-        const { id: ids, name, d: decryptVariables } = argv;
+        const { id: ids, name, d: decryptVariables, projectId, project: projectName } = argv;
         const limit = argv.limit;
         const offset = (argv.page - 1) * limit;
         const labels = prepareKeyValueFromCLIEnvOption(argv.label);
@@ -74,11 +80,21 @@ const command = new Command({
             }
             Output.print(pipelines);
         } else {
+            let _projectId = projectId;
+            if (!projectId && projectName) {
+                const project = await sdk.projects.getByName({ name: projectName })
+                    .catch(e => Promise.reject(new CFError({
+                        message: `Could not get project "${projectName}"`,
+                        cause: e,
+                    })));
+                _projectId = project.id;
+            }
             const pipelines = await sdk.pipelines.list({
                 limit,
                 offset,
                 id: name,
                 labels,
+                projectId: _projectId,
             });
             Output.print(pipelines.docs.map(Pipeline.fromResponse));
         }

lib/interface/cli/commands/project/apply.cmd.js

@@ -0,0 +1,84 @@
+const Command = require('../../Command');
+const CFError = require('cf-errors');
+const _ = require('lodash');
+const { sdk } = require('../../../../logic');
+
+const applyRoot = require('../root/apply.cmd');
+const { prepareKeyValueObjectsFromCLIEnvOption, ignoreHttpError } = require('../../helpers/general');
+
+const command = new Command({
+    command: 'project [id|name]',
+    aliases: [],
+    parent: applyRoot,
+    description: 'Patch a project',
+    webDocs: {
+        category: 'Projects',
+        title: 'Patch Project',
+    },
+    builder: (yargs) => {
+        yargs
+            .positional('id|name', {
+                describe: 'project id or name',
+            })
+            .option('newName', {
+                describe: 'New name',
+                alias: 'n',
+            })
+            .option('tag', {
+                array: true,
+                alias: 't',
+                describe: 'Project tags',
+            })
+            .option('variable', {
+                array: true,
+                alias: 'v',
+                describe: 'Project variables',
+                coerce: prepareKeyValueObjectsFromCLIEnvOption,
+            })
+            .option('encrypted', {
+                array: true,
+                alias: 'e',
+                describe: 'Variable names to encrypt',
+            })
+            .example(
+                'codefresh patch project ID --new-name NEW_NAME --tag test',
+                'Replace project name and tags. Specifying project by ID',
+            )
+            .example(
+                'codefresh patch project NAME -v test=test',
+                'Replace project variables. Specifying project by NAME',
+            );
+
+        return yargs;
+    },
+    handler: async (argv) => {
+        const { id, name } = argv;
+
+        const {
+            newName: projectName = name,
+            tag: tags,
+            variable: variables,
+            encrypted,
+        } = argv;
+
+        const variableMap = _.reduce(variables, (acc, v) => _.assign(acc, { [v.key]: v }), {});
+        _.forEach(encrypted, (varName) => {
+            const variable = variableMap[varName];
+            if (!variable) {
+                throw new CFError(`Variable is not provided: "${varName}"`);
+            }
+            variable.encrypted = true;
+        });
+
+        let project = await sdk.projects.get({ id }).catch(ignoreHttpError);
+        project = project || await sdk.projects.getByName({ name }).catch(ignoreHttpError);
+        if (!project) {
+            throw new CFError(`No such project: "${name || id}"`);
+        }
+
+        await sdk.projects.patch({ id: project.id }, { projectName, tags, variables });
+        console.log(`Project: "${name || id}" patched.`);
+    },
+});
+
+module.exports = command;

lib/interface/cli/commands/project/create.cmd.js

@@ -0,0 +1,73 @@
+const Command = require('../../Command');
+const CFError = require('cf-errors');
+const _ = require('lodash');
+const { sdk } = require('../../../../logic');
+const createRoot = require('../root/create.cmd');
+const { prepareKeyValueObjectsFromCLIEnvOption, ignoreHttpError } = require('../../helpers/general');
+
+const command = new Command({
+    command: 'project <name>',
+    parent: createRoot,
+    description: 'Create a project',
+    usage: 'Create a project specifying name unique for account.',
+    webDocs: {
+        category: 'Projects',
+        title: 'Create Project',
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('name', {
+                describe: 'Name of project',
+            })
+            .option('tag', {
+                array: true,
+                alias: 't',
+                describe: 'Project tags',
+                default: [],
+            })
+            .option('variable', {
+                array: true,
+                alias: 'v',
+                describe: 'Project variables',
+                default: [],
+                coerce: prepareKeyValueObjectsFromCLIEnvOption,
+            })
+            .option('encrypted', {
+                array: true,
+                alias: 'e',
+                describe: 'Variable names to encrypt',
+                default: [],
+            })
+            .example('codefresh create project NAME', 'Create a project')
+            .example('codefresh create project NAME -t test -t run', 'Create a project with tags: [ "test", "run"]')
+            .example('codefresh create project NAME -v test=true -v run=false', 'Create a project with specific variables')
+            .example('codefresh create project NAME -v secret=secret -e secret', 'Create a project with encrypted variables');
+    },
+    handler: async (argv) => {
+        const {
+            name: projectName,
+            tag: tags,
+            variable: variables,
+            encrypted,
+        } = argv;
+
+        const variableMap = _.reduce(variables, (acc, v) => _.assign(acc, { [v.key]: v }), {});
+        _.forEach(encrypted, (varName) => {
+            const variable = variableMap[varName];
+            if (!variable) {
+                throw new CFError(`Variable is not provided: "${varName}"`);
+            }
+            variable.encrypted = true;
+        });
+
+        const existing = await sdk.projects.getByName({ name: projectName }).catch(ignoreHttpError); // ignore not found error
+        if (existing) {
+            throw new CFError(`Project already exists: "${projectName}"`);
+        }
+
+        await sdk.projects.create({ projectName, tags, variables });
+        console.log(`Project: "${projectName}" created`);
+    },
+});
+
+module.exports = command;

lib/interface/cli/commands/project/delete.cmd.js

@@ -0,0 +1,39 @@
+const Command = require('../../Command');
+const CFError = require('cf-errors');
+const { sdk } = require('../../../../logic');
+const deleteRoot = require('../root/delete.cmd');
+const { ignoreHttpError } = require('../../helpers/general');
+
+const command = new Command({
+    command: 'project <id|name>',
+    aliases: [],
+    parent: deleteRoot,
+    description: 'Delete a project',
+    webDocs: {
+        category: 'Projects',
+        title: 'Delete Project',
+    },
+    builder: (yargs) => {
+        yargs
+            .positional('id|name', {
+                describe: 'project id or name',
+            })
+            .example('codefresh delete project NAME', 'Delete project by name.')
+            .example('codefresh delete project ID', 'Delete project by Id.');
+        return yargs;
+    },
+    handler: async (argv) => {
+        const { id, name } = argv;
+
+        let project = await sdk.projects.get({ id }).catch(ignoreHttpError);
+        project = project || await sdk.projects.getByName({ name }).catch(ignoreHttpError);
+        if (!project) {
+            throw new CFError(`No such project: "${name || id}"`);
+        }
+
+        await sdk.projects.delete({ id: project.id });
+        console.log(`Project '${name || id}' deleted.`);
+    },
+});
+
+module.exports = command;

lib/interface/cli/commands/project/get.cmd.js

@@ -0,0 +1,65 @@
+const Command = require('../../Command');
+const { sdk } = require('../../../../logic');
+const Project = require('../../../../logic/entities/Project');
+const Output = require('../../../../output/Output');
+const _ = require('lodash');
+const DEFAULTS = require('../../defaults');
+const { ignoreHttpError } = require('../../helpers/general');
+
+const getRoot = require('../root/get.cmd');
+
+const command = new Command({
+    command: 'projects [id|name]',
+    aliases: ['project'],
+    parent: getRoot,
+    description: 'Get a specific project or an array of projects',
+    webDocs: {
+        category: 'Projects',
+        title: 'Get Projects',
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('id|name', {
+                describe: 'Project id or name to get one project',
+            })
+            .option('name', {
+                alias: 'n',
+                describe: 'Project name to filter by',
+            })
+            .option('tag', {
+                alias: 't',
+                describe: 'Project tags array to filter by',
+                array: true,
+            })
+            .option('limit', {
+                describe: 'Limit amount of returned results',
+                default: DEFAULTS.GET_LIMIT_RESULTS,
+            })
+            .option('page', {
+                describe: 'Paginated page',
+                default: DEFAULTS.GET_PAGINATED_PAGE,
+            });
+    },
+    handler: async (argv) => {
+        const { id, name, limit, page, tag: tags } = argv; // eslint-disable-line
+        const offset = (page - 1) * limit;
+
+        let projects;
+        if (id) {
+            let project = await sdk.projects.get({ id }).catch(ignoreHttpError);
+            project = project || await sdk.projects.getByName({ name }).catch(ignoreHttpError);
+            projects = project ? [project] : [];
+        } else {
+            const result = await sdk.projects.list({
+                name,
+                tags,
+                limit,
+                offset,
+            });
+            projects = result.projects; // eslint-disable-line
+        }
+        Output.print(_.map(projects, Project.fromResponse));
+    },
+});
+
+module.exports = command;