zcatalyst-cli 1.26.1 → 1.26.2

package/lib/appsail-utils.d.ts

@@ -1,3 +1,3 @@
 import { TAppSailDetails } from './util_modules/config/lib/appsail';
 export declare function filterTargets(allTargets: Array<TAppSailDetails>): Array<TAppSailDetails>;
-export declare function validateAppSail(targDetails: Array<TAppSailDetails>): Promise<Array<TAppSailDetails>>;
+export declare function validateAppSail(targDetails: Array<TAppSailDetails>, resolveLocalRuntime?: boolean): [Promise<Array<TAppSailDetails>>, Record<string, string>];

package/lib/appsail-utils.js

@@ -24,6 +24,10 @@ const container_1 = require("./util_modules/container");
 const image_1 = require("@zcatalyst/container-plugin/out/endpoints/image");
 const fs_1 = require("./util_modules/fs");
 const util_1 = require("util");
+const node_1 = require("./fn-utils/lib/node");
+const java_1 = require("./fn-utils/lib/java");
+const ensure_python_1 = require("./init/dependencies/python/ensure-python");
+const path_1 = require("path");
 const OCI_IMAGE_INDEX_MEDIA_TYPES = [
     'application/vnd.oci.image.index.v1+json',
     'application/vnd.docker.distribution.manifest.list.v2+json'
@@ -98,158 +102,195 @@ function filterTargets(allTargets) {
     }
     return allTargets;
 }
-function validateAppSail(targDetails) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let isSocket;
-        const getImageInfo = (target) => __awaiter(this, void 0, void 0, function* () {
-            switch (true) {
-                case target.source.startsWith(appsail_1.CONTAINER_IMAGE_PROTOCOLS.docker): {
-                    const imgTag = target.source.replace(appsail_1.CONTAINER_IMAGE_PROTOCOLS.docker, '');
-                    return (0, image_1.inspectImage)(imgTag);
+function validateAppSail(targDetails, resolveLocalRuntime = true) {
+    let isSocket;
+    const binPathMap = {};
+    const getImageInfo = (target) => __awaiter(this, void 0, void 0, function* () {
+        switch (true) {
+            case target.source.startsWith(appsail_1.CONTAINER_IMAGE_PROTOCOLS.docker): {
+                const imgTag = target.source.replace(appsail_1.CONTAINER_IMAGE_PROTOCOLS.docker, '');
+                return (0, image_1.inspectImage)(imgTag);
+            }
+            case target.source.startsWith(appsail_1.CONTAINER_IMAGE_PROTOCOLS.dockerArchive): {
+                const imgTar = target.source.replace(appsail_1.CONTAINER_IMAGE_PROTOCOLS.dockerArchive, '');
+                const isFile = yield fs_1.ASYNC.fileExists(imgTar);
+                if (!isFile) {
+                    throw new error_1.default('Invalid image tar path: ' + imgTar, { exit: 1 });
                 }
-                case target.source.startsWith(appsail_1.CONTAINER_IMAGE_PROTOCOLS.dockerArchive): {
-                    const imgTar = target.source.replace(appsail_1.CONTAINER_IMAGE_PROTOCOLS.dockerArchive, '');
-                    const isFile = yield fs_1.ASYNC.fileExists(imgTar);
-                    if (!isFile) {
-                        throw new error_1.default('Invalid image tar path: ' + imgTar, { exit: 1 });
-                    }
-                    return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
-                        var _a;
-                        try {
-                            const manifestJsonStream = yield (0, image_1.getTarEntry)(imgTar, 'manifest.json');
-                            const repositoriesStream = yield (0, image_1.getTarEntry)(imgTar, 'repositories');
-                            const indexJsonStream = yield (0, image_1.getTarEntry)(imgTar, 'index.json');
-                            if (!indexJsonStream) {
-                                if (manifestJsonStream || repositoriesStream) {
-                                    throw new error_1.default('Legacy docker-archive format is not supported. Only OCI-compliant docker-archive formats (pure OCI or hybrid OCI) are supported.', { exit: 1 });
-                                }
-                                throw new error_1.default('Corrupted image tar :: required OCI metadata index.json not found in the tar', { exit: 1 });
-                            }
-                            const indexJson = yield fs_1.ASYNC.readStreamAsJSON(indexJsonStream);
-                            if (indexJson.schemaVersion !== 2) {
-                                throw new error_1.default('Corrupted image tar :: invalid index.json file. Unsupported schemaVersion', { exit: 1 });
+                return new Promise((resolve, reject) => __awaiter(this, void 0, void 0, function* () {
+                    var _a;
+                    try {
+                        const manifestJsonStream = yield (0, image_1.getTarEntry)(imgTar, 'manifest.json');
+                        const repositoriesStream = yield (0, image_1.getTarEntry)(imgTar, 'repositories');
+                        const indexJsonStream = yield (0, image_1.getTarEntry)(imgTar, 'index.json');
+                        if (!indexJsonStream) {
+                            if (manifestJsonStream || repositoriesStream) {
+                                throw new error_1.default('Legacy docker-archive format is not supported. Only OCI-compliant docker-archive formats (pure OCI or hybrid OCI) are supported.', { exit: 1 });
                             }
-                            const traversedDigests = new Set();
-                            const resolveImageManifestPath = (manifestIndex, sourceFile) => __awaiter(this, void 0, void 0, function* () {
-                                var _a;
-                                const imageDescriptor = (_a = manifestIndex.manifests) === null || _a === void 0 ? void 0 : _a.find((manifest) => {
-                                    if (!(manifest === null || manifest === void 0 ? void 0 : manifest.digest)) {
-                                        return false;
-                                    }
-                                    if (!manifest.mediaType) {
-                                        return true;
-                                    }
-                                    return (OCI_IMAGE_MANIFEST_MEDIA_TYPES.includes(manifest.mediaType) ||
-                                        OCI_IMAGE_INDEX_MEDIA_TYPES.includes(manifest.mediaType));
-                                });
-                                if (!(imageDescriptor === null || imageDescriptor === void 0 ? void 0 : imageDescriptor.digest)) {
-                                    throw new error_1.default(`Corrupted image tar :: invalid ${sourceFile} file. Unable to identify image manifest`, { exit: 1 });
-                                }
-                                if (traversedDigests.has(imageDescriptor.digest)) {
-                                    throw new error_1.default(`Corrupted image tar :: circular descriptor reference found for digest ${imageDescriptor.digest}`, { exit: 1 });
-                                }
-                                if (!imageDescriptor.mediaType ||
-                                    OCI_IMAGE_MANIFEST_MEDIA_TYPES.includes(imageDescriptor.mediaType)) {
-                                    return getBlobPathFromDigest(imageDescriptor.digest, sourceFile);
-                                }
-                                traversedDigests.add(imageDescriptor.digest);
-                                const nestedIndexPath = getBlobPathFromDigest(imageDescriptor.digest, sourceFile);
-                                const nestedIndexStream = yield (0, image_1.getTarEntry)(imgTar, nestedIndexPath);
-                                if (!nestedIndexStream) {
-                                    throw new error_1.default(`Corrupted image tar :: nested image index ${nestedIndexPath} not found in the tar`, { exit: 1 });
+                            throw new error_1.default('Corrupted image tar :: required OCI metadata index.json not found in the tar', { exit: 1 });
+                        }
+                        const indexJson = yield fs_1.ASYNC.readStreamAsJSON(indexJsonStream);
+                        if (indexJson.schemaVersion !== 2) {
+                            throw new error_1.default('Corrupted image tar :: invalid index.json file. Unsupported schemaVersion', { exit: 1 });
+                        }
+                        const traversedDigests = new Set();
+                        const resolveImageManifestPath = (manifestIndex, sourceFile) => __awaiter(this, void 0, void 0, function* () {
+                            var _a;
+                            const imageDescriptor = (_a = manifestIndex.manifests) === null || _a === void 0 ? void 0 : _a.find((manifest) => {
+                                if (!(manifest === null || manifest === void 0 ? void 0 : manifest.digest)) {
+                                    return false;
                                 }
-                                const nestedIndex = yield fs_1.ASYNC.readStreamAsJSON(nestedIndexStream);
-                                if (nestedIndex.schemaVersion !== 2) {
-                                    throw new error_1.default(`Corrupted image tar :: invalid nested image index ${nestedIndexPath}. Unsupported schemaVersion`, { exit: 1 });
+                                if (!manifest.mediaType) {
+                                    return true;
                                 }
-                                return resolveImageManifestPath(nestedIndex, nestedIndexPath);
+                                return (OCI_IMAGE_MANIFEST_MEDIA_TYPES.includes(manifest.mediaType) ||
+                                    OCI_IMAGE_INDEX_MEDIA_TYPES.includes(manifest.mediaType));
                             });
-                            const imageManifestPath = yield resolveImageManifestPath(indexJson, 'index.json');
-                            const imageManifestStream = yield (0, image_1.getTarEntry)(imgTar, imageManifestPath);
-                            if (!imageManifestStream) {
-                                throw new error_1.default(`Corrupted image tar :: image manifest ${imageManifestPath} not found in the tar`, { exit: 1 });
+                            if (!(imageDescriptor === null || imageDescriptor === void 0 ? void 0 : imageDescriptor.digest)) {
+                                throw new error_1.default(`Corrupted image tar :: invalid ${sourceFile} file. Unable to identify image manifest`, { exit: 1 });
+                            }
+                            if (traversedDigests.has(imageDescriptor.digest)) {
+                                throw new error_1.default(`Corrupted image tar :: circular descriptor reference found for digest ${imageDescriptor.digest}`, { exit: 1 });
                             }
-                            const imageManifest = yield fs_1.ASYNC.readStreamAsJSON(imageManifestStream);
-                            if (imageManifest.schemaVersion !== 2) {
-                                throw new error_1.default('Corrupted image tar :: invalid image manifest file. Unsupported schemaVersion', { exit: 1 });
+                            if (!imageDescriptor.mediaType ||
+                                OCI_IMAGE_MANIFEST_MEDIA_TYPES.includes(imageDescriptor.mediaType)) {
+                                return getBlobPathFromDigest(imageDescriptor.digest, sourceFile);
                             }
-                            const configDigest = (_a = imageManifest.config) === null || _a === void 0 ? void 0 : _a.digest;
-                            if (!configDigest) {
-                                throw new error_1.default('Corrupted image tar :: invalid image manifest file. Unable to identify the config blob', { exit: 1 });
+                            traversedDigests.add(imageDescriptor.digest);
+                            const nestedIndexPath = getBlobPathFromDigest(imageDescriptor.digest, sourceFile);
+                            const nestedIndexStream = yield (0, image_1.getTarEntry)(imgTar, nestedIndexPath);
+                            if (!nestedIndexStream) {
+                                throw new error_1.default(`Corrupted image tar :: nested image index ${nestedIndexPath} not found in the tar`, { exit: 1 });
                             }
-                            const configBlobPath = getBlobPathFromDigest(configDigest, imageManifestPath);
-                            const configFileStream = yield (0, image_1.getTarEntry)(imgTar, configBlobPath);
-                            if (!configFileStream) {
-                                throw new error_1.default(`Corrupted image tar :: config blob ${configBlobPath} not found in the tar`, { exit: 1 });
+                            const nestedIndex = yield fs_1.ASYNC.readStreamAsJSON(nestedIndexStream);
+                            if (nestedIndex.schemaVersion !== 2) {
+                                throw new error_1.default(`Corrupted image tar :: invalid nested image index ${nestedIndexPath}. Unsupported schemaVersion`, { exit: 1 });
                             }
-                            const configFile = yield fs_1.ASYNC.readStreamAsJSON(configFileStream);
-                            resolve(configFile);
+                            return resolveImageManifestPath(nestedIndex, nestedIndexPath);
+                        });
+                        const imageManifestPath = yield resolveImageManifestPath(indexJson, 'index.json');
+                        const imageManifestStream = yield (0, image_1.getTarEntry)(imgTar, imageManifestPath);
+                        if (!imageManifestStream) {
+                            throw new error_1.default(`Corrupted image tar :: image manifest ${imageManifestPath} not found in the tar`, { exit: 1 });
                         }
-                        catch (er) {
-                            er instanceof error_1.default
-                                ? reject(er)
-                                : reject(error_1.default.getErrorInstance(er));
+                        const imageManifest = yield fs_1.ASYNC.readStreamAsJSON(imageManifestStream);
+                        if (imageManifest.schemaVersion !== 2) {
+                            throw new error_1.default('Corrupted image tar :: invalid image manifest file. Unsupported schemaVersion', { exit: 1 });
                         }
-                    }));
-                }
-                default: {
-                    throw new error_1.default('Unsupported image source: ' + target.source, { exit: 1 });
-                }
-            }
-        });
-        const _details = targDetails.map((targ) => __awaiter(this, void 0, void 0, function* () {
-            var _a, _b;
-            if (targ.validity.valid) {
-                if (targ.runtime === 'custom') {
-                    if (isSocket === undefined) {
-                        isSocket = yield (0, container_1.isSocketAccessible)(false);
-                    }
-                    if (isSocket === false) {
-                        targ.validity = {
-                            valid: false,
-                            reason: 'ZCatalyst-CLI is unable to communicate with the Container runtime'
-                        };
-                        return targ;
-                    }
-                    try {
-                        const imgInfo = (yield getImageInfo(targ));
-                        const os = 'os' in imgInfo ? imgInfo.os : imgInfo.Os;
-                        if ((os === null || os === void 0 ? void 0 : os.toLowerCase()) !== 'linux') {
-                            targ.validity = {
-                                valid: false,
-                                reason: 'container image should be Linux based'
-                            };
-                            return targ;
+                        const configDigest = (_a = imageManifest.config) === null || _a === void 0 ? void 0 : _a.digest;
+                        if (!configDigest) {
+                            throw new error_1.default('Corrupted image tar :: invalid image manifest file. Unable to identify the config blob', { exit: 1 });
                         }
-                        const arch = 'architecture' in imgInfo
-                            ? imgInfo.architecture
-                            : imgInfo.Architecture;
-                        if ((arch === null || arch === void 0 ? void 0 : arch.toLowerCase()) !== 'amd64') {
-                            targ.validity = {
-                                valid: false,
-                                reason: 'container image should be amd64 based'
-                            };
-                            return targ;
+                        const configBlobPath = getBlobPathFromDigest(configDigest, imageManifestPath);
+                        const configFileStream = yield (0, image_1.getTarEntry)(imgTar, configBlobPath);
+                        if (!configFileStream) {
+                            throw new error_1.default(`Corrupted image tar :: config blob ${configBlobPath} not found in the tar`, { exit: 1 });
                         }
+                        const configFile = yield fs_1.ASYNC.readStreamAsJSON(configFileStream);
+                        resolve(configFile);
                     }
                     catch (er) {
-                        targ.validity = {
-                            valid: false,
-                            reason: er instanceof error_1.default ? er.message : (0, util_1.inspect)(er)
-                        };
+                        er instanceof error_1.default
+                            ? reject(er)
+                            : reject(error_1.default.getErrorInstance(er));
                     }
+                }));
+            }
+            default: {
+                throw new error_1.default('Unsupported image source: ' + target.source, { exit: 1 });
+            }
+        }
+    });
+    const _details = targDetails.map((targ) => __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        if (!targ.validity.valid) {
+            return targ;
+        }
+        if (targ.runtime === 'custom') {
+            if (isSocket === undefined) {
+                isSocket = yield (0, container_1.isSocketAccessible)(false);
+            }
+            if (isSocket === false) {
+                targ.validity = {
+                    valid: false,
+                    reason: 'ZCatalyst-CLI is unable to communicate with the Container runtime'
+                };
+                return targ;
+            }
+            try {
+                const imgInfo = (yield getImageInfo(targ));
+                const os = 'os' in imgInfo ? imgInfo.os : imgInfo.Os;
+                if ((os === null || os === void 0 ? void 0 : os.toLowerCase()) !== 'linux') {
+                    targ.validity = {
+                        valid: false,
+                        reason: 'container image should be Linux based'
+                    };
                     return targ;
                 }
-                if (((_a = targ.config) === null || _a === void 0 ? void 0 : _a.platform) !== 'war' && !((_b = targ.config) === null || _b === void 0 ? void 0 : _b.command)) {
+                const arch = 'architecture' in imgInfo
+                    ? imgInfo.architecture
+                    : imgInfo.Architecture;
+                if ((arch === null || arch === void 0 ? void 0 : arch.toLowerCase()) !== 'amd64') {
                     targ.validity = {
                         valid: false,
-                        reason: 'Start-up command missing'
+                        reason: 'container image should be amd64 based'
                     };
                     return targ;
                 }
             }
+            catch (er) {
+                targ.validity = {
+                    valid: false,
+                    reason: er instanceof error_1.default ? er.message : (0, util_1.inspect)(er)
+                };
+            }
             return targ;
-        }));
-        return Promise.all(_details);
-    });
+        }
+        try {
+            const stack = (_a = targ.config) === null || _a === void 0 ? void 0 : _a.stack;
+            if (!stack) {
+                throw new error_1.default(`Stack is not defined for AppSail target ${targ.name}`, {
+                    exit: 2
+                });
+            }
+            if (((_b = targ.config) === null || _b === void 0 ? void 0 : _b.platform) !== 'war' && !((_c = targ.config) === null || _c === void 0 ? void 0 : _c.command)) {
+                throw new error_1.default(`Start-up command missing for AppSail target ${targ.name}`, {
+                    exit: 2
+                });
+            }
+            if (resolveLocalRuntime === false) {
+                return targ;
+            }
+            if (binPathMap[stack]) {
+                return targ;
+            }
+            switch (true) {
+                case stack.startsWith('node'): {
+                    binPathMap[stack] = yield (0, node_1.ensureNodeVersion)(stack, true);
+                    break;
+                }
+                case stack.startsWith('java'): {
+                    const javaBinPath = yield (0, java_1.ensureJava)(stack);
+                    if (!javaBinPath) {
+                        throw new error_1.default(`Invalid bin path for ${stack}`, { exit: 1 });
+                    }
+                    binPathMap[stack] = javaBinPath;
+                    break;
+                }
+                case stack.startsWith('python'): {
+                    const stackVersion = stack.replace('python_', '');
+                    const pyExe = yield (0, ensure_python_1.ensurePython)(stackVersion.replace('_', '.'), false, true);
+                    binPathMap[stack] = (0, path_1.dirname)(pyExe);
+                    break;
+                }
+            }
+        }
+        catch (err) {
+            const error = error_1.default.getErrorInstance(err);
+            targ.validity.valid = false;
+            targ.validity.reason = error.message;
+        }
+        return targ;
+    }));
+    return [Promise.all(_details), binPathMap];
 }

package/lib/deploy/features/appsail/index.js

@@ -43,7 +43,8 @@ exports.default = (...args_1) => __awaiter(void 0, [...args_1], void 0, function
         throw new error_1.default('No targets found');
     }
     const filtered = (0, appsail_utils_1.filterTargets)(targets);
-    const validTargets = (yield (0, appsail_utils_1.validateAppSail)(filtered)).filter((targ) => {
+    const [_validatePromise] = (0, appsail_utils_1.validateAppSail)(filtered, false);
+    const validTargets = (yield _validatePromise).filter((targ) => {
         if (targ.validity.valid) {
             return targ;
         }

package/lib/serve/features/appsail.js

@@ -12,12 +12,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = require("path");
 const appsail_utils_1 = require("../../appsail-utils");
 const error_1 = __importDefault(require("../../error"));
-const java_1 = require("../../fn-utils/lib/java");
-const node_1 = require("../../fn-utils/lib/node");
-const ensure_python_1 = require("../../init/dependencies/python/ensure-python");
 const port_resolver_1 = __importDefault(require("../../port-resolver"));
 const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const config_1 = require("../../util_modules/config");
@@ -30,47 +26,8 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
         (0, index_1.debug)('AppSail targets are empty');
         return [];
     }
-    const validated = yield (0, appsail_utils_1.validateAppSail)(optionTargets);
-    const binPathMap = {};
-    yield Promise.all(validated.map((target) => __awaiter(void 0, void 0, void 0, function* () {
-        var _a;
-        try {
-            const stack = (_a = target.config) === null || _a === void 0 ? void 0 : _a.stack;
-            if (!stack) {
-                throw new error_1.default(`Stack is not defined for AppSail target ${target.name}`, {
-                    exit: 2
-                });
-            }
-            if (binPathMap[stack]) {
-                return;
-            }
-            switch (true) {
-                case stack.startsWith('node'): {
-                    binPathMap[stack] = yield (0, node_1.ensureNodeVersion)(stack, true);
-                    break;
-                }
-                case stack.startsWith('java'): {
-                    const javaBinPath = yield (0, java_1.ensureJava)(stack);
-                    if (!javaBinPath) {
-                        throw new error_1.default(`Invalid bin path for ${stack}`, { exit: 1 });
-                    }
-                    binPathMap[stack] = javaBinPath;
-                    break;
-                }
-                case stack.startsWith('python'): {
-                    const stackVersion = stack.replace('python_', '');
-                    const pyExe = yield (0, ensure_python_1.ensurePython)(stackVersion.replace('_', '.'), false, true);
-                    binPathMap[stack] = (0, path_1.dirname)(pyExe);
-                    break;
-                }
-            }
-        }
-        catch (err) {
-            const error = error_1.default.getErrorInstance(err);
-            target.validity.valid = false;
-            target.validity.reason = error.message;
-        }
-    })));
+    const [_validatePromise, binPathMap] = (0, appsail_utils_1.validateAppSail)(optionTargets);
+    const validated = yield _validatePromise;
     const filledTargets = yield Promise.all(validated.map((targ) => __awaiter(void 0, void 0, void 0, function* () {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         if (!targ.validity.valid) {

package/lib/util_modules/config/lib/appsail.js

@@ -27,7 +27,7 @@ exports.CONTAINER_IMAGE_PROTOCOLS = {
     docker: 'docker://',
     dockerArchive: 'docker-archive://'
 };
-function validateConfig(source, configJson) {
+function validateManagedAppConfig(source, configJson) {
     if (!configJson) {
         return {
             valid: false,
@@ -73,6 +73,19 @@ function validateConfig(source, configJson) {
             };
         }
     }
+    if (!configJson.stack || configJson.stack.length === 0) {
+        return {
+            valid: false,
+            reason: 'Stack is not defined'
+        };
+    }
+    if (!configJson.command &&
+        !(configJson.stack.startsWith('java') && configJson.platform === 'war')) {
+        return {
+            valid: false,
+            reason: 'Start-up command is missing'
+        };
+    }
     return {
         valid: true
     };
@@ -177,7 +190,7 @@ function getAllTargetDetails() {
                 try {
                     const configJson = yield fs_1.ASYNC.readJSONFile(catalystConfigPth);
                     configJson && (configJson.raw = {});
-                    target.validity = validateConfig(target.source, configJson);
+                    target.validity = validateManagedAppConfig(target.source, configJson);
                     target.config = configJson;
                     return res(target);
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "zcatalyst-cli",
-	"version": "1.26.1",
+	"version": "1.26.2",
 	"description": "Command Line Tool for CATALYST",
 	"main": "./lib/index.js",
 	"bin": {