Files
OpenShell/crates/openshell-driver-docker/src/tests.rs
T
2026-08-13 21:00:17 -07:00

2529 lines
80 KiB
Rust

// SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0
use super::*;
use openshell_core::config::DEFAULT_SERVER_PORT;
use openshell_core::driver_utils::{
LABEL_MANAGED_BY, LABEL_MANAGED_BY_VALUE, LABEL_SANDBOX_ID, LABEL_SANDBOX_NAME,
LABEL_SANDBOX_NAMESPACE,
};
use openshell_core::progress::{
PROGRESS_ACTIVE_DETAIL_KEY, PROGRESS_ACTIVE_STEP_KEY, PROGRESS_COMPLETE_LABEL_KEY,
PROGRESS_COMPLETE_STEP_KEY, PROGRESS_STEP_PULLING_IMAGE, PROGRESS_STEP_REQUESTING_SANDBOX,
PROGRESS_STEP_STARTING_SANDBOX,
};
use openshell_core::proto::compute::v1::{
DriverResourceRequirements, DriverSandboxSpec, DriverSandboxTemplate,
GetGatewayListenerRequirementsRequest, GpuResourceRequirements, ResourceRequirements,
gateway_listener_requirement::Selector,
};
use std::fs;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::sync::{Arc, LazyLock, Mutex};
use tempfile::TempDir;
const TLS_MOUNT_DIR: &str = "/etc/openshell/tls/client";
static ENV_LOCK: LazyLock<Mutex<()>> = LazyLock::new(|| Mutex::new(()));
fn test_sandbox() -> DriverSandbox {
// Mirrors the gateway-supplied request: the public `Sandbox` API no
// longer carries `namespace`, so the gateway elides the field and the
// driver must source it from its own runtime config.
DriverSandbox {
id: "sbx-123".to_string(),
name: "demo".to_string(),
namespace: String::new(),
spec: Some(DriverSandboxSpec {
log_level: "debug".to_string(),
environment: HashMap::from([("SPEC_ENV".to_string(), "spec".to_string())]),
template: Some(DriverSandboxTemplate {
image: "ghcr.io/nvidia/openshell/sandbox:dev".to_string(),
agent_socket_path: String::new(),
labels: HashMap::new(),
environment: HashMap::from([("TEMPLATE_ENV".to_string(), "template".to_string())]),
..Default::default()
}),
resource_requirements: None,
sandbox_token: String::new(),
}),
status: None,
workspace: String::new(),
}
}
fn cdi_devices_config(device_ids: &[&str]) -> prost_types::Struct {
list_string_driver_config("cdi_devices", device_ids)
}
fn cdi_device_typo_config(device_ids: &[&str]) -> prost_types::Struct {
list_string_driver_config("cdi_device", device_ids)
}
fn list_string_driver_config(field: &str, values: &[&str]) -> prost_types::Struct {
prost_types::Struct {
fields: std::iter::once((
field.to_string(),
prost_types::Value {
kind: Some(prost_types::value::Kind::ListValue(
prost_types::ListValue {
values: values
.iter()
.map(|device_id| prost_types::Value {
kind: Some(prost_types::value::Kind::StringValue(
(*device_id).to_string(),
)),
})
.collect(),
},
)),
},
))
.collect(),
}
}
fn gpu_resources(count: Option<u32>) -> ResourceRequirements {
ResourceRequirements {
gpu: Some(GpuResourceRequirements { count }),
}
}
fn runtime_config() -> DockerDriverRuntimeConfig {
DockerDriverRuntimeConfig {
default_image: "image:latest".to_string(),
image_pull_policy: String::new(),
sandbox_namespace: "default".to_string(),
grpc_endpoint: "https://localhost:8443".to_string(),
network_name: DEFAULT_DOCKER_NETWORK_NAME.to_string(),
gateway_route: DockerGatewayRoute::Bridge {
bind_address: SocketAddr::new(
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
),
host_alias_ip: IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
},
ssh_socket_path: "/run/openshell/ssh.sock".to_string(),
stop_timeout_secs: DEFAULT_STOP_TIMEOUT_SECS,
log_level: "info".to_string(),
supervisor_bin: PathBuf::from("/tmp/openshell-sandbox"),
guest_tls: Some(DockerGuestTlsPaths {
ca: PathBuf::from("/tmp/ca.crt"),
cert: PathBuf::from("/tmp/tls.crt"),
key: PathBuf::from("/tmp/tls.key"),
}),
daemon_version: "28.0.0".to_string(),
supports_gpu: false,
allow_all_default_gpu: false,
sandbox_pids_limit: DEFAULT_SANDBOX_PIDS_LIMIT,
enable_bind_mounts: false,
}
}
fn json_struct(value: serde_json::Value) -> prost_types::Struct {
let serde_json::Value::Object(object) = value else {
panic!("expected JSON object");
};
openshell_core::proto_struct::json_object_to_struct(object)
.expect("test JSON must convert to a protobuf Struct")
}
fn inspected_volume(driver: &str, options: HashMap<String, String>) -> bollard::models::Volume {
bollard::models::Volume {
name: "openshell-test-volume".to_string(),
driver: driver.to_string(),
mountpoint: "/var/lib/docker/volumes/openshell-test-volume/_data".to_string(),
created_at: None,
status: None,
labels: HashMap::new(),
scope: None,
cluster_volume: None,
options,
usage_data: None,
}
}
fn test_driver_with_config(config: DockerDriverRuntimeConfig) -> DockerComputeDriver {
let allow_all_default_gpu = config.allow_all_default_gpu;
DockerComputeDriver {
docker: Arc::new(
Docker::connect_with_http("http://127.0.0.1:2375", 1, bollard::API_DEFAULT_VERSION)
.expect("construct test Docker client"),
),
config,
events: broadcast::channel(WATCH_BUFFER).0,
pending: Arc::new(tokio::sync::Mutex::new(HashMap::new())),
gpu_selector: Arc::new(CdiGpuDefaultSelector::new(
CdiGpuInventory::default(),
allow_all_default_gpu,
)),
}
}
#[tokio::test]
async fn gateway_listener_requirements_report_managed_bridge_address() {
let config = runtime_config();
let expected_address = match config.gateway_route {
DockerGatewayRoute::Bridge { bind_address, .. } => bind_address,
DockerGatewayRoute::HostGateway => panic!("test config must use a managed bridge"),
};
let driver = test_driver_with_config(config);
let response = driver
.get_gateway_listener_requirements(Request::new(GetGatewayListenerRequirementsRequest {}))
.await
.unwrap()
.into_inner();
assert_eq!(response.requirements.len(), 1);
assert_eq!(
response.requirements[0].selector,
Some(Selector::ExactBindAddress(expected_address.to_string()))
);
}
#[tokio::test]
async fn gateway_listener_requirements_are_empty_for_host_gateway_route() {
let mut config = runtime_config();
config.gateway_route = DockerGatewayRoute::HostGateway;
let driver = test_driver_with_config(config);
let response = driver
.get_gateway_listener_requirements(Request::new(GetGatewayListenerRequirementsRequest {}))
.await
.unwrap()
.into_inner();
assert!(response.requirements.is_empty());
}
#[test]
fn container_visible_endpoint_rewrites_loopback_hosts() {
assert_eq!(
docker_container_openshell_endpoint(
"https://localhost:8443",
HOST_OPENSHELL_INTERNAL,
DEFAULT_SERVER_PORT,
),
"https://host.openshell.internal:17670/"
);
assert_eq!(
docker_container_openshell_endpoint(
"http://127.0.0.1:8080",
HOST_OPENSHELL_INTERNAL,
DEFAULT_SERVER_PORT,
),
"http://host.openshell.internal:17670/"
);
assert_eq!(
docker_container_openshell_endpoint(
"https://gateway.internal:8443",
HOST_OPENSHELL_INTERNAL,
DEFAULT_SERVER_PORT,
),
"https://host.openshell.internal:17670/"
);
}
#[test]
fn docker_bridge_gateway_ip_requires_ipv4_gateway() {
let network = bollard::models::NetworkInspect {
driver: Some(DOCKER_NETWORK_DRIVER.to_string()),
ipam: Some(bollard::models::Ipam {
config: Some(vec![
bollard::models::IpamConfig {
gateway: Some("fd00::1".to_string()),
..Default::default()
},
bollard::models::IpamConfig {
gateway: Some("172.18.0.1".to_string()),
..Default::default()
},
]),
..Default::default()
}),
..Default::default()
};
assert_eq!(
docker_bridge_gateway_ip(DEFAULT_DOCKER_NETWORK_NAME, &network).unwrap(),
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1))
);
let ipv6_only_network = bollard::models::NetworkInspect {
driver: Some(DOCKER_NETWORK_DRIVER.to_string()),
ipam: Some(bollard::models::Ipam {
config: Some(vec![bollard::models::IpamConfig {
gateway: Some("fd00::1".to_string()),
..Default::default()
}]),
..Default::default()
}),
..Default::default()
};
assert!(
docker_bridge_gateway_ip(DEFAULT_DOCKER_NETWORK_NAME, &ipv6_only_network)
.unwrap_err()
.to_string()
.contains("IPv4 IPAM gateway")
);
}
#[test]
fn docker_gateway_route_uses_host_gateway_for_docker_desktop() {
let info = SystemInfo {
operating_system: Some("Docker Desktop".to_string()),
labels: Some(vec![
"com.docker.desktop.address=unix:///tmp/docker.sock".to_string(),
]),
..Default::default()
};
assert_eq!(
docker_gateway_route(
&info,
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
None,
),
DockerGatewayRoute::HostGateway
);
assert_eq!(
docker_extra_hosts(&DockerGatewayRoute::HostGateway),
vec![
"host.docker.internal:host-gateway".to_string(),
"host.openshell.internal:host-gateway".to_string()
]
);
}
#[test]
fn docker_gateway_route_uses_host_gateway_for_colima() {
let info = SystemInfo {
name: Some("colima".to_string()),
operating_system: Some("Ubuntu 24.04.4 LTS".to_string()),
..Default::default()
};
assert_eq!(
docker_gateway_route(
&info,
IpAddr::V4(Ipv4Addr::new(172, 20, 0, 1)),
DEFAULT_SERVER_PORT,
None,
),
DockerGatewayRoute::HostGateway
);
assert_eq!(
docker_extra_hosts(&DockerGatewayRoute::HostGateway),
vec![
"host.docker.internal:host-gateway".to_string(),
"host.openshell.internal:host-gateway".to_string()
]
);
}
#[test]
fn docker_gateway_route_uses_host_gateway_for_colima_named_profile() {
let info = SystemInfo {
operating_system: Some("Ubuntu 24.04 LTS".to_string()),
// `colima start --profile <name>` sets the daemon hostname to
// `colima-<name>`; the prefix match still catches it.
name: Some("colima-default".to_string()),
..Default::default()
};
assert_eq!(
docker_gateway_route(
&info,
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
None,
),
DockerGatewayRoute::HostGateway
);
}
#[test]
fn docker_gateway_route_uses_host_gateway_for_rancher_desktop() {
let info = SystemInfo {
operating_system: Some("Alpine Linux v3.20".to_string()),
name: Some("lima-rancher-desktop".to_string()),
labels: Some(vec![
"dev.rancherdesktop.profile=Rancher Desktop".to_string(),
]),
..Default::default()
};
assert_eq!(
docker_gateway_route(
&info,
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
None,
),
DockerGatewayRoute::HostGateway
);
}
#[test]
fn docker_gateway_route_uses_host_gateway_for_orbstack() {
let info = SystemInfo {
operating_system: Some("OrbStack".to_string()),
name: Some("orbstack".to_string()),
labels: Some(vec!["dev.orbstack.machine_type=docker".to_string()]),
..Default::default()
};
assert_eq!(
docker_gateway_route(
&info,
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
None,
),
DockerGatewayRoute::HostGateway
);
}
#[test]
fn docker_gateway_route_uses_bridge_gateway_for_linux_docker() {
let info = SystemInfo {
operating_system: Some("Ubuntu 24.04 LTS".to_string()),
..Default::default()
};
let route = docker_gateway_route_for_host(
&info,
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
None,
false,
);
assert_eq!(
route,
DockerGatewayRoute::Bridge {
bind_address: "172.18.0.1:17670".parse().unwrap(),
host_alias_ip: IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
}
);
assert_eq!(
docker_extra_hosts(&route),
vec![
"host.docker.internal:172.18.0.1".to_string(),
"host.openshell.internal:172.18.0.1".to_string()
]
);
}
#[test]
fn docker_gateway_route_uses_host_gateway_when_host_runtime_requires_it() {
let info = SystemInfo {
operating_system: Some("Ubuntu 24.04 LTS".to_string()),
..Default::default()
};
assert_eq!(
docker_gateway_route_for_host(
&info,
IpAddr::V4(Ipv4Addr::new(10, 89, 10, 1)),
DEFAULT_SERVER_PORT,
None,
true,
),
DockerGatewayRoute::HostGateway
);
}
#[test]
fn docker_gateway_route_prefers_configured_host_gateway_ip() {
let info = SystemInfo {
operating_system: Some("Ubuntu 24.04 LTS".to_string()),
..Default::default()
};
let route = docker_gateway_route(
&info,
IpAddr::V4(Ipv4Addr::new(172, 18, 0, 1)),
DEFAULT_SERVER_PORT,
Some(IpAddr::V4(Ipv4Addr::new(172, 20, 0, 4))),
);
assert_eq!(
route,
DockerGatewayRoute::Bridge {
bind_address: "172.20.0.4:17670".parse().unwrap(),
host_alias_ip: IpAddr::V4(Ipv4Addr::new(172, 20, 0, 4)),
}
);
assert_eq!(
docker_extra_hosts(&route),
vec![
"host.docker.internal:172.20.0.4".to_string(),
"host.openshell.internal:172.20.0.4".to_string()
]
);
}
#[test]
fn parse_optional_host_gateway_ip_rejects_invalid_values() {
assert_eq!(parse_optional_host_gateway_ip("").unwrap(), None);
assert_eq!(
parse_optional_host_gateway_ip("172.20.0.4").unwrap(),
Some(IpAddr::V4(Ipv4Addr::new(172, 20, 0, 4)))
);
assert!(
parse_optional_host_gateway_ip("not-an-ip")
.unwrap_err()
.to_string()
.contains("host_gateway_ip")
);
}
#[test]
fn parse_cpu_limit_supports_cores_and_millicores() {
assert_eq!(parse_cpu_limit("250m").unwrap(), Some(250_000_000));
assert_eq!(parse_cpu_limit("2").unwrap(), Some(2_000_000_000));
assert!(parse_cpu_limit("0").is_err());
}
#[test]
fn parse_memory_limit_supports_binary_quantities() {
assert_eq!(parse_memory_limit("512Mi").unwrap(), Some(536_870_912));
assert_eq!(parse_memory_limit("1G").unwrap(), Some(1_000_000_000));
assert!(parse_memory_limit("12XB").is_err());
}
#[test]
fn docker_resource_limits_rejects_requests() {
let template = DriverSandboxTemplate {
image: "img".to_string(),
agent_socket_path: String::new(),
labels: HashMap::new(),
environment: HashMap::new(),
resources: Some(DriverResourceRequirements {
cpu_request: "250m".to_string(),
cpu_limit: String::new(),
memory_request: String::new(),
memory_limit: String::new(),
}),
..Default::default()
};
let err = docker_resource_limits(&template).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("resources.requests.cpu"));
}
#[test]
fn docker_resource_limits_applies_cpu_and_memory_limits() {
let template = DriverSandboxTemplate {
image: "img".to_string(),
agent_socket_path: String::new(),
labels: HashMap::new(),
environment: HashMap::new(),
resources: Some(DriverResourceRequirements {
cpu_limit: "500m".to_string(),
memory_limit: "2Gi".to_string(),
..Default::default()
}),
..Default::default()
};
let limits = docker_resource_limits(&template).unwrap();
assert_eq!(limits.nano_cpus, Some(500_000_000));
assert_eq!(limits.memory_bytes, Some(2_147_483_648));
}
#[test]
fn docker_pids_limit_uses_driver_default_and_allows_runtime_inherit() {
assert_eq!(
docker_pids_limit(DEFAULT_SANDBOX_PIDS_LIMIT).unwrap(),
Some(DEFAULT_SANDBOX_PIDS_LIMIT)
);
assert_eq!(docker_pids_limit(0).unwrap(), None);
assert!(docker_pids_limit(-1).is_err());
}
#[test]
fn docker_compute_config_disables_bind_mounts_by_default() {
let cfg = DockerComputeConfig::default();
assert!(!cfg.enable_bind_mounts);
}
#[test]
fn container_create_body_sets_driver_owned_pids_limit() {
let body = build_container_create_body(&test_sandbox(), &runtime_config()).unwrap();
let host_config = body.host_config.expect("host config");
assert_eq!(host_config.pids_limit, Some(DEFAULT_SANDBOX_PIDS_LIMIT));
}
#[test]
fn build_environment_sets_docker_tls_paths() {
let env = build_environment(&test_sandbox(), &runtime_config());
assert!(env.contains(&format!("OPENSHELL_TLS_CA={TLS_CA_MOUNT_PATH}")));
assert!(env.contains(&format!("OPENSHELL_TLS_CERT={TLS_CERT_MOUNT_PATH}")));
assert!(env.contains(&format!("OPENSHELL_TLS_KEY={TLS_KEY_MOUNT_PATH}")));
assert!(env.contains(&"TEMPLATE_ENV=template".to_string()));
assert!(env.contains(&"SPEC_ENV=spec".to_string()));
assert!(env.contains(&"OPENSHELL_SANDBOX_COMMAND=sleep infinity".to_string()));
}
#[test]
fn build_environment_protects_oci_identity_metadata() {
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
for (key, value) in [
(openshell_core::sandbox_env::OCI_IMAGE_USER, "spoofed"),
(openshell_core::sandbox_env::SANDBOX_UID, "9999"),
(openshell_core::sandbox_env::SANDBOX_GID, "9999"),
] {
spec.environment.insert(key.to_string(), value.to_string());
}
let env = build_environment_for_oci_user(&sandbox, &runtime_config(), "app:staff");
assert!(env.contains(&format!(
"{}=app:staff",
openshell_core::sandbox_env::OCI_IMAGE_USER
)));
assert!(env.contains(&format!("{}=", openshell_core::sandbox_env::SANDBOX_UID)));
assert!(env.contains(&format!("{}=", openshell_core::sandbox_env::SANDBOX_GID)));
assert!(!env.iter().any(|entry| entry.ends_with("=spoofed")));
assert!(!env.iter().any(|entry| entry.ends_with("=9999")));
}
#[test]
fn container_creation_uses_inspected_immutable_image() {
let sandbox = test_sandbox();
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/workspace/project".to_string(),
volumes: Vec::new(),
};
let body = build_container_create_body_for_image(
&sandbox,
&runtime_config(),
&DockerSandboxDriverConfig::default(),
None,
&metadata,
)
.unwrap();
assert_eq!(body.image.as_deref(), Some("sha256:immutable"));
assert_eq!(body.user.as_deref(), Some("0"));
assert_eq!(body.working_dir.as_deref(), Some("/"));
assert_eq!(
body.cmd.as_deref(),
Some(&["--workdir".to_string(), "/workspace/project".to_string()][..])
);
assert!(body.env.unwrap().contains(&format!(
"{}=1234:1235",
openshell_core::sandbox_env::OCI_IMAGE_USER
)));
}
#[test]
fn container_creation_rejects_invalid_oci_working_dir() {
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "relative/workspace".to_string(),
volumes: Vec::new(),
};
let err = build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&DockerSandboxDriverConfig::default(),
None,
&metadata,
)
.unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("must be an absolute container path"));
}
#[test]
fn container_creation_rejects_openshell_control_path_working_dir() {
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/opt/openshell/bin/project".to_string(),
volumes: Vec::new(),
};
let err = build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&DockerSandboxDriverConfig::default(),
None,
&metadata,
)
.unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("OpenShell control path"));
}
#[test]
fn container_creation_protects_forbidden_roots_but_allows_usr_application_paths() {
let rejected = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/usr".to_string(),
volumes: Vec::new(),
};
let error = build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&DockerSandboxDriverConfig::default(),
None,
&rejected,
)
.unwrap_err();
assert!(error.message().contains("forbidden workspace root"));
let allowed = DockerImageMetadata {
working_dir: "/usr/src/app".to_string(),
..rejected
};
build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&DockerSandboxDriverConfig::default(),
None,
&allowed,
)
.expect("application workdirs below /usr remain valid");
}
#[test]
fn container_creation_rejects_image_volume_that_masks_working_dir() {
let sandbox = test_sandbox();
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/workspace/project".to_string(),
volumes: vec!["/workspace".to_string()],
};
let error = build_container_create_body_for_image(
&sandbox,
&runtime_config(),
&DockerSandboxDriverConfig::default(),
None,
&metadata,
)
.unwrap_err();
assert!(
error
.message()
.contains("masks OCI WorkingDir '/workspace/project'")
);
}
#[test]
fn container_creation_rejects_image_volume_over_configured_ssh_socket() {
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/workspace".to_string(),
volumes: vec!["/custom-runtime".to_string()],
};
let mut config = runtime_config();
config.ssh_socket_path = "/custom-runtime/ssh.sock".to_string();
let error = build_container_create_body_for_image(
&test_sandbox(),
&config,
&DockerSandboxDriverConfig::default(),
None,
&metadata,
)
.unwrap_err();
assert!(error.message().contains("OpenShell control path"));
}
#[test]
fn container_creation_reserves_resolved_workspace_root_but_allows_nested_mounts() {
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/workspace".to_string(),
volumes: Vec::new(),
};
let root_mount: DockerSandboxDriverConfig = serde_json::from_value(serde_json::json!({
"mounts": [{"type": "tmpfs", "target": "/workspace"}]
}))
.unwrap();
let err = build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&root_mount,
None,
&metadata,
)
.unwrap_err();
assert!(
err.message()
.contains("reserved for the OpenShell workspace")
);
let ancestor_mount: DockerSandboxDriverConfig = serde_json::from_value(serde_json::json!({
"mounts": [{"type": "tmpfs", "target": "/workspace"}]
}))
.unwrap();
let nested_metadata = DockerImageMetadata {
working_dir: "/workspace/project".to_string(),
volumes: Vec::new(),
..metadata.clone()
};
let err = build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&ancestor_mount,
None,
&nested_metadata,
)
.unwrap_err();
assert!(
err.message()
.contains("reserved for the OpenShell workspace")
);
let nested_mount: DockerSandboxDriverConfig = serde_json::from_value(serde_json::json!({
"mounts": [{"type": "tmpfs", "target": "/workspace/cache"}]
}))
.unwrap();
build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&nested_mount,
None,
&metadata,
)
.expect("nested workspace mounts remain supported");
let compatibility_path_mount: DockerSandboxDriverConfig =
serde_json::from_value(serde_json::json!({
"mounts": [{"type": "tmpfs", "target": "/sandbox"}]
}))
.unwrap();
build_container_create_body_for_image(
&test_sandbox(),
&runtime_config(),
&compatibility_path_mount,
None,
&metadata,
)
.expect("/sandbox remains mountable when the inspected workspace is elsewhere");
}
#[test]
fn build_environment_keeps_path_driver_controlled() {
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.environment
.insert("PATH".to_string(), "/malicious/spec/bin".to_string());
spec.template
.as_mut()
.unwrap()
.environment
.insert("PATH".to_string(), "/malicious/template/bin".to_string());
let env = build_environment(&sandbox, &runtime_config());
let path_entries = env
.iter()
.filter(|entry| entry.starts_with("PATH="))
.collect::<Vec<_>>();
let expected_path = format!("PATH={SUPERVISOR_PATH}");
assert_eq!(path_entries.len(), 1);
assert_eq!(path_entries[0], &expected_path);
}
#[test]
fn build_environment_keeps_telemetry_toggle_driver_controlled() {
let _guard = ENV_LOCK.lock().unwrap();
temp_env::with_vars(
[(
openshell_core::sandbox_env::TELEMETRY_ENABLED,
Some("false"),
)],
|| {
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().environment.insert(
openshell_core::sandbox_env::TELEMETRY_ENABLED.to_string(),
"true".to_string(),
);
let env = build_environment(&sandbox, &runtime_config());
let telemetry_entries = env
.iter()
.filter(|entry| {
entry.starts_with(&format!(
"{}=",
openshell_core::sandbox_env::TELEMETRY_ENABLED
))
})
.collect::<Vec<_>>();
assert_eq!(telemetry_entries.len(), 1);
assert_eq!(
telemetry_entries[0],
&format!("{}=false", openshell_core::sandbox_env::TELEMETRY_ENABLED)
);
},
);
}
#[test]
fn build_binds_uses_docker_tls_directory() {
let binds = build_binds(&test_sandbox(), &runtime_config()).unwrap();
let targets = binds
.iter()
.filter_map(|bind| bind.split(':').nth(1).map(String::from))
.collect::<Vec<_>>();
assert!(targets.contains(&SUPERVISOR_MOUNT_PATH.to_string()));
assert!(targets.contains(&TLS_CA_MOUNT_PATH.to_string()));
assert!(targets.contains(&TLS_CERT_MOUNT_PATH.to_string()));
assert!(targets.contains(&TLS_KEY_MOUNT_PATH.to_string()));
assert!(
targets
.iter()
.all(|target| target.starts_with(TLS_MOUNT_DIR) || target == SUPERVISOR_MOUNT_PATH)
);
}
#[test]
fn build_container_create_body_includes_driver_config_mounts() {
let mut sandbox = test_sandbox();
let template = sandbox.spec.as_mut().unwrap().template.as_mut().unwrap();
template.driver_config = Some(json_struct(serde_json::json!({
"mounts": [
{
"type": "volume",
"source": "work-nfs",
"target": "/sandbox/work",
"read_only": true,
"subpath": "project-a"
},
{
"type": "tmpfs",
"target": "/sandbox/cache",
"options": ["nosuid", "size=1048576"],
"size_bytes": 1_048_576,
"mode": 511
}
]
})));
let body = build_container_create_body(&sandbox, &runtime_config()).unwrap();
let mounts = body
.host_config
.unwrap()
.mounts
.expect("driver config mounts should be set");
assert_eq!(mounts.len(), 2);
assert_eq!(mounts[0].typ, Some(MountTypeEnum::VOLUME));
assert_eq!(mounts[0].source.as_deref(), Some("work-nfs"));
assert_eq!(mounts[0].target.as_deref(), Some("/sandbox/work"));
assert_eq!(mounts[0].read_only, Some(true));
assert_eq!(
mounts[0]
.volume_options
.as_ref()
.and_then(|options| options.subpath.as_deref()),
Some("project-a")
);
assert_eq!(mounts[1].typ, Some(MountTypeEnum::TMPFS));
assert_eq!(mounts[1].target.as_deref(), Some("/sandbox/cache"));
assert_eq!(
mounts[1]
.tmpfs_options
.as_ref()
.and_then(|options| options.size_bytes),
Some(1_048_576)
);
}
#[test]
fn driver_config_defaults_volume_mounts_to_read_only() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "volume",
"source": "work-nfs",
"target": "/sandbox/work"
}]
})));
let body = build_container_create_body(&sandbox, &runtime_config()).unwrap();
let mounts = body
.host_config
.unwrap()
.mounts
.expect("driver config mounts should be set");
assert_eq!(mounts[0].read_only, Some(true));
}
#[test]
fn driver_config_allows_explicit_writable_volume_mounts() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "volume",
"source": "work-nfs",
"target": "/sandbox/work",
"read_only": false
}]
})));
let body = build_container_create_body(&sandbox, &runtime_config()).unwrap();
let mounts = body
.host_config
.unwrap()
.mounts
.expect("driver config mounts should be set");
assert_eq!(mounts[0].read_only, Some(false));
}
#[test]
fn driver_config_rejects_duplicate_mount_targets() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [
{
"type": "volume",
"source": "work-nfs",
"target": "/sandbox/work"
},
{
"type": "tmpfs",
"target": "/sandbox/work"
}
]
})));
let err = build_container_create_body(&sandbox, &runtime_config()).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(
err.message()
.contains("duplicate docker driver_config mount target")
);
}
#[test]
fn driver_config_rejects_bind_mounts_unless_enabled() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": "/host/path",
"target": "/sandbox/host"
}]
})));
let err = build_container_create_body(&sandbox, &runtime_config()).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("enable_bind_mounts = true"));
}
#[test]
fn build_container_create_body_includes_bind_mounts_when_enabled() {
let bind_src = TempDir::new().unwrap();
let src_path = bind_src.path().to_str().unwrap();
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": src_path,
"target": "/sandbox/host",
"read_only": true
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let body = build_container_create_body(&sandbox, &config).unwrap();
let binds = body
.host_config
.as_ref()
.unwrap()
.binds
.as_ref()
.expect("binds should be set");
// User bind mount appears after the system binds.
let expected = format!("{src_path}:/sandbox/host:ro");
assert!(
binds.iter().any(|b| b == &expected),
"expected bind entry '{expected}', got {binds:?}"
);
// Bind mounts must not appear in the structured mounts vec.
let mounts = body.host_config.unwrap().mounts.unwrap_or_default();
assert!(
mounts.iter().all(|m| m.typ != Some(MountTypeEnum::BIND)),
"bind mounts should not appear in structured mounts"
);
}
#[test]
fn driver_config_defaults_enabled_bind_mounts_to_read_only() {
let bind_src = TempDir::new().unwrap();
let src_path = bind_src.path().to_str().unwrap();
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": src_path,
"target": "/sandbox/host"
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let body = build_container_create_body(&sandbox, &config).unwrap();
let binds = body
.host_config
.unwrap()
.binds
.expect("binds should be set");
let expected = format!("{src_path}:/sandbox/host:ro");
assert!(
binds.iter().any(|b| b == &expected),
"default bind mount should be read-only, got {binds:?}"
);
}
#[test]
fn bind_mount_selinux_shared_label() {
let bind_src = TempDir::new().unwrap();
let src_path = bind_src.path().to_str().unwrap();
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": src_path,
"target": "/sandbox/data",
"read_only": true,
"selinux_label": "shared"
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let body = build_container_create_body(&sandbox, &config).unwrap();
let binds = body
.host_config
.unwrap()
.binds
.expect("binds should be set");
let expected = format!("{src_path}:/sandbox/data:ro,z");
assert!(
binds.iter().any(|b| b == &expected),
"expected ':ro,z' label, got {binds:?}"
);
}
#[test]
fn bind_mount_selinux_private_label() {
let bind_src = TempDir::new().unwrap();
let src_path = bind_src.path().to_str().unwrap();
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": src_path,
"target": "/sandbox/data",
"read_only": false,
"selinux_label": "private"
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let body = build_container_create_body(&sandbox, &config).unwrap();
let binds = body
.host_config
.unwrap()
.binds
.expect("binds should be set");
let expected = format!("{src_path}:/sandbox/data:Z");
assert!(
binds.iter().any(|b| b == &expected),
"expected ':Z' label, got {binds:?}"
);
}
#[test]
fn bind_mount_without_selinux_label() {
let bind_src = TempDir::new().unwrap();
let src_path = bind_src.path().to_str().unwrap();
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": src_path,
"target": "/sandbox/host",
"read_only": false
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let body = build_container_create_body(&sandbox, &config).unwrap();
let binds = body
.host_config
.unwrap()
.binds
.expect("binds should be set");
let expected = format!("{src_path}:/sandbox/host");
assert!(
binds.iter().any(|b| b == &expected),
"expected no options suffix, got {binds:?}"
);
}
#[test]
fn driver_config_rejects_missing_bind_source() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": "/no/such/path",
"target": "/sandbox/data"
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let err = build_container_create_body(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(
err.message().contains("bind source path does not exist"),
"expected missing-source error, got: {}",
err.message()
);
}
#[test]
fn driver_config_rejects_relative_bind_sources_when_enabled() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "bind",
"source": "relative/path",
"target": "/sandbox/host"
}]
})));
let mut config = runtime_config();
config.enable_bind_mounts = true;
let err = build_container_create_body(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(
err.message()
.contains("bind source must be an absolute host path")
);
}
#[test]
fn driver_config_rejects_image_mounts() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "image",
"source": "ghcr.io/acme/tools:latest",
"target": "/opt/tools"
}]
})));
let err = build_container_create_body(&sandbox, &runtime_config()).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("invalid docker driver_config"));
}
#[test]
fn driver_config_rejects_reserved_mount_targets() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(json_struct(serde_json::json!({
"mounts": [{
"type": "volume",
"source": "work-nfs",
"target": "/etc/openshell/auth"
}]
})));
let err = build_container_create_body(&sandbox, &runtime_config()).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("reserved OpenShell path"));
}
#[test]
fn driver_config_rejects_mount_over_configured_ssh_socket() {
let mount_config: DockerSandboxDriverConfig = serde_json::from_value(serde_json::json!({
"mounts": [{
"type": "tmpfs",
"target": "/custom-runtime"
}]
}))
.unwrap();
let metadata = DockerImageMetadata {
id: "sha256:immutable".to_string(),
user: "1234:1235".to_string(),
working_dir: "/workspace".to_string(),
volumes: Vec::new(),
};
let mut config = runtime_config();
config.ssh_socket_path = "/custom-runtime/ssh.sock".to_string();
let error = build_container_create_body_for_image(
&test_sandbox(),
&config,
&mount_config,
None,
&metadata,
)
.unwrap_err();
assert!(error.message().contains("OpenShell control path"));
}
#[test]
fn docker_local_volume_with_bind_option_is_bind_backed() {
let volume = inspected_volume(
"local",
HashMap::from([
("type".to_string(), "none".to_string()),
("o".to_string(), "rw,bind".to_string()),
("device".to_string(), "/tmp/openshell".to_string()),
]),
);
assert!(docker_volume_is_bind_backed(&volume));
}
#[test]
fn docker_local_volume_with_rbind_option_is_bind_backed() {
let volume = inspected_volume(
"local",
HashMap::from([
("type".to_string(), "none".to_string()),
("o".to_string(), "rw,rbind".to_string()),
("device".to_string(), "/tmp/openshell".to_string()),
]),
);
assert!(docker_volume_is_bind_backed(&volume));
}
#[test]
fn docker_local_volume_without_bind_option_is_not_bind_backed() {
let volume = inspected_volume(
"local",
HashMap::from([
("type".to_string(), "nfs".to_string()),
("o".to_string(), "addr=127.0.0.1,rw".to_string()),
("device".to_string(), ":/exports/openshell".to_string()),
]),
);
assert!(!docker_volume_is_bind_backed(&volume));
}
#[test]
fn docker_nonlocal_volume_with_bind_option_is_not_bind_backed() {
let volume = inspected_volume(
"custom",
HashMap::from([("o".to_string(), "bind".to_string())]),
);
assert!(!docker_volume_is_bind_backed(&volume));
}
#[test]
fn build_environment_uses_token_file_without_raw_token_env() {
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.sandbox_token = "secret.jwt.value".to_string();
spec.environment.insert(
openshell_core::sandbox_env::SANDBOX_TOKEN.to_string(),
"user-provided-token".to_string(),
);
let env = build_environment(&sandbox, &runtime_config());
assert!(!env.iter().any(|entry| {
entry.starts_with(&format!("{}=", openshell_core::sandbox_env::SANDBOX_TOKEN))
}));
assert!(env.contains(&format!(
"{}={SANDBOX_TOKEN_MOUNT_PATH}",
openshell_core::sandbox_env::SANDBOX_TOKEN_FILE
)));
}
#[test]
fn managed_container_label_filters_include_gateway_namespace() {
let filters =
managed_container_label_filters("tenant-a", [format!("{LABEL_SANDBOX_ID}=sbx-123")]);
let labels = filters.get("label").unwrap();
assert!(labels.contains(&format!("{LABEL_MANAGED_BY}={LABEL_MANAGED_BY_VALUE}")));
assert!(labels.contains(&format!("{LABEL_SANDBOX_NAMESPACE}=tenant-a")));
assert!(labels.contains(&format!("{LABEL_SANDBOX_ID}=sbx-123")));
}
#[test]
fn build_container_create_body_replaces_inherited_cmd_with_workspace_arg() {
let create_body = build_container_create_body(&test_sandbox(), &runtime_config()).unwrap();
assert_eq!(
create_body.entrypoint,
Some(vec![SUPERVISOR_MOUNT_PATH.to_string()])
);
assert_eq!(
create_body.cmd,
Some(vec!["--workdir".to_string(), "/sandbox".to_string(),])
);
assert_eq!(
create_body
.labels
.as_ref()
.and_then(|labels| labels.get(LABEL_SANDBOX_NAMESPACE)),
Some(&"default".to_string())
);
let host_config = create_body.host_config.as_ref().unwrap();
assert!(
host_config.device_requests.as_ref().is_none(),
"non-GPU containers should not request Docker devices"
);
assert_eq!(
host_config.security_opt.as_ref(),
Some(&vec!["apparmor=unconfined".to_string()])
);
assert_eq!(
host_config.network_mode.as_deref(),
Some(DEFAULT_DOCKER_NETWORK_NAME)
);
assert_eq!(
host_config.extra_hosts.as_ref(),
Some(&vec![
"host.docker.internal:172.18.0.1".to_string(),
"host.openshell.internal:172.18.0.1".to_string()
])
);
assert_eq!(
create_body
.networking_config
.as_ref()
.and_then(|config| config.endpoints_config.as_ref())
.and_then(|endpoints| endpoints.get(DEFAULT_DOCKER_NETWORK_NAME)),
Some(&EndpointSettings::default())
);
}
#[test]
fn validate_sandbox_rejects_gpu_when_cdi_unavailable() {
let config = runtime_config();
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().resource_requirements = Some(gpu_resources(None));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("Docker CDI"));
}
#[test]
fn validate_sandbox_rejects_missing_gpu_support_before_request_shape() {
let config = runtime_config();
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(Some(2)));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("Docker CDI"));
}
#[test]
fn validate_sandbox_rejects_invalid_cdi_devices_before_gpu_capability() {
let config = runtime_config();
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&[]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(err.message().contains("invalid docker driver_config"));
assert!(err.message().contains("non-empty list"));
}
#[test]
fn validate_sandbox_rejects_unknown_driver_config_fields() {
let config = runtime_config();
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
spec.template.as_mut().unwrap().driver_config =
Some(cdi_device_typo_config(&["nvidia.com/gpu=0"]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(err.message().contains("unknown field"));
}
#[test]
fn validate_sandbox_accepts_gpu_count_request_shape() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().resource_requirements = Some(gpu_resources(Some(2)));
DockerComputeDriver::validate_sandbox(&sandbox, &config)
.expect("default GPU count shape should be accepted before inventory selection");
}
#[test]
fn validate_sandbox_accepts_gpu_count_matching_cdi_devices() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(Some(2)));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&[
"nvidia.com/gpu=0",
"nvidia.com/gpu=1",
]));
DockerComputeDriver::validate_sandbox(&sandbox, &config)
.expect("matching explicit CDI device count should be accepted");
}
#[test]
fn validate_sandbox_accepts_single_cdi_device_without_gpu_count() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
DockerComputeDriver::validate_sandbox(&sandbox, &config)
.expect("single exact CDI device should be compatible with a default GPU request");
}
#[test]
fn validate_sandbox_rejects_multiple_cdi_devices_without_gpu_count() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&[
"nvidia.com/gpu=0",
"nvidia.com/gpu=1",
]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(
err.message()
.contains("gpu count (1) must match driver_config.cdi_devices length (2)")
);
}
#[test]
fn validate_sandbox_rejects_cdi_devices_without_gpu_request() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(err.message().contains("requires a gpu request"));
}
#[test]
fn validate_sandbox_rejects_gpu_count_mismatched_cdi_devices() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(Some(2)));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(
err.message()
.contains("gpu count (2) must match driver_config.cdi_devices length (1)")
);
}
#[test]
fn validate_sandbox_rejects_template_errors_before_device_config() {
let config = runtime_config();
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
let template = spec.template.as_mut().unwrap();
template.agent_socket_path = "/tmp/agent.sock".to_string();
template.driver_config = Some(cdi_devices_config(&[]));
let err = DockerComputeDriver::validate_sandbox(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert!(err.message().contains("agent_socket_path"));
}
#[test]
fn validate_sandbox_auth_requires_gateway_token() {
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().sandbox_token.clear();
let err = DockerComputeDriver::validate_sandbox_auth(&sandbox).unwrap_err();
assert_eq!(err.code(), tonic::Code::FailedPrecondition);
assert_eq!(
err.message(),
"docker sandboxes require gateway JWT auth; configure [openshell.gateway.gateway_jwt]"
);
}
#[test]
fn validate_sandbox_auth_accepts_gateway_token() {
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().sandbox_token = "secret.jwt.value".to_string();
DockerComputeDriver::validate_sandbox_auth(&sandbox).unwrap();
}
#[test]
fn build_container_create_body_maps_default_gpu_to_selected_cdi_device() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().resource_requirements = Some(gpu_resources(None));
let driver_config = DockerSandboxDriverConfig::default();
let gpu_devices = vec!["nvidia.com/gpu=1".to_string()];
let create_body = build_container_create_body_with_gpu_devices(
&sandbox,
&config,
&driver_config,
Some(&gpu_devices),
)
.unwrap();
let request = create_body
.host_config
.as_ref()
.and_then(|host_config| host_config.device_requests.as_ref())
.and_then(|requests| requests.first())
.expect("GPU request should add a Docker device request");
assert_eq!(request.driver.as_deref(), Some("cdi"));
assert_eq!(
request.device_ids.as_ref().unwrap(),
&vec!["nvidia.com/gpu=1".to_string()]
);
}
#[test]
fn build_container_create_body_omits_devices_without_resolved_default_cdi_devices() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
sandbox.spec.as_mut().unwrap().resource_requirements = Some(gpu_resources(None));
let create_body = build_container_create_body(&sandbox, &config).unwrap();
assert!(
create_body
.host_config
.as_ref()
.and_then(|host_config| host_config.device_requests.as_ref())
.is_none()
);
}
#[test]
fn build_container_create_body_passes_explicit_cdi_device_id_through() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
let create_body = build_container_create_body(&sandbox, &config).unwrap();
let request = create_body
.host_config
.as_ref()
.and_then(|host_config| host_config.device_requests.as_ref())
.and_then(|requests| requests.first())
.expect("GPU request should add a Docker device request");
assert_eq!(request.driver.as_deref(), Some("cdi"));
assert_eq!(
request.device_ids.as_ref().unwrap(),
&vec!["nvidia.com/gpu=0".to_string()]
);
}
#[test]
fn build_container_create_body_rejects_gpu_count_mismatched_cdi_devices() {
let mut config = runtime_config();
config.supports_gpu = true;
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(Some(2)));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
let err = build_container_create_body(&sandbox, &config).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(
err.message()
.contains("gpu count (2) must match driver_config.cdi_devices length (1)")
);
}
#[test]
fn build_container_create_body_rejects_cdi_devices_without_gpu_request() {
let mut sandbox = test_sandbox();
sandbox
.spec
.as_mut()
.unwrap()
.template
.as_mut()
.unwrap()
.driver_config = Some(cdi_devices_config(&["nvidia.com/gpu=0"]));
let err = build_container_create_body(&sandbox, &runtime_config()).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(err.message().contains("requires a gpu request"));
}
#[test]
fn build_container_create_body_rejects_empty_cdi_devices() {
let mut sandbox = test_sandbox();
let spec = sandbox.spec.as_mut().unwrap();
spec.resource_requirements = Some(gpu_resources(None));
spec.template.as_mut().unwrap().driver_config = Some(cdi_devices_config(&[]));
let err = build_container_create_body(&sandbox, &runtime_config()).unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(err.message().contains("non-empty list"));
}
#[test]
fn driver_default_gpu_selection_consumes_distinct_devices_for_creates() {
let mut config = runtime_config();
config.supports_gpu = true;
let driver = test_driver_with_config(config);
driver.gpu_selector.refresh(
CdiGpuInventory::new(["nvidia.com/gpu=0", "nvidia.com/gpu=1"]),
false,
);
let mut first_sandbox = test_sandbox();
first_sandbox.id = "sbx-first".to_string();
first_sandbox.name = "first".to_string();
first_sandbox.spec.as_mut().unwrap().resource_requirements = Some(gpu_resources(None));
let mut second_sandbox = test_sandbox();
second_sandbox.id = "sbx-second".to_string();
second_sandbox.name = "second".to_string();
second_sandbox.spec.as_mut().unwrap().resource_requirements = Some(gpu_resources(None));
DockerComputeDriver::validate_sandbox(&first_sandbox, &driver.config).unwrap();
assert_eq!(
driver.gpu_selector.peek_device_ids(1).unwrap(),
vec!["nvidia.com/gpu=0".to_string()]
);
let first_devices = driver.gpu_selector.next_device_ids(1).unwrap();
let driver_config = DockerSandboxDriverConfig::default();
let first_create_body = build_container_create_body_with_gpu_devices(
&first_sandbox,
&driver.config,
&driver_config,
Some(&first_devices),
)
.unwrap();
DockerComputeDriver::validate_sandbox(&second_sandbox, &driver.config).unwrap();
assert_eq!(
driver.gpu_selector.peek_device_ids(1).unwrap(),
vec!["nvidia.com/gpu=1".to_string()]
);
let second_devices = driver.gpu_selector.next_device_ids(1).unwrap();
let second_create_body = build_container_create_body_with_gpu_devices(
&second_sandbox,
&driver.config,
&driver_config,
Some(&second_devices),
)
.unwrap();
let first_request = first_create_body
.host_config
.as_ref()
.and_then(|host_config| host_config.device_requests.as_ref())
.and_then(|requests| requests.first())
.expect("first default GPU request should add a Docker device request");
let second_request = second_create_body
.host_config
.as_ref()
.and_then(|host_config| host_config.device_requests.as_ref())
.and_then(|requests| requests.first())
.expect("second default GPU request should add a Docker device request");
assert_eq!(
first_request.device_ids.as_ref().unwrap(),
&vec!["nvidia.com/gpu=0".to_string()]
);
assert_eq!(
second_request.device_ids.as_ref().unwrap(),
&vec!["nvidia.com/gpu=1".to_string()]
);
}
#[test]
fn docker_info_reports_wsl2_from_kernel_version() {
let info = SystemInfo {
kernel_version: Some("5.15.153.1-microsoft-standard-WSL2".to_string()),
operating_system: Some("Docker Desktop".to_string()),
..Default::default()
};
assert!(docker_info_reports_wsl2(&info));
}
#[test]
fn docker_info_reports_wsl2_from_operating_system() {
let info = SystemInfo {
operating_system: Some("Ubuntu 24.04.4 LTS on WSL2".to_string()),
..Default::default()
};
assert!(docker_info_reports_wsl2(&info));
}
#[test]
fn docker_info_reports_wsl2_ignores_daemon_name_and_labels() {
let info = SystemInfo {
kernel_version: Some("6.8.0-60-generic".to_string()),
operating_system: Some("Ubuntu 24.04.4 LTS".to_string()),
name: Some("wsl-docker-daemon".to_string()),
labels: Some(vec!["com.example.platform=wsl2".to_string()]),
..Default::default()
};
assert!(!docker_info_reports_wsl2(&info));
}
#[test]
fn docker_info_reports_wsl2_rejects_plain_linux() {
let info = SystemInfo {
kernel_version: Some("6.8.0-60-generic".to_string()),
operating_system: Some("Ubuntu 24.04.4 LTS".to_string()),
os_type: Some("linux".to_string()),
architecture: Some("x86_64".to_string()),
..Default::default()
};
assert!(!docker_info_reports_wsl2(&info));
}
#[test]
fn require_sandbox_identifier_rejects_when_id_and_name_are_empty() {
// Regression test: `delete_sandbox` (and the other identifier-keyed
// RPCs) must refuse requests where both the id and the name are
// empty. Otherwise the empty filters fed to
// `find_managed_container_summary` match the first managed container
// in the namespace, allowing an arbitrary sandbox to be deleted.
let err = require_sandbox_identifier("", "").unwrap_err();
assert_eq!(err.code(), tonic::Code::InvalidArgument);
assert!(err.message().contains("sandbox_id or sandbox_name"));
require_sandbox_identifier("sbx-1", "").expect("id-only is accepted");
require_sandbox_identifier("", "demo").expect("name-only is accepted");
require_sandbox_identifier("sbx-1", "demo").expect("id and name is accepted");
}
#[test]
fn build_container_create_body_uses_bridge_network() {
let create_body = build_container_create_body(&test_sandbox(), &runtime_config()).unwrap();
let host_config = create_body.host_config.expect("host_config is populated");
assert_eq!(
host_config.network_mode,
Some(DEFAULT_DOCKER_NETWORK_NAME.to_string()),
"sandbox should join the driver-managed bridge network"
);
assert_eq!(
host_config.extra_hosts,
Some(vec![
"host.docker.internal:172.18.0.1".to_string(),
"host.openshell.internal:172.18.0.1".to_string()
]),
"sandbox should expose stable host aliases for gateway callbacks"
);
}
#[test]
fn build_container_create_body_uses_runtime_namespace_label() {
// Regression test: the namespace label must come from the driver's
// runtime config, not from `DriverSandbox.namespace`. The gateway
// does not populate `DriverSandbox.namespace`, so a container created
// with that empty value would not match subsequent list/get/find
// queries (which filter on `config.sandbox_namespace`), leaking
// sandboxes that the driver itself cannot observe.
let mut config = runtime_config();
config.sandbox_namespace = "tenant-a".to_string();
let mut sandbox = test_sandbox();
sandbox.namespace = "ignored-by-driver".to_string();
let create_body = build_container_create_body(&sandbox, &config).unwrap();
let labels = create_body.labels.expect("labels are populated");
assert_eq!(
labels.get(LABEL_SANDBOX_NAMESPACE),
Some(&"tenant-a".to_string()),
"namespace label must reflect the driver's runtime config"
);
}
#[test]
fn driver_status_keeps_running_sandboxes_provisioning_with_stable_message() {
let running = ContainerSummary {
id: Some("cid".to_string()),
names: Some(vec!["/openshell-demo".to_string()]),
labels: Some(HashMap::from([
(LABEL_SANDBOX_ID.to_string(), "sbx-1".to_string()),
(LABEL_SANDBOX_NAME.to_string(), "demo".to_string()),
(LABEL_SANDBOX_NAMESPACE.to_string(), "default".to_string()),
])),
state: Some(ContainerSummaryStateEnum::RUNNING),
status: Some("Up 2 seconds".to_string()),
..Default::default()
};
let exited = ContainerSummary {
state: Some(ContainerSummaryStateEnum::EXITED),
status: Some("Exited (1) 3 seconds ago".to_string()),
..running.clone()
};
let running_later = ContainerSummary {
status: Some("Up 4 seconds".to_string()),
..running.clone()
};
// A running container always emits Ready=True with BackendReady. The gateway
// composes this with supervisor-session presence to decide public SandboxPhase.
let running_status = driver_status_from_summary(&running, "demo");
let running_later_status = driver_status_from_summary(&running_later, "demo");
assert_eq!(running_status.conditions[0].status, "True");
assert_eq!(running_status.conditions[0].reason, "BackendReady");
assert_eq!(running_status.conditions[0].message, "Container is running");
assert_eq!(running_status.conditions, running_later_status.conditions);
let exited_status = driver_status_from_summary(&exited, "demo");
assert_eq!(exited_status.conditions[0].status, "False");
assert_eq!(exited_status.conditions[0].reason, "ContainerExited");
assert_eq!(exited_status.conditions[0].message, "Container exited");
}
#[test]
fn driver_status_marks_restarting_sandboxes_as_error() {
let restarting = ContainerSummary {
id: Some("cid".to_string()),
names: Some(vec!["/openshell-demo".to_string()]),
labels: Some(HashMap::from([
(LABEL_SANDBOX_ID.to_string(), "sbx-1".to_string()),
(LABEL_SANDBOX_NAME.to_string(), "demo".to_string()),
(LABEL_SANDBOX_NAMESPACE.to_string(), "default".to_string()),
])),
state: Some(ContainerSummaryStateEnum::RESTARTING),
status: Some("Restarting (1) 2 seconds ago".to_string()),
..Default::default()
};
let status = driver_status_from_summary(&restarting, "demo");
assert_eq!(status.conditions[0].status, "False");
assert_eq!(status.conditions[0].reason, "ContainerRestarting");
assert_eq!(
status.conditions[0].message,
"Container is restarting after a failure"
);
}
#[test]
fn docker_scheduled_event_adds_progress_metadata() {
let mut metadata = HashMap::from([(
"image_ref".to_string(),
"ghcr.io/acme/sandbox:latest".to_string(),
)]);
attach_docker_progress_metadata(
&mut metadata,
"Scheduled",
"Docker sandbox accepted for image \"ghcr.io/acme/sandbox:latest\"",
);
assert_eq!(
metadata.get(PROGRESS_COMPLETE_STEP_KEY).map(String::as_str),
Some(PROGRESS_STEP_REQUESTING_SANDBOX)
);
assert_eq!(
metadata
.get(PROGRESS_COMPLETE_LABEL_KEY)
.map(String::as_str),
Some("Sandbox allocated")
);
assert_eq!(
metadata.get(PROGRESS_ACTIVE_STEP_KEY).map(String::as_str),
Some(PROGRESS_STEP_PULLING_IMAGE)
);
assert_eq!(
metadata.get(PROGRESS_ACTIVE_DETAIL_KEY).map(String::as_str),
Some("ghcr.io/acme/sandbox:latest")
);
}
#[test]
fn docker_pulled_event_advances_to_starting_progress() {
let mut metadata = HashMap::new();
attach_docker_progress_metadata(
&mut metadata,
"Pulled",
"Pulled Docker image \"ghcr.io/acme/sandbox:latest\"",
);
assert_eq!(
metadata.get(PROGRESS_COMPLETE_STEP_KEY).map(String::as_str),
Some(PROGRESS_STEP_PULLING_IMAGE)
);
assert_eq!(
metadata
.get(PROGRESS_COMPLETE_LABEL_KEY)
.map(String::as_str),
Some("Image pulled")
);
assert_eq!(
metadata.get(PROGRESS_ACTIVE_STEP_KEY).map(String::as_str),
Some(PROGRESS_STEP_STARTING_SANDBOX)
);
}
#[test]
fn docker_pull_progress_event_adds_layer_detail_metadata() {
let event = docker_pull_progress_event(
"ghcr.io/acme/sandbox:latest",
&CreateImageInfo {
id: Some("layer-1".to_string()),
status: Some("Downloading".to_string()),
progress_detail: Some(ProgressDetail {
current: Some(42 * 1024 * 1024),
total: Some(84 * 1024 * 1024),
}),
..Default::default()
},
)
.expect("pull progress event");
assert_eq!(event.source, "docker");
assert_eq!(event.reason, "PullingLayer");
assert_eq!(
event
.metadata
.get(PROGRESS_ACTIVE_STEP_KEY)
.map(String::as_str),
Some(PROGRESS_STEP_PULLING_IMAGE)
);
assert_eq!(
event
.metadata
.get(PROGRESS_ACTIVE_DETAIL_KEY)
.map(String::as_str),
Some("Downloading layer-1 (42 MB/84 MB)")
);
}
#[test]
fn pending_sandbox_snapshot_uses_docker_namespace_and_starting_condition() {
let sandbox = test_sandbox();
let snapshot =
pending_sandbox_snapshot(&sandbox, "docker-dev", provisioning_condition(), false);
assert_eq!(snapshot.id, "sbx-123");
assert_eq!(snapshot.name, "demo");
assert_eq!(snapshot.namespace, "docker-dev");
assert!(snapshot.spec.is_none());
assert!(pending_sandbox_matches(&snapshot, "sbx-123", ""));
assert!(pending_sandbox_matches(&snapshot, "", "demo"));
let status = snapshot.status.expect("status");
assert!(!status.deleting);
assert_eq!(status.sandbox_name, "demo");
assert_eq!(status.conditions.len(), 1);
assert_eq!(status.conditions[0].r#type, "Ready");
assert_eq!(status.conditions[0].status, "False");
assert_eq!(status.conditions[0].reason, "Starting");
assert_eq!(status.conditions[0].message, "Docker container is starting");
}
#[test]
fn validate_linux_elf_binary_rejects_non_elf_files() {
let tempdir = TempDir::new().unwrap();
let path = tempdir.path().join("openshell-sandbox");
fs::write(&path, b"not-elf").unwrap();
let err = validate_linux_elf_binary(&path).unwrap_err();
assert!(err.to_string().contains("Linux ELF executable"));
}
#[test]
fn docker_guest_tls_paths_require_all_files_for_https() {
let tempdir = TempDir::new().unwrap();
let ca = tempdir.path().join("ca.crt");
fs::write(&ca, b"ca").unwrap();
let err = docker_guest_tls_paths(&DockerComputeConfig {
grpc_endpoint: "https://localhost:8443".to_string(),
guest_tls_ca: Some(ca),
..Default::default()
})
.unwrap_err();
assert!(err.to_string().contains("guest_tls_cert"));
}
#[test]
fn linux_supervisor_candidates_follow_daemon_arch() {
assert_eq!(
linux_supervisor_candidates("amd64"),
vec![PathBuf::from(
"target/x86_64-unknown-linux-gnu/release/openshell-sandbox",
)]
);
assert_eq!(
linux_supervisor_candidates("arm64"),
vec![PathBuf::from(
"target/aarch64-unknown-linux-gnu/release/openshell-sandbox",
)]
);
}
#[test]
fn container_name_preserves_id_suffix_for_long_names() {
// Names up to 253 chars are permitted by the gRPC layer. The id
// suffix is what makes the container name unique between sandboxes
// sharing a prefix, so it must always appear in the final name.
let long_name = "a".repeat(253);
let first = DriverSandbox {
id: "sbx-first-1234567890".to_string(),
name: long_name,
namespace: "default".to_string(),
spec: None,
status: None,
workspace: "default".to_string(),
};
let second = DriverSandbox {
id: "sbx-second-0987654321".to_string(),
..first.clone()
};
let first_container = container_name_for_sandbox(&first);
let second_container = container_name_for_sandbox(&second);
assert!(
first_container.len() <= MAX_CONTAINER_NAME_LEN,
"container name {} exceeded {MAX_CONTAINER_NAME_LEN} chars: {first_container}",
first_container.len(),
);
assert!(
first_container.ends_with(&first.id),
"container name should end with sandbox id: {first_container}",
);
assert_ne!(
first_container, second_container,
"container names must differ for sandboxes with distinct ids",
);
}
#[test]
fn container_name_empty_sandbox_name_uses_workspace_and_id() {
let sandbox = DriverSandbox {
id: "sbx-abc".to_string(),
name: String::new(),
namespace: "default".to_string(),
spec: None,
status: None,
workspace: "default".to_string(),
};
assert_eq!(
container_name_for_sandbox(&sandbox),
"openshell-default---sbx-abc",
);
}
#[test]
fn trim_container_name_tail_strips_separators() {
assert_eq!(trim_container_name_tail("foo-".to_string()), "foo");
assert_eq!(trim_container_name_tail("foo-.".to_string()), "foo");
assert_eq!(trim_container_name_tail("foo_-.".to_string()), "foo");
assert_eq!(trim_container_name_tail("foo".to_string()), "foo");
}
#[test]
fn docker_guest_tls_paths_rejects_tls_flags_without_https() {
let tempdir = TempDir::new().unwrap();
let ca = tempdir.path().join("ca.crt");
fs::write(&ca, b"ca").unwrap();
let err = docker_guest_tls_paths(&DockerComputeConfig {
grpc_endpoint: "http://localhost:8080".to_string(),
guest_tls_ca: Some(ca),
..Default::default()
})
.unwrap_err();
assert!(err.to_string().contains("https://"));
}
#[test]
fn docker_guest_tls_paths_allows_plain_http_without_tls_flags() {
let result = docker_guest_tls_paths(&DockerComputeConfig {
grpc_endpoint: "http://localhost:8080".to_string(),
..Default::default()
})
.unwrap();
assert!(result.is_none());
}
#[test]
fn default_docker_supervisor_image_uses_nvidia_ghcr_repo() {
let image = openshell_core::config::default_supervisor_image();
assert!(
image.starts_with("ghcr.io/nvidia/openshell/supervisor:"),
"unexpected default image reference: {image}",
);
}
#[test]
fn configured_supervisor_image_takes_precedence_over_local_binaries() {
let tempdir = TempDir::new().unwrap();
let bin_dir = tempdir.path().join("bin");
fs::create_dir_all(&bin_dir).unwrap();
let current_exe = bin_dir.join("openshell-gateway");
let sibling = bin_dir.join("openshell-sandbox");
fs::write(&current_exe, b"gateway").unwrap();
fs::write(&sibling, b"\x7fELFsibling").unwrap();
let local_build = tempdir.path().join("target/openshell-sandbox");
fs::create_dir_all(local_build.parent().unwrap()).unwrap();
fs::write(&local_build, b"\x7fELFlocal").unwrap();
let source = resolve_supervisor_bin_source(
&DockerComputeConfig {
supervisor_image: Some("example.com/openshell/supervisor:test".to_string()),
..Default::default()
},
Some(&current_exe),
&[local_build],
)
.unwrap();
assert_eq!(
source,
SupervisorBinSource::Image("example.com/openshell/supervisor:test".to_string())
);
}
#[test]
fn docker_supervisor_image_tag_prefers_explicit_build_tags() {
use openshell_core::config::resolve_supervisor_image_tag;
assert_eq!(
resolve_supervisor_image_tag(&["1.2.3", "sha", "0.0.0"]),
"1.2.3"
);
assert_eq!(resolve_supervisor_image_tag(&["", "sha", "0.0.0"]), "sha");
assert_eq!(resolve_supervisor_image_tag(&["", "", "1.2.3"]), "1.2.3");
assert_eq!(resolve_supervisor_image_tag(&["", "", "0.0.0"]), "dev");
}
#[test]
fn docker_supervisor_image_tag_sanitizes_build_metadata_for_docker() {
use openshell_core::config::resolve_supervisor_image_tag;
assert_eq!(
resolve_supervisor_image_tag(&["", "", "0.0.37-dev.156+g1d3b741ee"]),
"0.0.37-dev.156-g1d3b741ee",
);
assert_eq!(
resolve_supervisor_image_tag(&["0.0.37-dev.156+g1d3b741ee", "", "0.0.0"]),
"0.0.37-dev.156-g1d3b741ee",
);
}
#[test]
fn docker_supervisor_image_refreshes_mutable_tags_only() {
assert!(supervisor_image_should_refresh(
"ghcr.io/nvidia/openshell/supervisor:dev"
));
assert!(supervisor_image_should_refresh(
"ghcr.io/nvidia/openshell/supervisor:latest"
));
assert!(supervisor_image_should_refresh(
"ghcr.io/nvidia/openshell/supervisor"
));
assert!(!supervisor_image_should_refresh(
"ghcr.io/nvidia/openshell/supervisor:0.0.47-dev.13-g57b71c68f"
));
assert!(!supervisor_image_should_refresh(
"ghcr.io/nvidia/openshell/supervisor@sha256:abc123"
));
}
#[test]
fn supervisor_cache_path_namespaces_by_digest_under_openshell_data_dir() {
let base = PathBuf::from("/var/cache/share");
let path =
supervisor_cache_path_with_base(&base, "sha256:abc123deadbeef0123456789cafe0123456789fe");
assert_eq!(
path,
PathBuf::from(
"/var/cache/share/openshell/docker-supervisor/sha256-abc123deadbeef0123456789cafe0123456789fe/openshell-sandbox",
),
);
}
#[test]
fn supervisor_cache_path_isolates_different_digests() {
let base = PathBuf::from("/data");
let left = supervisor_cache_path_with_base(&base, "sha256:aaaaaaaa");
let right = supervisor_cache_path_with_base(&base, "sha256:bbbbbbbb");
assert_ne!(
left.parent().unwrap(),
right.parent().unwrap(),
"digest-keyed directories must differ so rollouts are isolated",
);
}
#[test]
fn write_cache_binary_atomic_materializes_file_with_executable_mode() {
let tempdir = TempDir::new().unwrap();
let target = tempdir.path().join("nested").join("openshell-sandbox");
fs::create_dir_all(target.parent().unwrap()).unwrap();
write_cache_binary_atomic(&target, b"\x7fELFpayload").unwrap();
assert!(target.is_file());
assert_eq!(fs::read(&target).unwrap(), b"\x7fELFpayload");
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
let mode = fs::metadata(&target).unwrap().permissions().mode() & 0o777;
assert_eq!(mode, 0o755, "expected 0755, got {mode:04o}");
}
}
#[test]
fn write_cache_binary_atomic_overwrites_existing_file() {
let tempdir = TempDir::new().unwrap();
let target = tempdir.path().join("openshell-sandbox");
fs::write(&target, b"stale").unwrap();
write_cache_binary_atomic(&target, b"\x7fELFfresh").unwrap();
assert_eq!(fs::read(&target).unwrap(), b"\x7fELFfresh");
}
#[test]
fn temp_extract_container_names_are_unique_per_call() {
let first = temp_extract_container_name();
let second = temp_extract_container_name();
assert_ne!(first, second);
assert!(first.starts_with("openshell-supervisor-extract-"));
}
#[test]
fn extract_first_tar_entry_returns_payload_of_single_file_archive() {
// Build a tar archive with the same shape Docker returns from
// `/containers/<id>/archive` for a single file.
let payload = b"\x7fELFtest-binary-bytes";
let mut tar_buf = Vec::new();
{
let mut builder = tar::Builder::new(&mut tar_buf);
let mut header = tar::Header::new_gnu();
header.set_path("openshell-sandbox").unwrap();
header.set_size(payload.len() as u64);
header.set_mode(0o755);
header.set_cksum();
builder.append(&header, payload.as_slice()).unwrap();
builder.finish().unwrap();
}
let extracted = extract_first_tar_entry(&tar_buf).unwrap();
assert_eq!(extracted, payload);
}
#[test]
fn extract_first_tar_entry_rejects_empty_archive() {
let mut tar_buf = Vec::new();
tar::Builder::new(&mut tar_buf).finish().unwrap();
let err = extract_first_tar_entry(&tar_buf).unwrap_err();
assert!(err.contains("empty"), "unexpected error message: {err}");
}
#[test]
fn container_state_needs_resume_matches_startable_states() {
for state in [
ContainerSummaryStateEnum::EXITED,
ContainerSummaryStateEnum::CREATED,
] {
assert!(
container_state_needs_resume(state),
"{state:?} should be resumed with Docker start",
);
}
for state in [
ContainerSummaryStateEnum::RUNNING,
ContainerSummaryStateEnum::RESTARTING,
ContainerSummaryStateEnum::PAUSED,
ContainerSummaryStateEnum::DEAD,
ContainerSummaryStateEnum::REMOVING,
ContainerSummaryStateEnum::EMPTY,
] {
assert!(
!container_state_needs_resume(state),
"{state:?} should not be resumed with Docker start",
);
}
}