@sap-ux/deploy-tooling 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,78 @@
+#  `@sap-ux/deploy-tooling`
+
+## ui5-task
+
+To be documented ...
+
+### Configuration Examples
+
+#### Minimal Configuration
+This is the minimal configuration for deployment to `$TMP` without the change being recorded in a transport.
+
+```yaml
+- name: abap-deploy-task
+  configuration:
+    app:
+      name: Z_TEST
+      package: $TMP
+    target:
+      url: https://target.example
+```
+
+## CLI
+The module also exposes the two commands `deploy` and `undeploy`. 
+
+### deploy
+The `deploy` command executes the same functionality as the `abap-deploy` UI5 task independent of the `ui5 build` execution. This allows to separate the build and the deployment process e.g. for CI/CD or to provide configurations as CLI args instead of having them defined in the `ui5.yaml` - nevertheless, the `ui5.yaml` is always required as a basis for the configuration.
+
+```
+Usage: deploy [options]
+
+Options:
+  -c, --config <path-to-yaml>          Path to config yaml file
+  -y, --yes                            yes to all questions (default: false)
+  -n, --no-retry                       do not retry if deploy fails for any reason
+  --verbose                            verbose log output (default: false)
+  --destination  <destination>         Destination in SAP BTP pointing to an ABAP system
+  --url <target-url>                   URL of target ABAP system
+  --client <sap-client>                Client number of target ABAP system
+  --cloud                              target is an ABAP Cloud system
+  --cloud-service-key <file-location>  JSON file location with the ABAP cloud service key.
+  --transport <transport-request>      Transport number to record the change in the ABAP system
+  --name <bsp-name>                    Project name of the app
+  --strict-ssl                         Perform certificate validation (use --no-strict-ssl to deactivate it)
+  --test                               Run in test mode. ABAP backend reports deployment errors without actually deploying. (use --no-test to deactivate it)
+  --package <abap-package>             Package name for deploy target ABAP system
+  --description <description>          Project description of the app
+  --safe                               Prevents accidentally breaking deployments.
+  --keep                               Keep a copy of the deployed archive in the project folder.
+  --archive-url <url>                  Download app bundle from this url and upload this bundle for deployment
+  --archive-path <path>                Provide path of the app bundle for deployment
+  --archive-folder <path>              Provide path to a folder for deployment
+  -v, --version                        version of the deploy tooling
+  -h, --help                           display help for command
+```
+
+### undeploy
+The `undeploy` command allows undeploying a previously deployed application. This functionality is only available as CLI command and not as ui5 task.
+
+```
+Usage: undeploy [options]
+
+Options:
+  -c, --config <path-to-yaml>          Path to config yaml file
+  -y, --yes                            yes to all questions (default: false)
+  -n, --no-retry                       do not retry if undeploy fails for any reason
+  --verbose                            verbose log output (default: false)
+  --destination  <destination>         Destination in SAP BTP pointing to an ABAP system
+  --url <target-url>                   URL of target ABAP system
+  --client <sap-client>                Client number of target ABAP system
+  --cloud                              target is an ABAP Cloud system
+  --cloud-service-key <file-location>  JSON file location with the ABAP cloud service key.
+  --transport <transport-request>      Transport number to record the change in the ABAP system
+  --name <bsp-name>                    Project name of the app
+  --strict-ssl                         Perform certificate validation (use --no-strict-ssl to deactivate it)
+  --test                               Run in test mode. ABAP backend reports undeployment errors without actually undeploying (use --no-test to deactivate it).
+  -v, --version                        version of the deploy tooling
+  -h, --help                           display help for command
+```

package/bin/deploy

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/cli/index.js').runDeploy();

package/bin/undeploy

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/cli/index.js').runUndeploy();

package/dist/base/archive.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { ZipFile } from 'yazl';
+/**
+ * Helper function to recursively get a list of all files in a given folder and its sub folders.
+ *
+ * @param path - path to the folder that is to be searched
+ * @returns list of files names
+ */
+export declare function getFileNames(path: string): string[];
+/**
+ * Create a zip file based on the given object.
+ *
+ * @param zip zip file as object
+ * @returns the zip file as buffer
+ */
+export declare function createBuffer(zip: ZipFile): Promise<Buffer>;
+//# sourceMappingURL=archive.d.ts.map

package/dist/base/archive.js

@@ -0,0 +1,82 @@
+"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 __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBuffer = exports.getFileNames = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+/**
+ * Helper function to recursively get a list of all files in a given folder and its sub folders.
+ *
+ * @param path - path to the folder that is to be searched
+ * @returns list of files names
+ */
+function getFileNames(path) {
+    const names = [];
+    const files = (0, fs_1.readdirSync)(path);
+    for (const file of files) {
+        const filePath = (0, path_1.join)(path, file);
+        if ((0, fs_1.statSync)(filePath).isDirectory()) {
+            names.push(...getFileNames(filePath));
+        }
+        else {
+            names.push(filePath);
+        }
+    }
+    return names;
+}
+exports.getFileNames = getFileNames;
+/**
+ * Create a zip file based on the given object.
+ *
+ * @param zip zip file as object
+ * @returns the zip file as buffer
+ */
+function createBuffer(zip) {
+    var _a, e_1, _b, _c;
+    return __awaiter(this, void 0, void 0, function* () {
+        yield new Promise((resolve) => {
+            zip.end({ forceZip64Format: false }, () => {
+                resolve();
+            });
+        });
+        const chunks = [];
+        try {
+            for (var _d = true, _e = __asyncValues(zip.outputStream), _f; _f = yield _e.next(), _a = _f.done, !_a;) {
+                _c = _f.value;
+                _d = false;
+                try {
+                    const chunk = _c;
+                    chunks.push(chunk);
+                }
+                finally {
+                    _d = true;
+                }
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) yield _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return Buffer.concat(chunks);
+    });
+}
+exports.createBuffer = createBuffer;
+//# sourceMappingURL=archive.js.map

package/dist/base/config.d.ts

@@ -0,0 +1,31 @@
+import type { AbapDeployConfig, AbapTarget, UrlAbapTarget } from '../types';
+/**
+ * Check if it is a url or destination target.
+ *
+ * @param target target configuration
+ * @returns true is it is a UrlAbapTarget
+ */
+export declare function isUrlTarget(target: AbapTarget): target is UrlAbapTarget;
+/**
+ * Clones the given config and removes secrets so that it can be printed to a log file.
+ *
+ * @param config - config object
+ * @returns config object that can be logged
+ */
+export declare function getConfigForLogging(config: AbapDeployConfig): AbapDeployConfig | (Omit<AbapDeployConfig, 'credentials'> & {
+    credentials: 'hidden';
+});
+/**
+ * Replace environment variable references of pattern `env:VAR_NAME` with the value of the corresponding environment variable.
+ *
+ * @param obj - any object structure
+ */
+export declare function replaceEnvVariables(obj: object): void;
+/**
+ * Validate the given config. If anything mandatory is missing throw an error.
+ *
+ * @param config - the config to be validated
+ * @returns reference to the given config
+ */
+export declare function validateConfig(config: AbapDeployConfig | undefined): AbapDeployConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/base/config.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateConfig = exports.replaceEnvVariables = exports.getConfigForLogging = exports.isUrlTarget = void 0;
+const dotenv_1 = require("dotenv");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+/**
+ * Check if it is a url or destination target.
+ *
+ * @param target target configuration
+ * @returns true is it is a UrlAbapTarget
+ */
+function isUrlTarget(target) {
+    return target.url !== undefined;
+}
+exports.isUrlTarget = isUrlTarget;
+/**
+ * Clones the given config and removes secrets so that it can be printed to a log file.
+ *
+ * @param config - config object
+ * @returns config object that can be logged
+ */
+function getConfigForLogging(config) {
+    var _a;
+    if ((_a = config.credentials) === null || _a === void 0 ? void 0 : _a.password) {
+        return Object.assign(Object.assign({}, config), { credentials: 'hidden' });
+    }
+    else {
+        return config;
+    }
+}
+exports.getConfigForLogging = getConfigForLogging;
+/**
+ * Replace environment variable references of pattern `env:VAR_NAME` with the value of the corresponding environment variable.
+ *
+ * @param obj - any object structure
+ */
+function replaceEnvVariables(obj) {
+    (0, dotenv_1.config)();
+    for (const key in obj) {
+        const value = obj[key];
+        if (typeof value === 'object') {
+            replaceEnvVariables(value);
+        }
+        else if (typeof value === 'string' && value.startsWith('env:')) {
+            const varName = value.split('env:')[1];
+            obj[key] = process.env[varName];
+        }
+    }
+}
+exports.replaceEnvVariables = replaceEnvVariables;
+/**
+ * Helper function for throwing a missing property error.
+ *
+ * @param property Invalid missing property
+ */
+function throwConfigMissingError(property) {
+    throw new Error(`Invalid deployment configuration. Property ${property} is missing.`);
+}
+/**
+ * Validate the given target config. If anything mandatory is missing throw an error.
+ *
+ * @param target - target configuration to be validated
+ * @returns reference to the given target config
+ */
+function validateTarget(target) {
+    if (isUrlTarget(target)) {
+        if (target.client) {
+            target.client = (target.client + '').padStart(3, '0');
+        }
+    }
+    else if (!target.destination) {
+        throwConfigMissingError((0, btp_utils_1.isAppStudio)() ? 'target-destination' : 'target-url');
+    }
+    return target;
+}
+/**
+ * Validate the given config. If anything mandatory is missing throw an error.
+ *
+ * @param config - the config to be validated
+ * @returns reference to the given config
+ */
+function validateConfig(config) {
+    if (!config) {
+        throw new Error('The deployment configuration is missing.');
+    }
+    if (config.target) {
+        config.target = validateTarget(config.target);
+    }
+    else {
+        throwConfigMissingError('target');
+    }
+    if (config.app) {
+        if (!config.app.name) {
+            throwConfigMissingError('app-name');
+        }
+    }
+    else {
+        throwConfigMissingError('app');
+    }
+    return config;
+}
+exports.validateConfig = validateConfig;
+//# sourceMappingURL=config.js.map

package/dist/base/deploy.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { Logger } from '@sap-ux/logger';
+import type { BackendSystem } from '@sap-ux/store';
+import type { AbapDeployConfig, UrlAbapTarget } from '../types';
+type BasicAuth = Required<Pick<BackendSystem, 'username' | 'password'>>;
+type ServiceAuth = Required<Pick<BackendSystem, 'serviceKeys' | 'name'>> & {
+    refreshToken?: string;
+};
+/**
+ * Check the secure storage if it has credentials for the given target.
+ *
+ * @param target - ABAP target
+ */
+export declare function getCredentials<T extends BasicAuth | ServiceAuth | undefined>(target: UrlAbapTarget): Promise<T | undefined>;
+/**
+ * Deploy the given archive to the given target using the given app description.
+ *
+ * @param archive - archive file that is to be deployed
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+export declare function deploy(archive: Buffer, config: AbapDeployConfig, logger: Logger): Promise<void>;
+/**
+ * Deploy the given archive to the given target using the given app description.
+ *
+ * @param config - deployment configuration
+ * @param logger - reference to the logger instance
+ */
+export declare function undeploy(config: AbapDeployConfig, logger: Logger): Promise<void>;
+export {};
+//# sourceMappingURL=deploy.d.ts.map