feat: Enclave inspect relying on the API container service only (#1070)

## Description:
The current `enclave inspect` command gets the services info from the
backend and from the APIC. This is done to be able to display the
enclave details even when the enclave (APIC) is stopped. In practice,
inspecting a stopped enclave hasn't proven useful so we are migrating
this command to only use the APIC. This change is also required by the
bastion/remote host design because the CLI only has access to the remote
backend APIC.

The APIC provides all the information required except the service status
so we are adding it to `ServiceInfo`.

## Is this change user facing?
YES

api/golang/core/lib/binding_constructors/binding_constructors.go

@@ -297,6 +297,7 @@ func NewServiceInfo(
 	privatePorts map[string]*kurtosis_core_rpc_api_bindings.Port,
 	maybePublicIpAddr string,
 	maybePublicPorts map[string]*kurtosis_core_rpc_api_bindings.Port,
+	serviceStatus kurtosis_core_rpc_api_bindings.ServiceStatus,
 ) *kurtosis_core_rpc_api_bindings.ServiceInfo {
 	return &kurtosis_core_rpc_api_bindings.ServiceInfo{
 		ServiceUuid:       uuid,
@@ -306,6 +307,7 @@ func NewServiceInfo(
 		PrivatePorts:      privatePorts,
 		MaybePublicIpAddr: maybePublicIpAddr,
 		MaybePublicPorts:  maybePublicPorts,
+		ServiceStatus:     serviceStatus,
 	}
 }
 

api/protobuf/core/api_container_service.proto

@@ -68,6 +68,12 @@ message Port {
   string maybe_wait_timeout = 4;
 }
 
+enum ServiceStatus {
+  STOPPED = 0;
+  RUNNING = 1;
+  UNKNOWN = 2;
+}
+
 message ServiceInfo {
   // UUID of the service
   string service_uuid = 1;
@@ -93,6 +99,9 @@ message ServiceInfo {
 
   // Shortened uuid of the service
   string shortened_uuid = 7;
+
+  // Service status: stopped, running.
+  ServiceStatus service_status = 8;
 }
 
 // ==============================================================================================

api/rust/src/api_container_api.rs

@@ -88,6 +88,9 @@ pub struct ServiceInfo {
     /// Shortened uuid of the service
     #[prost(string, tag = "7")]
     pub shortened_uuid: ::prost::alloc::string::String,
+    /// Service status: stopped, running.
+    #[prost(enumeration = "ServiceStatus", tag = "8")]
+    pub service_status: i32,
 }
 /// ==============================================================================================
 ///                                Execute Starlark Arguments
@@ -552,6 +555,35 @@ pub struct FileArtifactContentsFileDescription {
 }
 #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
 #[repr(i32)]
+pub enum ServiceStatus {
+    Stopped = 0,
+    Running = 1,
+    Unknown = 2,
+}
+impl ServiceStatus {
+    /// String value of the enum field names used in the ProtoBuf definition.
+    ///
+    /// The values are not transformed in any way and thus are considered stable
+    /// (if the ProtoBuf definition does not change) and safe for programmatic use.
+    pub fn as_str_name(&self) -> &'static str {
+        match self {
+            ServiceStatus::Stopped => "STOPPED",
+            ServiceStatus::Running => "RUNNING",
+            ServiceStatus::Unknown => "UNKNOWN",
+        }
+    }
+    /// Creates an enum from field names used in the ProtoBuf definition.
+    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
+        match value {
+            "STOPPED" => Some(Self::Stopped),
+            "RUNNING" => Some(Self::Running),
+            "UNKNOWN" => Some(Self::Unknown),
+            _ => None,
+        }
+    }
+}
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
+#[repr(i32)]
 pub enum KurtosisFeatureFlag {
     NoInstructionsCaching = 0,
 }

api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.d.ts

@@ -61,6 +61,9 @@ export class ServiceInfo extends jspb.Message {
   getShortenedUuid(): string;
   setShortenedUuid(value: string): ServiceInfo;
 
+  getServiceStatus(): ServiceStatus;
+  setServiceStatus(value: ServiceStatus): ServiceInfo;
+
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): ServiceInfo.AsObject;
   static toObject(includeInstance: boolean, msg: ServiceInfo): ServiceInfo.AsObject;
@@ -78,6 +81,7 @@ export namespace ServiceInfo {
     maybePublicPortsMap: Array<[string, Port.AsObject]>,
     name: string,
     shortenedUuid: string,
+    serviceStatus: ServiceStatus,
   }
 }
 
@@ -1072,6 +1076,11 @@ export namespace FileArtifactContentsFileDescription {
   }
 }
 
+export enum ServiceStatus { 
+  STOPPED = 0,
+  RUNNING = 1,
+  UNKNOWN = 2,
+}
 export enum KurtosisFeatureFlag { 
   NO_INSTRUCTIONS_CACHING = 0,
 }

api/typescript/src/core/kurtosis_core_rpc_api_bindings/api_container_service_pb.js

@@ -43,6 +43,7 @@ goog.exportSymbol('proto.api_container_api.RunStarlarkPackageArgs.StarlarkPackag
 goog.exportSymbol('proto.api_container_api.RunStarlarkScriptArgs', null, global);
 goog.exportSymbol('proto.api_container_api.ServiceIdentifiers', null, global);
 goog.exportSymbol('proto.api_container_api.ServiceInfo', null, global);
+goog.exportSymbol('proto.api_container_api.ServiceStatus', null, global);
 goog.exportSymbol('proto.api_container_api.StarlarkError', null, global);
 goog.exportSymbol('proto.api_container_api.StarlarkError.ErrorCase', null, global);
 goog.exportSymbol('proto.api_container_api.StarlarkExecutionError', null, global);
@@ -1109,7 +1110,8 @@ proto.api_container_api.ServiceInfo.toObject = function(includeInstance, msg) {
     maybePublicIpAddr: jspb.Message.getFieldWithDefault(msg, 4, ""),
     maybePublicPortsMap: (f = msg.getMaybePublicPortsMap()) ? f.toObject(includeInstance, proto.api_container_api.Port.toObject) : [],
     name: jspb.Message.getFieldWithDefault(msg, 6, ""),
-    shortenedUuid: jspb.Message.getFieldWithDefault(msg, 7, "")
+    shortenedUuid: jspb.Message.getFieldWithDefault(msg, 7, ""),
+    serviceStatus: jspb.Message.getFieldWithDefault(msg, 8, 0)
   };
 
   if (includeInstance) {
@@ -1178,6 +1180,10 @@ proto.api_container_api.ServiceInfo.deserializeBinaryFromReader = function(msg,
       var value = /** @type {string} */ (reader.readString());
       msg.setShortenedUuid(value);
       break;
+    case 8:
+      var value = /** @type {!proto.api_container_api.ServiceStatus} */ (reader.readEnum());
+      msg.setServiceStatus(value);
+      break;
     default:
       reader.skipField();
       break;
@@ -1250,6 +1256,13 @@ proto.api_container_api.ServiceInfo.serializeBinaryToWriter = function(message,
       f
     );
   }
+  f = message.getServiceStatus();
+  if (f !== 0.0) {
+    writer.writeEnum(
+      8,
+      f
+    );
+  }
 };
 
 
@@ -1387,6 +1400,24 @@ proto.api_container_api.ServiceInfo.prototype.setShortenedUuid = function(value)
 };
 
 
+/**
+ * optional ServiceStatus service_status = 8;
+ * @return {!proto.api_container_api.ServiceStatus}
+ */
+proto.api_container_api.ServiceInfo.prototype.getServiceStatus = function() {
+  return /** @type {!proto.api_container_api.ServiceStatus} */ (jspb.Message.getFieldWithDefault(this, 8, 0));
+};
+
+
+/**
+ * @param {!proto.api_container_api.ServiceStatus} value
+ * @return {!proto.api_container_api.ServiceInfo} returns this
+ */
+proto.api_container_api.ServiceInfo.prototype.setServiceStatus = function(value) {
+  return jspb.Message.setProto3EnumField(this, 8, value);
+};
+
+
 
 /**
  * List of repeated fields within this message type.
@@ -8474,6 +8505,15 @@ proto.api_container_api.FileArtifactContentsFileDescription.prototype.hasTextPre
 };
 
 
+/**
+ * @enum {number}
+ */
+proto.api_container_api.ServiceStatus = {
+  STOPPED: 0,
+  RUNNING: 1,
+  UNKNOWN: 2
+};
+
 /**
  * @enum {number}
  */

api/typescript/src/core/lib/enclaves/enclave_context.ts

@@ -254,6 +254,7 @@ export class EnclaveContext {
             serviceCtxPrivatePorts,
             serviceInfo.getMaybePublicIpAddr(),
             serviceCtxPublicPorts,
+            serviceInfo.getServiceStatus(),
         );
 
         return ok(serviceContext);

api/typescript/src/core/lib/services/service_context.ts

@@ -1,6 +1,6 @@
 import { err, ok, Result } from 'neverthrow';
 import { newExecCommandArgs } from '../constructor_calls';
-import type { ExecCommandArgs } from '../../kurtosis_core_rpc_api_bindings/api_container_service_pb';
+import type { ExecCommandArgs, ServiceStatus } from '../../kurtosis_core_rpc_api_bindings/api_container_service_pb';
 import type { PortSpec } from './port_spec';
 import type { ServiceName, ServiceUUID } from './service';
 import { GenericApiContainerClient } from '../enclaves/generic_api_container_client';
@@ -15,6 +15,7 @@ export class ServiceContext {
         private readonly privatePorts: Map<string, PortSpec>,
         private readonly publicIpAddress: string,
         private readonly publicPorts: Map<string, PortSpec>,
+        private readonly serviceStatus: ServiceStatus,
     ) {}
 
     // Docs available at https://docs.kurtosis.com/sdk/#getservicename---servicename
@@ -47,6 +48,11 @@ export class ServiceContext {
         return this.publicPorts
     }
 
+    // Docs available at https://docs.kurtosis.com/sdk/#getservicestatus---servicestatus
+    public getServiceStatus(): ServiceStatus {
+        return this.serviceStatus
+    }
+
     // Docs available at https://docs.kurtosis.com/sdk/#execcommandliststring-command---int-exitcode-string-logs
     public async execCommand(command: string[]): Promise<Result<[number, string], Error>> {
         const execCommandArgs: ExecCommandArgs = newExecCommandArgs(this.serviceName, command);

cli/cli/commands/enclave/inspect/files_artifacts.go

@@ -6,7 +6,6 @@ import (
 	"github.com/kurtosis-tech/kurtosis/api/golang/engine/kurtosis_engine_rpc_api_bindings"
 	"github.com/kurtosis-tech/kurtosis/api/golang/engine/lib/kurtosis_context"
 	"github.com/kurtosis-tech/kurtosis/cli/cli/helpers/output_printers"
-	"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/backend_interface"
 	"github.com/kurtosis-tech/kurtosis/container-engine-lib/lib/uuid_generator"
 	"github.com/kurtosis-tech/stacktrace"
 	"sort"
@@ -17,7 +16,7 @@ const (
 	fileNameHeader  = "Name"
 )
 
-func printFilesArtifacts(ctx context.Context, kurtosisCtx *kurtosis_context.KurtosisContext, _ backend_interface.KurtosisBackend, enclaveInfo *kurtosis_engine_rpc_api_bindings.EnclaveInfo, showFullUuids bool, _ bool) error {
+func printFilesArtifacts(ctx context.Context, kurtosisCtx *kurtosis_context.KurtosisContext, enclaveInfo *kurtosis_engine_rpc_api_bindings.EnclaveInfo, showFullUuids bool, _ bool) error {
 	enclaveContext, err := kurtosisCtx.GetEnclaveContext(ctx, enclaveInfo.GetName())
 	if err != nil {
 		return stacktrace.Propagate(err, "An error occurred while fetching enclave with name '%v'", enclaveInfo.GetName())

cli/cli/commands/enclave/inspect/inspect.go

@@ -47,12 +47,13 @@ const (
 	kurtosisBackendCtxKey = "kurtosis-backend"
 	engineClientCtxKey    = "engine-client"
 
-	filesArtifactsHeader = "Files Artifacts"
+	userServicesArtifactsHeader = "User Services"
+	filesArtifactsHeader        = "Files Artifacts"
 )
 
-var enclaveObjectPrintingFuncs = map[string]func(ctx context.Context, kurtosisCtx *kurtosis_context.KurtosisContext, kurtosisBackend backend_interface.KurtosisBackend, enclaveInfo *kurtosis_engine_rpc_api_bindings.EnclaveInfo, showFullUuid bool, isAPIContainerRunning bool) error{
-	"User Services":      printUserServices,
-	filesArtifactsHeader: printFilesArtifacts,
+var enclaveObjectPrintingFuncs = map[string]func(ctx context.Context, kurtosisCtx *kurtosis_context.KurtosisContext, enclaveInfo *kurtosis_engine_rpc_api_bindings.EnclaveInfo, showFullUuid bool, isAPIContainerRunning bool) error{
+	userServicesArtifactsHeader: printUserServices,
+	filesArtifactsHeader:        printFilesArtifacts,
 }
 
 var EnclaveInspectCmd = &engine_consuming_kurtosis_command.EngineConsumingKurtosisCommand{
@@ -171,7 +172,7 @@ func PrintEnclaveInspect(ctx context.Context, kurtosisBackend backend_interface.
 		padStr := strings.Repeat(headerPadChar, numPadChars)
 		fmt.Printf("%v %v %v\n", padStr, header, padStr)
 
-		if err := printingFunc(ctx, kurtosisCtx, kurtosisBackend, enclaveInfo, showFullUuids, isApiContainerRunning); err != nil {
+		if err := printingFunc(ctx, kurtosisCtx, enclaveInfo, showFullUuids, isApiContainerRunning); err != nil {
 			logrus.Error(err)
 			headersWithPrintErrs = append(headersWithPrintErrs, header)
 		}