[feature] #3868: Add iroha_swarm disclaimer header

Signed-off-by: Daniil Polyakov <arjentix@gmail.com>

Author: Arjentix

Cargo.lock

@@ -1,3 +1,6 @@
+# This file is generated by iroha_swarm.
+# Do not edit it manually.
+
 version: '3.8'
 services:
   iroha0:

docker-compose.dev.local.yml

@@ -1,3 +1,6 @@
+# This file is generated by iroha_swarm.
+# Do not edit it manually.
+
 version: '3.8'
 services:
   iroha0:

docker-compose.dev.single.yml

@@ -1,3 +1,6 @@
+# This file is generated by iroha_swarm.
+# Do not edit it manually.
+
 version: '3.8'
 services:
   iroha0:

docker-compose.dev.yml

@@ -39,7 +39,7 @@ case $1 in
 
             eval "$full_cmd"
             diff "$temp_file" "$target" || {
-                echo "Please re-generate \`$target\` with \`$full_cmd\`"
+                echo "Please re-generate \`$target\` with \`$cmd_base --outfile $target\`"
                 exit 1
             }
         }

scripts/check.sh

@@ -20,6 +20,11 @@ pub struct Cli {
     /// overwrite the file anyway, pass `--force` flag.
     #[arg(long, short)]
     pub outfile: PathBuf,
+    /// Disable banner in the file saying that the file is generated.
+    ///
+    /// It includes all passed arguments in order to help with reproducibility.
+    #[arg(long)]
+    pub no_banner: bool,
     /// Path to a directory with Iroha configuration. It will be mapped as volume for containers.
     ///
     /// The directory should contain `config.json` and `genesis.json`.

tools/swarm/src/cli.rs

@@ -39,13 +39,26 @@ impl DockerCompose {
         }
     }
 
-    pub fn write_file(&self, path: &PathBuf) -> Result<(), color_eyre::Report> {
+    pub fn write_file(
+        &self,
+        path: &PathBuf,
+        banner_enabled: bool,
+    ) -> Result<(), color_eyre::Report> {
+        let mut file = File::create(path)
+            .wrap_err_with(|| eyre!("Failed to create file {}", path.display()))?;
+
+        if banner_enabled {
+            file.write_all(
+                b"# This file is generated by iroha_swarm.\n\
+                  # Do not edit it manually.\n\n",
+            )
+            .wrap_err_with(|| eyre!("Failed to write banner into {}", path.display()))?;
+        }
+
         let yaml = serde_yaml::to_string(self).wrap_err("Failed to serialise YAML")?;
-        File::create(path)
-            .wrap_err_with(|| eyre!("Failed to create file {}", path.display()))?
-            .write_all(yaml.as_bytes())
-            .wrap_err_with(|| eyre!("Failed to write YAML content into {}", path.display()))?;
-        Ok(())
+        file.write_all(yaml.as_bytes())
+            .wrap_err_with(|| eyre!("Failed to write YAML content into {}", path.display()))
+            .map_err(Into::into)
     }
 }
 
@@ -331,12 +344,12 @@ impl DockerComposeBuilder<'_> {
         Ok(compose)
     }
 
-    pub(crate) fn build_and_write(&self) -> color_eyre::Result<()> {
+    pub(crate) fn build_and_write(&self, banner_enabled: bool) -> color_eyre::Result<()> {
         let target_file = self.target_file;
         let compose = self
             .build()
             .wrap_err("Failed to build a docker compose file")?;
-        compose.write_file(&target_file.path)
+        compose.write_file(&target_file.path, banner_enabled)
     }
 }
 

tools/swarm/src/compose.rs

@@ -17,6 +17,7 @@ fn main() -> Result<()> {
         peers,
         seed,
         force,
+        no_banner,
         source: image_source,
         outfile: target_file_raw,
         config_dir: config_dir_raw,
@@ -41,14 +42,16 @@ fn main() -> Result<()> {
         }
     }
 
+    let banner_enabled = !no_banner;
+
     compose::DockerComposeBuilder {
         target_file: &target_file,
         config_dir: &config_dir,
         image_source,
         peers,
         seed,
     }
-    .build_and_write()?;
+    .build_and_write(banner_enabled)?;
 
     ui::log_file_mode_complete(&target_file, &target_file_raw);