Saas rename step to step type (#341)

Author: itai-codefresh

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

@@ -9,7 +9,7 @@ const get = new Command({
     root: true,
     command: 'create',
     description: 'Create a resource from a file or stdin',
-    usage: 'Supported resources: \n\t\'context\'\n\t\'pipeline\'\'\n\t\'step\'',
+    usage: 'Supported resources: \n\t\'context\'\n\t\'pipeline\'\'\n\t\'step-type\'',
     webDocs: {
         description: 'Create a resource from a file, directory or url',
         category: 'Operate On Resources',
@@ -48,9 +48,9 @@ const get = new Command({
                 await sdk.pipelines.create(data);
                 console.log(`Pipeline '${name}' created`);
                 break;
-            case 'step':
+            case 'step-type':
                 await sdk.steps.create(data);
-                console.log(`Step '${name}' created`);
+                console.log(`Step-type '${name}' created`);
                 break;
             default:
                 throw new CFError(`Entity: ${entity} not supported`);

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

@@ -9,7 +9,7 @@ const annotate = new Command({
     root: true,
     command: 'replace',
     description: 'Replace a resource by filename',
-    usage: 'Supported resources: \n\t\'Context\'\n\t\'Pipeline\'\'\n\t\'Step\'',
+    usage: 'Supported resources: \n\t\'Context\'\n\t\'Pipeline\'\'\n\t\'Step-type\'',
     webDocs: {
         description: 'Replace a resource from a file, directory or url',
         category: 'Operate On Resources',
@@ -56,11 +56,11 @@ const annotate = new Command({
                 }, data);
                 console.log(`Pipeline '${name}' updated`);
                 break;
-            case 'step':
+            case 'step-type':
                 await sdk.steps.replace({
                     name,
                 }, data);
-                console.log(`Step '${name}' updated`);
+                console.log(`Step-type '${name}' updated`);
                 break;
             default:
                 throw new CFError(`Entity: ${entity} not supported`);

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

@@ -4,24 +4,24 @@ const { sdk } = require('../../../../logic');
 
 
 const command = new Command({
-    command: 'step [name]',
+    command: 'step-type [name]',
     parent: deleteRoot,
-    description: 'Delete a step',
+    description: 'Delete a step-type',
     webDocs: {
-        category: 'Steps',
-        title: 'Delete Step',
+        category: 'Step-types',
+        title: 'Delete Step-type',
     },
     builder: (yargs) => {
         return yargs
             .positional('name', {
-                describe: 'Step name',
+                describe: 'Step-type name',
             });
     },
     handler: async (argv) => {
         const { name } = argv;
 
         await sdk.steps.delete({ name });
-        console.log(`Step '${name}' deleted.`);
+        console.log(`Step-type '${name}' deleted.`);
     },
 });
 

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

@@ -6,14 +6,14 @@ const DEFAULTS = require('../../defaults');
 const { prepareKeyValueFromCLIEnvOption } = require('../../helpers/general');
 const Output = require('../../../../output/Output');
 const { sdk } = require('../../../../logic');
-const Step = require('../../../../logic/entities/Step');
+const StepType = require('../../../../logic/entities/StepType');
 
 const getRoot = require('../root/get.cmd');
 
 
 const command = new Command({
-    command: 'steps [id..]',
-    aliases: ['step'],
+    command: 'step-types [id..]',
+    aliases: ['step-type'],
     parent: getRoot,
     description: 'Get a specific step or an array of steps',
     webDocs: {
@@ -79,14 +79,14 @@ const command = new Command({
             for (const id of ids) {
                 try {
                     const currStep = await sdk.steps.get({ name: id });
-                    steps.push(Step.fromResponse(currStep));
+                    steps.push(StepType.fromResponse(currStep));
                 } catch (err) {
                     if (steps.length) {
                         Output.print(steps);
                     }
 
                     debug(err.toString());
-                    const message = err.toString().includes('not find') ? `Step '${id}' was not found.` : 'Error occurred';
+                    const message = err.toString().includes('not find') ? `Step-type '${id}' was not found.` : 'Error occurred';
                     throw new CFError({
                         cause: err,
                         message,
@@ -106,7 +106,7 @@ const command = new Command({
                 official,
                 tag,
             });
-            Output.print(_.map(_.get(steps, 'docs'), Step.fromResponse));
+            Output.print(_.map(_.get(steps, 'docs'), StepType.fromResponse));
         }
     },
 });

lib/interface/cli/commands/step/get.completion.js

@@ -1,11 +1,11 @@
 const _ = require('lodash');
 const steps = () => require('../../../../logic').sdk.steps;
-const Step = require('../../../../logic/entities/Step');
+const StepType = require('../../../../logic/entities/StepType');
 const { authContextWrapper } = require('../../completion/helpers');
 
 const positionalHandler = async ({word, argv}) => {
     const stps = await steps().list({ limit: 25, offset: 0 });
-    return _.map(_.get(stps, 'docs'), Step.fromResponse).map(p => p.name);
+    return _.map(_.get(stps, 'docs'), StepType.fromResponse).map(p => p.name);
 };
 
 module.exports = {

lib/interface/cli/commands/step/step.sdk.spec.js

@@ -10,7 +10,7 @@ jest.mock('../../completion/helpers', () => { // eslint-disable-line
     };
 });
 
-jest.mock('../../../../logic/entities/Step', () => { // eslint-disable-line
+jest.mock('../../../../logic/entities/StepType', () => { // eslint-disable-line
     return {
         fromResponse: res => res,
     };

lib/logic/entities/Step.js renamed to lib/logic/entities/StepType.js

@@ -1,10 +1,10 @@
 const Entity = require('./Entity');
 const _ = require('lodash');
 
-class Step extends Entity {
+class StepType extends Entity {
     constructor(data) {
         super();
-        this.entityType = 'step';
+        this.entityType = 'step-type';
         this.info = data;
         this.name = this.info.metadata.name;
         this.visibility = this.info.metadata.isPublic ? 'public' : 'private';
@@ -18,8 +18,8 @@ class Step extends Entity {
     }
 
     static fromResponse(response) {
-        return new Step(_.pick(response, 'version', 'kind', 'metadata', 'spec'));
+        return new StepType(_.pick(response, 'version', 'kind', 'metadata', 'spec'));
     }
 }
 
-module.exports = Step;
+module.exports = StepType;

openapi.json

@@ -5395,7 +5395,7 @@
       }
     },
 
-    "/steps": {
+    "/step-types": {
       "get": {
         "responses": {
           "200": {
@@ -5532,70 +5532,7 @@
         }
       }
     },
-    "/steps/labels": {
-      "get": {
-        "responses": {
-          "200": {
-            "$ref": "#/components/responses/json"
-          }
-        },
-        "tags": [
-          "steps"
-        ],
-        "operationId": "steps-get-labels",
-        "parameters": [],
-        "summary": "Get all labels",
-        "x-sdk-interface": "steps.getLabels",
-        "x-endpoint": {
-          "isEndpoint": false,
-          "preMiddleware": [
-            "auth.isAuthenticated"
-          ],
-          "postMiddleware": [
-            "global.iseMiddleware"
-          ],
-          "handler": "steps.getLabels"
-        }
-      }
-    },
-    "/steps/labels/{label}": {
-      "get": {
-        "responses": {
-          "200": {
-            "$ref": "#/components/responses/json"
-          }
-        },
-        "tags": [
-          "steps"
-        ],
-        "operationId": "steps-get-label-values",
-        "parameters": [
-          {
-            "in": "path",
-            "name": "label",
-            "schema": {
-              "type": "string"
-            },
-            "required": true,
-            "description": "label"
-          }
-
-        ],
-        "summary": "Get label values",
-        "x-sdk-interface": "steps.getLabelValues",
-        "x-endpoint": {
-          "isEndpoint": false,
-          "preMiddleware": [
-            "auth.isAuthenticated"
-          ],
-          "postMiddleware": [
-            "global.iseMiddleware"
-          ],
-          "handler": "steps.getLabelValues"
-        }
-      }
-    },
-    "/steps/names": {
+    "/step-types/names": {
       "get": {
         "parameters": [
           {
@@ -5654,7 +5591,7 @@
         }
       }
     },
-    "/steps/{name}": {
+    "/step-types/{name}": {
       "get": {
         "parameters": [
           {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,