warg-cli 0.10.0

The warg registry command line interface.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! Commands for the `warg` tool.

use anyhow::Result;
use clap::Args;
use std::path::PathBuf;
use warg_client::keyring::Keyring;
use warg_client::storage::RegistryDomain;
use warg_client::{ClientError, Config, FileSystemClient, StorageLockResult};
use warg_crypto::signing::PrivateKey;

mod bundle;
mod clear;
mod config;
mod dependencies;
mod download;
mod info;
mod key;
mod lock;
mod login;
mod logout;
mod publish;
mod reset;
mod update;

pub use self::bundle::*;
pub use self::clear::*;
pub use self::config::*;
pub use self::dependencies::*;
pub use self::download::*;
pub use self::info::*;
pub use self::key::*;
pub use self::lock::*;
pub use self::login::*;
pub use self::logout::*;
pub use self::publish::*;
pub use self::reset::*;
pub use self::update::*;

/// Common options for commands.
#[derive(Args)]
pub struct CommonOptions {
    /// The URL of the registry to use.
    #[clap(long, value_name = "URL")]
    pub registry: Option<String>,
    /// The path to the client configuration file to use.
    ///
    /// If not specified, the following locations are searched in order: `./warg-config.json`, `<system-config-dir>/warg/config.json`.
    ///
    /// If no configuration file is found, a default configuration is used.
    #[clap(long, value_name = "CONFIG")]
    pub config: Option<PathBuf>,
}

impl CommonOptions {
    /// Reads the client configuration.
    ///
    /// If a client configuration was not specified, a default configuration is returned.
    pub fn read_config(&self) -> Result<Config> {
        Ok(self
            .config
            .as_ref()
            .map_or_else(Config::from_default_file, |p| {
                Config::from_file(p).map(Some)
            })?
            .unwrap_or_default())
    }

    /// Creates the warg client to use.
    pub async fn create_client(&self, config: &Config) -> Result<FileSystemClient, ClientError> {
        let client =
            match FileSystemClient::try_new_with_config(self.registry.as_deref(), config, None)
                .await?
            {
                StorageLockResult::Acquired(client) => Ok(client),
                StorageLockResult::NotAcquired(path) => {
                    println!(
                        "blocking on lock for directory `{path}`...",
                        path = path.display()
                    );

                    FileSystemClient::new_with_config(self.registry.as_deref(), config, None).await
                }
            }?;
        Ok(client)
    }

    /// Gets the signing key for the given registry URL.
    pub async fn signing_key(
        &self,
        registry_domain: Option<&RegistryDomain>,
    ) -> Result<PrivateKey> {
        let config = self.read_config()?;
        let key = Keyring::from_config(&config)?.get_signing_key(
            registry_domain.map(|domain| domain.to_string()).as_deref(),
            &config.keys,
            config.home_url.as_deref(),
        )?;
        Ok(key)
    }
}