Add two options for run/watch arguments

Author: markcda

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "deployer"
-version = "1.5.0-1"
+version = "1.5.0-2-beta.1"
 edition = "2024"
 
 [dependencies]

TODO.md

@@ -1,3 +1,11 @@
 # `deployer`'s TODO list
 
 - [ ] TUI for editing containered & Ansible options for Pipelines
+- [ ] Replace complete `RemoteHost` definitions from `ansible_opts` for their shortnames
+- [ ] Add `deployer cd` command to change current directory to one of run directories
+- [ ] Make `deployer export` command:
+  1. [ ] for exporting Pipelines to `bash` scripts
+  2. [ ] for exporting (and importing with merging) Actions & Pipelines Registries
+  3. [ ] for exporting Pipelines to CI (GitHub Actions, GitLab CI, Jenkins (? maybe ?)) configurations
+- [x] Add `--skip N` argument to skip N Actions inside selected Pipelines, if you exactly know that they have no need to re-run after changes
+- [x] Add `--no-clear` argument to disable screen clear on `run`/`watch`

src/cmd.rs

@@ -270,6 +270,9 @@ pub struct RunArgs {
   /// Run in specified folder
   #[arg(short('o'), long)]
   pub run_at: Option<PathBuf>,
+  /// Skip N Actions inside selected Pipelines
+  #[arg(short('p'), long)]
+  pub skip: Option<usize>,
 
   /// Run remotely on specified hosts
   #[arg(short('R'), long, value_delimiter(','))]
@@ -291,4 +294,7 @@ pub struct RunArgs {
   /// Don't pipe I/O channels
   #[arg(short('t'), long)]
   pub no_pipe: bool,
+  /// Don't clear terminal
+  #[arg(short('k'), long)]
+  pub no_clear: bool,
 }

src/containered.rs

@@ -68,6 +68,7 @@ async fn run_simple(env: &RunEnvironment<'_>, bash_c: String) -> anyhow::Result<
   .execute(&RunEnvironment {
     no_pipe: true,
     daemons: env.daemons.clone(),
+    skipper: env.skipper.clone(),
     ..(*env)
   })
   .await?

src/entities.rs

@@ -16,5 +16,6 @@ pub mod placements;
 pub mod programming_languages;
 pub mod remote_host;
 pub mod requirements;
+pub mod skipper;
 pub mod targets;
 pub mod variables;

src/entities/environment.rs

@@ -15,6 +15,7 @@ use crate::entities::observe_executor::ObserveClient;
 use crate::entities::placements::Placement;
 #[cfg(feature = "ssh-remotes")]
 use crate::entities::remote_host::RemoteHost;
+use crate::entities::skipper::Skipper;
 
 /// Run environment.
 pub struct RunEnvironment<'a> {
@@ -60,4 +61,6 @@ pub struct RunEnvironment<'a> {
   pub daemons: Daemons,
   /// Observe Actions executor client.
   pub observe_cli: &'a Option<ObserveClient>,
+  /// Skipper to count Actions to skip (see `--skip` option for `deployer run/watch`).
+  pub skipper: Skipper,
 }

src/entities/observe_executor.rs

@@ -68,8 +68,9 @@ impl OwnedEnvironment {
       master_pipeline: &self._empty_str,
       #[cfg(feature = "ansible")]
       ansible_run: false,
-      daemons: Daemons::default(),
+      daemons: Default::default(),
       observe_cli: &None,
+      skipper: Default::default(),
     }
   }
 }

src/entities/skipper.rs

@@ -0,0 +1,33 @@
+//! Skipper module.
+
+use std::sync::Arc;
+use tokio::sync::Mutex;
+
+/// Utility to skip N Actions over chosen Pipelines,
+/// when you exactly know that they have no need to re-run after changes
+#[derive(Clone)]
+pub struct Skipper(Arc<Mutex<usize>>);
+
+impl Default for Skipper {
+  fn default() -> Self {
+    Self(Arc::new(Mutex::new(0usize)))
+  }
+}
+
+impl Skipper {
+  /// Creates a new skipper.
+  pub fn new(skip: usize) -> Self {
+    Self(Arc::new(Mutex::new(skip)))
+  }
+
+  /// Checks if skipper has non-empty counter. It also decreases the counter, if has.
+  pub async fn skip(&self) -> bool {
+    let mut guard = self.0.lock().await;
+    if *guard != 0 {
+      *guard -= 1;
+      true
+    } else {
+      false
+    }
+  }
+}

src/main.rs

@@ -29,6 +29,7 @@ pub use deployer::*;
 use crate::actions::{cat_action, edit_action, list_actions, new_action, remove_action};
 use crate::cmd::{CatType, Cli, DeployerExecType, EditType, ListType, NewType, RemoveType};
 use crate::configs::{DeployerGlobalConfig, DeployerProjectOptions};
+use crate::entities::skipper::Skipper;
 use crate::pipelines::{
   assign_pipeline_to_project, cat_pipeline, cat_project, edit_pipeline, list_pipelines, new_pipeline, remove_pipeline,
 };
@@ -194,7 +195,10 @@ async fn main() {
       write(get_current_working_dir().unwrap(), conf_file, &config);
     }
     DeployerExecType::Run(args) => {
-      clearscreen::clear().expect("Failed to clear screen");
+      if !args.no_clear {
+        clearscreen::clear().expect("Failed to clear screen");
+      }
+      let skipper = Skipper::new(args.skip.unwrap_or(0usize));
       let success = run(
         &mut config,
         &globals,
@@ -204,6 +208,7 @@ async fn main() {
         &storage_folder,
         &args,
         None,
+        skipper,
       )
       .await
       .unwrap();

src/run.rs

@@ -28,6 +28,7 @@ use crate::entities::placements::Placement;
 #[cfg(feature = "ssh-remotes")]
 use crate::entities::remote_host::RemoteHost;
 use crate::entities::requirements::{Satisfy, SatisfyErr};
+use crate::entities::skipper::Skipper;
 use crate::entities::traits::Merge;
 use crate::i18n;
 use crate::pipelines::DescribedPipeline;
@@ -265,6 +266,7 @@ pub async fn run(
   storage_dir: &Path,
   args: &RunArgs,
   observe_cli: Option<ObserveClient>,
+  skipper: Skipper,
 ) -> anyhow::Result<bool> {
   let remote_folder = match std::env::var("DEPLOYER_REMOTE_AS_WORKER") {
     Ok(path) => Some(PathBuf::from(path)),
@@ -288,6 +290,7 @@ pub async fn run(
       storage_dir,
       &globals.remote_hosts,
       args,
+      skipper,
     )
     .await;
   }
@@ -350,6 +353,7 @@ pub async fn run(
         ansible_run: matches!(std::env::var("DEPLOYER_ANSIBLE_RUN"), Ok(val) if val.as_str().eq("1")),
         daemons: Daemons::default(),
         observe_cli: &observe_cli,
+        skipper: skipper.clone(),
       };
 
       let status = execute_pipeline(config, &mut env, pipeline).await?;
@@ -393,6 +397,7 @@ pub async fn run(
           ansible_run: matches!(std::env::var("DEPLOYER_ANSIBLE_RUN"), Ok(val) if val.as_str().eq("1")),
           daemons: Daemons::default(),
           observe_cli: &observe_cli,
+          skipper: skipper.clone(),
         };
 
         let status = execute_pipeline(config, &mut env, pipeline).await?;
@@ -418,6 +423,7 @@ pub async fn run(
 /// Runs project as worker node (e.g., without project directory itself
 /// and with given run folder path from controller's node).
 #[cfg(feature = "ssh-remotes")]
+#[allow(clippy::too_many_arguments)]
 pub async fn run_as_worker(
   config: &mut DeployerProjectOptions,
   run_dir: &Path,
@@ -426,6 +432,7 @@ pub async fn run_as_worker(
   storage_dir: &Path,
   remotes: &HashMap<ShortName, RemoteHost>,
   args: &RunArgs,
+  skipper: Skipper,
 ) -> anyhow::Result<bool> {
   let artifacts_dir = prepare_artifacts_folder(run_dir)?;
 
@@ -455,6 +462,7 @@ pub async fn run_as_worker(
         ansible_run: matches!(std::env::var("DEPLOYER_ANSIBLE_RUN"), Ok(val) if val.as_str().eq("1")),
         daemons: Daemons::default(),
         observe_cli: &None,
+        skipper: skipper.clone(),
       };
 
       success &= execute_pipeline(config, &mut env, pipeline).await?;
@@ -569,6 +577,7 @@ pub async fn execute_pipeline(
     let env = RunEnvironment {
       silent_build: false,
       daemons: env.daemons.clone(),
+      skipper: env.skipper.clone(),
       ..(*env)
     };
     return execute_pipeline_containered(config, &env, pipeline).await;
@@ -637,17 +646,24 @@ pub async fn execute_pipeline(
   let mut cntr = 1usize;
   let total = pipeline.actions.len();
   for action in &pipeline.actions {
+    if env.skipper.skip().await {
+      cntr += 1;
+      continue;
+    }
+
     let mut env = if action.exec_in_project_dir.is_some_and(|v| v)
       && let Some(project_dir) = env.project_dir
     {
       RunEnvironment {
         run_dir: project_dir,
         daemons: env.daemons.clone(),
+        skipper: env.skipper.clone(),
         ..(*env)
       }
     } else {
       RunEnvironment {
         daemons: env.daemons.clone(),
+        skipper: env.skipper.clone(),
         ..(*env)
       }
     };