From 66391862c1d0f9af48260cb6db93217c7cb3f8c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cyryl=20P=C5=82otnicki?= Date: Sat, 7 Sep 2019 14:42:30 +0100 Subject: [PATCH] Cleanup tests --- src/index.rs | 26 ++-------------- src/repository.rs | 27 ++++++++++++++-- src/repository_item.rs | 2 +- src/restore.rs | 1 - src/test/assertions.rs | 71 ++++++++++++++++++++++++++++++++++++++++-- tests/system_tests.rs | 58 ++++++---------------------------- 6 files changed, 106 insertions(+), 79 deletions(-) diff --git a/src/index.rs b/src/index.rs index 871875f..8663727 100644 --- a/src/index.rs +++ b/src/index.rs @@ -1,15 +1,11 @@ +use std::fs::File; use std::path::Path; use serde::{Deserialize, Serialize}; use crate::error::BakareError; +use crate::repository::ItemVersion; use crate::repository_item::RepositoryItem; -use std::fmt; -use std::fmt::Formatter; -use std::fs::File; - -#[derive(Clone, Debug, PartialOrd, PartialEq, Ord, Eq, Serialize, Deserialize)] -pub struct ItemVersion(Box<[u8]>); #[derive(Clone, Debug, PartialOrd, PartialEq, Ord, Eq, Serialize, Deserialize)] pub struct IndexItem { @@ -25,24 +21,6 @@ pub struct Index { repository_path: String, } -impl AsRef<[u8]> for ItemVersion { - fn as_ref(&self) -> &[u8] { - &self.0 - } -} - -impl From<&[u8]> for ItemVersion { - fn from(a: &[u8]) -> Self { - ItemVersion(Box::from(a)) - } -} - -impl fmt::Display for ItemVersion { - fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> { - write!(f, "{}", hex::encode(self)) - } -} - impl Index { pub fn new(repository_path: &Path) -> Self { Index { diff --git a/src/repository.rs b/src/repository.rs index 301a479..9a884c6 100644 --- a/src/repository.rs +++ b/src/repository.rs @@ -1,11 +1,13 @@ use std::path::Path; -use std::{fs, io}; +use std::{fmt, fs, io}; use crate::error::BakareError; -use crate::index::{Index, IndexIterator, ItemVersion}; +use crate::index::{Index, IndexIterator}; use crate::repository_item::RepositoryItem; +use serde::{Deserialize, Serialize}; use sha2::Digest; use sha2::Sha512; +use std::fmt::Formatter; use std::fs::File; use std::io::BufReader; @@ -19,6 +21,27 @@ pub struct Repository<'a> { index: Index, } +#[derive(Clone, Debug, PartialOrd, PartialEq, Ord, Eq, Serialize, Deserialize)] +pub struct ItemVersion(Box<[u8]>); + +impl AsRef<[u8]> for ItemVersion { + fn as_ref(&self) -> &[u8] { + &self.0 + } +} + +impl From<&[u8]> for ItemVersion { + fn from(a: &[u8]) -> Self { + ItemVersion(Box::from(a)) + } +} + +impl fmt::Display for ItemVersion { + fn fmt(&self, f: &mut Formatter) -> Result<(), fmt::Error> { + write!(f, "{}", hex::encode(self)) + } +} + pub struct RepositoryIterator<'a> { index_iterator: IndexIterator<'a>, } diff --git a/src/repository_item.rs b/src/repository_item.rs index 617b8f9..0f499b1 100644 --- a/src/repository_item.rs +++ b/src/repository_item.rs @@ -1,5 +1,5 @@ use crate::error::BakareError; -use crate::index::ItemVersion; +use crate::repository::ItemVersion; use std::fmt::{Display, Formatter}; use std::path::Path; use std::{fmt, fs}; diff --git a/src/restore.rs b/src/restore.rs index 43611a2..0dbcca5 100644 --- a/src/restore.rs +++ b/src/restore.rs @@ -1,7 +1,6 @@ use std::path::Path; use crate::error::BakareError; -use crate::index::ItemVersion; use crate::repository::Repository; use crate::repository_item::RepositoryItem; diff --git a/src/test/assertions.rs b/src/test/assertions.rs index 3d353ad..1160ddb 100644 --- a/src/test/assertions.rs +++ b/src/test/assertions.rs @@ -1,12 +1,16 @@ -use crate::error::BakareError; -use crate::repository::Repository; -use crate::{backup, restore}; +use std::fs; use std::fs::File; use std::io::Read; use std::path::Path; + use tempfile::tempdir; use walkdir::WalkDir; +use crate::{backup, restore}; +use crate::error::BakareError; +use crate::repository::{ItemVersion, Repository}; +use crate::source::TempSource; + pub fn assert_target_file_contents(restored_path: &Path, expected_contents: &str) -> Result<(), BakareError> { let mut actual_contents = String::new(); assert!(restored_path.exists(), "Expected '{}' to be there", restored_path.display()); @@ -38,6 +42,67 @@ pub fn assert_same_after_restore(source_path: &Path) -> Result<(), BakareError> Ok(()) } +pub fn assert_restored_from_version_has_contents( + repository_path: &Path, + source_file_full_path: &Path, + old_contents: &str, + old_version: &ItemVersion, +) -> Result<(), BakareError> { + let restore_repository = Repository::open(repository_path)?; + let restore_target = tempdir()?; + let restore_engine = restore::Engine::new(&restore_repository, &restore_target.path())?; + let old_item = restore_repository.item_by_source_path_and_version(&source_file_full_path, &old_version)?; + restore_engine.restore(&old_item.unwrap())?; + let restored_file_path = restore_target.path().join(source_file_full_path.strip_prefix("/")?); + assert_target_file_contents(&restored_file_path, old_contents) +} + +pub fn item_version(repository_path: &Path, source_file_full_path: &Path) -> Result { + let old_version = { + let reading_repository = Repository::open(repository_path)?; + let item = reading_repository.item_by_source_path(&source_file_full_path)?; + assert!(item.is_some()); + let item = item.unwrap(); + item.version().clone() + }; + Ok(old_version) +} + +pub fn read_restored_file_contents( + source: TempSource, + restore_target: &Path, + source_file_relative_path: &str, +) -> Result { + let source_file_full_path = source.file_path(source_file_relative_path); + let restored_file_path = restore_target.join(source_file_full_path.strip_prefix("/")?); + let contents = fs::read_to_string(restored_file_path)?; + Ok(contents) +} + +pub fn restore_all_from_reloaded_repository(repository_path: &Path, restore_target: &Path) -> Result<(), BakareError> { + { + let restore_repository = Repository::open(repository_path)?; + let restore_engine = restore::Engine::new(&restore_repository, &restore_target)?; + restore_engine.restore_all()?; + Ok(()) + } +} + +pub fn backup_file_with_contents( + source: &TempSource, + repository_path: &Path, + source_file_relative_path: &str, + contents: &str, +) -> Result<(), BakareError> { + { + let mut backup_repository = Repository::open(repository_path)?; + let mut backup_engine = backup::Engine::new(source.path(), &mut backup_repository); + source.write_text_to_file(source_file_relative_path, contents)?; + backup_engine.backup()?; + Ok(()) + } +} + fn assert_directory_trees_have_same_contents(left: &Path, right: &Path) -> Result<(), BakareError> { let left_files = get_sorted_files_recursively(left)?; let right_files = get_sorted_files_recursively(right)?; diff --git a/tests/system_tests.rs b/tests/system_tests.rs index 33148bd..91b884e 100644 --- a/tests/system_tests.rs +++ b/tests/system_tests.rs @@ -1,13 +1,9 @@ -use bakare::backup; -use bakare::restore; +use tempfile::tempdir; use bakare::error::BakareError; use bakare::repository::Repository; use bakare::source::TempSource; - -use bakare::test::assertions::{assert_same_after_restore, assert_target_file_contents}; -use std::fs; -use tempfile::tempdir; +use bakare::test::assertions::*; #[test] fn restore_multiple_files() -> Result<(), BakareError> { @@ -30,22 +26,11 @@ fn restore_files_after_reopening_repository() -> Result<(), BakareError> { let source_file_relative_path = "some file path"; let original_contents = "some old contents"; - { - let mut backup_repository = Repository::open(repository_path.as_path())?; - let mut backup_engine = backup::Engine::new(source.path(), &mut backup_repository); - source.write_text_to_file(source_file_relative_path, original_contents)?; - backup_engine.backup()?; - } + backup_file_with_contents(&source, &repository_path, source_file_relative_path, original_contents)?; - { - let restore_repository = Repository::open(repository_path.as_path())?; - let restore_engine = restore::Engine::new(&restore_repository, &restore_target)?; - restore_engine.restore_all()?; - } + restore_all_from_reloaded_repository(&repository_path, &restore_target)?; - let source_file_full_path = source.file_path(source_file_relative_path); - let restored_file_path = restore_target.join(source_file_full_path.strip_prefix("/")?); - let contents = fs::read_to_string(restored_file_path)?; + let contents = read_restored_file_contents(source, &restore_target, source_file_relative_path)?; assert_eq!(contents, original_contents); Ok(()) @@ -61,37 +46,14 @@ fn restore_older_version_of_file() -> Result<(), BakareError> { let source_file_full_path = source.file_path(source_file_relative_path); let old_contents = "some old contents"; - { - let mut backup_repository = Repository::open(repository_path.as_path())?; - let mut backup_engine = backup::Engine::new(source.path(), &mut backup_repository); - source.write_text_to_file(source_file_relative_path, old_contents)?; - backup_engine.backup()?; - } + backup_file_with_contents(&source, &repository_path, source_file_relative_path, old_contents)?; - let old_version = { - let reading_repository = Repository::open(repository_path.as_path())?; - let item = reading_repository.item_by_source_path(&source_file_full_path)?; - assert!(item.is_some()); - let item = item.unwrap(); - item.version().clone() - }; + let old_version = item_version(&repository_path, &source_file_full_path)?; - { - let new_contents = "totally new contents"; - let mut backup_repository = Repository::open(repository_path.as_path())?; - let mut backup_engine = backup::Engine::new(source.path(), &mut backup_repository); - source.write_text_to_file(source_file_relative_path, new_contents)?; - backup_engine.backup()?; - } + let new_contents = "totally new contents"; + backup_file_with_contents(&source, &repository_path, source_file_relative_path, new_contents)?; - let restore_repository = Repository::open(repository_path.as_path())?; - let restore_target = tempdir()?; - let restore_engine = restore::Engine::new(&restore_repository, &restore_target.path())?; - let old_item = restore_repository.item_by_source_path_and_version(&source_file_full_path, &old_version)?; - restore_engine.restore(&old_item.unwrap())?; - - let restored_file_path = restore_target.path().join(source_file_full_path.strip_prefix("/")?); - assert_target_file_contents(&restored_file_path, old_contents) + assert_restored_from_version_has_contents(&repository_path, &source_file_full_path, old_contents, &old_version) } // TODO: restore latest version by default