Skip to content

Commit 6317a86

Browse files
Merge pull request NVIDIA#24 from markatcanonical/fix/gateway-listing-in-snap
Includes the snapd daemon gateway in `gateway select` with a status column, and adds a `--list` option for non-interactive gateway listings.
2 parents 4d839f2 + fa8b06d commit 6317a86

6 files changed

Lines changed: 201 additions & 72 deletions

File tree

‎crates/openshell-bootstrap/src/metadata.rs‎

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,26 @@ pub fn store_gateway_metadata(name: &str, metadata: &GatewayMetadata) -> Result<
247247

248248
pub fn load_gateway_metadata(name: &str) -> Result<GatewayMetadata> {
249249
let path = stored_metadata_path(name)?;
250+
251+
if !path.exists() && name == "local-vm" && std::env::var("SNAP").is_ok() {
252+
let endpoint = std::env::var("OPENSHELL_GATEWAY_ENDPOINT").unwrap_or_else(|_| {
253+
let snap_common = std::env::var("SNAP_COMMON")
254+
.unwrap_or_else(|_| "/var/snap/openshell/common".to_string());
255+
format!("unix://{snap_common}/run/gateway.sock")
256+
});
257+
return Ok(GatewayMetadata {
258+
name: "local-vm".to_string(),
259+
gateway_endpoint: endpoint,
260+
is_remote: false,
261+
gateway_port: 0,
262+
remote_host: None,
263+
resolved_host: None,
264+
auth_mode: None,
265+
edge_team_domain: None,
266+
edge_auth_url: None,
267+
});
268+
}
269+
250270
let contents = std::fs::read_to_string(&path)
251271
.into_diagnostic()
252272
.wrap_err_with(|| format!("failed to read metadata from {}", path.display()))?;
@@ -320,27 +340,32 @@ pub fn clear_last_sandbox_if_matches(gateway: &str, sandbox: &str) {
320340
/// `metadata.json` and returns the parsed metadata for each.
321341
pub fn list_gateways() -> Result<Vec<GatewayMetadata>> {
322342
let dir = gateways_dir()?;
323-
if !dir.exists() {
324-
return Ok(Vec::new());
325-
}
326-
327343
let mut gateways = Vec::new();
328-
let entries = std::fs::read_dir(&dir)
329-
.into_diagnostic()
330-
.wrap_err_with(|| format!("failed to read directory {}", dir.display()))?;
331-
332-
for entry in entries {
333-
let entry = entry.into_diagnostic()?;
334-
let path = entry.path();
335-
// Only consider directories that contain a metadata.json file
336-
if path.is_dir() {
337-
let gateway_name = entry.file_name().to_string_lossy().to_string();
338-
if let Ok(metadata) = load_gateway_metadata(&gateway_name) {
339-
gateways.push(metadata);
344+
345+
if dir.exists() {
346+
let entries = std::fs::read_dir(&dir)
347+
.into_diagnostic()
348+
.wrap_err_with(|| format!("failed to read directory {}", dir.display()))?;
349+
350+
for entry in entries {
351+
let entry = entry.into_diagnostic()?;
352+
let path = entry.path();
353+
// Only consider directories that contain a metadata.json file
354+
if path.is_dir() {
355+
let gateway_name = entry.file_name().to_string_lossy().to_string();
356+
if let Ok(metadata) = load_gateway_metadata(&gateway_name) {
357+
gateways.push(metadata);
358+
}
340359
}
341360
}
342361
}
343362

363+
if std::env::var("SNAP").is_ok() && !gateways.iter().any(|g| g.name == "local-vm") {
364+
if let Ok(metadata) = load_gateway_metadata("local-vm") {
365+
gateways.push(metadata);
366+
}
367+
}
368+
344369
// Sort by name for stable output
345370
gateways.sort_by(|a, b| a.name.cmp(&b.name));
346371
Ok(gateways)

‎crates/openshell-cli/src/main.rs‎

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -142,19 +142,7 @@ fn resolve_gateway_name(gateway_flag: &Option<String>) -> Option<String> {
142142
})
143143
}
144144

145-
/// Apply edge authentication token from local storage when the gateway uses edge auth.
146-
///
147-
/// When the resolved gateway has `auth_mode == "cloudflare_jwt"`, loads the
148-
/// stored edge token from disk and sets it on the `TlsOptions`. The token is
149-
/// always read from gateway metadata rather than supplied via a CLI flag.
150-
fn apply_edge_auth(tls: &mut TlsOptions, gateway_name: &str) {
151-
if let Some(meta) = get_gateway_metadata(gateway_name)
152-
&& meta.auth_mode.as_deref() == Some("cloudflare_jwt")
153-
&& let Some(token) = load_edge_token(gateway_name)
154-
{
155-
tls.edge_token = Some(token);
156-
}
157-
}
145+
158146

159147
/// Resolve a sandbox name, falling back to the last-used sandbox for the gateway.
160148
///
@@ -995,6 +983,10 @@ enum GatewayCommands {
995983
/// Gateway name (omit to choose interactively or list in non-interactive mode).
996984
#[arg(add = ArgValueCompleter::new(completers::complete_gateway_names))]
997985
name: Option<String>,
986+
987+
/// Print the list of available gateways and exit.
988+
#[arg(long)]
989+
list: bool,
998990
},
999991

1000992
/// Show gateway deployment details.
@@ -1991,14 +1983,14 @@ async fn main() -> Result<()> {
19911983
})?;
19921984
run::gateway_login(&name).await?;
19931985
}
1994-
GatewayCommands::Select { name } => {
1995-
run::gateway_select(name.as_deref(), &cli.gateway)?;
1986+
GatewayCommands::Select { name, list } => {
1987+
run::gateway_select(name.as_deref(), list, &cli.gateway, &tls).await?;
19961988
}
19971989
GatewayCommands::Info { name } => {
19981990
let name = name
19991991
.or_else(|| resolve_gateway_name(&cli.gateway))
20001992
.unwrap_or_else(|| "openshell".to_string());
2001-
run::gateway_admin_info(&name)?;
1993+
run::gateway_admin_info(&name, &tls).await?;
20021994
}
20031995
},
20041996

@@ -2052,7 +2044,7 @@ async fn main() -> Result<()> {
20522044
Some(Commands::Status) => {
20532045
if let Ok(ctx) = resolve_gateway(&cli.gateway, &cli.gateway_endpoint) {
20542046
let mut tls = tls.with_gateway_name(&ctx.name);
2055-
apply_edge_auth(&mut tls, &ctx.name);
2047+
run::apply_edge_auth(&mut tls, &ctx.name);
20562048
run::gateway_status(&ctx.name, &ctx.endpoint, &tls).await?;
20572049
} else {
20582050
println!("{}", "Gateway Status".cyan().bold());
@@ -2151,7 +2143,7 @@ async fn main() -> Result<()> {
21512143
let spec = openshell_core::forward::ForwardSpec::parse(&port)?;
21522144
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
21532145
let mut tls = tls.with_gateway_name(&ctx.name);
2154-
apply_edge_auth(&mut tls, &ctx.name);
2146+
run::apply_edge_auth(&mut tls, &ctx.name);
21552147
let name = resolve_sandbox_name(name, &ctx.name)?;
21562148
run::sandbox_forward(&ctx.endpoint, &name, &spec, background, &tls).await?;
21572149
if background {
@@ -2179,7 +2171,7 @@ async fn main() -> Result<()> {
21792171
}) => {
21802172
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
21812173
let mut tls = tls.with_gateway_name(&ctx.name);
2182-
apply_edge_auth(&mut tls, &ctx.name);
2174+
run::apply_edge_auth(&mut tls, &ctx.name);
21832175
let name = resolve_sandbox_name(name, &ctx.name)?;
21842176
run::sandbox_logs(
21852177
&ctx.endpoint,
@@ -2224,7 +2216,7 @@ async fn main() -> Result<()> {
22242216
}) => {
22252217
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
22262218
let mut tls = tls.with_gateway_name(&ctx.name);
2227-
apply_edge_auth(&mut tls, &ctx.name);
2219+
run::apply_edge_auth(&mut tls, &ctx.name);
22282220
match policy_cmd {
22292221
PolicyCommands::Set {
22302222
name,
@@ -2332,7 +2324,7 @@ async fn main() -> Result<()> {
23322324
}) => {
23332325
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
23342326
let mut tls = tls.with_gateway_name(&ctx.name);
2335-
apply_edge_auth(&mut tls, &ctx.name);
2327+
run::apply_edge_auth(&mut tls, &ctx.name);
23362328

23372329
match settings_cmd {
23382330
SettingsCommands::Get { name, global, json } => {
@@ -2386,7 +2378,7 @@ async fn main() -> Result<()> {
23862378
}) => {
23872379
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
23882380
let mut tls = tls.with_gateway_name(&ctx.name);
2389-
apply_edge_auth(&mut tls, &ctx.name);
2381+
run::apply_edge_auth(&mut tls, &ctx.name);
23902382
match draft_cmd {
23912383
DraftCommands::Get { name, status } => {
23922384
let name = resolve_sandbox_name(name, &ctx.name)?;
@@ -2439,7 +2431,7 @@ async fn main() -> Result<()> {
24392431
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
24402432
let endpoint = &ctx.endpoint;
24412433
let mut tls = tls.with_gateway_name(&ctx.name);
2442-
apply_edge_auth(&mut tls, &ctx.name);
2434+
run::apply_edge_auth(&mut tls, &ctx.name);
24432435
match command {
24442436
InferenceCommands::Set {
24452437
provider,
@@ -2564,7 +2556,7 @@ async fn main() -> Result<()> {
25642556
}
25652557
let endpoint = &ctx.endpoint;
25662558
let mut tls = tls.with_gateway_name(&ctx.name);
2567-
apply_edge_auth(&mut tls, &ctx.name);
2559+
run::apply_edge_auth(&mut tls, &ctx.name);
25682560
// The user already has a configured gateway. Disable
25692561
// auto-bootstrap in the retry path so we don't
25702562
// silently replace their selected gateway with a new
@@ -2622,7 +2614,7 @@ async fn main() -> Result<()> {
26222614
} => {
26232615
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
26242616
let mut tls = tls.with_gateway_name(&ctx.name);
2625-
apply_edge_auth(&mut tls, &ctx.name);
2617+
run::apply_edge_auth(&mut tls, &ctx.name);
26262618
let sandbox_dest = dest.as_deref();
26272619
let local = std::path::Path::new(&local_path);
26282620
if !local.exists() {
@@ -2657,7 +2649,7 @@ async fn main() -> Result<()> {
26572649
} => {
26582650
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
26592651
let mut tls = tls.with_gateway_name(&ctx.name);
2660-
apply_edge_auth(&mut tls, &ctx.name);
2652+
run::apply_edge_auth(&mut tls, &ctx.name);
26612653
let local_dest = std::path::Path::new(dest.as_deref().unwrap_or("."));
26622654
eprintln!(
26632655
"Downloading sandbox:{} -> {}",
@@ -2672,7 +2664,7 @@ async fn main() -> Result<()> {
26722664
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
26732665
let endpoint = &ctx.endpoint;
26742666
let mut tls = tls.with_gateway_name(&ctx.name);
2675-
apply_edge_auth(&mut tls, &ctx.name);
2667+
run::apply_edge_auth(&mut tls, &ctx.name);
26762668
match other {
26772669
SandboxCommands::Create { .. }
26782670
| SandboxCommands::Upload { .. }
@@ -2752,7 +2744,7 @@ async fn main() -> Result<()> {
27522744
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
27532745
let endpoint = &ctx.endpoint;
27542746
let mut tls = tls.with_gateway_name(&ctx.name);
2755-
apply_edge_auth(&mut tls, &ctx.name);
2747+
run::apply_edge_auth(&mut tls, &ctx.name);
27562748

27572749
match command {
27582750
ProviderCommands::Create {
@@ -2807,7 +2799,7 @@ async fn main() -> Result<()> {
28072799
Some(Commands::Term { theme }) => {
28082800
let ctx = resolve_gateway(&cli.gateway, &cli.gateway_endpoint)?;
28092801
let mut tls = tls.with_gateway_name(&ctx.name);
2810-
apply_edge_auth(&mut tls, &ctx.name);
2802+
run::apply_edge_auth(&mut tls, &ctx.name);
28112803
let channel = openshell_cli::tls::build_channel(&ctx.endpoint, &tls).await?;
28122804
openshell_tui::run(channel, &ctx.name, &ctx.endpoint, theme).await?;
28132805
}
@@ -2839,7 +2831,7 @@ async fn main() -> Result<()> {
28392831
None => tls,
28402832
};
28412833
if let Some(ref g) = gateway_name_opt {
2842-
apply_edge_auth(&mut effective_tls, g);
2834+
run::apply_edge_auth(&mut effective_tls, g);
28432835
}
28442836
run::sandbox_ssh_proxy(&gw, &sid, &tok, &effective_tls).await?;
28452837
}
@@ -2858,7 +2850,7 @@ async fn main() -> Result<()> {
28582850
meta.gateway_endpoint
28592851
};
28602852
let mut tls = tls.with_gateway_name(&g);
2861-
apply_edge_auth(&mut tls, &g);
2853+
run::apply_edge_auth(&mut tls, &g);
28622854
run::sandbox_ssh_proxy_by_name(&endpoint, &n, &tls).await?;
28632855
}
28642856
// Legacy name mode with --server only (no --gateway-name).
@@ -3429,7 +3421,7 @@ mod tests {
34293421
store_edge_token("edge-gateway", "token-123").unwrap();
34303422

34313423
let mut tls = TlsOptions::default();
3432-
apply_edge_auth(&mut tls, "edge-gateway");
3424+
run::apply_edge_auth(&mut tls, "edge-gateway");
34333425

34343426
assert_eq!(tls.edge_token.as_deref(), Some("token-123"));
34353427
});

0 commit comments

Comments
 (0)