Add tests for state detection

Author: forivall

src/test_helpers/with_todo_file.rs

@@ -1,14 +1,23 @@
 //! Utilities for writing tests that interact with todo file
 use std::{
 	cell::RefCell,
+	io::Write,
 	fmt::{Debug, Formatter},
-	path::Path,
+	fs::File,
+	path::{Path, PathBuf},
 };
 
-use tempfile::{Builder, NamedTempFile};
+use tempfile::{Builder, NamedTempFile, TempDir};
 
 use crate::todo_file::{Line, TodoFile, TodoFileOptions};
 
+fn get_repo_dir() -> PathBuf {
+	Path::new(env!("CARGO_MANIFEST_DIR"))
+		.join("test")
+		.join("fixtures")
+		.join("simple")
+}
+
 /// Context for `with_todo_file`
 pub(crate) struct TodoFileTestContext {
 	todo_file: TodoFile,
@@ -76,10 +85,7 @@ impl TodoFileTestContext {
 /// Will panic if a temporary file cannot be created
 pub(crate) fn with_todo_file<C>(lines: &[&str], callback: C)
 where C: FnOnce(TodoFileTestContext) {
-	let git_repo_dir = Path::new(env!("CARGO_MANIFEST_DIR"))
-		.join("test")
-		.join("fixtures")
-		.join("simple");
+	let git_repo_dir = get_repo_dir();
 	let git_todo_file = Builder::new()
 		.prefix("git-rebase-todo-scratch")
 		.suffix("")
@@ -93,3 +99,136 @@ where C: FnOnce(TodoFileTestContext) {
 		todo_file,
 	});
 }
+
+
+/// Context for `with_todo_file`
+pub struct TodoFileTestDirContext {
+	todo_file: TodoFile,
+	git_todo_dir: RefCell<TempDir>,
+	git_todo_file: RefCell<File>,
+}
+
+impl Debug for TodoFileTestDirContext {
+	#[inline]
+	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+		f.debug_struct("TodoFileTestDirContext")
+			.field("todo_file", &self.todo_file)
+			.field("filepath", &self.todo_file.filepath)
+			.finish()
+	}
+}
+
+impl TodoFileTestDirContext {
+	/// Return the path of the todo file
+	#[inline]
+	pub fn path(&self) -> String {
+		String::from(self.todo_file.filepath.to_str().unwrap_or_default())
+	}
+
+	/// Return the path of the todo dir
+	#[inline]
+	pub fn dir_path(&self) -> String {
+		String::from(self.git_todo_dir.borrow().path().to_str().unwrap_or_default())
+	}
+
+	/// Get the todo file instance
+	#[inline]
+	pub const fn todo_file(&self) -> &TodoFile {
+		&self.todo_file
+	}
+
+	/// Get the todo file instance as mutable
+	#[inline]
+	pub fn todo_file_mut(&mut self) -> &mut TodoFile {
+		&mut self.todo_file
+	}
+
+	/// Get the todo file instance
+	#[inline]
+	pub fn to_owned(self) -> (TempDir, TodoFile) {
+		(self.git_todo_dir.into_inner(), self.todo_file)
+	}
+
+	/// Delete the path behind the todo dir
+	///
+	/// # Panics
+	/// Will panic if the dir cannot be deleted for any reason
+	#[inline]
+	pub fn delete_dir(&self) {
+		self.git_todo_dir
+			.replace(Builder::new().tempdir().unwrap())
+			.close()
+			.unwrap();
+	}
+
+	/// Set the path behind ot todo file as readonly
+	///
+	/// # Panics
+	/// Will panic if the file permissions cannot be changed for any reason
+	#[inline]
+	pub fn set_file_readonly(&self) {
+		let git_todo_file = self.git_todo_file.borrow_mut();
+		let mut permissions = git_todo_file.metadata().unwrap().permissions();
+		permissions.set_readonly(true);
+		git_todo_file.set_permissions(permissions).unwrap();
+	}
+}
+
+/// Provide a `TodoFileTestDirContext` instance containing a `Todo` for use in tests.
+///
+/// # Panics
+/// Will panic if a temporary file cannot be created
+#[inline]
+fn with_todo_file_dir<C>(prefix: &str, filename: &str, lines: &[&str], callback: C)
+where C: FnOnce(TodoFileTestDirContext) {
+	let git_repo_dir = get_repo_dir();
+	let git_todo_dir = Builder::new()
+		.prefix(prefix)
+		.suffix("")
+		.tempdir_in(git_repo_dir.as_path())
+		.unwrap();
+	let git_todo_file_path = git_todo_dir.path().join(filename);
+	let git_todo_file = File::create(git_todo_file_path.clone()).unwrap();
+
+	let mut todo_file = TodoFile::new(git_todo_file_path, TodoFileOptions::new(1, "#"));
+	todo_file.set_lines(lines.iter().map(|l| Line::parse(l).unwrap()).collect());
+	callback(TodoFileTestDirContext {
+		git_todo_dir: RefCell::new(git_todo_dir),
+		todo_file,
+		git_todo_file: RefCell::new(git_todo_file),
+	});
+}
+
+/// Provide a `TodoFileTestDirContext` instance containing a `Todo` for use in tests.
+///
+/// # Panics
+/// Will panic if a temporary file cannot be created
+#[inline]
+pub fn with_todo_revise_file<C>(lines: &[&str], callback: C)
+where C: FnOnce(TodoFileTestDirContext) {
+	with_todo_file_dir("revise.", "git-revise-todo", lines, callback)
+}
+
+/// Provide a `TodoFileTestDirContext` instance containing a `Todo` for use in tests.
+///
+/// # Panics
+/// Will panic if a temporary file cannot be created
+#[inline]
+pub fn with_todo_rebase_edit_file<C>(lines: &[&str], callback: C)
+where C: FnOnce(TodoFileTestDirContext) {
+	with_todo_file_dir("rebase-merge-scratch", "git-rebase-todo", lines, callback)
+}
+
+/// Provide a `TodoFileTestDirContext` instance containing a `Todo`, with a stopped-sha
+///
+/// # Panics
+/// Will panic if a temporary file cannot be created
+#[inline]
+pub fn with_todo_rebase_edit_file_stopped<C>(lines: &[&str], callback: C)
+where C: FnOnce(TodoFileTestDirContext) {
+	with_todo_rebase_edit_file(lines, |context| {
+		let mut stopped_sha = File::create(Path::new(context.dir_path().as_str()).join("stopped-sha")).unwrap();
+		writeln!(&mut stopped_sha, "this is a test file").unwrap();
+		callback(context);
+	});
+}

src/todo_file/state.rs

@@ -52,6 +52,7 @@ mod tests {
 	use rstest::rstest;
 
 	use super::*;
+	use crate::testutil::{with_todo_revise_file, TodoFileTestDirContext, with_todo_rebase_edit_file, with_todo_rebase_edit_file_stopped};
 
 	#[rstest]
 	#[case::edit(State::Initial, "initial")]
@@ -60,4 +61,22 @@ mod tests {
 	fn to_string(#[case] action: State, #[case] expected: &str) {
 		assert_eq!(format!("{action}"), expected);
 	}
+
+	#[rstest]
+	#[case::edit(State::Initial)]
+	#[case::edit(State::Edit)]
+	#[case::edit(State::Revise)]
+	fn detect(#[case] expected: State) {
+		let check = |context: TodoFileTestDirContext| {
+			assert_eq!(
+				detect_state(context.todo_file().filepath.as_path()).unwrap(),
+				expected
+			)
+		};
+		match expected {
+			State::Initial => with_todo_rebase_edit_file(&[], check),
+			State::Edit => with_todo_rebase_edit_file_stopped(&[], check),
+			State::Revise => with_todo_revise_file(&[], check),
+		}
+	}
 }