component/
args.rs

1// Copyright 2023 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5use argh::FromArgs;
6use component_debug::cli::{GraphFilter, GraphOrientation, ListFilter};
7use component_debug::config::RawConfigEntry;
8use component_debug::explore::DashNamespaceLayout;
9use fuchsia_url::AbsoluteComponentUrl;
10use moniker::Moniker;
11
12#[derive(FromArgs, PartialEq, Debug)]
13#[argh(
14    name = "component",
15    description = "Discover and manage components. Functionally equivalent to `ffx component`."
16)]
17pub struct ComponentArgs {
18    #[argh(subcommand)]
19    pub subcommand: ComponentSubcommand,
20}
21
22#[derive(FromArgs, PartialEq, Debug)]
23#[argh(subcommand)]
24pub enum ComponentSubcommand {
25    Capability(CapabilityArgs),
26    List(ListArgs),
27    Graph(GraphArgs),
28    Show(ShowArgs),
29    Create(CreateArgs),
30    Destroy(DestroyArgs),
31    Resolve(ResolveArgs),
32    Run(RunArgs),
33    Start(StartArgs),
34    Stop(StopArgs),
35    Reload(ReloadArgs),
36    Doctor(DoctorArgs),
37    Copy(CopyArgs),
38    Storage(StorageArgs),
39    Collection(CollectionArgs),
40    Explore(ExploreArgs),
41    Config(ConfigArgs),
42}
43
44#[derive(FromArgs, PartialEq, Debug)]
45#[argh(subcommand, name = "show", description = "Same as `ffx component show`")]
46pub struct ShowArgs {
47    #[argh(positional)]
48    /// component URL, moniker or instance ID. Partial matches allowed.
49    pub query: String,
50}
51
52#[derive(FromArgs, Debug, PartialEq)]
53#[argh(subcommand, name = "create", description = "Same as `ffx component create`")]
54pub struct CreateArgs {
55    #[argh(positional)]
56    pub moniker: Moniker,
57
58    #[argh(positional)]
59    pub url: AbsoluteComponentUrl,
60
61    #[argh(option)]
62    /// provide a configuration override to the component being run. Requires
63    /// `mutability: [ "parent" ]` on the configuration field. Specified in the format
64    /// `KEY=VALUE` where `VALUE` is a JSON string which can be resolved as the correct type of
65    /// configuration value.
66    pub config: Vec<RawConfigEntry>,
67}
68
69#[derive(FromArgs, Debug, PartialEq)]
70#[argh(subcommand, name = "resolve", description = "Same as `ffx component resolve`")]
71pub struct ResolveArgs {
72    #[argh(positional)]
73    /// component URL, moniker or instance ID. Partial matches allowed.
74    pub query: String,
75}
76
77#[derive(FromArgs, Debug, PartialEq)]
78#[argh(subcommand, name = "destroy", description = "Same as `ffx component destroy`")]
79pub struct DestroyArgs {
80    #[argh(positional)]
81    /// component URL, moniker or instance ID. Partial matches allowed.
82    pub query: String,
83}
84
85#[derive(FromArgs, Debug, PartialEq)]
86#[argh(subcommand, name = "start", description = "Same as `ffx component start`")]
87pub struct StartArgs {
88    #[argh(positional)]
89    /// component URL, moniker or instance ID. Partial matches allowed.
90    pub query: String,
91}
92
93#[derive(FromArgs, Debug, PartialEq)]
94#[argh(subcommand, name = "stop", description = "Same as `ffx component stop`")]
95pub struct StopArgs {
96    #[argh(positional)]
97    /// component URL, moniker or instance ID. Partial matches allowed.
98    pub query: String,
99}
100
101#[derive(FromArgs, Debug, PartialEq)]
102#[argh(subcommand, name = "reload", description = "Same as `ffx component reload`")]
103pub struct ReloadArgs {
104    #[argh(positional)]
105    /// component URL, moniker or instance ID. Partial matches allowed.
106    pub query: String,
107}
108
109#[derive(FromArgs, Debug, PartialEq)]
110#[argh(subcommand, name = "doctor", description = "Same as `ffx component doctor`")]
111pub struct DoctorArgs {
112    #[argh(positional)]
113    /// component URL, moniker or instance ID. Partial matches allowed.
114    pub query: String,
115}
116
117#[derive(FromArgs, Debug, PartialEq)]
118#[argh(subcommand, name = "capability", description = "Same as `ffx component capability`")]
119pub struct CapabilityArgs {
120    #[argh(positional)]
121    pub capability_name: String,
122}
123
124#[derive(FromArgs, Debug, PartialEq)]
125#[argh(subcommand, name = "list", description = "Same as `ffx component list`")]
126pub struct ListArgs {
127    #[argh(option, long = "only", short = 'o')]
128    /// filter the instance list by a criteria: running, stopped, ancestors:<component_name>, descendants:<component_name>, or relatives:<component_name>
129    pub filter: Option<ListFilter>,
130
131    #[argh(switch, long = "verbose", short = 'v')]
132    /// show detailed information about each instance
133    pub verbose: bool,
134}
135
136#[derive(FromArgs, Debug, PartialEq)]
137#[argh(subcommand, name = "graph", description = "Same as `ffx component graph`")]
138pub struct GraphArgs {
139    #[argh(option, long = "only", short = 'o')]
140    /// filter the instance list by a criteria: ancestor, descendant, relative
141    pub filter: Option<GraphFilter>,
142
143    #[argh(option, long = "orientation", short = 'r', default = "GraphOrientation::TopToBottom")]
144    /// changes the visual orientation of the graph's nodes.
145    /// Allowed values are "lefttoright"/"lr" and "toptobottom"/"tb".
146    pub orientation: GraphOrientation,
147}
148
149#[derive(FromArgs, Debug, PartialEq)]
150#[argh(subcommand, name = "run", description = "Same as `ffx component run`")]
151pub struct RunArgs {
152    #[argh(positional)]
153    pub moniker: Moniker,
154
155    #[argh(positional)]
156    pub url: AbsoluteComponentUrl,
157
158    #[argh(switch, short = 'r')]
159    /// destroy and recreate the component instance if it already exists
160    pub recreate: bool,
161
162    #[argh(switch)]
163    /// connect stdin, stdout, and stderr to the component (requires component
164    /// to be in a collection with single_run durability)
165    pub connect_stdio: bool,
166
167    #[argh(option)]
168    /// provide a configuration override to the component being run. Requires
169    /// `mutability: [ "parent" ]` on the configuration field. Specified in the format
170    /// `KEY=VALUE` where `VALUE` is a JSON string which can be resolved as the correct type of
171    /// configuration value.
172    pub config: Vec<RawConfigEntry>,
173}
174
175#[derive(FromArgs, Debug, PartialEq)]
176#[argh(subcommand, name = "copy", description = "Same as `ffx component copy`")]
177pub struct CopyArgs {
178    #[argh(positional)]
179    pub paths: Vec<String>,
180    /// show detailed information about copy action
181    #[argh(switch, short = 'v')]
182    pub verbose: bool,
183}
184
185#[derive(FromArgs, Debug, PartialEq)]
186#[argh(subcommand, name = "storage", description = "Same as `ffx component storage`")]
187pub struct StorageArgs {
188    #[argh(subcommand)]
189    pub subcommand: StorageSubcommand,
190
191    #[argh(option, default = "String::from(\"/core\")")]
192    /// the moniker of the storage provider component.
193    /// Defaults to "/core"
194    pub provider: String,
195
196    #[argh(option, default = "String::from(\"data\")")]
197    /// the capability name of the storage to use.
198    /// Examples: "data", "cache", "tmp"
199    /// Defaults to "data"
200    pub capability: String,
201}
202
203#[derive(FromArgs, PartialEq, Debug)]
204#[argh(subcommand)]
205pub enum StorageSubcommand {
206    Copy(StorageCopyArgs),
207    Delete(StorageDeleteArgs),
208    List(StorageListArgs),
209    MakeDirectory(StorageMakeDirectoryArgs),
210}
211
212#[derive(FromArgs, PartialEq, Debug)]
213#[argh(subcommand, name = "list", description = "Same as `ffx component storage list`")]
214pub struct StorageListArgs {
215    #[argh(positional)]
216    pub path: String,
217}
218
219#[derive(FromArgs, Debug, PartialEq)]
220#[argh(
221    subcommand,
222    name = "make-directory",
223    description = "Same as `ffx component storage make-directory`"
224)]
225pub struct StorageMakeDirectoryArgs {
226    #[argh(positional)]
227    pub path: String,
228}
229
230#[derive(FromArgs, Debug, PartialEq)]
231#[argh(subcommand, name = "copy", description = "Same as `ffx component storage copy`")]
232pub struct StorageCopyArgs {
233    #[argh(positional)]
234    pub source_path: String,
235
236    #[argh(positional)]
237    pub destination_path: String,
238}
239
240#[derive(FromArgs, Debug, PartialEq)]
241#[argh(subcommand, name = "delete", description = "Same as `ffx component storage delete`")]
242pub struct StorageDeleteArgs {
243    #[argh(positional)]
244    pub path: String,
245}
246
247#[derive(FromArgs, Debug, PartialEq)]
248#[argh(subcommand, name = "collection", description = "Same as `ffx component collection`")]
249pub struct CollectionArgs {
250    #[argh(subcommand)]
251    pub subcommand: CollectionSubcommand,
252}
253
254#[derive(FromArgs, PartialEq, Debug)]
255#[argh(subcommand)]
256pub enum CollectionSubcommand {
257    List(CollectionListArgs),
258    Show(CollectionShowArgs),
259}
260
261#[derive(FromArgs, PartialEq, Debug)]
262#[argh(subcommand, name = "list", description = "Same as `ffx component collection list`")]
263pub struct CollectionListArgs {
264    #[argh(positional)]
265    pub path: String,
266}
267
268#[derive(FromArgs, Debug, PartialEq)]
269#[argh(subcommand, name = "show", description = "Same as `ffx component collection show`")]
270pub struct CollectionShowArgs {
271    #[argh(positional)]
272    pub query: String,
273}
274
275#[derive(FromArgs, Debug, PartialEq)]
276#[argh(subcommand, name = "explore", description = "Same as `ffx component explore`")]
277pub struct ExploreArgs {
278    #[argh(positional)]
279    /// component URL, moniker or instance ID. Partial matches allowed.
280    pub query: String,
281
282    #[argh(option)]
283    /// list of URLs of tools packages to include in the shell environment.
284    /// the PATH variable will be updated to include binaries from these tools packages.
285    /// repeat `--tools url` for each package to be included.
286    /// The path preference is given by command line order.
287    pub tools: Vec<String>,
288
289    #[argh(option, short = 'c', long = "command")]
290    /// execute a command instead of reading from stdin.
291    /// the exit code of the command will be forwarded to the host.
292    pub command: Option<String>,
293
294    #[argh(
295        option,
296        short = 'l',
297        long = "layout",
298        default = "DashNamespaceLayout::NestAllInstanceDirs"
299    )]
300    /// changes the namespace layout that is created for the shell.
301    /// nested: nests all instance directories under subdirs (default)
302    /// namespace: sets the instance namespace as the root (works better for tools)
303    pub ns_layout: DashNamespaceLayout,
304}
305
306#[derive(FromArgs, Debug, PartialEq)]
307#[argh(subcommand, name = "config", description = "Same as `ffx component config`")]
308pub struct ConfigArgs {
309    #[argh(subcommand)]
310    pub subcommand: ConfigSubcommand,
311}
312
313#[derive(FromArgs, Debug, PartialEq)]
314#[argh(subcommand)]
315pub enum ConfigSubcommand {
316    Set(SetArgs),
317    Unset(UnsetArgs),
318    List(ConfigListArgs),
319}
320
321#[derive(FromArgs, Debug, PartialEq)]
322#[argh(subcommand, name = "set", description = "Same as `ffx component config set`")]
323pub struct SetArgs {
324    #[argh(positional)]
325    /// component URL, moniker or instance ID. Partial matches allowed.
326    pub query: String,
327    #[argh(positional)]
328    /// key-value pairs of the configuration capability to be overridden. Takes
329    /// the form 'key="value"'.
330    pub key_values: Vec<String>,
331    #[argh(switch, short = 'r')]
332    /// if enabled, component instance will be immediately reloaded so overrides
333    /// take effect.
334    pub reload: bool,
335}
336
337#[derive(FromArgs, Debug, PartialEq)]
338#[argh(subcommand, name = "unset", description = "Same as `ffx component config unset`")]
339pub struct UnsetArgs {
340    #[argh(positional)]
341    /// component URL, moniker or instance ID. Partial matches allowed. If
342    /// empty, unsets structured config overrides for all components.
343    pub query: Option<String>,
344    #[argh(switch, short = 'r')]
345    /// if enabled, component instance will be immediately reloaded so overrides
346    /// take effect.
347    pub reload: bool,
348}
349
350#[derive(FromArgs, Debug, PartialEq)]
351#[argh(subcommand, name = "list", description = "Same as `ffx component config list`")]
352pub struct ConfigListArgs {
353    #[argh(positional)]
354    /// component URL, moniker or instance ID. Partial matches allowed.
355    pub query: String,
356}
component/args.rs

component/
args.rs
