albert/shepherd-launcher
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Use common command/args syntax

Browse source
This commit is contained in:
Albert Armea 2025-12-28 00:35:33 -05:00
parent 1238987732
commit 336a8f7eb2
10 changed files with 68 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
config.example.toml
View file

@ -41,7 +41,8 @@ icon = "scummvm"
[entries.kind]
type = "process"
argv = ["scummvm", "-f"]
command = "scummvm"
args = ["-f"]
[entries.availability]
[[entries.availability.windows]]
@ -95,7 +96,7 @@ seconds_before = 30
severity = "critical"
message = "30 seconds! Save NOW!"
# Example: Educational game - unrestricted
# Example: Educational game
[[entries]]
id = "tuxmath"
label = "Tux Math"
@ -103,7 +104,21 @@ icon = "tuxmath"
[entries.kind]
type = "process"
argv = ["tuxmath"]
command = "tuxmath"
[entries.availability]
always = true
# Example: Steam game
[[entries]]
id = "steam-human-resource-machine"
label = "Human Resource Machine"
icon = "steam"
[entries.kind]
type = "snap"
snap_name = "steam"
args = ["steam://rungameid/375820"] # Steam App ID (passed to 'snap run steam')
[entries.availability]
always = true
@ -119,7 +134,8 @@ icon = "mpv"
[entries.kind]
type = "process"
argv = ["mpv", "https://www.youtube.com/watch?v=jfKfPfyJRdk"]
command = "mpv"
args = ["https://www.youtube.com/watch?v=jfKfPfyJRdk"]
[entries.availability]
always = true
@ -138,4 +154,4 @@ disabled_reason = "This game is being updated"
[entries.kind]
type = "process"
argv = ["/bin/false"]
command = "/bin/false"

9
crates/shepherd-api/src/types.rs
View file

@ -23,7 +23,11 @@ pub enum EntryKindTag {
#[serde(tag = "type", rename_all = "snake_case")]
pub enum EntryKind {
Process {
argv: Vec<String>,
/// Command to run (required)
command: String,
/// Additional command-line arguments
#[serde(default)]
args: Vec<String>,
#[serde(default)]
env: HashMap<String, String>,
cwd: Option<PathBuf>,
@ -252,7 +256,8 @@ mod tests {
#[test]
fn entry_kind_serialization() {
let kind = EntryKind::Process {
argv: vec!["scummvm".into(), "-f".into()],
command: "scummvm".into(),
args: vec!["-f".into()],
env: HashMap::new(),
cwd: None,
};

4
crates/shepherd-config/src/lib.rs
View file

@ -75,7 +75,7 @@ mod tests {
[[entries]]
id = "test-game"
label = "Test Game"
kind = { type = "process", argv = ["/usr/bin/game"] }
kind = { type = "process", command = "/usr/bin/game" }
"#;
let policy = parse_config(config).unwrap();
@ -91,7 +91,7 @@ mod tests {
[[entries]]
id = "test"
label = "Test"
kind = { type = "process", argv = ["/bin/test"] }
kind = { type = "process", command = "/bin/test" }
"#;
let result = parse_config(config);

2
crates/shepherd-config/src/policy.rs
View file

@ -194,7 +194,7 @@ pub struct LimitsPolicy {
fn convert_entry_kind(raw: RawEntryKind) -> EntryKind {
match raw {
RawEntryKind::Process { argv, env, cwd } => EntryKind::Process { argv, env, cwd },
RawEntryKind::Process { command, args, env, cwd } => EntryKind::Process { command, args, env, cwd },
RawEntryKind::Snap { snap_name, command, args, env } => EntryKind::Snap { snap_name, command, args, env },
RawEntryKind::Vm { driver, args } => EntryKind::Vm { driver, args },
RawEntryKind::Media { library_id, args } => EntryKind::Media { library_id, args },

10
crates/shepherd-config/src/schema.rs
View file

@ -78,7 +78,11 @@ pub struct RawEntry {
#[serde(tag = "type", rename_all = "snake_case")]
pub enum RawEntryKind {
Process {
argv: Vec<String>,
/// Command to run (required)
command: String,
/// Additional command-line arguments
#[serde(default)]
args: Vec<String>,
#[serde(default)]
env: HashMap<String, String>,
cwd: Option<PathBuf>,
@ -189,7 +193,7 @@ mod tests {
[[entries]]
id = "scummvm"
label = "ScummVM"
kind = { type = "process", argv = ["scummvm", "-f"] }
kind = { type = "process", command = "scummvm", args = ["-f"] }
[entries.limits]
max_run_seconds = 3600
@ -208,7 +212,7 @@ mod tests {
[[entries]]
id = "game"
label = "Game"
kind = { type = "process", argv = ["/bin/game"] }
kind = { type = "process", command = "/bin/game" }
[entries.availability]
[[entries.availability.windows]]

12
crates/shepherd-config/src/validation.rs
View file

@ -55,11 +55,11 @@ fn validate_entry(entry: &RawEntry, config: &RawConfig) -> Vec<ValidationError>
// Validate kind
match &entry.kind {
RawEntryKind::Process { argv, .. } => {
if argv.is_empty() {
RawEntryKind::Process { command, .. } => {
if command.is_empty() {
errors.push(ValidationError::EntryError {
entry_id: entry.id.clone(),
message: "argv cannot be empty".into(),
message: "command cannot be empty".into(),
});
}
}
@ -252,7 +252,8 @@ mod tests {
label: "Game 1".into(),
icon: None,
kind: RawEntryKind::Process {
argv: vec!["game1".into()],
command: "game1".into(),
args: vec![],
env: Default::default(),
cwd: None,
},
@ -267,7 +268,8 @@ mod tests {
label: "Game 2".into(),
icon: None,
kind: RawEntryKind::Process {
argv: vec!["game2".into()],
command: "game2".into(),
args: vec![],
env: Default::default(),
cwd: None,
},

9
crates/shepherd-core/src/engine.rs
View file

@ -559,7 +559,8 @@ mod tests {
label: "Test Game".into(),
icon_ref: None,
kind: EntryKind::Process {
argv: vec!["game".into()],
command: "game".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
},
@ -635,7 +636,8 @@ mod tests {
label: "Test".into(),
icon_ref: None,
kind: EntryKind::Process {
argv: vec!["test".into()],
command: "test".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
},
@ -697,7 +699,8 @@ mod tests {
label: "Test".into(),
icon_ref: None,
kind: EntryKind::Process {
argv: vec!["test".into()],
command: "test".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
},

6
crates/shepherd-host-api/src/mock.rs
View file

@ -189,7 +189,8 @@ mod tests {
let session_id = SessionId::new();
let entry = EntryKind::Process {
argv: vec!["test".into()],
command: "test".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
};
@ -217,7 +218,8 @@ mod tests {
let session_id = SessionId::new();
let entry = EntryKind::Process {
argv: vec!["test".into()],
command: "test".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
};

12
crates/shepherd-host-linux/src/adapter.rs
View file

@ -115,8 +115,10 @@ impl HostAdapter for LinuxHost {
) -> HostResult<HostSessionHandle> {
// Extract argv, env, cwd, and snap_name based on entry kind
let (argv, env, cwd, snap_name) = match entry_kind {
EntryKind::Process { argv, env, cwd } => {
(argv.clone(), env.clone(), cwd.clone(), None)
EntryKind::Process { command, args, env, cwd } => {
let mut argv = vec![command.clone()];
argv.extend(args.clone());
(argv, env.clone(), cwd.clone(), None)
}
EntryKind::Snap { snap_name, command, args, env } => {
// For snap apps, we need to use 'snap run <snap_name>' to launch them.
@ -318,7 +320,8 @@ mod tests {
let session_id = SessionId::new();
let entry = EntryKind::Process {
argv: vec!["true".into()],
command: "true".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
};
@ -348,7 +351,8 @@ mod tests {
let session_id = SessionId::new();
let entry = EntryKind::Process {
argv: vec!["sleep".into(), "60".into()],
command: "sleep".into(),
args: vec!["60".into()],
env: HashMap::new(),
cwd: None,
};

8
crates/shepherdd/tests/integration.rs
View file

@ -22,7 +22,8 @@ fn make_test_policy() -> Policy {
label: "Test Game".into(),
icon_ref: None,
kind: EntryKind::Process {
argv: vec!["sleep".into(), "999".into()],
command: "sleep".into(),
args: vec!["999".into()],
env: HashMap::new(),
cwd: None,
},
@ -227,7 +228,8 @@ async fn test_mock_host_integration() {
let session_id = SessionId::new();
let entry = EntryKind::Process {
argv: vec!["test".into()],
command: "test".into(),
args: vec![],
env: HashMap::new(),
cwd: None,
};
@ -262,7 +264,7 @@ fn test_config_parsing() {
[[entries]]
id = "scummvm"
label = "ScummVM"
kind = { type = "process", argv = ["scummvm", "-f"] }
kind = { type = "process", command = "scummvm", args = ["-f"] }
[entries.availability]
[[entries.availability.windows]]