move integration tests to separate folder

Author: o2sh

Cargo.lock

@@ -24,7 +24,6 @@ section = "utility"
 
 [dev-dependencies]
 git-testtools = "0.9.0"
-strip-ansi-escapes = "0.1.1"
 pretty_assertions = "1.3.0"
 insta = { version = "1.21.0", features = ["json", "redactions"] }
 

Cargo.toml

@@ -32,7 +32,9 @@ mod git;
 pub mod info_field;
 pub mod langs;
 mod repo;
-mod title;
+#[cfg(test)]
+pub mod test;
+pub mod title;
 
 pub struct Info {
     title: Title,
@@ -327,9 +329,6 @@ mod tests {
     use super::*;
     use crate::ui::num_to_color;
     use clap::Parser;
-    use git_repository::{open, ThreadSafeRepository};
-    use git_testtools;
-    use insta::assert_json_snapshot;
     use owo_colors::AnsiColors;
     use pretty_assertions::assert_eq;
 
@@ -372,85 +371,4 @@ mod tests {
         );
         Ok(())
     }
-
-    type Result<T = ()> = std::result::Result<T, Box<dyn std::error::Error>>;
-
-    #[test]
-    fn test_bare_repo() -> Result {
-        let repo_path = git_testtools::scripted_fixture_repo_read_only("bare_repo.sh").unwrap();
-        let safe_repo =
-            ThreadSafeRepository::open_opts(repo_path, open::Options::isolated()).unwrap();
-        let repo = safe_repo.to_thread_local();
-        let res = Info::init_repo_path(&repo);
-        assert!(res.is_err(), "oops, info was returned on a bare git repo");
-        assert_eq!(
-            res.unwrap_err().to_string(),
-            "please run onefetch inside of a non-bare git repository"
-        );
-        Ok(())
-    }
-
-    fn assert_info_str_matches(config: &Config, re: &Regex) {
-        let info = Info::new(config).unwrap();
-        let info_str = format!("{}", info);
-        let info_u8 = strip_ansi_escapes::strip(&info_str).unwrap();
-        let simple_info_str = std::str::from_utf8(&info_u8).unwrap();
-        assert!(
-            re.is_match(&simple_info_str),
-            "OOPS, REGEX\n{}\nDOESNT MATCH\n{}",
-            re.to_string(),
-            simple_info_str
-        );
-    }
-
-    #[test]
-    fn test_language_repo() -> Result {
-        let repo_path = git_testtools::scripted_fixture_repo_read_only_with_args(
-            "language_repo.sh",
-            ["verilog"],
-        )
-        .unwrap();
-        let safe_repo =
-            ThreadSafeRepository::open_opts(repo_path.join("verilog"), open::Options::isolated())?;
-        let repo = safe_repo.to_thread_local();
-
-        // TEST JSON SERILIZER FIRST
-        let mut config: Config = Config {
-            input: repo.path().to_path_buf(),
-            ..Default::default()
-        };
-        let info = Info::new(&config).unwrap();
-        assert_json_snapshot!(
-            info,
-            {
-                ".gitVersion" => "git version",
-                ".head.short_commit_id" => "short commit"
-            }
-        );
-
-        // TEST FORMAT FUNCTION DEFAULT Config
-        let expected_regex = include_str!("../../tests/regex/test_verilog_repo.stdout.regex");
-        let re = Regex::new(&expected_regex).unwrap();
-        assert_info_str_matches(&config, &re);
-
-        // TEST FORMAT FUNCTION Config true_color Always
-        config.true_color = When::Always;
-        assert_info_str_matches(&config, &re);
-
-        // TEST FORMAT FUNCTION Config true_color Never
-        config.true_color = When::Never;
-        assert_info_str_matches(&config, &re);
-
-        // TEST FORMAT FUNCTION Config no_bots default regex
-        config.no_bots.replace(None);
-        assert_info_str_matches(&config, &re);
-
-        // TEST FORMAT FUNCTION Config no_bots user provided regex
-        config
-            .no_bots
-            .replace(Some(MyRegex(Regex::from_str(r"(b|B)ot")?)));
-        assert_info_str_matches(&config, &re);
-
-        Ok(())
-    }
 }

src/info/mod.rs

@@ -0,0 +1,12 @@
+#[cfg(test)]
+pub mod utils {
+    use anyhow::Result;
+    use git_repository::{open, Repository, ThreadSafeRepository};
+
+    pub fn repo(name: &str) -> Result<Repository> {
+        let name = name.to_string();
+        let repo_path = git_testtools::scripted_fixture_repo_read_only(name).unwrap();
+        let safe_repo = ThreadSafeRepository::open_opts(repo_path, open::Options::isolated())?;
+        Ok(safe_repo.to_thread_local())
+    }
+}

src/info/test.rs

@@ -84,23 +84,13 @@ impl std::fmt::Display for Title {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use git_repository::{open, Repository, ThreadSafeRepository};
-
+    use crate::info::test::utils::repo;
+    use anyhow::Result;
     use owo_colors::AnsiColors;
 
-    type Result<T = ()> = std::result::Result<T, Box<dyn std::error::Error>>;
-
-    fn basic_repo() -> Result<Repository> {
-        let name = "basic_repo.sh".to_string();
-        let repo_path = git_testtools::scripted_fixture_repo_read_only(name)?;
-        let safe_repo = ThreadSafeRepository::open_opts(repo_path, open::Options::isolated())?;
-        Ok(safe_repo.to_thread_local())
-    }
-
     #[test]
-    fn test_get_git_username() -> Result {
-        // See file ../tests/fixtures/basic_repo.sh for specific repo values
-        let repo = basic_repo()?;
+    fn test_get_git_username() -> Result<()> {
+        let repo = repo("basic_repo.sh")?;
         let username = get_git_username(&repo);
         assert_eq!(
             username, "onefetch-committer-name",
@@ -110,17 +100,16 @@ mod tests {
     }
 
     #[test]
-    fn test_title_format() -> Result {
-        let repo = basic_repo()?;
+    fn test_title_format() -> Result<()> {
+        let repo = repo("basic_repo.sh")?;
         let mut title = Title::new(
             &repo,
             DynColors::Ansi(AnsiColors::Red),
             DynColors::Ansi(AnsiColors::White),
             DynColors::Ansi(AnsiColors::Blue),
             true,
         );
-        // git version is collected from command line call to git --version
-        // setting git_version to known value
+
         title.git_version = "git version 2.37.2".to_string();
         assert!(title.to_string().contains("onefetch-committer-name"));
         assert!(title.to_string().contains('~'));

src/info/title.rs

@@ -0,0 +1,3 @@
+pub mod cli;
+pub mod info;
+pub mod ui;

src/lib.rs

@@ -2,16 +2,16 @@
 
 use anyhow::Result;
 use clap::{CommandFactory, Parser};
-use cli::Config;
-use info::Info;
+use onefetch::cli;
+use onefetch::info::Info;
+use onefetch::ui::printer::Printer;
 use std::io;
-use ui::printer::Printer;
 
 fn main() -> Result<()> {
     #[cfg(windows)]
     let _ = enable_ansi_support::enable_ansi_support();
 
-    let config = Config::parse();
+    let config = cli::Config::parse();
 
     if config.languages {
         return cli::print_supported_languages();
@@ -22,7 +22,7 @@ fn main() -> Result<()> {
     }
 
     if let Some(generator) = config.completion {
-        let mut cmd = Config::command();
+        let mut cmd = cli::Config::command();
         cli::print_completions(generator, &mut cmd);
         return Ok(());
     }
@@ -34,7 +34,3 @@ fn main() -> Result<()> {
 
     Ok(())
 }
-
-mod cli;
-mod info;
-mod ui;

src/main.rs

@@ -1,21 +1,6 @@
 #!/bin/bash
 set -eu -o pipefail
 
-case "${1}" in
-  verilog)
-      LANG_DIR="verilog"
-      LANG_EXT="vg"
-      ;;
-  *)
-      echo "OOPS, ARGUMENT EXPECTED TO BE ONE OF THESE VALUES:"
-      echo "  verilog  for language type verilog"
-      exit
-      ;;
-esac
-
-mkdir ${LANG_DIR}
-cd ${LANG_DIR}
-
 git init -q
 
 # BOTH NAME AND EMAIL ARE NEEDED FOR RECOGNITION
@@ -31,20 +16,20 @@ git config --local --add "author.email" "onefetch-author-email@onefetch.com"
 git remote add origin https://github.com/user/repo.git
 
 git checkout -b main
-touch code.${LANG_EXT}
-git add code.${LANG_EXT}
+touch code.rs
+git add code.rs
 git commit -q -m c1 --author="Author One <author1@example.org>"
 git tag tag1
-echo hello >> code.${LANG_EXT}
-git add code.${LANG_EXT}
+echo hello >> code.rs
+git add code.rs
 git commit -q -m c2 --author="Author Two <author2@example.org>"
-echo world >> code.${LANG_EXT}
-git add code.${LANG_EXT}
+echo world >> code.rs
+git add code.rs
 git commit -q -m c3 --author="Author Three <author3@example.org>"
-echo something >> code.${LANG_EXT}
-git add code.${LANG_EXT}
+echo something >> code.rs
+git add code.rs
 git commit -q -m c4 --author="Author Four <author4@example.org>"
-echo more >> code.${LANG_EXT}
+echo more >> code.rs
 
 echo "[dependencies]" > Cargo.toml
 echo 'anyhow = "1.0.65"' >> Cargo.toml