SSH and HC Vault support exposed to optional features

Author: markcda

Cargo.toml

@@ -18,18 +18,18 @@ inquire = { optional = true, git = "https://github.com/markcda/inquire.git", bra
 mimalloc = "0.1.43"
 nix = { optional = true, version = "0.29", features = ["signal", "user"] }
 regex = "1.11"
-russh = "0.49"
+russh = { optional = true, version = "0.49" }
 safe-path = "0.1"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 serde_yaml = { git = "https://github.com/markcda/serde-yaml.git", tag = "0.9.36" }
 smart-patcher = { git = "https://github.com/impulse-sw/smart-patcher", tag = "0.2.1", default-features = false }
 strip-ansi-escapes = "0.2"
 termimad = "0.20"
-tokio = { version = "1.0", features = ["rt-multi-thread", "io-std"] }
+tokio = { optional = true, version = "1.0", features = ["rt-multi-thread", "io-std"] }
 toml = "0.8"
 uuid = { version = "1.11", features = ["v4", "fast-rng"] }
-vaultrs = "0.7"
+vaultrs = { optional = true, version = "0.7" }
 
 [features]
 default = ["lua", "rhai", "tui", "containered"]
@@ -40,3 +40,5 @@ lua = ["smart-patcher/lua"]
 rhai = ["smart-patcher/rhai"]
 tui = ["dep:inquire"]
 containered = ["dep:nix"]
+hc-vault = ["dep:vaultrs", "dep:tokio"]
+ssh-remotes = ["dep:russh", "dep:tokio"]

deploy-config.yaml

@@ -44,7 +44,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Format
         info: cargo-fmt@0.1.0
@@ -74,7 +74,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=lua,rhai,tui,containered,hc-vault,ssh-remotes
       - title: Compress
         info: upx@0.1.0
         tags:
@@ -154,7 +154,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=i18n-ru,lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Форматирование кода
         info: cargo-fmt@0.1.0
@@ -184,7 +184,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=i18n-ru,lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
       - title: Сжатие
         info: upx@0.1.0
         tags:
@@ -264,7 +264,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=python,lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=python,lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Format
         info: cargo-fmt@0.1.0
@@ -294,7 +294,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=python,lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=python,lua,rhai,tui,containered,hc-vault,ssh-remotes
       - title: Compress
         info: upx@0.1.0
         tags:
@@ -374,7 +374,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=python,i18n-ru,lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=python,i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Форматирование кода
         info: cargo-fmt@0.1.0
@@ -404,7 +404,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=python,i18n-ru,lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=python,i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
       - title: Сжатие
         info: upx@0.1.0
         tags:
@@ -491,7 +491,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=i18n-ru,lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Форматирование кода
         info: cargo-fmt@0.1.0
@@ -521,7 +521,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=i18n-ru,lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
       - title: Сжатие
         info: upx@0.1.0
         tags:
@@ -597,7 +597,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --lib --features=lua,rhai
+            - bash_c: cargo clippy --no-default-features --lib --features=lua,rhai,hc-vault,ssh-remotes
               show_success_output: true
       - title: Lint with `containered` feature
         info: cargo-clippy@0.1.0
@@ -614,7 +614,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --lib --features=lua,rhai,containered
+            - bash_c: cargo clippy --no-default-features --lib --features=lua,rhai,containered,hc-vault,ssh-remotes
               show_success_output: true
   - title: test
     desc: ""
@@ -727,7 +727,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Build
         info: cargo-rel@0.1
@@ -744,7 +744,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=lua,rhai,tui,containered,hc-vault,ssh-remotes
   - title: ru-containered
     desc: Got from `Deployer Pipeline`.
     info: deployer-default@0.1.2
@@ -795,7 +795,7 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: cargo clippy --no-default-features --features=i18n-ru,lua,rhai,tui,containered
+            - bash_c: cargo clippy --no-default-features --features=i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes
               show_success_output: true
       - title: Сборка
         info: cargo-rel@0.1
@@ -812,4 +812,4 @@ pipelines:
           supported_langs:
             - rust
           commands:
-            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=i18n-ru,lua,rhai,tui,containered
+            - bash_c: RUSTFLAGS='-Zthreads=16' cargo build --release --no-default-features --features=i18n-ru,lua,rhai,tui,containered,hc-vault,ssh-remotes

src/actions.rs

@@ -145,10 +145,12 @@ impl Action {
 
   pub fn run_with(&self, config: &DeployerProjectOptions, env: &RunEnvironment) -> anyhow::Result<(bool, Vec<String>)> {
     use crate::entities::traits::Execute;
+    #[cfg(feature = "ssh-remotes")]
     use crate::remote::{sync_from_remote, sync_to_remote};
     use crate::run::{execute_pipeline, place_artifacts};
 
     let (status, output) = match self {
+      #[cfg(feature = "ssh-remotes")]
       Action::SyncToRemote { remote_host_name } => {
         if let Some(remote) = env.remotes.get(remote_host_name) {
           if let Err(e) = sync_to_remote(env.run_dir, remote, env.ignore) {
@@ -160,6 +162,7 @@ impl Action {
           (false, vec![i18n::NO_SUCH_REMOTE.to_string()])
         }
       }
+      #[cfg(feature = "ssh-remotes")]
       Action::SyncFromRemote { remote_host_name } => {
         if let Some(remote) = env.remotes.get(remote_host_name) {
           if let Err(e) = sync_from_remote(env.run_dir, remote) {
@@ -212,6 +215,11 @@ impl Action {
       #[cfg(not(feature = "containered"))]
       Action::ConfigureDeploy(a) | Action::Deploy(a) | Action::PostDeploy(a) => a.execute(env)?,
 
+      #[cfg(not(feature = "ssh-remotes"))]
+      Action::SyncToRemote { .. } | Action::SyncFromRemote { .. } => {
+        panic!("SSH remotes are not enabled in this configuration");
+      }
+
       #[cfg(feature = "containered")]
       _ => (true, vec![i18n::CTRD_SKIP_ACTION.to_string()]),
     };

src/cmd.rs

@@ -71,6 +71,7 @@ pub enum ListType {
   /// List available content in Deployer's storage
   Content,
   /// List available remote hosts
+  #[cfg(feature = "ssh-remotes")]
   Remote,
 }
 
@@ -83,6 +84,7 @@ pub enum RemoveType {
   /// Remove content
   Content,
   /// Remove remote host
+  #[cfg(feature = "ssh-remotes")]
   Remote,
 }
 
@@ -95,6 +97,7 @@ pub enum CatType {
   /// Prints all Pipelines used by current Project
   Project(CatProjectArgs),
   /// Prints all information about remote host
+  #[cfg(feature = "ssh-remotes")]
   Remote(CatRemoteArgs),
 }
 
@@ -107,6 +110,7 @@ pub enum EditType {
   /// Edits Project settings
   Project,
   /// Edits an information about remote hosts
+  #[cfg(feature = "ssh-remotes")]
   Remote(CatRemoteArgs),
 }
 
@@ -140,6 +144,7 @@ pub enum NewType {
   /// Add new Content to Deployer's storage
   Content,
   /// Add new remote host to Deployer's registry
+  #[cfg(feature = "ssh-remotes")]
   Remote(NewRemoteArgs),
 }
 

src/entities/custom_command.rs

@@ -15,6 +15,7 @@ use serde::{Deserialize, Serialize};
 use crate::CTRLC_HANDLER;
 use crate::entities::environment::RunEnvironment;
 use crate::entities::info::ShortName;
+#[cfg(feature = "ssh-remotes")]
 use crate::entities::remote_host::RemoteHost;
 use crate::entities::traits::Execute;
 use crate::i18n;
@@ -125,6 +126,7 @@ pub struct Replacement {
 impl Execute for CustomCommand {
   /// Runs given command one time or more, replacing the placeholders with given values.
   fn execute(&self, env: &RunEnvironment) -> anyhow::Result<(bool, Vec<String>)> {
+    #[cfg(feature = "ssh-remotes")]
     if self.remote_exec.as_ref().is_some_and(|rs| !rs.is_empty()) {
       return self.remote_execute(env);
     }
@@ -219,6 +221,7 @@ impl Execute for CustomCommand {
 
   /// Runs given command one time or more, replacing the placeholders with given values, and forcing `no_pipe` option.
   fn execute_observer(&self, env: &RunEnvironment) -> anyhow::Result<(bool, Vec<String>)> {
+    #[cfg(feature = "ssh-remotes")]
     if self.remote_exec.as_ref().is_some_and(|rs| !rs.is_empty()) {
       return self.remote_execute(env);
     }
@@ -297,6 +300,7 @@ impl Execute for CustomCommand {
 
 impl CustomCommand {
   /// Runs given command remotely on one or more remote hosts.
+  #[cfg(feature = "ssh-remotes")]
   pub fn remote_execute(&self, env: &RunEnvironment) -> anyhow::Result<(bool, Vec<String>)> {
     let hosts = self.remote_exec.as_ref().unwrap();
     let mut output = vec![];

src/entities/environment.rs

@@ -3,12 +3,16 @@
 //! `RunEnvironment` is just a struct that have all needed variables
 //! and paths during Pipeline execution.
 
-use std::collections::{HashMap, HashSet};
+#[cfg(feature = "ssh-remotes")]
+use std::collections::HashMap;
+use std::collections::HashSet;
 use std::path::{Path, PathBuf};
 
 use crate::configs::Placement;
 use crate::entities::daemons::Daemons;
+#[cfg(feature = "ssh-remotes")]
 use crate::entities::info::ShortName;
+#[cfg(feature = "ssh-remotes")]
 use crate::entities::remote_host::RemoteHost;
 
 /// Run environment.
@@ -18,6 +22,7 @@ pub struct RunEnvironment<'a> {
   /// System-wide or local common cache folder (usually `~/.cache`).
   pub cache_dir: &'a Path,
   /// System-wide or local common configuration folder (usually `~/.config`).
+  #[allow(dead_code)]
   pub config_dir: &'a Path,
   /// Project folder.
   pub project_dir: Option<&'a Path>,
@@ -28,6 +33,7 @@ pub struct RunEnvironment<'a> {
   /// Artifacts placements.
   pub artifacts_placements: &'a Vec<Placement>,
   /// Remote hosts's Registry. Used to find hosts by short name.
+  #[cfg(feature = "ssh-remotes")]
   pub remotes: &'a HashMap<ShortName, RemoteHost>,
   /// What files you should ignore when running Pipelines remotely.
   pub ignore: &'a HashSet<PathBuf>,

src/entities/remote_host.rs

@@ -2,12 +2,16 @@
 //!
 //! Any remote host struct is a set of properties needed to connect and authenticate by `ssh`.
 
+#![allow(unused_imports)]
+
 use anyhow::bail;
 use serde::{Deserialize, Serialize};
 use std::borrow::Cow;
 use std::net::IpAddr;
 use std::path::{Path, PathBuf};
 use std::sync::Arc;
+
+#[cfg(feature = "ssh-remotes")]
 use tokio::net::ToSocketAddrs;
 
 use crate::entities::custom_command::compose_output;
@@ -29,6 +33,7 @@ pub struct RemoteHost {
   pub ssh_private_key_file: PathBuf,
 }
 
+#[cfg(feature = "ssh-remotes")]
 impl RemoteHost {
   /// Checks the remote host connectivity, authorization and Deployer installation existence.
   pub fn check(&self) -> anyhow::Result<()> {
@@ -112,8 +117,10 @@ impl RemoteHost {
   }
 }
 
+#[cfg(feature = "ssh-remotes")]
 struct Client {}
 
+#[cfg(feature = "ssh-remotes")]
 #[async_trait::async_trait]
 impl russh::client::Handler for Client {
   type Error = anyhow::Error;
@@ -126,10 +133,12 @@ impl russh::client::Handler for Client {
   }
 }
 
+#[cfg(feature = "ssh-remotes")]
 pub struct Session {
   session: russh::client::Handle<Client>,
 }
 
+#[cfg(feature = "ssh-remotes")]
 impl Session {
   async fn connect<P: AsRef<Path>, A: ToSocketAddrs>(
     key_path: P,

src/entities/requirements.rs

@@ -8,6 +8,7 @@ use crate::actions::test::TestAction;
 use crate::entities::environment::RunEnvironment;
 use crate::entities::info::ShortName;
 use crate::entities::traits::Execute;
+#[cfg(feature = "ssh-remotes")]
 use crate::i18n;
 
 /// Requirement.
@@ -82,6 +83,7 @@ impl<'a> Satisfy<'a> for Requirement {
           .map_err(|e| SatisfyErr::Check(vec![e.to_string()]))?;
         if status { Ok(()) } else { Err(SatisfyErr::Check(out)) }
       }
+      #[cfg(feature = "ssh-remotes")]
       Self::RemoteAccessibleAndReady { remote_host_name } => {
         let globals = crate::rw::read::<crate::configs::DeployerGlobalConfig>(&env.config_dir, crate::GLOBAL_CONF);
         if let Some(remote) = globals.remote_hosts.get(remote_host_name) {
@@ -90,6 +92,8 @@ impl<'a> Satisfy<'a> for Requirement {
           Err(SatisfyErr::Remote(i18n::NO_SUCH_REMOTE.to_string()))
         }
       }
+      #[cfg(not(feature = "ssh-remotes"))]
+      Self::RemoteAccessibleAndReady { .. } => Err(SatisfyErr::Remote("Remote hosts aren't supported!".to_string())),
     }
   }
 }