mirror of
https://github.com/tealdeer-rs/tealdeer.git
synced 2026-08-09 09:49:10 +02:00
Only create a single temporary directory in integration tests (#411)
This commit is contained in:
Nachiket Kanore
GitHub
parent
009af7063f
commit
c6de583c46
1 changed files with 50 additions and 65 deletions
115
tests/lib.rs
115
tests/lib.rs
|
|
@ -18,52 +18,60 @@ use tempfile::{Builder as TempfileBuilder, TempDir};
|
|||
pub static TLDR_PAGES_DIR: &str = "tldr-pages";
|
||||
|
||||
struct TestEnv {
|
||||
pub cache_dir: TempDir,
|
||||
pub custom_pages_dir: TempDir,
|
||||
pub config_dir: TempDir,
|
||||
_test_dir: TempDir,
|
||||
pub default_features: bool,
|
||||
pub features: Vec<String>,
|
||||
}
|
||||
|
||||
impl TestEnv {
|
||||
fn new() -> Self {
|
||||
let test_dir: TempDir = TempfileBuilder::new()
|
||||
.prefix(".tldr.test")
|
||||
.tempdir()
|
||||
.unwrap();
|
||||
|
||||
let this = TestEnv {
|
||||
cache_dir: TempfileBuilder::new()
|
||||
.prefix(".tldr.test.cache")
|
||||
.tempdir()
|
||||
.unwrap(),
|
||||
config_dir: TempfileBuilder::new()
|
||||
.prefix(".tldr.test.conf")
|
||||
.tempdir()
|
||||
.unwrap(),
|
||||
custom_pages_dir: TempfileBuilder::new()
|
||||
.prefix(".tldr.test.custom-pages")
|
||||
.tempdir()
|
||||
.unwrap(),
|
||||
_test_dir: test_dir,
|
||||
default_features: true,
|
||||
features: vec![],
|
||||
};
|
||||
|
||||
create_dir_all(&this.cache_dir()).unwrap();
|
||||
create_dir_all(&this.config_dir()).unwrap();
|
||||
create_dir_all(&this.custom_pages_dir()).unwrap();
|
||||
|
||||
this.append_to_config(format!(
|
||||
"directories.cache_dir = '{}'\n",
|
||||
this.cache_dir.path().to_str().unwrap(),
|
||||
this.cache_dir().to_str().unwrap(),
|
||||
));
|
||||
|
||||
this
|
||||
}
|
||||
|
||||
fn cache_dir(&self) -> PathBuf {
|
||||
self._test_dir.path().join(".cache")
|
||||
}
|
||||
|
||||
fn config_dir(&self) -> PathBuf {
|
||||
self._test_dir.path().join(".config")
|
||||
}
|
||||
|
||||
fn custom_pages_dir(&self) -> PathBuf {
|
||||
self._test_dir.path().join(".custom_pages")
|
||||
}
|
||||
|
||||
fn append_to_config(&self, content: impl AsRef<str>) {
|
||||
File::options()
|
||||
.create(true)
|
||||
.append(true)
|
||||
.open(self.config_dir.path().join("config.toml"))
|
||||
.open(self.config_dir().join("config.toml"))
|
||||
.expect("Failed to open config file")
|
||||
.write_all(content.as_ref().as_bytes())
|
||||
.expect("Failed to append to config file.");
|
||||
}
|
||||
|
||||
fn remove_initial_config(self) -> Self {
|
||||
let _ = fs::remove_file(self.config_dir.path().join("config.toml"));
|
||||
let _ = fs::remove_file(self.config_dir().join("config.toml"));
|
||||
self
|
||||
}
|
||||
|
||||
|
|
@ -74,12 +82,7 @@ impl TestEnv {
|
|||
|
||||
/// Add entry for that environment to an OS-specific subfolder.
|
||||
fn add_os_entry(&self, os: &str, name: &str, contents: &str) {
|
||||
let dir = self
|
||||
.cache_dir
|
||||
.path()
|
||||
.join(TLDR_PAGES_DIR)
|
||||
.join("pages")
|
||||
.join(os);
|
||||
let dir = self.cache_dir().join(TLDR_PAGES_DIR).join("pages").join(os);
|
||||
create_dir_all(&dir).unwrap();
|
||||
|
||||
fs::write(dir.join(format!("{name}.md")), contents.as_bytes()).unwrap();
|
||||
|
|
@ -87,14 +90,14 @@ impl TestEnv {
|
|||
|
||||
/// Add custom patch entry to the custom_pages_dir
|
||||
fn add_page_entry(&self, name: &str, contents: &str) {
|
||||
let dir = self.custom_pages_dir.path();
|
||||
let dir = &self.custom_pages_dir();
|
||||
create_dir_all(dir).unwrap();
|
||||
fs::write(dir.join(format!("{name}.page.md")), contents.as_bytes()).unwrap();
|
||||
}
|
||||
|
||||
/// Add custom patch entry to the custom_pages_dir
|
||||
fn add_patch_entry(&self, name: &str, contents: &str) {
|
||||
let dir = self.custom_pages_dir.path();
|
||||
let dir = &self.custom_pages_dir();
|
||||
create_dir_all(dir).unwrap();
|
||||
fs::write(dir.join(format!("{name}.patch.md")), contents.as_bytes()).unwrap();
|
||||
}
|
||||
|
|
@ -126,17 +129,14 @@ impl TestEnv {
|
|||
}
|
||||
let run = build.run().expect("Failed to build tealdeer for testing");
|
||||
let mut cmd = run.command();
|
||||
cmd.env(
|
||||
"TEALDEER_CONFIG_DIR",
|
||||
self.config_dir.path().to_str().unwrap(),
|
||||
);
|
||||
cmd.env("TEALDEER_CONFIG_DIR", self.config_dir().to_str().unwrap());
|
||||
cmd
|
||||
}
|
||||
|
||||
fn install_default_cache(self) -> Self {
|
||||
copy_recursively(
|
||||
&PathBuf::from_iter([env!("CARGO_MANIFEST_DIR"), "tests", "cache"]),
|
||||
&self.cache_dir.path().join(TLDR_PAGES_DIR),
|
||||
&self.cache_dir().join(TLDR_PAGES_DIR),
|
||||
)
|
||||
.expect("Failed to copy the cache to the test environment");
|
||||
|
||||
|
|
@ -146,7 +146,7 @@ impl TestEnv {
|
|||
fn install_default_custom_pages(self) -> Self {
|
||||
copy_recursively(
|
||||
&PathBuf::from_iter([env!("CARGO_MANIFEST_DIR"), "tests", "custom-pages"]),
|
||||
self.custom_pages_dir.path(),
|
||||
self.custom_pages_dir().as_path(),
|
||||
)
|
||||
.expect("Failed to copy the custom pages to the test environment");
|
||||
|
||||
|
|
@ -156,7 +156,7 @@ impl TestEnv {
|
|||
fn write_custom_pages_config(self) -> Self {
|
||||
self.append_to_config(format!(
|
||||
"directories.custom_pages_dir = '{}'\n",
|
||||
self.custom_pages_dir.path().to_str().unwrap()
|
||||
self.custom_pages_dir().to_str().unwrap()
|
||||
));
|
||||
|
||||
self
|
||||
|
|
@ -316,7 +316,7 @@ fn test_quiet_old_cache() {
|
|||
let testenv = TestEnv::new().install_default_cache();
|
||||
|
||||
filetime::set_file_mtime(
|
||||
testenv.cache_dir.path().join(TLDR_PAGES_DIR),
|
||||
testenv.cache_dir().join(TLDR_PAGES_DIR),
|
||||
filetime::FileTime::from_unix_time(1, 0),
|
||||
)
|
||||
.unwrap();
|
||||
|
|
@ -340,7 +340,7 @@ fn test_quiet_old_cache() {
|
|||
#[test]
|
||||
fn test_create_cache_directory_path() {
|
||||
let testenv = TestEnv::new().remove_initial_config();
|
||||
let cache_dir = testenv.cache_dir.path();
|
||||
let cache_dir = &testenv.cache_dir();
|
||||
let internal_cache_dir = cache_dir.join("internal");
|
||||
testenv.append_to_config(format!(
|
||||
"directories.cache_dir = '{}'\n",
|
||||
|
|
@ -368,7 +368,7 @@ fn test_create_cache_directory_path() {
|
|||
#[test]
|
||||
fn test_cache_location_not_a_directory() {
|
||||
let testenv = TestEnv::new().remove_initial_config();
|
||||
let cache_dir = testenv.cache_dir.path();
|
||||
let cache_dir = &testenv.cache_dir();
|
||||
let internal_file = cache_dir.join("internal");
|
||||
File::create(&internal_file).unwrap();
|
||||
|
||||
|
|
@ -391,7 +391,7 @@ fn test_cache_location_not_a_directory() {
|
|||
#[test]
|
||||
fn test_cache_location_source() {
|
||||
let testenv = TestEnv::new().remove_initial_config();
|
||||
let default_cache_dir = testenv.cache_dir.path();
|
||||
let default_cache_dir = &testenv.cache_dir();
|
||||
let tmp_cache_dir = TempfileBuilder::new()
|
||||
.prefix(".tldr.test.cache_dir")
|
||||
.tempdir()
|
||||
|
|
@ -447,7 +447,7 @@ fn test_setup_seed_config() {
|
|||
.success()
|
||||
.stderr(contains("Successfully created seed config file here"));
|
||||
|
||||
assert!(testenv.config_dir.path().join("config.toml").is_file());
|
||||
assert!(testenv.config_dir().join("config.toml").is_file());
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
|
@ -462,29 +462,19 @@ fn test_show_paths() {
|
|||
.success()
|
||||
.stdout(contains(format!(
|
||||
"Config dir: {}",
|
||||
testenv.config_dir.path().to_str().unwrap(),
|
||||
testenv.config_dir().to_str().unwrap(),
|
||||
)))
|
||||
.stdout(contains(format!(
|
||||
"Config path: {}",
|
||||
testenv
|
||||
.config_dir
|
||||
.path()
|
||||
.join("config.toml")
|
||||
.to_str()
|
||||
.unwrap(),
|
||||
testenv.config_dir().join("config.toml").to_str().unwrap(),
|
||||
)))
|
||||
.stdout(contains(format!(
|
||||
"Cache dir: {}",
|
||||
testenv.cache_dir.path().to_str().unwrap(),
|
||||
testenv.cache_dir().to_str().unwrap(),
|
||||
)))
|
||||
.stdout(contains(format!(
|
||||
"Pages dir: {}",
|
||||
testenv
|
||||
.cache_dir
|
||||
.path()
|
||||
.join(TLDR_PAGES_DIR)
|
||||
.to_str()
|
||||
.unwrap(),
|
||||
testenv.cache_dir().join(TLDR_PAGES_DIR).to_str().unwrap(),
|
||||
)));
|
||||
|
||||
let testenv = testenv.write_custom_pages_config();
|
||||
|
|
@ -497,7 +487,7 @@ fn test_show_paths() {
|
|||
.success()
|
||||
.stdout(contains(format!(
|
||||
"Custom pages dir: {}",
|
||||
testenv.custom_pages_dir.path().to_str().unwrap(),
|
||||
testenv.custom_pages_dir().to_str().unwrap(),
|
||||
)));
|
||||
}
|
||||
|
||||
|
|
@ -853,7 +843,7 @@ fn test_autoupdate_cache() {
|
|||
.failure()
|
||||
.stderr(contains("Page cache not found. Please run `tldr --update`"));
|
||||
|
||||
let cache_file_path = testenv.cache_dir.path().join(TLDR_PAGES_DIR);
|
||||
let cache_file_path = testenv.cache_dir().join(TLDR_PAGES_DIR);
|
||||
|
||||
testenv
|
||||
.append_to_config("updates.auto_update = true\nupdates.auto_update_interval_hours = 24\n");
|
||||
|
|
@ -1006,8 +996,7 @@ fn test_raw_render_file() {
|
|||
let testenv = TestEnv::new().install_default_cache();
|
||||
|
||||
let path = testenv
|
||||
.cache_dir
|
||||
.path()
|
||||
.cache_dir()
|
||||
.join(TLDR_PAGES_DIR)
|
||||
.join("pages/common/inkscape-v1.md");
|
||||
let mut args = vec!["--color", "never", "-f", &path.to_str().unwrap()];
|
||||
|
|
@ -1041,7 +1030,7 @@ fn touch_custom_page(testenv: &TestEnv) {
|
|||
.env("EDITOR", "touch")
|
||||
.assert()
|
||||
.success();
|
||||
assert!(testenv.custom_pages_dir.path().join("foo.page.md").exists());
|
||||
assert!(testenv.custom_pages_dir().join("foo.page.md").exists());
|
||||
}
|
||||
|
||||
fn touch_custom_patch(testenv: &TestEnv) {
|
||||
|
|
@ -1053,11 +1042,7 @@ fn touch_custom_patch(testenv: &TestEnv) {
|
|||
.env("EDITOR", "touch")
|
||||
.assert()
|
||||
.success();
|
||||
assert!(testenv
|
||||
.custom_pages_dir
|
||||
.path()
|
||||
.join("foo.patch.md")
|
||||
.exists());
|
||||
assert!(testenv.custom_pages_dir().join("foo.patch.md").exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
|
@ -1082,9 +1067,9 @@ fn test_recreate_dir() {
|
|||
#[test]
|
||||
fn test_custom_pages_dir_is_not_dir() {
|
||||
let testenv = TestEnv::new().write_custom_pages_config();
|
||||
let _ = std::fs::remove_dir_all(testenv.custom_pages_dir.path());
|
||||
let _ = File::create(testenv.custom_pages_dir.path()).unwrap();
|
||||
assert!(testenv.custom_pages_dir.path().is_file());
|
||||
let _ = std::fs::remove_dir_all(testenv.custom_pages_dir());
|
||||
let _ = File::create(testenv.custom_pages_dir()).unwrap();
|
||||
assert!(testenv.custom_pages_dir().is_file());
|
||||
|
||||
let args = vec!["--edit-patch", "foo"];
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue