kurtosis-sdk 0.86.4 → 0.86.6

package/build/core/lib/enclaves/enclave_context.d.ts

@@ -33,6 +33,7 @@ export declare class EnclaveContext {
     getAllFilesArtifactNamesAndUuids(): Promise<Result<FilesArtifactNameAndUuid[], Error>>;
     connectServices(connect: Connect): Promise<Result<ConnectServicesResponse, Error>>;
     getStarlarkRun(): Promise<Result<GetStarlarkRunResponse, Error>>;
+    private getPackageNameAndReplaceOptions;
     private static convertApiPortsToServiceContextPorts;
     private assembleRunStarlarkPackageArg;
     private getKurtosisYaml;

package/build/core/lib/enclaves/enclave_context.js

@@ -21,12 +21,25 @@ const service_context_1 = require("../services/service_context");
 const port_spec_1 = require("../services/port_spec");
 const api_container_service_pb_1 = require("../../kurtosis_core_rpc_api_bindings/api_container_service_pb");
 const path = require("path");
+const fs = require("fs");
 const kurtosis_yaml_1 = require("./kurtosis_yaml");
 const starlark_run_blocking_1 = require("./starlark_run_blocking");
 const service_identifiers_1 = require("../services/service_identifiers");
 exports.KURTOSIS_YAML_FILENAME = "kurtosis.yml";
 const OS_PATH_SEPARATOR_STRING = "/";
 const DOT_RELATIVE_PATH_INDICATOR_STRING = ".";
+// required to get around the "only Github URLs" validation
+const composePackageIdPlaceholder = 'github.com/NOTIONAL_USER/COMPOSE-PACKAGE';
+// TODO Remove this once package ID is detected ONLY the APIC side (i.e. the CLI doesn't need to tell the APIC what package ID it's using)
+// Doing so requires that we upload completely anonymous packages to the APIC, and it figures things out from there
+let supportedDockerComposeYmlFilenames = [
+    "compose.yml",
+    "compose.yaml",
+    "docker-compose.yml",
+    "docker-compose.yaml",
+    "docker_compose.yml",
+    "docker_compose.yaml",
+];
 // Docs available at https://docs.kurtosis.com/sdk/#enclavecontext
 class EnclaveContext {
     constructor(backend, pathJoiner, genericTgzArchiver) {
@@ -100,14 +113,12 @@ class EnclaveContext {
     // Docs available at https://docs.kurtosis.com/sdk/#runstarlarkpackagestring-packagerootpath-string-serializedparams-boolean-dryrun---streamstarlarkrunresponseline-responselines-error-error
     runStarlarkPackage(packageRootPath, runConfig) {
         return __awaiter(this, void 0, void 0, function* () {
-            const kurtosisYmlResult = yield this.getKurtosisYaml(packageRootPath);
-            if (kurtosisYmlResult.isErr()) {
-                return (0, neverthrow_1.err)(new Error(`Unexpected error while getting the Kurtosis yaml file from path '${packageRootPath}'`));
-            }
-            const kurtosisYaml = kurtosisYmlResult.value;
-            const packageId = kurtosisYaml.name;
-            const packageReplaceOptions = kurtosisYaml.packageReplaceOptions;
-            const args = yield this.assembleRunStarlarkPackageArg(kurtosisYaml, runConfig.relativePathToMainFile, runConfig.mainFunctionName, runConfig.serializedParams, runConfig.dryRun, runConfig.cloudInstanceId, runConfig.cloudUserId);
+            const packageNameAndReplaceOptionsResult = yield this.getPackageNameAndReplaceOptions(packageRootPath);
+            if (packageNameAndReplaceOptionsResult.isErr()) {
+                return (0, neverthrow_1.err)(new Error(`Unexpected error occurred while trying to get package name and replace options:\n${packageNameAndReplaceOptionsResult.error}`));
+            }
+            const [packageName, packageReplaceOptions] = packageNameAndReplaceOptionsResult.value;
+            const args = yield this.assembleRunStarlarkPackageArg(packageName, runConfig.relativePathToMainFile, runConfig.mainFunctionName, runConfig.serializedParams, runConfig.dryRun, runConfig.cloudInstanceId, runConfig.cloudUserId);
             if (args.isErr()) {
                 return (0, neverthrow_1.err)(new Error(`Unexpected error while assembling arguments to pass to the Starlark executor \n${args.error}`));
             }
@@ -115,9 +126,9 @@ class EnclaveContext {
             if (archiverResponse.isErr()) {
                 return (0, neverthrow_1.err)(new Error(`Unexpected error while creating the package's tgs file from '${packageRootPath}'\n${archiverResponse.error}`));
             }
-            const uploadStarlarkPackageResponse = yield this.backend.uploadStarlarkPackage(packageId, archiverResponse.value);
+            const uploadStarlarkPackageResponse = yield this.backend.uploadStarlarkPackage(packageName, archiverResponse.value);
             if (uploadStarlarkPackageResponse.isErr()) {
-                return (0, neverthrow_1.err)(new Error(`Unexpected error while uploading Starlark package '${packageId}'\n${uploadStarlarkPackageResponse.error}`));
+                return (0, neverthrow_1.err)(new Error(`Unexpected error while uploading Starlark package '${packageName}'\n${uploadStarlarkPackageResponse.error}`));
             }
             if (packageReplaceOptions !== undefined && packageReplaceOptions.size > 0) {
                 const uploadLocalStarlarkPackageDependenciesResponse = yield this.uploadLocalStarlarkPackageDependencies(packageRootPath, packageReplaceOptions);
@@ -308,6 +319,42 @@ class EnclaveContext {
     // ====================================================================================================
     //                                       Private helper functions
     // ====================================================================================================
+    // Determines the package name and replace options based on [packageRootPath]
+    // If a kurtosis.yml is detected, package is a kurtosis package
+    // If a valid [supportedDockerComposeYaml] is detected, package is a docker compose package
+    getPackageNameAndReplaceOptions(packageRootPath) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let packageName;
+            let packageReplaceOptions;
+            // Use kurtosis package if it exists
+            if (fs.existsSync(path.join(packageRootPath, exports.KURTOSIS_YAML_FILENAME))) {
+                const kurtosisYmlResult = yield this.getKurtosisYaml(packageRootPath);
+                if (kurtosisYmlResult.isErr()) {
+                    return (0, neverthrow_1.err)(new Error(`Unexpected error while getting the Kurtosis yaml file from path '${packageRootPath}'`));
+                }
+                const kurtosisYml = kurtosisYmlResult.value;
+                packageName = kurtosisYml.name;
+                packageReplaceOptions = kurtosisYml.packageReplaceOptions;
+            }
+            else {
+                // Use compose package if it exists
+                let composeAbsFilepath = '';
+                for (const candidateComposeFilename of supportedDockerComposeYmlFilenames) {
+                    const candidateComposeAbsFilepath = path.join(packageRootPath, candidateComposeFilename);
+                    if (fs.existsSync(candidateComposeAbsFilepath)) {
+                        composeAbsFilepath = candidateComposeAbsFilepath;
+                        break;
+                    }
+                }
+                if (composeAbsFilepath === '') {
+                    return (0, neverthrow_1.err)(new Error(`Neither a '${exports.KURTOSIS_YAML_FILENAME}' file nor one of the default Compose files (${supportedDockerComposeYmlFilenames.join(', ')}) was found in the package root; at least one of these is required`));
+                }
+                packageName = composePackageIdPlaceholder;
+                packageReplaceOptions = new Map();
+            }
+            return (0, neverthrow_1.ok)([packageName, packageReplaceOptions]);
+        });
+    }
     // convertApiPortsToServiceContextPorts returns a converted map where Port objects associated with strings in [apiPorts] are
     // properly converted to PortSpec objects.
     // Returns error if:
@@ -329,10 +376,10 @@ class EnclaveContext {
         }
         return (0, neverthrow_1.ok)(result);
     }
-    assembleRunStarlarkPackageArg(kurtosisYaml, relativePathToMainFile, mainFunctionName, serializedParams, dryRun, cloudInstanceId, cloudUserId) {
+    assembleRunStarlarkPackageArg(packageName, relativePathToMainFile, mainFunctionName, serializedParams, dryRun, cloudInstanceId, cloudUserId) {
         return __awaiter(this, void 0, void 0, function* () {
             const args = new api_container_service_pb_1.RunStarlarkPackageArgs;
-            args.setPackageId(kurtosisYaml.name);
+            args.setPackageId(packageName);
             args.setSerializedParams(serializedParams);
             args.setDryRun(dryRun);
             args.setRelativePathToMainFile(relativePathToMainFile);

package/build/kurtosis_version/kurtosis_version.js

@@ -4,5 +4,5 @@ exports.KURTOSIS_VERSION = void 0;
 // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!!
 // This is necessary so that Kurt Core consumers (e.g. modules) will know if they're compatible with the currently-running
 //  API container
-exports.KURTOSIS_VERSION = "0.86.4";
+exports.KURTOSIS_VERSION = "0.86.6";
 // !!!!!!!!!!! DO NOT UPDATE! WILL BE MANUALLY UPDATED DURING THE RELEASE PROCESS !!!!!!!!!!!!!!!!!!!!!!

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "kurtosis-sdk",
     "//": "NOTE: DO NOT UPDATE THIS VERSION MANUALLY - IT WILL BE UPDATED DURING THE RELEASE PROCESS!",
-    "version": "0.86.4",
+    "version": "0.86.6",
     "main": "./build/index",
     "description": "This repo contains a Typescript client for communicating with the Kurtosis Engine server, which is responsible for creating, managing and destroying Kurtosis Enclaves.",
     "types": "./build/index",