@catladder/cli 0.0.0-prettier-cbceeed9 → 0.0.0-rails-cloud-run-wip-7bc25e04

package/CONTRIBUTING.md

@@ -2,10 +2,11 @@
 
 #### Atomic commits
 
-If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
-- a commit should contain exactly one self-contained functional change
-- a functional change should be contained in exactly one commit
-- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)
+If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means that a commit should:
+
+- Contain exactly one self-contained functional change
+- Not depend on changes in one of your later commits
+- Not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc…)
 
 A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
 
@@ -27,7 +28,8 @@ The **footer** can contain a [closing reference to an issue](https://help.github
 
 #### Revert
 
-If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.  
+In the body, it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
 
 #### Type
 
@@ -42,25 +44,28 @@ The type must be one of the following:
 | **fix**      | A bug fix                                                                                                   |
 | **perf**     | A code change that improves performance                                                                     |
 | **refactor** | A code change that neither fixes a bug nor adds a feature                                                   |
-| **style**    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)      |
+| **style**    | Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc)      |
 | **test**     | Adding missing tests or correcting existing tests                                                           |
 
 #### Subject
 
-The subject contains succinct description of the change:
+The subject contains a succinct description of the change:
 
 - use the imperative, present tense: "change" not "changed" nor "changes"
-- don't capitalize first letter
+- don't capitalize the first letter
 - no dot (.) at the end
 
 #### Body
-Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
-The body should include the motivation for the change and contrast this with previous behavior.
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".  
+The body should include the motivation for the change and contrast this with previous behaviour.
 
 #### Footer
+
 The footer should contain any information about **Breaking Changes** and is also the place to reference GitLab issues that this commit **Closes**.
 
-**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.  
+The rest of the commit message is then used for this.
 
 #### Examples
 
@@ -80,4 +85,4 @@ perf(pencil): remove graphiteWidth option`
 BREAKING CHANGE: The graphiteWidth option has been removed.
 
 The default graphite width of 10mm is always used for performance reasons.
-```
+```

package/README.md

@@ -1,34 +1,41 @@
 # catladder 🐱 🔧
 
-panter cli tool for kubernetes
+Panter cli tool for Kubernetes.
 
 ## Install
 
-`yarn global add @catladder/cli`
+```sh
+# yarn users
+yarn global add @catladder/cli
+# npm users
+npm install -g @catladder/cli
+```
 
-or npm users
-
-`npm install -g @catladder/cli`
-
-_Note: if you have `@panter/catladder` installed upgrade it to >=4.0.0 before installing `@catladder/cli`_
+> **Note**: If you have [@catladder/pipeline](https://www.npmjs.com/package/@catladder/pipeline) installed, upgrade it to >=4.0.0 before installing [@catladder/cli](https://www.npmjs.com/package/@catladder/cli).
 
 ## Getting started
 
-You'll need
+You'll need:
 
 - Google Cloud SDK ([see installation instructions](https://cloud.google.com/sdk/docs/install))
 - Kubectl ([see installation instructions](https://kubernetes.io/docs/tasks/tools/))
 - Cloud SQL Auth proxy ([see installation instructions](https://cloud.google.com/sql/docs/postgres/sql-proxy#install))
 
-Afterwards you need to connect to your cluster, e.g. `gcloud container clusters get-credentials clustername --zone google-zone --project google-project-id`
-In most cases you'll find the details on the Google Cloud [cluster overview ](https://console.cloud.google.com/kubernetes/list?project=skynet-164509)
+Afterwards, you need to connect to your cluster, e.g. `gcloud container clusters get-credentials clustername --zone google-zone --project google-project-id`
+In most cases, you'll find the details on the Google Cloud [cluster overview ](https://console.cloud.google.com/kubernetes/list?project=skynet-164509)
 
 It just works™
 
 ## Preferences
 
-catladder stores some preferences in `~/.catladder/preferences.yml` in case you want to change settings.
+Catladder stores some preferences in `~/.catladder/preferences.yml` in case you want to change settings.
 
 ## Contribution
 
-Check the docu [here](/CONTRIBUTING.md).
+Check the documentation [here](https://git.panter.ch/catladder/catladder/-/tree/main/cli/CONTRIBUTING.md).
+
+### Adding packages in cli
+
+if you add npm libs in cli, make sure to add them as dev-dependencies.
+
+the reason is that we bundle all dependencies in the cli package, so that if you add that to your project, it won't install all @catladder/cli's dependencies.

package/bin/catci

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// tslint:disable-next-line:no-var-requires
+require("../dist/bundles/catci/index.js");

package/bin/catci-dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+// tslint:disable-next-line:no-var-requires
+require("../dist/catci.js");

package/dist/apps/catci/catci.d.ts

@@ -0,0 +1 @@
+export declare function runCatCi(): Promise<void>;

package/dist/apps/catci/catci.js

@@ -0,0 +1,86 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.runCatCi = void 0;
+var vorpal_1 = __importDefault(require("vorpal"));
+var packageInfos_1 = __importDefault(require("../../packageInfos"));
+var commands_1 = __importDefault(require("./commands/security/commands"));
+function reconstructArgs(args) {
+    return __spreadArray([args[0]], args.slice(1).map(function (arg) { return "\"".concat(arg, "\""); }), true).join(" ");
+}
+function runCatCi() {
+    return __awaiter(this, void 0, void 0, function () {
+        var vorpal, isInteractive, args;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    vorpal = new vorpal_1["default"]();
+                    process.exitCode = 0;
+                    vorpal.delimiter("catci $").history("catci").version(packageInfos_1["default"].version);
+                    (0, commands_1["default"])(vorpal);
+                    isInteractive = process.argv.length <= 2;
+                    if (!isInteractive) return [3 /*break*/, 1];
+                    vorpal.log("Catladder CI Tools \uD83D\uDE3B\uD83D\uDD28 version ".concat(packageInfos_1["default"].version)).show();
+                    return [3 /*break*/, 3];
+                case 1:
+                    process.exitCode = 1;
+                    args = reconstructArgs(process.argv.slice(2));
+                    return [4 /*yield*/, vorpal.exec(args)];
+                case 2:
+                    _a.sent();
+                    process.exit();
+                    _a.label = 3;
+                case 3: return [2 /*return*/];
+            }
+        });
+    });
+}
+exports.runCatCi = runCatCi;
+//# sourceMappingURL=catci.js.map

package/dist/apps/catci/catci.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"catci.js","sourceRoot":"","sources":["../../../src/apps/catci/catci.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAA4B;AAC5B,oEAA6C;AAC7C,0EAA4D;AAE5D,SAAS,eAAe,CAAC,IAAc;IACrC,OAAO,eAAC,IAAI,CAAC,CAAC,CAAC,GAAK,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,YAAI,GAAG,OAAG,EAAV,CAAU,CAAC,QAAE,IAAI,CAAC,GAAG,CAAC,CAAC;AACxE,CAAC;AAED,SAAsB,QAAQ;;;;;;oBACtB,MAAM,GAAG,IAAI,mBAAM,EAAE,CAAC;oBAE5B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;oBACrB,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,yBAAW,CAAC,OAAO,CAAC,CAAC;oBAE1E,IAAA,qBAAgB,EAAC,MAAM,CAAC,CAAC;oBAEnB,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;yBAC3C,aAAa,EAAb,wBAAa;oBACf,MAAM,CAAC,GAAG,CAAC,8DAAmC,yBAAW,CAAC,OAAO,CAAE,CAAC,CAAC,IAAI,EAAE,CAAC;;;oBAE5E,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;oBACf,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBACpD,qBAAM,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAA;;oBAAvB,SAAuB,CAAC;oBACxB,OAAO,CAAC,IAAI,EAAE,CAAC;;;;;;CAElB;AAjBD,4BAiBC"}

package/dist/apps/catci/commands/security/auditDocument.d.ts

@@ -0,0 +1,19 @@
+export declare function makeTemplate(): string;
+export declare type SecurityEvaluation = {
+    topics: {
+        description: string;
+        responsibles: string[];
+        note: string;
+        isUnknown: boolean;
+        isAnswered: boolean;
+        isSecured: boolean;
+    }[];
+    score: {
+        rating: number;
+        totalTopics: number;
+        answeredTopics: number;
+        securedTopics: number;
+        unknownTopics: number;
+    };
+};
+export declare function evaluateDocument(document: string): SecurityEvaluation;

package/dist/apps/catci/commands/security/auditDocument.js

@@ -0,0 +1,90 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.evaluateDocument = exports.makeTemplate = void 0;
+var topics_json_1 = __importDefault(require("./topics.json"));
+var allTopics = topics_json_1["default"];
+var checkYes = "✅";
+var checkNo = "❌";
+var checkPlaceholder = "".concat(checkYes, "/").concat(checkNo);
+var responsiblePlaceholder = "@...";
+var rows = [
+    ["Responsible", checkPlaceholder, "Description", "Note", "More Information"],
+].concat(allTopics.map(function (t) { return [
+    Array(t.responsibles).fill(responsiblePlaceholder).join(", "),
+    checkPlaceholder,
+    t.description,
+    "",
+    t.more,
+]; }));
+function makeTable(rows) {
+    var colWidths = calculateColumnWidths(rows);
+    return "\n".concat(makeRow(rows[0], colWidths, " "), "\n").concat(makeRow(rows[0].map(function () { return ""; }), colWidths, "-"), "\n").concat(rows
+        .slice(1)
+        .map(function (row) { return makeRow(row, colWidths, " "); })
+        .join("\n"), "\n");
+}
+function calculateColumnWidths(rows) {
+    var columnCount = rows[0].length;
+    return Array.from({ length: columnCount }, function (_, i) { return i; }).map(function (columnIndex) {
+        return Math.max.apply(Math, rows.map(function (row) { return row[columnIndex].length; }));
+    });
+}
+function makeRow(row, colWidths, fillString) {
+    return "| ".concat(row
+        .map(function (cell, i) { return cell.padEnd(colWidths[i], fillString); })
+        .join(" | "), " |");
+}
+function makeTemplate() {
+    return "\n# Security Audit Report\n\nA security audit report document is a comprehensive assessment of an application's security posture, containing security topics that auditors can mark to indicate the state of various security aspects.\n\nIt serves as a structured guide for security team to evaluate different security factors such as authentication, authorization, data encryption, input validation, and more.\n\n## General Information\n\n- Project Owner is @...\n- Dev team:\n  - @...\n  - @...\n  - @...\n\n## Project Security\n\n".concat(makeTable(rows), "\n\n");
+}
+exports.makeTemplate = makeTemplate;
+function evaluateDocument(document) {
+    var _a, _b;
+    var rawRows = (_b = (_a = document.match(/^\s*\|.*?\|\s*$/gm)) === null || _a === void 0 ? void 0 : _a.map(function (row) { return row.trim(); })) !== null && _b !== void 0 ? _b : [];
+    var matchedRows = rawRows
+        .map(function (row) { return row.split("|").map(function (col) { return col.trim(); }); })
+        .slice(2);
+    var knownTopics = new Set(allTopics.map(function (t) { return t.description; }));
+    var topics = matchedRows.map(function (col) {
+        var responsibles = col[1].split(", ");
+        var answer = col[2];
+        var description = col[3];
+        var note = col[4];
+        var isUnknown = !knownTopics.has(description);
+        var isAnswered = !isUnknown &&
+            !answer.includes(checkPlaceholder) &&
+            !responsibles.some(function (responsible) {
+                return responsible.includes(responsiblePlaceholder);
+            });
+        var isSecured = !isUnknown && isAnswered && answer.includes(checkYes);
+        return {
+            responsibles: responsibles,
+            answer: answer,
+            description: description,
+            note: note,
+            isUnknown: isUnknown,
+            isAnswered: isAnswered,
+            isSecured: isSecured
+        };
+    });
+    var totalTopics = allTopics.length;
+    var answeredTopics = topics.filter(function (t) { return t.isAnswered; }).length;
+    var securedTopics = topics.filter(function (t) { return t.isSecured; }).length;
+    var unknownTopics = topics.filter(function (t) { return t.isUnknown; }).length;
+    var rating = Math.round((securedTopics / totalTopics) * 100);
+    return {
+        topics: topics,
+        score: {
+            rating: rating,
+            totalTopics: totalTopics,
+            answeredTopics: answeredTopics,
+            securedTopics: securedTopics,
+            unknownTopics: unknownTopics
+        }
+    };
+}
+exports.evaluateDocument = evaluateDocument;
+//# sourceMappingURL=auditDocument.js.map

package/dist/apps/catci/commands/security/auditDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditDocument.js","sourceRoot":"","sources":["../../../../../src/apps/catci/commands/security/auditDocument.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAuC;AAQvC,IAAM,SAAS,GAAY,wBAAU,CAAC;AAEtC,IAAM,QAAQ,GAAG,GAAG,CAAC;AACrB,IAAM,OAAO,GAAG,GAAG,CAAC;AAEpB,IAAM,gBAAgB,GAAG,UAAG,QAAQ,cAAI,OAAO,CAAE,CAAC;AAClD,IAAM,sBAAsB,GAAG,MAAM,CAAC;AACtC,IAAM,IAAI,GAAG;IACX,CAAC,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,EAAE,kBAAkB,CAAC;CAC7E,CAAC,MAAM,CACN,SAAS,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA;IACnB,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;IAC7D,gBAAgB;IAChB,CAAC,CAAC,WAAW;IACb,EAAE;IACF,CAAC,CAAC,IAAI;CACP,EANoB,CAMpB,CAAC,CACH,CAAC;AAEF,SAAS,SAAS,CAAC,IAAgB;IACjC,IAAM,SAAS,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE9C,OAAO,YACP,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,eAChC,OAAO,CACP,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,cAAM,OAAA,EAAE,EAAF,CAAE,CAAC,EACrB,SAAS,EACT,GAAG,CACJ,eACC,IAAI;SACH,KAAK,CAAC,CAAC,CAAC;SACR,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,GAAG,CAAC,EAA5B,CAA4B,CAAC;SAC1C,IAAI,CAAC,IAAI,CAAC,OACZ,CAAC;AACF,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAgB;IAC7C,IAAM,WAAW,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;IACnC,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,EAAE,UAAC,CAAC,EAAE,CAAC,IAAK,OAAA,CAAC,EAAD,CAAC,CAAC,CAAC,GAAG,CAAC,UAAC,WAAW;QACtE,OAAA,IAAI,CAAC,GAAG,OAAR,IAAI,EAAQ,IAAI,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,WAAW,CAAC,CAAC,MAAM,EAAvB,CAAuB,CAAC;IAAtD,CAAuD,CACxD,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,GAAa,EAAE,SAAmB,EAAE,UAAkB;IACrE,OAAO,YAAK,GAAG;SACZ,GAAG,CAAC,UAAC,IAAI,EAAE,CAAC,IAAK,OAAA,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,EAArC,CAAqC,CAAC;SACvD,IAAI,CAAC,KAAK,CAAC,OAAI,CAAC;AACrB,CAAC;AAED,SAAgB,YAAY;IAC1B,OAAO,2hBAiBP,SAAS,CAAC,IAAI,CAAC,SAEhB,CAAC;AACF,CAAC;AArBD,oCAqBC;AAoBD,SAAgB,gBAAgB,CAAC,QAAgB;;IAC/C,IAAM,OAAO,GACX,MAAA,MAAA,QAAQ,CAAC,KAAK,CAAC,mBAAmB,CAAC,0CAAE,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,IAAI,EAAE,EAAV,CAAU,CAAC,mCAAI,EAAE,CAAC;IACtE,IAAM,WAAW,GAAG,OAAO;SACxB,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,CAAC,IAAI,EAAE,EAAV,CAAU,CAAC,EAAvC,CAAuC,CAAC;SACrD,KAAK,CAAC,CAAC,CAAC,CAAC;IACZ,IAAM,WAAW,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,WAAW,EAAb,CAAa,CAAC,CAAC,CAAC;IAEjE,IAAM,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,UAAC,GAAG;QACjC,IAAM,YAAY,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACxC,IAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QACtB,IAAM,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAC3B,IAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;QAEpB,IAAM,SAAS,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChD,IAAM,UAAU,GACd,CAAC,SAAS;YACV,CAAC,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC;YAClC,CAAC,YAAY,CAAC,IAAI,CAAC,UAAC,WAAW;gBAC7B,OAAA,WAAW,CAAC,QAAQ,CAAC,sBAAsB,CAAC;YAA5C,CAA4C,CAC7C,CAAC;QACJ,IAAM,SAAS,GAAG,CAAC,SAAS,IAAI,UAAU,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAExE,OAAO;YACL,YAAY,cAAA;YACZ,MAAM,QAAA;YACN,WAAW,aAAA;YACX,IAAI,MAAA;YACJ,SAAS,WAAA;YACT,UAAU,YAAA;YACV,SAAS,WAAA;SACV,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC;IACrC,IAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,UAAU,EAAZ,CAAY,CAAC,CAAC,MAAM,CAAC;IACjE,IAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,SAAS,EAAX,CAAW,CAAC,CAAC,MAAM,CAAC;IAC/D,IAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,SAAS,EAAX,CAAW,CAAC,CAAC,MAAM,CAAC;IAE/D,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,aAAa,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC,CAAC;IAE/D,OAAO;QACL,MAAM,QAAA;QACN,KAAK,EAAE;YACL,MAAM,QAAA;YACN,WAAW,aAAA;YACX,cAAc,gBAAA;YACd,aAAa,eAAA;YACb,aAAa,eAAA;SACd;KACF,CAAC;AACJ,CAAC;AAnDD,4CAmDC"}

package/dist/apps/catci/commands/security/commands.d.ts

@@ -0,0 +1,2 @@
+import type Vorpal from "vorpal";
+export default function (vorpal: Vorpal): void;

package/dist/apps/catci/commands/security/commands.js

@@ -0,0 +1,185 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+var evaluateSecurityAudit_1 = require("./evaluateSecurityAudit");
+var rest_1 = require("@gitbeaker/rest");
+var createSecurityAuditMergeRequest_1 = require("./createSecurityAuditMergeRequest");
+var ts_results_es_1 = require("ts-results-es");
+var GITLAB_HOST = "https://git.panter.ch";
+function default_1(vorpal) {
+    commandCiJob(vorpal);
+    commandEvaluate(vorpal);
+    commandCreate(vorpal);
+}
+exports["default"] = default_1;
+function resultAsExitCode(func) {
+    var _this = this;
+    return function (args) { return __awaiter(_this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, func(args)];
+                case 1:
+                    result = _a.sent();
+                    process.exitCode = result.isErr() ? 1 : 0;
+                    return [2 /*return*/];
+            }
+        });
+    }); };
+}
+function commandCiJob(vorpal) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _this = this;
+        return __generator(this, function (_a) {
+            vorpal
+                .command("security-audit-ci-job <path> <token> <mainBranch> <projectId> <userId>", "Evaluates security audit document. If the document can't be evaluated or does not exist, creates a new MR with security audit document template.\n\n<path> root path of a project with security audit document (".concat(createSecurityAuditMergeRequest_1.SECURITY_AUDIT_FILE_NAME, ")\n<token> gitlab token with 'api' scopes and permissions to create a new branch\n<main-branch> main branch name\n<project-id> project id to create security audit for\n<user-id> gitlab user id that will be assignee of the audit\n"))
+                .action(resultAsExitCode(function (args) { return __awaiter(_this, void 0, void 0, function () {
+                var evaluation, token, mainBranch, projectId, userId, api, mr;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, (0, evaluateSecurityAudit_1.evaluateSecurityAudit)({ path: args.path })];
+                        case 1:
+                            evaluation = _a.sent();
+                            if (!evaluation.isErr()) return [3 /*break*/, 3];
+                            console.log("could not evaluate security audit document");
+                            console.log("creating new merge request with security audit template...");
+                            token = args.token, mainBranch = args.mainBranch, projectId = args.projectId, userId = args.userId;
+                            api = new rest_1.Gitlab({
+                                host: GITLAB_HOST,
+                                token: token
+                            });
+                            return [4 /*yield*/, (0, createSecurityAuditMergeRequest_1.createSecurityAuditMergeRequest)({
+                                    api: api,
+                                    mainBranch: mainBranch,
+                                    projectId: projectId,
+                                    userId: parseInt(userId)
+                                })];
+                        case 2:
+                            mr = _a.sent();
+                            if (mr.isErr()) {
+                                console.error("could not create merge request with security audit template: ".concat(mr.error));
+                                return [2 /*return*/, mr];
+                            }
+                            console.log("security audit merge request created successfully");
+                            console.log("please finish the MR by updating SECURITY.md document: ".concat(mr.value.web_url));
+                            return [2 /*return*/, (0, ts_results_es_1.Err)("merge request created")];
+                        case 3:
+                            if (evaluation.value.score.answeredTopics === 0) {
+                                console.error("audit document has no answered topics");
+                                console.error("please answer security topics in ".concat(createSecurityAuditMergeRequest_1.SECURITY_AUDIT_FILE_NAME, " by adding responsible people and check/cross in the table"));
+                                return [2 /*return*/, (0, ts_results_es_1.Err)("audit document has no answered topics")];
+                            }
+                            console.log((0, evaluateSecurityAudit_1.makeSecurityAuditOverview)(evaluation.value));
+                            return [2 /*return*/, (0, ts_results_es_1.Ok)({})];
+                    }
+                });
+            }); }));
+            return [2 /*return*/];
+        });
+    });
+}
+function commandEvaluate(vorpal) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _this = this;
+        return __generator(this, function (_a) {
+            vorpal
+                .command("security-audit-evaluate <path>", "Evaluates security audit document in given <path>")
+                .action(resultAsExitCode(function (args) { return __awaiter(_this, void 0, void 0, function () {
+                var result;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            console.log("evaluating security audit document...");
+                            return [4 /*yield*/, (0, evaluateSecurityAudit_1.evaluateSecurityAudit)({ path: args.path })];
+                        case 1:
+                            result = _a.sent();
+                            if (result.isErr()) {
+                                console.error(result.error);
+                                console.error("please make sure the security audit document ".concat(createSecurityAuditMergeRequest_1.SECURITY_AUDIT_FILE_NAME, " is in the repository"));
+                            }
+                            else {
+                                console.log((0, evaluateSecurityAudit_1.makeSecurityAuditOverview)(result.value));
+                            }
+                            return [2 /*return*/, result];
+                    }
+                });
+            }); }));
+            return [2 /*return*/];
+        });
+    });
+}
+function commandCreate(vorpal) {
+    return __awaiter(this, void 0, void 0, function () {
+        var _this = this;
+        return __generator(this, function (_a) {
+            vorpal
+                .command("security-audit-create <token> <mainBranch> <projectId> <userId>", "Creates a MR in given project with the latest security audit template document\n\n<token> gitlab token with 'api' scopes and permissions to create a new branch\n<main-branch> main branch name\n<project-id> project id to create security audit for\n<user-id> gitlab user id that will be assignee of the audit\n")
+                .action(resultAsExitCode(function (args) { return __awaiter(_this, void 0, void 0, function () {
+                var token, mainBranch, projectId, userId, api, result;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0:
+                            token = args.token, mainBranch = args.mainBranch, projectId = args.projectId, userId = args.userId;
+                            api = new rest_1.Gitlab({
+                                host: GITLAB_HOST,
+                                token: token
+                            });
+                            return [4 /*yield*/, (0, createSecurityAuditMergeRequest_1.createSecurityAuditMergeRequest)({
+                                    api: api,
+                                    mainBranch: mainBranch,
+                                    projectId: projectId,
+                                    userId: parseInt(userId)
+                                })];
+                        case 1:
+                            result = _a.sent();
+                            if (result.isErr()) {
+                                console.error("could not create security audit merge request: ".concat(result.error));
+                            }
+                            else {
+                                console.log("security audit merge request created successfully");
+                                console.log("please finish the MR by updating SECURITY.md document: ".concat(result.value.web_url));
+                            }
+                            return [2 /*return*/, result];
+                    }
+                });
+            }); }));
+            return [2 /*return*/];
+        });
+    });
+}
+//# sourceMappingURL=commands.js.map

package/dist/apps/catci/commands/security/commands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.js","sourceRoot":"","sources":["../../../../../src/apps/catci/commands/security/commands.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,iEAGiC;AACjC,wCAAyC;AACzC,qFAG2C;AAC3C,+CAAqD;AAErD,IAAM,WAAW,GAAG,uBAAuB,CAAC;AAE5C,mBAAyB,MAAc;IACrC,YAAY,CAAC,MAAM,CAAC,CAAC;IACrB,eAAe,CAAC,MAAM,CAAC,CAAC;IACxB,aAAa,CAAC,MAAM,CAAC,CAAC;AACxB,CAAC;AAJD,+BAIC;AAID,SAAS,gBAAgB,CACvB,IAA8D;IADhE,iBAOC;IAJC,OAAO,UAAO,IAAiB;;;;wBACd,qBAAM,IAAI,CAAC,IAAI,CAAC,EAAA;;oBAAzB,MAAM,GAAG,SAAgB;oBAC/B,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;;;;SAC3C,CAAC;AACJ,CAAC;AAED,SAAe,YAAY,CAAC,MAAc;;;;YACxC,MAAM;iBACH,OAAO,CACN,wEAAwE,EACxE,0NAEwD,0DAAwB,0OAKrF,CACI;iBACA,MAAM,CACL,gBAAgB,CAAC,UAAO,IAAI;;;;gCACP,qBAAM,IAAA,6CAAqB,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,EAAA;;4BAA7D,UAAU,GAAG,SAAgD;iCAE/D,UAAU,CAAC,KAAK,EAAE,EAAlB,wBAAkB;4BACpB,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAC;4BAC1D,OAAO,CAAC,GAAG,CACT,4DAA4D,CAC7D,CAAC;4BAEM,KAAK,GAAoC,IAAI,MAAxC,EAAE,UAAU,GAAwB,IAAI,WAA5B,EAAE,SAAS,GAAa,IAAI,UAAjB,EAAE,MAAM,GAAK,IAAI,OAAT,CAAU;4BAChD,GAAG,GAAG,IAAI,aAAM,CAAC;gCACrB,IAAI,EAAE,WAAW;gCACjB,KAAK,OAAA;6BACN,CAAC,CAAC;4BAEQ,qBAAM,IAAA,iEAA+B,EAAC;oCAC/C,GAAG,KAAA;oCACH,UAAU,YAAA;oCACV,SAAS,WAAA;oCACT,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC;iCACzB,CAAC,EAAA;;4BALI,EAAE,GAAG,SAKT;4BAEF,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gCACd,OAAO,CAAC,KAAK,CACX,uEAAgE,EAAE,CAAC,KAAK,CAAE,CAC3E,CAAC;gCACF,sBAAO,EAAE,EAAC;6BACX;4BAED,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;4BACjE,OAAO,CAAC,GAAG,CACT,iEAA0D,EAAE,CAAC,KAAK,CAAC,OAAO,CAAE,CAC7E,CAAC;4BACF,sBAAO,IAAA,mBAAG,EAAC,uBAAgC,CAAC,EAAC;;4BAG/C,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc,KAAK,CAAC,EAAE;gCAC/C,OAAO,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;gCACvD,OAAO,CAAC,KAAK,CACX,2CAAoC,0DAAwB,+DAA4D,CACzH,CAAC;gCACF,sBAAO,IAAA,mBAAG,EAAC,uCAAgD,CAAC,EAAC;6BAC9D;4BAED,OAAO,CAAC,GAAG,CAAC,IAAA,iDAAyB,EAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;4BACzD,sBAAO,IAAA,kBAAE,EAAC,EAAE,CAAC,EAAC;;;iBACf,CAAC,CACH,CAAC;;;;CACL;AAED,SAAe,eAAe,CAAC,MAAc;;;;YAC3C,MAAM;iBACH,OAAO,CACN,gCAAgC,EAChC,mDAAmD,CACpD;iBACA,MAAM,CACL,gBAAgB,CAAC,UAAO,IAAI;;;;;4BAC1B,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;4BAEtC,qBAAM,IAAA,6CAAqB,EAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,EAAA;;4BAAzD,MAAM,GAAG,SAAgD;4BAC/D,IAAI,MAAM,CAAC,KAAK,EAAE,EAAE;gCAClB,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gCAC5B,OAAO,CAAC,KAAK,CACX,uDAAgD,0DAAwB,0BAAuB,CAChG,CAAC;6BACH;iCAAM;gCACL,OAAO,CAAC,GAAG,CAAC,IAAA,iDAAyB,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;6BACtD;4BACD,sBAAO,MAAM,EAAC;;;iBACf,CAAC,CACH,CAAC;;;;CACL;AAED,SAAe,aAAa,CAAC,MAAc;;;;YACzC,MAAM;iBACH,OAAO,CACN,iEAAiE,EACjE,sTAML,CACI;iBACA,MAAM,CACL,gBAAgB,CAAC,UAAO,IAAI;;;;;4BAClB,KAAK,GAAoC,IAAI,MAAxC,EAAE,UAAU,GAAwB,IAAI,WAA5B,EAAE,SAAS,GAAa,IAAI,UAAjB,EAAE,MAAM,GAAK,IAAI,OAAT,CAAU;4BAEhD,GAAG,GAAG,IAAI,aAAM,CAAC;gCACrB,IAAI,EAAE,WAAW;gCACjB,KAAK,OAAA;6BACN,CAAC,CAAC;4BAEY,qBAAM,IAAA,iEAA+B,EAAC;oCACnD,GAAG,KAAA;oCACH,UAAU,YAAA;oCACV,SAAS,WAAA;oCACT,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC;iCACzB,CAAC,EAAA;;4BALI,MAAM,GAAG,SAKb;4BAEF,IAAI,MAAM,CAAC,KAAK,EAAE,EAAE;gCAClB,OAAO,CAAC,KAAK,CACX,yDAAkD,MAAM,CAAC,KAAK,CAAE,CACjE,CAAC;6BACH;iCAAM;gCACL,OAAO,CAAC,GAAG,CAAC,mDAAmD,CAAC,CAAC;gCACjE,OAAO,CAAC,GAAG,CACT,iEAA0D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAE,CACjF,CAAC;6BACH;4BACD,sBAAO,MAAM,EAAC;;;iBACf,CAAC,CACH,CAAC;;;;CACL"}

package/dist/apps/catci/commands/security/createSecurityAuditMergeRequest.d.ts

@@ -0,0 +1,9 @@
+import type { Gitlab } from "@gitbeaker/core";
+import { Err } from "ts-results-es";
+export declare const SECURITY_AUDIT_FILE_NAME: "SECURITY.md";
+export declare function createSecurityAuditMergeRequest({ projectId, mainBranch, userId, api, }: {
+    projectId: string;
+    mainBranch: string;
+    userId: number;
+    api: Gitlab;
+}): Promise<Err<string> | import("ts-results-es").Ok<import("@gitbeaker/core").ExpandedMergeRequestSchema>>;