Merge pull request #1 from loco-rs/add-ci

add ci

.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+env:
+  RUST_TOOLCHAIN: 1.79.0
+  TOOLCHAIN_PROFILE: minimal
+
+jobs:
+  rustfmt:
+    name: Check Style
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
+          components: rustfmt
+      - name: Run cargo fmt
+        run: cargo fmt --all -- --check 
+
+  clippy:
+    name: Run Clippy
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
+          components: rustfmt,clippy 
+      - name: Setup Rust cache
+        uses: Swatinem/rust-cache@v2
+      - name: Run cargo clippy
+        run: cargo clippy --all-features -- -D warnings -W clippy::pedantic -W clippy::nursery -W rust-2018-idioms 
+
+  test:
+    name: Run Tests
+    needs: [rustfmt, clippy]
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: ${{ env.RUST_TOOLCHAIN }}
+      - name: Setup Rust cache
+        uses: Swatinem/rust-cache@v2
+      - name: Run cargo test
+        run: cargo test --all-features --all 

Cargo.toml

@@ -22,4 +22,3 @@ thiserror = { version = "1" }
 colored = { version = "2.1.0" }
 
 [dev-dependencies]
-insta = { version = "1.40.0" }

src/generator.rs

@@ -88,7 +88,7 @@ impl StringDefBuilder<'_> {
 
 impl std::fmt::Display for StringDefBuilder<'_> {
     /// Displays the generated string based on the current configuration of the builder.
-    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         let mut rng = self.rng.borrow_mut();
         let result = self.string_def.generate(&mut *rng);
         write!(f, "{result}")

src/lib.rs

@@ -1,7 +1,7 @@
 //! # Crazy Train
 //!
 //! **Crazy Train** is a Rust library designed for randomized and fuzz execution of command-line
-//! interfaces (CLIs). It helps discover unforeseen sequences of steps and parameters that can lead
+//! interfaces. It helps discover unforeseen sequences of steps and parameters that can lead
 //! to unexpected errors. This library facilitates reproducible test plan runs, ensuring that the
 //! command-line interface behaves as expected under various scenarios.
 //!
@@ -23,6 +23,7 @@
 //! crazy-train = "0.1.0"  // Replace with the latest version
 //! ```
 //!
+
 mod errors;
 pub mod executer;
 mod generator;

src/randomizer.rs

@@ -87,7 +87,7 @@ impl Randomizer {
     /// assert_eq!(randomizer.string(string_def.clone()).include_symbol(true).to_string(), "=wqf`g");
     /// assert_eq!(randomizer.string(string_def.clone()).length(10).to_string(), "wgavmyyuzw");
     /// ```
-    pub fn string(&self, def: StringDef) -> StringDefBuilder {
+    pub fn string(&self, def: StringDef) -> StringDefBuilder<'_> {
         StringDefBuilder {
             string_def: def,
             rng: &self.rng,

src/runner.rs

@@ -156,7 +156,6 @@ impl Runner {
 #[cfg(test)]
 mod tests {
 
-    use insta::assert_debug_snapshot;
     use std::path::PathBuf;
 
     use serde::{Deserialize, Serialize};
@@ -246,21 +245,6 @@ mod tests {
         }
     }
 
-    #[test]
-    fn can_dump_plan() {
-        let location = std::env::temp_dir().join("crazy-train");
-
-        let step_one = TestStepOne { location };
-        let step_two = TestStepOne {
-            location: std::env::temp_dir().join("crazy-train-1"),
-        };
-
-        let randomaizer = Randomizer::with_seed(42);
-        let runner = new(vec![Box::new(step_one), Box::new(step_two)]).randomizer(randomaizer);
-
-        assert_debug_snapshot!(runner.dump_plan());
-    }
-
     #[test]
     fn can_run() {
         let base_location = std::env::temp_dir().join("crazy-train");