updates workflow and adds custom formatting for rustfmt (#84)

* updates workflow and adds custom formatting for rustfmt

Author: ozgunozerk

.github/workflows/ci-tests.yml

@@ -1,5 +1,6 @@
 name: "ci tests"
 
+
 on:
   push:
     branches:
@@ -10,7 +11,13 @@ on:
     paths-ignore:
       - '**.md'
   workflow_dispatch:
-
+    inputs:
+      test-macos-and-windows:
+        description: 'run macOS and Windows tests'
+        required: true
+        default: false
+        type: boolean
+          
 env:
   # Not needed in CI, should make things a bit faster
   CARGO_INCREMENTAL: 0
@@ -25,6 +32,13 @@ jobs:
           - ubuntu-22.04
           - macos-12
           - windows-2022
+        run-all: 
+          - ${{ inputs.test-macos-and-windows == true || github.ref == 'refs/heads/main' }}
+        exclude:  # exclude macos-12 and windows-2022 when the condition is false
+          - run-all: false
+            os: macos-12
+          - run-all: false
+            os: windows-2022
 
     runs-on: ${{ matrix.os }}
     steps:

rustfmt.toml

@@ -0,0 +1,12 @@
+edition = "2021"
+format_code_in_doc_comments = true
+format_macro_bodies = true
+format_macro_matchers = true
+format_strings = true
+imports_granularity = "Module"
+match_arm_blocks = false
+reorder_impl_items = true
+group_imports = "StdExternalCrate"
+use_field_init_shorthand = true
+use_small_heuristics = "Max"
+wrap_comments = true

src/commands/farm.rs

@@ -6,9 +6,8 @@ use futures::prelude::*;
 use indicatif::{ProgressBar, ProgressStyle};
 use single_instance::SingleInstance;
 use subspace_sdk::node::SyncStatus;
-use tracing::instrument;
-
 use subspace_sdk::{chain_spec, Farmer, Node, PlotDescription};
+use tracing::instrument;
 
 use crate::config::{validate_config, ChainConfig, Config};
 use crate::summary::Summary;
@@ -23,7 +22,8 @@ pub(crate) const SINGLE_INSTANCE: &str = ".subspaceFarmer";
 ///
 /// first, checks for an existing farmer instance
 /// then starts the farming and node instances,
-/// lastly, depending on the verbosity, it subscribes to plotting progress and new solutions
+/// lastly, depending on the verbosity, it subscribes to plotting progress and
+/// new solutions
 #[instrument]
 pub(crate) async fn farm(is_verbose: bool) -> Result<(Farmer, Node, SingleInstance)> {
     install_tracing(is_verbose);
@@ -41,16 +41,11 @@ pub(crate) async fn farm(is_verbose: bool) -> Result<(Farmer, Node, SingleInstan
     raise_fd_limit();
 
     println!("Starting node ... (this might take up to couple of minutes)");
-    let Config {
-        chain,
-        farmer: farmer_config,
-        node: node_config,
-    } = validate_config()?;
+    let Config { chain, farmer: farmer_config, node: node_config } = validate_config()?;
 
     let chain = match chain {
-        ChainConfig::Gemini3a => {
-            chain_spec::gemini_3a().expect("cannot extract the gemini3a chain spec from SDK")
-        }
+        ChainConfig::Gemini3a =>
+            chain_spec::gemini_3a().expect("cannot extract the gemini3a chain spec from SDK"),
     };
 
     let node = node_config
@@ -98,9 +93,7 @@ pub(crate) async fn farm(is_verbose: bool) -> Result<(Farmer, Node, SingleInstan
 
         syncing_progress_bar.finish_with_message("Syncing is done!");
     } else {
-        node.sync()
-            .await
-            .map_err(|err| eyre!("Node syncing failed: {err}"))?;
+        node.sync().await.map_err(|err| eyre!("Node syncing failed: {err}"))?;
     }
 
     let summary = Summary::new(Some(farmer_config.plot_size)).await?;
@@ -111,10 +104,7 @@ pub(crate) async fn farm(is_verbose: bool) -> Result<(Farmer, Node, SingleInstan
         .build(
             farmer_config.address,
             node.clone(),
-            &[PlotDescription::new(
-                farmer_config.plot_directory,
-                farmer_config.plot_size,
-            )],
+            &[PlotDescription::new(farmer_config.plot_directory, farmer_config.plot_size)],
             farmer_config.cache,
         )
         .await?;

src/commands/init.rs

@@ -1,16 +1,16 @@
-use std::{io::Write, str::FromStr};
+use std::io::Write;
+use std::str::FromStr;
 
 use color_eyre::eyre::{Context, Result};
 use subspace_sdk::farmer::CacheDescription;
 
-use crate::config::DEFAULT_PLOT_SIZE;
-use crate::utils::{
-    cache_directory_getter, get_user_input, node_name_parser, plot_directory_getter,
-    plot_directory_parser, print_ascii_art, print_version, reward_address_parser, size_parser,
+use crate::config::{
+    create_config, ChainConfig, Config, FarmerConfig, NodeConfig, DEFAULT_PLOT_SIZE,
 };
-use crate::{
-    config::{create_config, ChainConfig, Config, FarmerConfig, NodeConfig},
-    utils::node_directory_getter,
+use crate::utils::{
+    cache_directory_getter, get_user_input, node_directory_getter, node_name_parser,
+    plot_directory_getter, plot_directory_parser, print_ascii_art, print_version,
+    reward_address_parser, size_parser,
 };
 
 /// implementation of the `init` command
@@ -25,38 +25,32 @@ pub(crate) fn init() -> Result<()> {
     println!("Configuration creation process has started...");
     let config = get_config_from_user_inputs()?;
     config_file
-        .write_all(
-            toml::to_string_pretty(&config)
-                .wrap_err("Failed to write config")?
-                .as_ref(),
-        )
+        .write_all(toml::to_string_pretty(&config).wrap_err("Failed to write config")?.as_ref())
         .wrap_err("Failed to write config")?;
 
-    println!(
-        "Configuration has been generated at {}",
-        config_path.display()
-    );
+    println!("Configuration has been generated at {}", config_path.display());
 
     println!("Ready for lift off! Run the follow command to begin:");
     println!("`./subspace-cli farm`");
 
     Ok(())
 }
 
-/// gets the necessary information from user, and writes them to the given configuration file
+/// gets the necessary information from user, and writes them to the given
+/// configuration file
 fn get_config_from_user_inputs() -> Result<Config> {
     // GET USER INPUTS...
     // get reward address
-    let reward_address = get_user_input(
-        "Enter your farmer/reward address: ",
-        None,
-        reward_address_parser,
-    )?;
+    let reward_address =
+        get_user_input("Enter your farmer/reward address: ", None, reward_address_parser)?;
 
     // get node name
     let default_node_name = whoami::username();
     let node_name = get_user_input(
-        &format!("Enter your node name to be identified on the network(defaults to `{default_node_name}`, press enter to use the default): "),
+        &format!(
+            "Enter your node name to be identified on the network(defaults to \
+             `{default_node_name}`, press enter to use the default): "
+        ),
         Some(default_node_name),
         node_name_parser,
     )?;
@@ -74,7 +68,9 @@ fn get_config_from_user_inputs() -> Result<Config> {
     // get plot size
     let plot_size = get_user_input(
         &format!(
-            "Specify a plot size (defaults to `{DEFAULT_PLOT_SIZE}`, press enter to use the default): "),
+            "Specify a plot size (defaults to `{DEFAULT_PLOT_SIZE}`, press enter to use the \
+             default): "
+        ),
         Some(DEFAULT_PLOT_SIZE),
         size_parser,
     )?;
@@ -83,7 +79,9 @@ fn get_config_from_user_inputs() -> Result<Config> {
     let default_chain = ChainConfig::Gemini3a;
     let chain = get_user_input(
         &format!(
-            "Specify the chain to farm(defaults to `{default_chain:}`, press enter to use the default): "),
+            "Specify the chain to farm(defaults to `{default_chain:}`, press enter to use the \
+             default): "
+        ),
         Some(crate::config::ChainConfig::Gemini3a),
         ChainConfig::from_str,
     )?;

src/commands/wipe.rs

@@ -1,5 +1,4 @@
 use color_eyre::eyre::Result;
-
 use subspace_sdk::{Node, PlotDescription};
 
 use crate::config::parse_config;
@@ -13,7 +12,10 @@ pub(crate) async fn wipe() -> Result<()> {
     let config = match parse_config() {
         Ok(args) => args,
         Err(_) => {
-            println!("could not read your config. You must have a valid config in order to wipe. Aborting...");
+            println!(
+                "could not read your config. You must have a valid config in order to wipe. \
+                 Aborting..."
+            );
             return Ok(());
         }
     };

src/config.rs

@@ -1,23 +1,16 @@
-use std::{
-    fs::{create_dir, File},
-    path::PathBuf,
-    str::FromStr,
-};
+use std::fs::{create_dir, File};
+use std::path::PathBuf;
+use std::str::FromStr;
 
 use bytesize::ByteSize;
-use color_eyre::{
-    eyre::{eyre, Result},
-    Report,
-};
+use color_eyre::eyre::{eyre, Result};
+use color_eyre::Report;
 use serde::{Deserialize, Serialize};
+use subspace_sdk::farmer::{self, CacheDescription, Config as SdkFarmerConfig, Farmer};
+use subspace_sdk::node::{self, Config as SdkNodeConfig, Node};
+use subspace_sdk::PublicKey;
 use tracing::instrument;
 
-use subspace_sdk::{
-    farmer::{self, CacheDescription, Config as SdkFarmerConfig, Farmer},
-    node::{self, Config as SdkNodeConfig, Node},
-    PublicKey,
-};
-
 /// defaults for the user config file
 pub(crate) const DEFAULT_PLOT_SIZE: bytesize::ByteSize = bytesize::ByteSize::gb(1);
 pub(crate) const MIN_PLOT_SIZE: bytesize::ByteSize = bytesize::ByteSize::mib(32);
@@ -101,9 +94,11 @@ impl FarmerConfig {
             plot_size,
             cache,
             farmer: Farmer::builder()
-                .dsn(farmer::DsnBuilder::new().listen_on(vec![
-                    "/ip4/0.0.0.0/tcp/30533".parse().expect("Valid multiaddr"),
-                ]))
+                .dsn(
+                    farmer::DsnBuilder::new().listen_on(vec!["/ip4/0.0.0.0/tcp/30533"
+                        .parse()
+                        .expect("Valid multiaddr")]),
+                )
                 .configuration(),
         }
     }
@@ -130,7 +125,10 @@ impl FromStr for ChainConfig {
         let chain_list = vec!["gemini-3a"];
         match s {
             "gemini-3a" => Ok(ChainConfig::Gemini3a),
-            _ => Err(eyre!("given chain: `{s}` is not recognized! Please enter a valid chain from this list: {chain_list:?}.")),
+            _ => Err(eyre!(
+                "given chain: `{s}` is not recognized! Please enter a valid chain from this list: \
+                 {chain_list:?}."
+            )),
         }
     }
 }

src/main.rs

@@ -12,7 +12,10 @@ mod utils;
 use clap::{Parser, Subcommand};
 use color_eyre::eyre::Report;
 use color_eyre::Help;
-use commands::{farm::farm, info::info, init::init, wipe::wipe};
+use commands::farm::farm;
+use commands::info::info;
+use commands::init::init;
+use commands::wipe::wipe;
 use tokio::signal;
 use tracing::instrument;
 
@@ -31,9 +34,8 @@ struct Cli {
 /// Available commands for the CLI
 #[derive(Debug, Subcommand)]
 enum Commands {
-    #[command(
-        about = "displays info about the farmer instance (i.e. total amount of rewards, and status of initial plotting)"
-    )]
+    #[command(about = "displays info about the farmer instance (i.e. total amount of rewards, \
+                       and status of initial plotting)")]
     Info,
     #[command(about = "initializes the config file required for the farming")]
     Init,
@@ -61,7 +63,10 @@ async fn main() -> Result<(), Report> {
             let (farmer, node, _instance) = farm(verbose).await.suggestion(support_message())?;
 
             signal::ctrl_c().await?;
-            println!("\nWill try to gracefully exit the application now. If you press ctrl+c again, it will try to forcefully close the app!");
+            println!(
+                "\nWill try to gracefully exit the application now. If you press ctrl+c again, it \
+                 will try to forcefully close the app!"
+            );
             let handle = tokio::spawn(async {
                 let _ = farmer.close().await;
                 node.close().await;

src/summary.rs

@@ -1,21 +1,20 @@
 /// Stores the summary of the farming process into a file.
 /// This allows to retrieve farming information with `info` command,
-/// and also store the amount of potentially farmed blocks during the initial plotting progress,
-/// so that progress bar won't be affected with `println!`, and user will still know about them
-/// when initial plotting is finished.
+/// and also store the amount of potentially farmed blocks during the initial
+/// plotting progress, so that progress bar won't be affected with `println!`,
+/// and user will still know about them when initial plotting is finished.
 use std::{path::PathBuf, sync::Arc};
 
 use bytesize::ByteSize;
 use color_eyre::eyre::{Report, Result};
 use serde::{Deserialize, Serialize};
-use tokio::{
-    fs::{create_dir_all, read_to_string, remove_file, File, OpenOptions},
-    io::AsyncWriteExt,
-    sync::Mutex,
-};
+use tokio::fs::{create_dir_all, read_to_string, remove_file, File, OpenOptions};
+use tokio::io::AsyncWriteExt;
+use tokio::sync::Mutex;
 use tracing::instrument;
 
-/// Struct for holding the information of what to be displayed with the `info` command
+/// Struct for holding the information of what to be displayed with the `info`
+/// command
 #[derive(Deserialize, Serialize, Debug)]
 struct FarmerSummary {
     initial_plotting_finished: bool,
@@ -24,7 +23,8 @@ struct FarmerSummary {
     user_space_pledged: ByteSize,
 }
 
-/// utilizing persistent storage for the information to be displayed for the `info` command
+/// utilizing persistent storage for the information to be displayed for the
+/// `info` command
 #[derive(Debug, Clone)]
 pub(crate) struct Summary {
     file: Arc<Mutex<PathBuf>>,
@@ -39,7 +39,8 @@ impl Summary {
             .expect("couldn't get the default local data directory!")
             .join("subspace-cli");
 
-        // providing `Some` value for `user_space_pledged` means, we are creating a new file
+        // providing `Some` value for `user_space_pledged` means, we are creating a new
+        // file
         if let Some(user_space_pledged) = user_space_pledged {
             // File::create will truncate the existing file, so first
             // check if the file exists, if not, `open` will return an error
@@ -63,9 +64,7 @@ impl Summary {
             }
         }
 
-        Ok(Summary {
-            file: Arc::new(Mutex::new(summary_path)),
-        })
+        Ok(Summary { file: Arc::new(Mutex::new(summary_path)) })
     }
 
     /// updates the summary file
@@ -101,7 +100,8 @@ impl Summary {
         Ok(())
     }
 
-    /// retrives how much space has user pledged to the network from the summary file
+    /// retrives how much space has user pledged to the network from the summary
+    /// file
     #[instrument]
     pub(crate) async fn get_user_space_pledged(&self) -> Result<ByteSize> {
         let summary = self.parse_summary().await?;