feat!: impl dependency list flag (#2543)

## Description `kurtosis run github.com/kurtosis-tech/... --dependencies` returns a `yaml` with a list of images and packages the run will need to depend on. Adding `--pull` will pull all the dependencies locally. The `kurtosis.yml` will be updated to use local versions of packages and Docker images are pulled onto the machine locally ## Is this change user facing? YES
kurtosis-tech · Dec 10, 2024 · a6c1113 · a6c1113
1 parent 4cb7e13
commit a6c1113
Show file tree

Hide file tree

Showing 45 changed files with 769 additions and 279 deletions.
diff --git a/api/golang/core/kurtosis_core_rpc_api_bindings/api_container_service.pb.go b/api/golang/core/kurtosis_core_rpc_api_bindings/api_container_service.pb.go
diff --git a/api/golang/core/lib/enclaves/enclave_context.go b/api/golang/core/lib/enclaves/enclave_context.go
@@ -531,6 +531,75 @@ func (enclaveCtx *EnclaveContext) GetStarlarkRun(ctx context.Context) (*kurtosis
 	return response, nil
 }
 
+func (enclaveCtx *EnclaveContext) GetStarlarkRemotePackagePlanYaml(ctx context.Context, packageId string, serializedParams string) (*kurtosis_core_rpc_api_bindings.PlanYaml, error) {
+	serializedParams, err := maybeParseYaml(serializedParams)
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "An error occurred when parsing YAML args for package '%s':\n%s", packageId, serializedParams)
+	}
+	response, err := enclaveCtx.client.GetStarlarkPackagePlanYaml(ctx, &kurtosis_core_rpc_api_bindings.StarlarkPackagePlanYamlArgs{
+		PackageId:              packageId,
+		SerializedParams:       &serializedParams,
+		IsRemote:               true,
+		RelativePathToMainFile: nil,
+		MainFunctionName:       nil,
+	})
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "An error occurred while getting the Starlark package plan yaml.")
+	}
+	return response, nil
+}
+
+func (enclaveCtx *EnclaveContext) GetStarlarkPackagePlanYaml(ctx context.Context, packageRootPath string, serializedParams string) (*kurtosis_core_rpc_api_bindings.PlanYaml, error) {
+	packageName, packageReplaceOptions, err := getPackageNameAndReplaceOptions(packageRootPath)
+	if err != nil {
+		return nil, err
+	}
+
+	serializedParams, err = maybeParseYaml(serializedParams)
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "An error occurred when parsing YAML args for package '%s':\n%s", packageName, serializedParams)
+	}
+
+	err = enclaveCtx.uploadStarlarkPackage(packageName, packageRootPath)
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "Error uploading package '%s' prior to executing it", packageRootPath)
+	}
+
+	if len(packageReplaceOptions) > 0 {
+		if err = enclaveCtx.uploadLocalStarlarkPackageDependencies(packageRootPath, packageReplaceOptions); err != nil {
+			return nil, stacktrace.Propagate(err, "An error occurred while uploading the local starlark package dependencies from the replace options '%+v'", packageReplaceOptions)
+		}
+	}
+
+	response, err := enclaveCtx.client.GetStarlarkPackagePlanYaml(ctx, &kurtosis_core_rpc_api_bindings.StarlarkPackagePlanYamlArgs{
+		PackageId:              packageName,
+		SerializedParams:       &serializedParams,
+		IsRemote:               false,
+		RelativePathToMainFile: nil,
+		MainFunctionName:       nil,
+	})
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "An error occurred while getting the Starlark package plan yaml.")
+	}
+	return response, nil
+}
+
+func (enclaveCtx *EnclaveContext) GetStarlarkScriptPlanYaml(ctx context.Context, serializedScript string, serializedParams string) (*kurtosis_core_rpc_api_bindings.PlanYaml, error) {
+	serializedParams, err := maybeParseYaml(serializedParams)
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "An error occurred when parsing YAML args for package '%v'", serializedParams)
+	}
+	response, err := enclaveCtx.client.GetStarlarkScriptPlanYaml(ctx, &kurtosis_core_rpc_api_bindings.StarlarkScriptPlanYamlArgs{
+		SerializedScript: serializedScript,
+		SerializedParams: &serializedParams,
+		MainFunctionName: nil,
+	})
+	if err != nil {
+		return nil, stacktrace.Propagate(err, "An error occurred while getting the starlark script plan yaml.")
+	}
+	return response, nil
+}
+
 // ====================================================================================================
 //
 //	Private helper methods

diff --git a/api/protobuf/core/api_container_service.proto b/api/protobuf/core/api_container_service.proto
@@ -607,9 +607,12 @@ message StarlarkPackagePlanYamlArgs {
   // This should be a valid JSON string
   optional string serialized_params = 2;
 
+  // whether or not this is package yaml should be pulled from on disk package or cloned
+  bool is_remote = 3;
+
   // The relative main file filepath, the default value is the "main.star" file in the root of a package
-  optional string relative_path_to_main_file = 3;
+  optional string relative_path_to_main_file = 4;
 
   // The name of the main function, the default value is "run"
-  optional string main_function_name = 4;
+  optional string main_function_name = 5;
 }
diff --git a/api/rust/src/api_container_api.rs b/api/rust/src/api_container_api.rs
@@ -719,13 +719,16 @@ pub struct StarlarkPackagePlanYamlArgs {
     /// This should be a valid JSON string
     #[prost(string, optional, tag = "2")]
     pub serialized_params: ::core::option::Option<::prost::alloc::string::String>,
+    /// whether or not this is package yaml should be pulled from on disk package or cloned
+    #[prost(bool, tag = "3")]
+    pub is_remote: bool,
     /// The relative main file filepath, the default value is the "main.star" file in the root of a package
-    #[prost(string, optional, tag = "3")]
+    #[prost(string, optional, tag = "4")]
     pub relative_path_to_main_file: ::core::option::Option<
         ::prost::alloc::string::String,
     >,
     /// The name of the main function, the default value is "run"
-    #[prost(string, optional, tag = "4")]
+    #[prost(string, optional, tag = "5")]
     pub main_function_name: ::core::option::Option<::prost::alloc::string::String>,
 }
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]

diff --git a/api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.d.ts b/api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.d.ts
@@ -1546,6 +1546,9 @@ export class StarlarkPackagePlanYamlArgs extends jspb.Message {
   hasSerializedParams(): boolean;
   clearSerializedParams(): StarlarkPackagePlanYamlArgs;
 
+  getIsRemote(): boolean;
+  setIsRemote(value: boolean): StarlarkPackagePlanYamlArgs;
+
   getRelativePathToMainFile(): string;
   setRelativePathToMainFile(value: string): StarlarkPackagePlanYamlArgs;
   hasRelativePathToMainFile(): boolean;
@@ -1568,6 +1571,7 @@ export namespace StarlarkPackagePlanYamlArgs {
   export type AsObject = {
     packageId: string,
     serializedParams?: string,
+    isRemote: boolean,
     relativePathToMainFile?: string,
     mainFunctionName?: string,
   }
@@ -1579,12 +1583,12 @@ export namespace StarlarkPackagePlanYamlArgs {
 
   export enum RelativePathToMainFileCase { 
     _RELATIVE_PATH_TO_MAIN_FILE_NOT_SET = 0,
-    RELATIVE_PATH_TO_MAIN_FILE = 3,
+    RELATIVE_PATH_TO_MAIN_FILE = 4,
   }
 
   export enum MainFunctionNameCase { 
     _MAIN_FUNCTION_NAME_NOT_SET = 0,
-    MAIN_FUNCTION_NAME = 4,
+    MAIN_FUNCTION_NAME = 5,
   }
 }
 

diff --git a/api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.js b/api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.js
@@ -11108,8 +11108,9 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.toObject = function(includeI
   var f, obj = {
     packageId: jspb.Message.getFieldWithDefault(msg, 1, ""),
     serializedParams: jspb.Message.getFieldWithDefault(msg, 2, ""),
-    relativePathToMainFile: jspb.Message.getFieldWithDefault(msg, 3, ""),
-    mainFunctionName: jspb.Message.getFieldWithDefault(msg, 4, "")
+    isRemote: jspb.Message.getBooleanFieldWithDefault(msg, 3, false),
+    relativePathToMainFile: jspb.Message.getFieldWithDefault(msg, 4, ""),
+    mainFunctionName: jspb.Message.getFieldWithDefault(msg, 5, "")
   };
 
   if (includeInstance) {
@@ -11155,10 +11156,14 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.deserializeBinaryFromReader
       msg.setSerializedParams(value);
       break;
     case 3:
+      var value = /** @type {boolean} */ (reader.readBool());
+      msg.setIsRemote(value);
+      break;
+    case 4:
       var value = /** @type {string} */ (reader.readString());
       msg.setRelativePathToMainFile(value);
       break;
-    case 4:
+    case 5:
       var value = /** @type {string} */ (reader.readString());
       msg.setMainFunctionName(value);
       break;
@@ -11205,9 +11210,9 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.serializeBinaryToWriter = fu
       f
     );
   }
-  f = /** @type {string} */ (jspb.Message.getField(message, 3));
-  if (f != null) {
-    writer.writeString(
+  f = message.getIsRemote();
+  if (f) {
+    writer.writeBool(
       3,
       f
     );
@@ -11219,6 +11224,13 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.serializeBinaryToWriter = fu
       f
     );
   }
+  f = /** @type {string} */ (jspb.Message.getField(message, 5));
+  if (f != null) {
+    writer.writeString(
+      5,
+      f
+    );
+  }
 };
 
 
@@ -11277,11 +11289,29 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.hasSerializedParam
 
 
 /**
- * optional string relative_path_to_main_file = 3;
+ * optional bool is_remote = 3;
+ * @return {boolean}
+ */
+proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.getIsRemote = function() {
+  return /** @type {boolean} */ (jspb.Message.getBooleanFieldWithDefault(this, 3, false));
+};
+
+
+/**
+ * @param {boolean} value
+ * @return {!proto.api_container_api.StarlarkPackagePlanYamlArgs} returns this
+ */
+proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.setIsRemote = function(value) {
+  return jspb.Message.setProto3BooleanField(this, 3, value);
+};
+
+
+/**
+ * optional string relative_path_to_main_file = 4;
  * @return {string}
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.getRelativePathToMainFile = function() {
-  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 3, ""));
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 4, ""));
 };
 
 
@@ -11290,7 +11320,7 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.getRelativePathToM
  * @return {!proto.api_container_api.StarlarkPackagePlanYamlArgs} returns this
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.setRelativePathToMainFile = function(value) {
-  return jspb.Message.setField(this, 3, value);
+  return jspb.Message.setField(this, 4, value);
 };
 
 
@@ -11299,7 +11329,7 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.setRelativePathToM
  * @return {!proto.api_container_api.StarlarkPackagePlanYamlArgs} returns this
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.clearRelativePathToMainFile = function() {
-  return jspb.Message.setField(this, 3, undefined);
+  return jspb.Message.setField(this, 4, undefined);
 };
 
 
@@ -11308,16 +11338,16 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.clearRelativePathT
  * @return {boolean}
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.hasRelativePathToMainFile = function() {
-  return jspb.Message.getField(this, 3) != null;
+  return jspb.Message.getField(this, 4) != null;
 };
 
 
 /**
- * optional string main_function_name = 4;
+ * optional string main_function_name = 5;
  * @return {string}
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.getMainFunctionName = function() {
-  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 4, ""));
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 5, ""));
 };
 
 
@@ -11326,7 +11356,7 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.getMainFunctionNam
  * @return {!proto.api_container_api.StarlarkPackagePlanYamlArgs} returns this
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.setMainFunctionName = function(value) {
-  return jspb.Message.setField(this, 4, value);
+  return jspb.Message.setField(this, 5, value);
 };
 
 
@@ -11335,7 +11365,7 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.setMainFunctionNam
  * @return {!proto.api_container_api.StarlarkPackagePlanYamlArgs} returns this
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.clearMainFunctionName = function() {
-  return jspb.Message.setField(this, 4, undefined);
+  return jspb.Message.setField(this, 5, undefined);
 };
 
 
@@ -11344,7 +11374,7 @@ proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.clearMainFunctionN
  * @return {boolean}
  */
 proto.api_container_api.StarlarkPackagePlanYamlArgs.prototype.hasMainFunctionName = function() {
-  return jspb.Message.getField(this, 4) != null;
+  return jspb.Message.getField(this, 5) != null;
 };
 
 

diff --git a/api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_pb.d.ts b/api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_pb.d.ts
@@ -1914,17 +1914,24 @@ export declare class StarlarkPackagePlanYamlArgs extends Message<StarlarkPackage
    */
   serializedParams?: string;
 
+  /**
+   * whether or not this is package yaml should be pulled from on disk package or cloned
+   *
+   * @generated from field: bool is_remote = 3;
+   */
+  isRemote: boolean;
+
   /**
    * The relative main file filepath, the default value is the "main.star" file in the root of a package
    *
-   * @generated from field: optional string relative_path_to_main_file = 3;
+   * @generated from field: optional string relative_path_to_main_file = 4;
    */
   relativePathToMainFile?: string;
 
   /**
    * The name of the main function, the default value is "run"
    *
-   * @generated from field: optional string main_function_name = 4;
+   * @generated from field: optional string main_function_name = 5;
    */
   mainFunctionName?: string;
 

diff --git a/api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_pb.js b/api/typescript/src/core/kurtosis_core_rpc_api_bindings/connect/api_container_service_pb.js
@@ -670,8 +670,9 @@ export const StarlarkPackagePlanYamlArgs = proto3.makeMessageType(
   () => [
     { no: 1, name: "package_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "serialized_params", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
-    { no: 3, name: "relative_path_to_main_file", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
-    { no: 4, name: "main_function_name", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 3, name: "is_remote", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
+    { no: 4, name: "relative_path_to_main_file", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 5, name: "main_function_name", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
   ],
 );