debian_workbench/

editor.rs

//! Editing files
use breezyshim::error::Error as BrzError;
use breezyshim::tree::MutableTree;
use std::borrow::Cow;
use std::io::BufRead;
use std::path::PathBuf;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
/// The type of template used to generate a file.
pub enum TemplateType {
    /// M4 template
    M4,
}

#[derive(Debug, Clone, PartialEq, Eq)]
/// Error indicating that a file is generated from another file.
pub struct GeneratedFile {
    /// The path to the template file
    pub template_path: Option<PathBuf>,

    /// The type of template
    pub template_type: Option<TemplateType>,
}

impl std::fmt::Display for GeneratedFile {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "File is generated")?;
        if let Some(template_path) = &self.template_path {
            write!(f, " from {}", template_path.display())?;
        }
        Ok(())
    }
}

impl std::error::Error for GeneratedFile {}

#[derive(Clone, PartialEq, Eq)]
/// Error indicating that formatting could not be preserved.
pub struct FormattingUnpreservable {
    /// The original contents of the file
    original_contents: Option<Vec<u8>>,

    /// The contents rewritten with our parser/serializer
    rewritten_contents: Option<Vec<u8>>,
}

impl std::fmt::Debug for FormattingUnpreservable {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("FormattingUnpreservable")
            .field(
                "original_contents",
                &self
                    .original_contents
                    .as_deref()
                    .map(|x| std::str::from_utf8(x)),
            )
            .field(
                "rewritten_contents",
                &self
                    .rewritten_contents
                    .as_deref()
                    .map(|x| std::str::from_utf8(x)),
            )
            .finish()
    }
}

impl std::fmt::Display for FormattingUnpreservable {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "Unable to preserve formatting",)
    }
}

impl std::error::Error for FormattingUnpreservable {}

impl FormattingUnpreservable {
    /// Get a unified diff of the original and rewritten contents.
    pub fn diff(&self) -> Vec<String> {
        let original_lines = std::str::from_utf8(self.original_contents.as_deref().unwrap_or(b""))
            .unwrap()
            .split_inclusive('\n')
            .collect::<Vec<_>>();
        let rewritten_lines =
            std::str::from_utf8(self.rewritten_contents.as_deref().unwrap_or(b""))
                .unwrap()
                .split_inclusive('\n')
                .collect::<Vec<_>>();

        difflib::unified_diff(
            original_lines.as_slice(),
            rewritten_lines.as_slice(),
            "original",
            "rewritten",
            "",
            "",
            3,
        )
    }
}

/// Check that formatting can be preserved.
///
/// # Arguments
/// * `rewritten_text` - The rewritten file contents
/// * `text` - The original file contents
/// * `allow_reformatting` - Whether to allow reformatting
fn check_preserve_formatting(
    rewritten_text: Option<&[u8]>,
    text: Option<&[u8]>,
    allow_reformatting: bool,
) -> Result<(), FormattingUnpreservable> {
    if allow_reformatting {
        return Ok(());
    }
    if rewritten_text == text {
        return Ok(());
    }
    Err(FormattingUnpreservable {
        original_contents: text.map(|x| x.to_vec()),
        rewritten_contents: rewritten_text.map(|x| x.to_vec()),
    })
}

/// Number of lines to scan for generated file indicators.
pub const DO_NOT_EDIT_SCAN_LINES: usize = 20;

fn check_generated_contents(bufread: &mut dyn BufRead) -> Result<(), GeneratedFile> {
    for l in bufread.lines().take(DO_NOT_EDIT_SCAN_LINES) {
        let l = if let Ok(l) = l { l } else { continue };
        if l.contains("DO NOT EDIT")
            || l.contains("Do not edit!")
            || l.contains("This file is autogenerated")
        {
            return Err(GeneratedFile {
                template_path: None,
                template_type: None,
            });
        }
    }
    Ok(())
}

/// List of extensions for template files.
pub const GENERATED_EXTENSIONS: &[&str] = &["in", "m4", "stub"];

fn check_template_exists(path: &std::path::Path) -> Option<(PathBuf, Option<TemplateType>)> {
    for ext in GENERATED_EXTENSIONS {
        let template_path = path.with_extension(ext);
        if template_path.exists() {
            return Some((
                template_path,
                match ext {
                    &"m4" => Some(TemplateType::M4),
                    _ => None,
                },
            ));
        }
    }
    None
}

fn tree_check_template_exists(
    tree: &dyn MutableTree,
    path: &std::path::Path,
) -> Option<(PathBuf, Option<TemplateType>)> {
    for ext in GENERATED_EXTENSIONS {
        let template_path = path.with_extension(ext);
        if tree.has_filename(&template_path) {
            return Some((
                template_path,
                match ext {
                    &"m4" => Some(TemplateType::M4),
                    _ => None,
                },
            ));
        }
    }
    None
}

/// Check if a file is generated from another file.
///
/// # Arguments
/// * `path` - Path to the file to check
///
/// # Errors
/// * `GeneratedFile` - when a generated file is found
pub fn check_generated_file(path: &std::path::Path) -> Result<(), GeneratedFile> {
    if let Some((template_path, template_type)) = check_template_exists(path) {
        return Err(GeneratedFile {
            template_path: Some(template_path),
            template_type,
        });
    }

    match std::fs::File::open(path) {
        Ok(f) => {
            let mut buf = std::io::BufReader::new(f);
            check_generated_contents(&mut buf)?;
        }
        Err(e) if e.kind() == std::io::ErrorKind::NotFound => {}
        Err(e) => panic!("Error reading file: {}", e),
    }
    Ok(())
}

/// Check if a file is generated from another file.
///
/// # Arguments
/// * `path` - Path to the file to check
///
/// # Errors
/// * `GeneratedFile` - when a generated file is found
pub fn tree_check_generated_file(
    tree: &dyn MutableTree,
    path: &std::path::Path,
) -> Result<(), GeneratedFile> {
    if let Some((template_path, template_type)) = tree_check_template_exists(tree, path) {
        return Err(GeneratedFile {
            template_path: Some(template_path),
            template_type,
        });
    }

    match tree.get_file(path) {
        Ok(f) => {
            let mut buf = std::io::BufReader::new(f);
            check_generated_contents(&mut buf)?;
        }
        Err(BrzError::NoSuchFile(..)) => {}
        Err(e) => panic!("Error reading file: {}", e),
    }
    Ok(())
}

#[derive(Debug)]
/// Error that can occur when editing a file.
pub enum EditorError<E: std::error::Error> {
    /// One of the files is generated from another file, and we were unable to edit it.
    GeneratedFile(PathBuf, GeneratedFile),

    /// Error in a template file
    TemplateError(PathBuf, String),

    /// Unable to preserve formatting in a file.
    FormattingUnpreservable(PathBuf, FormattingUnpreservable),

    /// I/O error
    IoError(std::io::Error),

    /// Breezy error
    BrzError(BrzError),

    /// UTF-8 encoding error
    Utf8Error(std::str::Utf8Error),

    /// Error parsing or marshalling file contents
    MarshallingError(E),
}

impl<E: std::error::Error> From<BrzError> for EditorError<E> {
    fn from(e: BrzError) -> Self {
        EditorError::BrzError(e)
    }
}

impl<E: std::error::Error> std::fmt::Display for EditorError<E> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            EditorError::GeneratedFile(p, _e) => {
                write!(f, "File {} is generated from another file", p.display())
            }
            EditorError::FormattingUnpreservable(p, _e) => {
                write!(f, "Unable to preserve formatting in {}", p.display())
            }
            EditorError::IoError(e) => write!(f, "I/O error: {}", e),
            EditorError::BrzError(e) => write!(f, "Breezy error: {}", e),
            EditorError::TemplateError(p, e) => {
                write!(f, "Error in template {}: {}", p.display(), e)
            }
            EditorError::Utf8Error(e) => write!(f, "UTF-8 error: {}", e),
            EditorError::MarshallingError(e) => write!(f, "Marshalling error: {}", e),
        }
    }
}

impl<E: std::error::Error> std::error::Error for EditorError<E> {}

impl<E: std::error::Error> From<std::io::Error> for EditorError<E> {
    fn from(e: std::io::Error) -> Self {
        EditorError::IoError(e)
    }
}

impl<E: std::error::Error> From<std::str::Utf8Error> for EditorError<E> {
    fn from(e: std::str::Utf8Error) -> Self {
        EditorError::Utf8Error(e)
    }
}

#[cfg(feature = "merge3")]
/// Update a file with a three-way merge.
fn update_with_merge3(
    original_contents: &[u8],
    rewritten_contents: &[u8],
    updated_contents: &[u8],
) -> Option<Vec<u8>> {
    let rewritten_lines = rewritten_contents
        .split_inclusive(|&x| x == b'\n')
        .collect::<Vec<_>>();
    let original_lines = original_contents
        .split_inclusive(|&x| x == b'\n')
        .collect::<Vec<_>>();
    let updated_lines = updated_contents
        .split_inclusive(|&x| x == b'\n')
        .collect::<Vec<_>>();
    let m3 = merge3::Merge3::new(
        rewritten_lines.as_slice(),
        original_lines.as_slice(),
        updated_lines.as_slice(),
    );
    if m3
        .merge_regions()
        .iter()
        .any(|x| matches!(x, merge3::MergeRegion::Conflict { .. }))
    {
        return None;
    }
    Some(
        m3.merge_lines(false, &merge3::StandardMarkers::default())
            .concat(),
    )
}

/// Reformat a file.
///
/// # Arguments
/// * `original_contents` - The original contents of the file
/// * `rewritten_contents` - The contents rewritten with our parser/serializer
/// * `updated_contents` - Updated contents rewritten with our parser/serializer after changes were
///  made
///  * `allow_reformatting` - Whether to allow reformatting of the file
///
///  # Returns
///  A tuple with the new contents and a boolean indicating whether the file was changed`
fn reformat_file<'a>(
    original_contents: Option<&'a [u8]>,
    rewritten_contents: Option<&'a [u8]>,
    updated_contents: Option<&'a [u8]>,
    allow_reformatting: bool,
) -> Result<(Option<Cow<'a, [u8]>>, bool), FormattingUnpreservable> {
    if updated_contents == rewritten_contents || updated_contents == original_contents {
        return Ok((updated_contents.map(Cow::Borrowed), false));
    }
    #[allow(unused_mut)]
    let mut updated_contents = updated_contents.map(std::borrow::Cow::Borrowed);
    match check_preserve_formatting(rewritten_contents, original_contents, allow_reformatting) {
        Ok(()) => {}
        Err(e) => {
            if rewritten_contents.is_none()
                || original_contents.is_none()
                || updated_contents.is_none()
            {
                return Err(e);
            }
            #[cfg(feature = "merge3")]
            {
                // Run three way merge
                log::debug!("Unable to preserve formatting; falling back to merge3");
                updated_contents = Some(std::borrow::Cow::Owned(
                    if let Some(lines) = update_with_merge3(
                        original_contents.unwrap(),
                        rewritten_contents.unwrap(),
                        updated_contents.unwrap().as_ref(),
                    ) {
                        lines
                    } else {
                        return Err(e);
                    },
                ));
            }
            #[cfg(not(feature = "merge3"))]
            {
                log::debug!("Unable to preserve formatting; merge3 feature not enabled");
                return Err(e);
            }
        }
    }

    Ok((updated_contents, true))
}

/// Edit a formatted file.
///
/// # Arguments
/// * `path` - Path to the file
/// * `original_contents` - The original contents of the file
/// * `rewritten_contents` - The contents rewritten with our parser/serializer
/// * `updated_contents` - Updated contents rewritten with our parser/serializer after changes were
///   made
/// * `allow_generated` - Do not raise `GeneratedFile` when encountering a generated file
/// * `allow_reformatting` - Whether to allow reformatting of the file
///
/// # Returns
/// `true` if the file was changed, `false` otherwise
pub fn edit_formatted_file<E: std::error::Error>(
    path: &std::path::Path,
    original_contents: Option<&[u8]>,
    rewritten_contents: Option<&[u8]>,
    updated_contents: Option<&[u8]>,
    allow_generated: bool,
    allow_reformatting: bool,
) -> Result<bool, EditorError<E>> {
    if original_contents == updated_contents {
        return Ok(false);
    }
    let (updated_contents, changed) = reformat_file(
        original_contents,
        rewritten_contents,
        updated_contents,
        allow_reformatting,
    )
    .map_err(|e| EditorError::FormattingUnpreservable(path.to_path_buf(), e))?;
    if changed && !allow_generated {
        check_generated_file(path)
            .map_err(|e| EditorError::GeneratedFile(path.to_path_buf(), e))?;
    }

    if changed {
        if let Some(updated_contents) = updated_contents {
            std::fs::write(path, updated_contents)?;
        } else {
            std::fs::remove_file(path)?;
        }
    }
    Ok(changed)
}

/// Edit a formatted file in a tree.
///
/// # Arguments
/// * `tree` - The tree to edit
/// * `path` - Path to the file
/// * `original_contents` - The original contents of the file
/// * `rewritten_contents` - The contents rewritten with our parser/serializer
/// * `updated_contents` - Updated contents rewritten with our parser/serializer after changes were
///   made
/// * `allow_generated` - Do not raise `GeneratedFile` when encountering a generated file
/// * `allow_reformatting` - Whether to allow reformatting of the file
///
/// # Returns
/// `true` if the file was changed, `false` otherwise
pub fn tree_edit_formatted_file<E: std::error::Error>(
    tree: &dyn MutableTree,
    path: &std::path::Path,
    original_contents: Option<&[u8]>,
    rewritten_contents: Option<&[u8]>,
    updated_contents: Option<&[u8]>,
    allow_generated: bool,
    allow_reformatting: bool,
) -> Result<bool, EditorError<E>> {
    assert!(path.is_relative());
    if original_contents == updated_contents {
        return Ok(false);
    }
    if !allow_generated {
        tree_check_generated_file(tree, path)
            .map_err(|e| EditorError::GeneratedFile(path.to_path_buf(), e))?;
    }

    let (updated_contents, changed) = reformat_file(
        original_contents,
        rewritten_contents,
        updated_contents,
        allow_reformatting,
    )
    .map_err(|e| EditorError::FormattingUnpreservable(path.to_path_buf(), e))?;
    if changed {
        if let Some(updated_contents) = updated_contents {
            tree.put_file_bytes_non_atomic(path, updated_contents.as_ref())?;
            tree.add(&[path])?;
        } else if tree.has_filename(path) {
            tree.remove(&[path])?;
        }
    }
    Ok(changed)
}

/// A trait for types that can be edited
pub trait Marshallable {
    /// The error type returned when parsing fails
    type Error: std::error::Error + Send + Sync + 'static;

    /// Parse the contents of a file
    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error>
    where
        Self: Sized;

    /// Create an empty instance
    fn empty() -> Self;

    /// Serialize the contents of a file
    fn to_bytes(&self) -> Option<Vec<u8>>;

    /// Create a snapshot of the current state
    fn snapshot(&self) -> Self;

    /// Check if the current state has changed compared to another state
    fn has_changed(&self, other: &Self) -> bool;
}

/// An editor for a file
pub trait Editor<P: Marshallable>:
    std::ops::Deref<Target = P> + std::ops::DerefMut<Target = P>
{
    /// The original content, if any - without reformatting
    fn orig_content(&self) -> Option<&[u8]>;

    /// The updated content, if any
    fn updated_content(&self) -> Option<Vec<u8>>;

    /// The original content, but rewritten with our parser/serializer
    fn rewritten_content(&self) -> Option<&[u8]>;

    /// Whether the file has changed
    fn has_changed(&self) -> bool {
        self.updated_content().as_deref() != self.rewritten_content()
    }

    /// Check if the file is generated
    fn is_generated(&self) -> bool;

    /// Commit the changes
    ///
    /// # Returns
    /// A list of paths that were changed
    fn commit(&mut self) -> Result<Vec<std::path::PathBuf>, EditorError<P::Error>>;

    /// Revert the changes to the original state
    ///
    /// # Errors
    /// Returns an error if reverting fails (e.g., I/O error, parsing error)
    fn revert(&mut self) -> Result<(), EditorError<P::Error>>;
}

/// Allow calling .edit_file("debian/control") on a tree
pub trait MutableTreeEdit {
    /// Edit a file in a tree
    fn edit_file<P: Marshallable>(
        &self,
        path: &std::path::Path,
        allow_generated: bool,
        allow_reformatting: bool,
    ) -> Result<TreeEditor<'_, P>, EditorError<P::Error>>;
}

impl<T: MutableTree> MutableTreeEdit for T {
    fn edit_file<P: Marshallable>(
        &self,
        path: &std::path::Path,
        allow_generated: bool,
        allow_reformatting: bool,
    ) -> Result<TreeEditor<'_, P>, EditorError<P::Error>> {
        TreeEditor::new(self, path, allow_generated, allow_reformatting)
    }
}

/// An editor for a file in a breezy tree
pub struct TreeEditor<'a, P: Marshallable> {
    tree: &'a dyn MutableTree,
    path: PathBuf,
    orig_content: Option<Vec<u8>>,
    rewritten_content: Option<Vec<u8>>,
    allow_generated: bool,
    allow_reformatting: bool,
    parsed: Option<P>,
    parsed_base: Option<P>,
}

impl<P: Marshallable> std::ops::Deref for TreeEditor<'_, P> {
    type Target = P;

    fn deref(&self) -> &Self::Target {
        self.parsed.as_ref().unwrap()
    }
}

impl<P: Marshallable> std::ops::DerefMut for TreeEditor<'_, P> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.parsed.as_mut().unwrap()
    }
}

impl<'a, P: Marshallable> TreeEditor<'a, P> {
    /// Create a new editor, with preferences being read from the environment
    pub fn from_env(
        tree: &'a dyn MutableTree,
        path: &std::path::Path,
        allow_generated: bool,
        allow_reformatting: Option<bool>,
    ) -> Result<Self, EditorError<P::Error>> {
        let allow_reformatting = allow_reformatting.unwrap_or_else(|| {
            std::env::var("REFORMATTING").unwrap_or("disallow".to_string()) == "allow"
        });

        Self::new(tree, path, allow_generated, allow_reformatting)
    }

    /// Read the file contents and parse them
    fn read(&mut self) -> Result<(), EditorError<P::Error>> {
        self.orig_content = match self.tree.get_file_text(&self.path) {
            Ok(c) => Some(c),
            Err(BrzError::NoSuchFile(..)) => None,
            Err(e) => return Err(e.into()),
        };
        self.parsed = match self.orig_content.as_deref() {
            Some(content) => Some(P::from_bytes(content).map_err(EditorError::MarshallingError)?),
            None => Some(P::empty()),
        };
        self.parsed_base = self.parsed.as_ref().map(|p| p.snapshot());
        self.rewritten_content = self.parsed.as_ref().unwrap().to_bytes();
        Ok(())
    }

    /// Create a new editor
    pub fn new(
        tree: &'a dyn MutableTree,
        path: &std::path::Path,
        allow_generated: bool,
        allow_reformatting: bool,
    ) -> Result<Self, EditorError<P::Error>> {
        assert!(path.is_relative());
        let mut ret = Self {
            tree,
            path: path.to_path_buf(),
            orig_content: None,
            rewritten_content: None,
            allow_generated,
            allow_reformatting,
            parsed: None,
            parsed_base: None,
        };
        ret.read()?;
        Ok(ret)
    }
}

impl<P: Marshallable> Editor<P> for TreeEditor<'_, P> {
    fn orig_content(&self) -> Option<&[u8]> {
        self.orig_content.as_deref()
    }

    fn updated_content(&self) -> Option<Vec<u8>> {
        self.parsed.as_ref().unwrap().to_bytes()
    }

    fn rewritten_content(&self) -> Option<&[u8]> {
        self.rewritten_content.as_deref()
    }

    fn commit(&mut self) -> Result<Vec<std::path::PathBuf>, EditorError<P::Error>> {
        let updated_content = self.updated_content();

        let changed = tree_edit_formatted_file(
            self.tree,
            &self.path,
            self.orig_content.as_deref(),
            self.rewritten_content.as_deref(),
            updated_content.as_deref(),
            self.allow_generated,
            self.allow_reformatting,
        )?;
        if changed {
            self.parsed_base = self.parsed.as_ref().map(|p| p.snapshot());
            self.orig_content = updated_content.clone();
            self.rewritten_content = updated_content;
            Ok(vec![self.path.clone()])
        } else {
            Ok(vec![])
        }
    }

    fn is_generated(&self) -> bool {
        tree_check_generated_file(self.tree, &self.path).is_ok() || {
            let mut buf =
                std::io::BufReader::new(std::io::Cursor::new(self.orig_content().unwrap()));
            check_generated_contents(&mut buf).is_err()
        }
    }

    fn revert(&mut self) -> Result<(), EditorError<P::Error>> {
        if let Some(base) = &self.parsed_base {
            self.parsed = Some(base.snapshot());
        }
        Ok(())
    }
}

/// An editor for a file
pub struct FsEditor<P: Marshallable> {
    path: PathBuf,
    orig_content: Option<Vec<u8>>,
    rewritten_content: Option<Vec<u8>>,
    allow_generated: bool,
    allow_reformatting: bool,
    parsed: Option<P>,
    parsed_base: Option<P>,
}

impl<M: Marshallable> std::ops::Deref for FsEditor<M> {
    type Target = M;

    fn deref(&self) -> &Self::Target {
        self.parsed.as_ref().unwrap()
    }
}

impl<M: Marshallable> std::ops::DerefMut for FsEditor<M> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.parsed.as_mut().unwrap()
    }
}

impl<P: Marshallable> FsEditor<P> {
    /// Create a new editor, with preferences being read from the environment
    pub fn from_env(
        path: &std::path::Path,
        allow_generated: bool,
        allow_reformatting: Option<bool>,
    ) -> Result<Self, EditorError<P::Error>> {
        let allow_reformatting = allow_reformatting.unwrap_or_else(|| {
            std::env::var("REFORMATTING").unwrap_or("disallow".to_string()) == "allow"
        });

        Self::new(path, allow_generated, allow_reformatting)
    }

    /// Read the file contents and parse them
    fn read(&mut self) -> Result<(), EditorError<P::Error>> {
        self.orig_content = match std::fs::read(&self.path) {
            Ok(c) => Some(c),
            Err(e) if e.kind() == std::io::ErrorKind::NotFound => None,
            Err(e) => return Err(e.into()),
        };
        self.parsed = match self.orig_content.as_deref() {
            Some(content) => Some(P::from_bytes(content).map_err(EditorError::MarshallingError)?),
            None => Some(P::empty()),
        };
        self.parsed_base = self.parsed.as_ref().map(|p| p.snapshot());
        self.rewritten_content = self.parsed.as_ref().unwrap().to_bytes();
        Ok(())
    }

    /// Create a new editor
    pub fn new(
        path: &std::path::Path,
        allow_generated: bool,
        allow_reformatting: bool,
    ) -> Result<Self, EditorError<P::Error>> {
        let mut ret = Self {
            path: path.to_path_buf(),
            orig_content: None,
            rewritten_content: None,
            allow_generated,
            allow_reformatting,
            parsed: None,
            parsed_base: None,
        };
        ret.read()?;
        Ok(ret)
    }
}

impl<P: Marshallable> Editor<P> for FsEditor<P> {
    fn orig_content(&self) -> Option<&[u8]> {
        self.orig_content.as_deref()
    }

    fn updated_content(&self) -> Option<Vec<u8>> {
        self.parsed.as_ref().unwrap().to_bytes()
    }

    fn rewritten_content(&self) -> Option<&[u8]> {
        self.rewritten_content.as_deref()
    }

    fn is_generated(&self) -> bool {
        check_template_exists(&self.path).is_some() || {
            let mut buf =
                std::io::BufReader::new(std::io::Cursor::new(self.orig_content().unwrap()));
            check_generated_contents(&mut buf).is_err()
        }
    }

    fn commit(&mut self) -> Result<Vec<std::path::PathBuf>, EditorError<P::Error>> {
        let updated_content = self.updated_content();

        let changed = edit_formatted_file(
            &self.path,
            self.orig_content.as_deref(),
            self.rewritten_content.as_deref(),
            updated_content.as_deref(),
            self.allow_generated,
            self.allow_reformatting,
        )?;
        if changed {
            self.parsed_base = self.parsed.as_ref().map(|p| p.snapshot());
            self.orig_content = updated_content.clone();
            self.rewritten_content = updated_content;
            Ok(vec![self.path.clone()])
        } else {
            Ok(vec![])
        }
    }

    fn revert(&mut self) -> Result<(), EditorError<P::Error>> {
        if let Some(base) = &self.parsed_base {
            self.parsed = Some(base.snapshot());
        }
        Ok(())
    }
}

impl Marshallable for debian_control::Control {
    type Error = deb822_lossless::Error;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        debian_control::Control::read_relaxed(std::io::Cursor::new(content))
            .map(|(control, _)| control)
    }

    fn empty() -> Self {
        debian_control::Control::new()
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        self.source()?;
        Some(self.to_string().into_bytes())
    }

    fn snapshot(&self) -> Self {
        debian_control::Control::snapshot(self)
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

impl Marshallable for debian_changelog::ChangeLog {
    type Error = debian_changelog::Error;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        debian_changelog::ChangeLog::read_relaxed(std::io::Cursor::new(content))
    }

    fn empty() -> Self {
        debian_changelog::ChangeLog::new()
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        Some(self.to_string().into_bytes())
    }

    fn snapshot(&self) -> Self {
        self.clone()
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

impl Marshallable for debian_copyright::lossless::Copyright {
    type Error = debian_copyright::lossless::Error;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        let s = std::str::from_utf8(content).unwrap();
        debian_copyright::lossless::Copyright::from_str_relaxed(s).map(|(copyright, _)| copyright)
    }

    fn empty() -> Self {
        debian_copyright::lossless::Copyright::new()
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        Some(self.to_string().into_bytes())
    }

    fn snapshot(&self) -> Self {
        self.clone()
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

impl Marshallable for makefile_lossless::Makefile {
    type Error = makefile_lossless::Error;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        makefile_lossless::Makefile::read_relaxed(std::io::Cursor::new(content))
    }

    fn empty() -> Self {
        makefile_lossless::Makefile::new()
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        Some(self.to_string().into_bytes())
    }

    fn snapshot(&self) -> Self {
        self.clone()
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

impl Marshallable for deb822_lossless::Deb822 {
    type Error = deb822_lossless::Error;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        deb822_lossless::Deb822::read_relaxed(std::io::Cursor::new(content))
            .map(|(deb822, _)| deb822)
            .map_err(deb822_lossless::Error::from)
    }

    fn empty() -> Self {
        deb822_lossless::Deb822::new()
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        Some(self.to_string().into_bytes())
    }

    fn snapshot(&self) -> Self {
        self.clone()
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

impl Marshallable for crate::maintscripts::Maintscript {
    type Error = crate::maintscripts::ParseError;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        use std::str::FromStr;
        let content = std::str::from_utf8(content).unwrap();
        crate::maintscripts::Maintscript::from_str(content)
    }

    fn empty() -> Self {
        crate::maintscripts::Maintscript::new()
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        if self.is_empty() {
            None
        } else {
            Some(self.to_string().into_bytes())
        }
    }

    fn snapshot(&self) -> Self {
        self.clone()
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

impl Marshallable for debian_watch::WatchFile {
    type Error = std::convert::Infallible;

    fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
        let content = std::str::from_utf8(content).unwrap();
        Ok(debian_watch::WatchFile::from_str_relaxed(content))
    }

    fn empty() -> Self {
        debian_watch::WatchFile::new(Some(4))
    }

    fn to_bytes(&self) -> Option<Vec<u8>> {
        Some(self.to_string().into_bytes())
    }

    fn snapshot(&self) -> Self {
        self.clone()
    }

    fn has_changed(&self, other: &Self) -> bool {
        self != other
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn test_formatting_same() {
        assert_eq!(
            Ok(()),
            check_preserve_formatting(Some(b"FOO  "), Some(b"FOO  "), false)
        );
    }

    #[test]
    fn test_formatting_different() {
        assert_eq!(
            Err(FormattingUnpreservable {
                original_contents: Some("FOO \n".as_bytes().to_vec()),
                rewritten_contents: Some("FOO  \n".as_bytes().to_vec()),
            }),
            check_preserve_formatting(Some(b"FOO  \n"), Some(b"FOO \n"), false)
        );
    }

    #[test]
    fn test_diff() {
        let e = FormattingUnpreservable {
            original_contents: Some(b"FOO X\n".to_vec()),
            rewritten_contents: Some(b"FOO  X\n".to_vec()),
        };
        assert_eq!(
            e.diff(),
            vec![
                "--- original\t\n",
                "+++ rewritten\t\n",
                "@@ -1 +1 @@\n",
                "-FOO X\n",
                "+FOO  X\n",
            ]
        );
    }

    #[test]
    fn test_reformatting_allowed() {
        assert_eq!(
            Ok(()),
            check_preserve_formatting(Some(b"FOO  "), Some(b"FOO "), true)
        );
    }

    #[test]
    fn test_generated_control_file() {
        let td = tempfile::tempdir().unwrap();
        std::fs::create_dir(td.path().join("debian")).unwrap();
        std::fs::write(td.path().join("debian/control.in"), "Source: blah\n").unwrap();
        assert_eq!(
            Err(GeneratedFile {
                template_path: Some(td.path().join("debian/control.in")),
                template_type: None,
            }),
            check_generated_file(&td.path().join("debian/control"))
        );
    }

    #[test]
    fn test_generated_file_missing() {
        let td = tempfile::tempdir().unwrap();
        std::fs::create_dir(td.path().join("debian")).unwrap();
        assert_eq!(
            Ok(()),
            check_generated_file(&td.path().join("debian/control"))
        );
    }

    #[test]
    fn test_do_not_edit() {
        let td = tempfile::tempdir().unwrap();
        std::fs::create_dir(td.path().join("debian")).unwrap();
        std::fs::write(
            td.path().join("debian/control"),
            "# DO NOT EDIT\nSource: blah\n",
        )
        .unwrap();
        assert_eq!(
            Err(GeneratedFile {
                template_path: None,
                template_type: None,
            }),
            check_generated_file(&td.path().join("debian/control"))
        );
    }

    #[test]
    fn test_do_not_edit_after_header() {
        // check_generated_file() only checks the first 20 lines.
        let td = tempfile::tempdir().unwrap();
        std::fs::create_dir(td.path().join("debian")).unwrap();
        std::fs::write(
            td.path().join("debian/control"),
            "\n".repeat(50) + "# DO NOT EDIT\nSource: blah\n",
        )
        .unwrap();
        assert_eq!(
            Ok(()),
            check_generated_file(&td.path().join("debian/control"))
        );
    }

    #[test]
    fn test_unchanged() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "some content\n").unwrap();
        assert!(!edit_formatted_file::<std::convert::Infallible>(
            &td.path().join("a"),
            Some("some content\n".as_bytes()),
            Some("some content reformatted\n".as_bytes()),
            Some("some content\n".as_bytes()),
            false,
            false
        )
        .unwrap());
        assert!(!edit_formatted_file::<std::convert::Infallible>(
            &td.path().join("a"),
            Some("some content\n".as_bytes()),
            Some("some content\n".as_bytes()),
            Some("some content\n".as_bytes()),
            false,
            false
        )
        .unwrap());
        assert!(!edit_formatted_file::<std::convert::Infallible>(
            &td.path().join("a"),
            Some("some content\n".as_bytes()),
            Some("some content reformatted\n".as_bytes()),
            Some("some content reformatted\n".as_bytes()),
            false,
            false
        )
        .unwrap());
    }

    #[test]
    fn test_changed() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "some content\n").unwrap();
        assert!(edit_formatted_file::<std::convert::Infallible>(
            &td.path().join("a"),
            Some("some content\n".as_bytes()),
            Some("some content\n".as_bytes()),
            Some("new content\n".as_bytes()),
            false,
            false
        )
        .unwrap());
        assert_eq!(
            "new content\n",
            std::fs::read_to_string(td.path().join("a")).unwrap()
        );
    }

    #[test]
    fn test_unformattable() {
        let td = tempfile::tempdir().unwrap();
        assert!(matches!(
            edit_formatted_file::<std::convert::Infallible>(
                &td.path().join("a"),
                Some(b"some content\n"),
                Some(b"reformatted content\n"),
                Some(b"new content\n"),
                false,
                false
            )
            .unwrap_err(),
            EditorError::FormattingUnpreservable(_, FormattingUnpreservable { .. })
        ));
    }

    #[derive(Clone, PartialEq)]
    struct TestMarshall {
        data: Option<usize>,
    }

    impl TestMarshall {
        fn get_data(&self) -> Option<usize> {
            self.data
        }

        fn unset_data(&mut self) {
            self.data = None;
        }

        fn inc_data(&mut self) {
            match &mut self.data {
                Some(x) => *x += 1,
                None => self.data = Some(1),
            }
        }
    }

    impl Marshallable for TestMarshall {
        type Error = std::num::ParseIntError;

        fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
            let s = std::str::from_utf8(content).unwrap();
            let data = s.parse()?;
            Ok(Self { data: Some(data) })
        }

        fn empty() -> Self {
            Self { data: None }
        }

        fn to_bytes(&self) -> Option<Vec<u8>> {
            self.data.map(|x| x.to_string().into_bytes())
        }

        fn snapshot(&self) -> Self {
            self.clone()
        }

        fn has_changed(&self, other: &Self) -> bool {
            self != other
        }
    }

    #[test]
    fn test_edit_create_file() {
        let td = tempfile::tempdir().unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert!(!editor.has_changed());
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(1));
        assert!(editor.has_changed());
        assert_eq!(editor.commit().unwrap(), vec![td.path().join("a")]);
        assert_eq!(editor.get_data(), Some(1));

        assert_eq!("1", std::fs::read_to_string(td.path().join("a")).unwrap());
    }

    #[test]
    fn test_edit_create_no_changes() {
        let td = tempfile::tempdir().unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert!(!editor.has_changed());
        assert_eq!(editor.commit().unwrap(), Vec::<std::path::PathBuf>::new());
        assert_eq!(editor.get_data(), None);
        assert!(!td.path().join("a").exists());
    }

    #[test]
    fn test_edit_change() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "1").unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert!(!editor.has_changed());
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(2));
        assert!(editor.has_changed());
        assert_eq!(editor.commit().unwrap(), vec![td.path().join("a")]);
        assert_eq!(editor.get_data(), Some(2));

        assert_eq!("2", std::fs::read_to_string(td.path().join("a")).unwrap());
    }

    #[test]
    fn test_edit_delete() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "1").unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert!(!editor.has_changed());
        editor.unset_data();
        assert_eq!(editor.get_data(), None);
        assert!(editor.has_changed());
        assert_eq!(editor.commit().unwrap(), vec![td.path().join("a")]);
        assert_eq!(editor.get_data(), None);

        assert!(!td.path().join("a").exists());
    }

    #[test]
    fn test_tree_editor_edit() {
        use breezyshim::controldir::{create_standalone_workingtree, ControlDirFormat};
        let tempdir = tempfile::tempdir().unwrap();

        let tree =
            create_standalone_workingtree(tempdir.path(), &ControlDirFormat::default()).unwrap();

        let mut editor = tree
            .edit_file::<TestMarshall>(std::path::Path::new("a"), false, false)
            .unwrap();

        assert!(!editor.has_changed());
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(1));
        assert!(editor.has_changed());
        assert_eq!(editor.commit().unwrap(), vec![std::path::Path::new("a")]);

        assert_eq!(
            "1",
            std::fs::read_to_string(tempdir.path().join("a")).unwrap()
        );
    }

    #[test]
    fn test_tree_edit_control() {
        use breezyshim::controldir::{create_standalone_workingtree, ControlDirFormat};
        let tempdir = tempfile::tempdir().unwrap();

        let tree =
            create_standalone_workingtree(tempdir.path(), &ControlDirFormat::default()).unwrap();

        tree.mkdir(std::path::Path::new("debian")).unwrap();

        let mut editor = tree
            .edit_file::<debian_control::Control>(
                std::path::Path::new("debian/control"),
                false,
                false,
            )
            .unwrap();

        assert!(!editor.has_changed());
        let mut source = editor.add_source("blah");
        source.set_homepage(&"https://example.com".parse().unwrap());
        assert!(editor.has_changed());
        assert_eq!(
            editor.commit().unwrap(),
            vec![std::path::Path::new("debian/control")]
        );

        assert_eq!(
            "Source: blah\nHomepage: https://example.com/\n",
            std::fs::read_to_string(tempdir.path().join("debian/control")).unwrap()
        );
    }

    #[derive(Clone, PartialEq, Debug)]
    struct LossyFormat {
        lines: Vec<String>,
    }

    impl Marshallable for LossyFormat {
        type Error = std::convert::Infallible;

        fn from_bytes(content: &[u8]) -> Result<Self, Self::Error> {
            let s = std::str::from_utf8(content).unwrap();
            Ok(LossyFormat {
                lines: s
                    .lines()
                    .filter(|l| !l.starts_with('#'))
                    .map(|l| l.to_string())
                    .collect(),
            })
        }

        fn empty() -> Self {
            LossyFormat { lines: vec![] }
        }

        fn to_bytes(&self) -> Option<Vec<u8>> {
            Some(self.lines.join("\n").into_bytes())
        }

        fn snapshot(&self) -> Self {
            self.clone()
        }

        fn has_changed(&self, other: &Self) -> bool {
            self != other
        }
    }

    #[test]
    fn test_merge3() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(
            td.path().join("test.txt"),
            "line1\nline2\nline3\n# comment\nline4\n",
        )
        .unwrap();

        let mut editor =
            super::FsEditor::<LossyFormat>::new(&td.path().join("test.txt"), false, false).unwrap();
        editor.lines.insert(0, "line0".to_string());

        #[cfg(feature = "merge3")]
        {
            editor.commit().unwrap();
            assert_eq!(
                "line0\nline1\nline2\nline3\n# comment\nline4\n",
                std::fs::read_to_string(td.path().join("test.txt")).unwrap()
            );
        }
        #[cfg(not(feature = "merge3"))]
        {
            let result = editor.commit();
            let updated_content = std::fs::read_to_string(td.path().join("test.txt")).unwrap();
            assert!(result.is_err(), "{:?}", updated_content);
            assert!(
                matches!(
                    result.as_ref().unwrap_err(),
                    super::EditorError::FormattingUnpreservable(_, _)
                ),
                "{:?} {:?}",
                result,
                updated_content
            );
            assert_eq!("line1\nline2\nline3\n# comment\nline4\n", updated_content);
        }
    }

    #[test]
    fn test_reformat_file_preserved() {
        let (updated_content, changed) = reformat_file(
            Some(b"original\n"),
            Some(b"original\n"),
            Some(b"updated\n"),
            false,
        )
        .unwrap();
        assert_eq!(updated_content, Some(Cow::Borrowed(&b"updated\n"[..])));
        assert!(changed);
    }

    #[test]
    fn test_reformat_file_not_preserved_allowed() {
        let (updated_content, changed) = reformat_file(
            Some(b"original\n#comment\n"),
            Some(b"original\n"),
            Some(b"updated\n"),
            true,
        )
        .unwrap();
        assert_eq!(updated_content, Some(Cow::Borrowed(&b"updated\n"[..])));
        assert!(changed);
    }

    #[test]
    fn test_reformat_file_not_preserved_not_allowed() {
        let err = reformat_file(
            Some(b"original\n#comment\n"),
            Some(b"original\n"),
            Some(b"updated\n"),
            false,
        )
        .unwrap_err();
        assert!(matches!(err, FormattingUnpreservable { .. }));
    }

    #[test]
    fn test_reformat_file_not_preserved_merge3() {
        let r = reformat_file(
            Some(b"original\noriginal 2\noriginal 3\n#comment\noriginal 4\n"),
            Some(b"original\noriginal 2\noriginal 3\noriginal 4\n"),
            Some(b"updated\noriginal 2\noriginal 3\n#comment\noriginal 4\n"),
            false,
        );
        #[cfg(feature = "merge3")]
        {
            let (updated_content, changed) = r.unwrap();
            let updated = std::str::from_utf8(updated_content.as_ref().unwrap().as_ref()).unwrap();
            assert_eq!(
                updated,
                "updated\noriginal 2\noriginal 3\n#comment\noriginal 4\n"
            );
            assert!(changed);
        }
        #[cfg(not(feature = "merge3"))]
        {
            assert!(matches!(r.unwrap_err(), FormattingUnpreservable { .. }));
        }
    }

    #[test]
    fn test_edit_formatted_file_preservable() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "some content\n").unwrap();
        assert!(edit_formatted_file::<std::convert::Infallible>(
            &td.path().join("a"),
            Some("some content\n".as_bytes()),
            Some("some content\n".as_bytes()),
            Some("new content\n".as_bytes()),
            false,
            false
        )
        .unwrap());
        assert_eq!(
            "new content\n",
            std::fs::read_to_string(td.path().join("a")).unwrap()
        );
    }

    #[test]
    fn test_edit_formatted_file_not_preservable() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "some content\n#extra\n").unwrap();
        assert!(matches!(
            edit_formatted_file::<std::convert::Infallible>(
                &td.path().join("a"),
                Some("some content\n#extra\n".as_bytes()),
                Some("some content\n".as_bytes()),
                Some("new content\n".as_bytes()),
                false,
                false
            )
            .unwrap_err(),
            EditorError::FormattingUnpreservable(_, FormattingUnpreservable { .. })
        ));

        assert_eq!(
            "some content\n#extra\n",
            std::fs::read_to_string(td.path().join("a")).unwrap()
        );
    }

    #[test]
    fn test_edit_formatted_file_not_preservable_allowed() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "some content\n").unwrap();
        assert!(edit_formatted_file::<std::convert::Infallible>(
            &td.path().join("a"),
            Some("some content\n#extra\n".as_bytes()),
            Some("some content\n".as_bytes()),
            Some("new content\n".as_bytes()),
            false,
            true
        )
        .is_ok());

        assert_eq!(
            "new content\n",
            std::fs::read_to_string(td.path().join("a")).unwrap()
        );
    }

    #[test]
    fn test_revert_before_commit() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "1").unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert_eq!(editor.get_data(), Some(1));
        assert!(!editor.has_changed());

        // Make a change
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(2));
        assert!(editor.has_changed());

        // Revert the change
        editor.revert().unwrap();
        assert_eq!(editor.get_data(), Some(1));
        assert!(!editor.has_changed());

        // File should still have original content
        assert_eq!("1", std::fs::read_to_string(td.path().join("a")).unwrap());
    }

    #[test]
    fn test_revert_after_commit() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "1").unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert_eq!(editor.get_data(), Some(1));

        // Make a change and commit
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(2));
        editor.commit().unwrap();
        assert_eq!("2", std::fs::read_to_string(td.path().join("a")).unwrap());
        assert!(!editor.has_changed());

        // Make another change
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(3));
        assert!(editor.has_changed());

        // Revert should go back to committed state (2, not original 1)
        editor.revert().unwrap();
        assert_eq!(editor.get_data(), Some(2));
        assert!(!editor.has_changed());

        // File should still have committed content
        assert_eq!("2", std::fs::read_to_string(td.path().join("a")).unwrap());
    }

    #[test]
    fn test_multiple_commit_revert_cycles() {
        let td = tempfile::tempdir().unwrap();
        std::fs::write(td.path().join("a"), "1").unwrap();

        let mut editor = FsEditor::<TestMarshall>::new(&td.path().join("a"), false, false).unwrap();
        assert_eq!(editor.get_data(), Some(1));

        // First cycle: change, commit
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(2));
        editor.commit().unwrap();
        assert_eq!("2", std::fs::read_to_string(td.path().join("a")).unwrap());

        // Second cycle: change, revert, change again, commit
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(3));
        editor.revert().unwrap();
        assert_eq!(editor.get_data(), Some(2));

        editor.inc_data();
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(4));
        editor.commit().unwrap();
        assert_eq!("4", std::fs::read_to_string(td.path().join("a")).unwrap());

        // Third cycle: change, revert
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(5));
        editor.revert().unwrap();
        assert_eq!(editor.get_data(), Some(4));
        assert!(!editor.has_changed());
        assert_eq!("4", std::fs::read_to_string(td.path().join("a")).unwrap());
    }

    #[test]
    fn test_tree_editor_revert_before_commit() {
        use breezyshim::controldir::{create_standalone_workingtree, ControlDirFormat};
        let tempdir = tempfile::tempdir().unwrap();

        let tree =
            create_standalone_workingtree(tempdir.path(), &ControlDirFormat::default()).unwrap();

        tree.put_file_bytes_non_atomic(std::path::Path::new("a"), b"1")
            .unwrap();

        let mut editor = tree
            .edit_file::<TestMarshall>(std::path::Path::new("a"), false, false)
            .unwrap();
        assert_eq!(editor.get_data(), Some(1));

        // Make a change
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(2));
        assert!(editor.has_changed());

        // Revert the change
        editor.revert().unwrap();
        assert_eq!(editor.get_data(), Some(1));
        assert!(!editor.has_changed());
    }

    #[test]
    fn test_tree_editor_revert_after_commit() {
        use breezyshim::controldir::{create_standalone_workingtree, ControlDirFormat};
        let tempdir = tempfile::tempdir().unwrap();

        let tree =
            create_standalone_workingtree(tempdir.path(), &ControlDirFormat::default()).unwrap();

        tree.put_file_bytes_non_atomic(std::path::Path::new("a"), b"1")
            .unwrap();

        let mut editor = tree
            .edit_file::<TestMarshall>(std::path::Path::new("a"), false, false)
            .unwrap();
        assert_eq!(editor.get_data(), Some(1));

        // Make a change and commit
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(2));
        editor.commit().unwrap();
        assert!(!editor.has_changed());

        // Make another change
        editor.inc_data();
        assert_eq!(editor.get_data(), Some(3));

        // Revert should go back to committed state (2, not original 1)
        editor.revert().unwrap();
        assert_eq!(editor.get_data(), Some(2));
        assert!(!editor.has_changed());
    }

    #[test]
    fn test_watchfile_editor() {
        let td = tempfile::tempdir().unwrap();
        let watch_path = td.path().join("debian/watch");
        std::fs::create_dir_all(watch_path.parent().unwrap()).unwrap();

        // Create a basic watch file
        std::fs::write(
            &watch_path,
            "version=4\nhttps://example.com/downloads example-(.*)\\.tar\\.gz\n",
        )
        .unwrap();

        // Test that we can read and edit the watch file
        let mut editor =
            FsEditor::<debian_watch::WatchFile>::new(&watch_path, false, false).unwrap();

        // Verify we can read the watch file
        assert_eq!(editor.version(), 4);
        let entries: Vec<_> = editor.entries().collect();
        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].url(), "https://example.com/downloads");
        assert_eq!(
            entries[0].matching_pattern(),
            Some("example-(.*)\\.tar\\.gz".to_string())
        );

        // Make a change
        let entry = debian_watch::EntryBuilder::new("https://example.com/other")
            .matching_pattern("other-(.*)\\.tar\\.gz")
            .build();
        editor.add_entry(entry);

        let entries: Vec<_> = editor.entries().collect();
        assert_eq!(entries.len(), 2);
        assert_eq!(entries[0].url(), "https://example.com/downloads");
        assert_eq!(entries[1].url(), "https://example.com/other");
        assert_eq!(
            entries[1].matching_pattern(),
            Some("other-(.*)\\.tar\\.gz".to_string())
        );
        assert!(editor.has_changed());

        // Commit the changes
        let changed_files = editor.commit().unwrap();
        assert_eq!(changed_files, vec![watch_path.clone()]);
        assert!(!editor.has_changed());

        // Verify the file was updated
        let content = std::fs::read_to_string(&watch_path).unwrap();
        let expected = "version=4\nhttps://example.com/downloads example-(.*)\\.tar\\.gz\nhttps://example.com/other other-(.*)\\.tar\\.gz\n";
        assert_eq!(content, expected);
    }

    #[test]
    fn test_marshalling_error_handling() {
        let td = tempfile::tempdir().unwrap();
        let test_path = td.path().join("test");

        // Write invalid content that will fail to parse as an integer
        std::fs::write(&test_path, "not a number").unwrap();

        // Attempt to create an editor should fail with a marshalling error
        let result = FsEditor::<TestMarshall>::new(&test_path, false, false);
        assert!(matches!(result, Err(EditorError::MarshallingError(_))));
    }

    #[test]
    fn test_tree_editor_marshalling_error() {
        use breezyshim::controldir::{create_standalone_workingtree, ControlDirFormat};
        let tempdir = tempfile::tempdir().unwrap();

        let tree =
            create_standalone_workingtree(tempdir.path(), &ControlDirFormat::default()).unwrap();

        // Put invalid content in the tree
        tree.put_file_bytes_non_atomic(std::path::Path::new("test"), b"invalid content")
            .unwrap();

        // Attempt to create an editor should fail with a marshalling error
        let result = tree.edit_file::<TestMarshall>(std::path::Path::new("test"), false, false);
        assert!(matches!(result, Err(EditorError::MarshallingError(_))));
    }
}