refactor(git): add mock repository and tests
Some checks failed
ci/woodpecker/push/cron-docker-builder Pipeline was successful
ci/woodpecker/push/push-next Pipeline was successful
ci/woodpecker/push/tag-created Pipeline was successful
Rust / build (push) Failing after 2m27s

Repository is now behind an enum to allow selection of a mock Repsitory
for use in tests.
This commit is contained in:
Paul Campbell 2024-05-19 20:02:06 +01:00
parent e5744e85ad
commit b03bd0c2e3
25 changed files with 525 additions and 82 deletions

View file

@ -62,6 +62,7 @@ derive_more = { version = "1.0.0-beta.6", features = [
"deref", "deref",
"from", "from",
] } ] }
derive-with = "0.5"
# file watcher # file watcher
inotify = "0.10" inotify = "0.10"

View file

@ -40,9 +40,10 @@ secrecy = { workspace = true }
# bytes = { workspace = true } # bytes = { workspace = true }
# ulid = { workspace = true } # ulid = { workspace = true }
# warp = { workspace = true } # warp = { workspace = true }
#
# # error handling # boilerplate
derive_more = { workspace = true } derive_more = { workspace = true }
derive-with = { workspace = true }
# #
# # file watcher # # file watcher
# inotify = { workspace = true } # inotify = { workspace = true }

View file

@ -9,3 +9,8 @@ impl secrecy::ExposeSecret<String> for ApiToken {
self.0.expose_secret() self.0.expose_secret()
} }
} }
impl Default for ApiToken {
fn default() -> Self {
Self("".to_string().into())
}
}

View file

@ -1,5 +1,5 @@
/// The name of a Branch /// The name of a Branch
#[derive(Clone, Debug, Hash, PartialEq, Eq, derive_more::Display)] #[derive(Clone, Default, Debug, Hash, PartialEq, Eq, derive_more::Display)]
pub struct BranchName(String); pub struct BranchName(String);
impl BranchName { impl BranchName {
pub fn new(str: impl Into<String>) -> Self { pub fn new(str: impl Into<String>) -> Self {

View file

@ -1,7 +1,7 @@
use crate::{ApiToken, ForgeConfig, ForgeName, ForgeType, Hostname, User}; use crate::{ApiToken, ForgeConfig, ForgeName, ForgeType, Hostname, User};
/// The derived information about a Forge, used to create interactions with it /// The derived information about a Forge, used to create interactions with it
#[derive(Clone, Debug, derive_more::Constructor)] #[derive(Clone, Default, Debug, derive_more::Constructor, derive_with::With)]
pub struct ForgeDetails { pub struct ForgeDetails {
forge_name: ForgeName, forge_name: ForgeName,
forge_type: ForgeType, forge_type: ForgeType,
@ -27,11 +27,6 @@ impl ForgeDetails {
pub const fn token(&self) -> &ApiToken { pub const fn token(&self) -> &ApiToken {
&self.token &self.token
} }
pub fn with_hostname(self, hostname: Hostname) -> Self {
let mut me = self;
me.hostname = hostname;
me
}
} }
impl From<(&ForgeName, &ForgeConfig)> for ForgeDetails { impl From<(&ForgeName, &ForgeConfig)> for ForgeDetails {
fn from(forge: (&ForgeName, &ForgeConfig)) -> Self { fn from(forge: (&ForgeName, &ForgeConfig)) -> Self {

View file

@ -1,7 +1,7 @@
use std::path::PathBuf; use std::path::PathBuf;
/// The name of a Forge to connect to /// The name of a Forge to connect to
#[derive(Clone, Debug, PartialEq, Eq, derive_more::Constructor, derive_more::Display)] #[derive(Clone, Default, Debug, PartialEq, Eq, derive_more::Constructor, derive_more::Display)]
pub struct ForgeName(String); pub struct ForgeName(String);
impl From<&ForgeName> for PathBuf { impl From<&ForgeName> for PathBuf {
fn from(value: &ForgeName) -> Self { fn from(value: &ForgeName) -> Self {

View file

@ -1,5 +1,5 @@
/// Identifier for the type of Forge /// Identifier for the type of Forge
#[derive(Clone, Copy, Debug, PartialEq, Eq, serde::Deserialize)] #[derive(Clone, Default, Copy, Debug, PartialEq, Eq, serde::Deserialize)]
pub enum ForgeType { pub enum ForgeType {
#[cfg(feature = "forgejo")] #[cfg(feature = "forgejo")]
ForgeJo, ForgeJo,
@ -7,6 +7,7 @@ pub enum ForgeType {
// GitHub, // GitHub,
// GitLab, // GitLab,
// BitBucket, // BitBucket,
#[default]
MockForge, MockForge,
} }
impl std::fmt::Display for ForgeType { impl std::fmt::Display for ForgeType {

View file

@ -1,7 +1,15 @@
use std::path::PathBuf; use std::path::PathBuf;
#[derive( #[derive(
Debug, Clone, PartialEq, Eq, serde::Deserialize, derive_more::Deref, derive_more::From, Clone,
Default,
Debug,
Hash,
PartialEq,
Eq,
serde::Deserialize,
derive_more::Deref,
derive_more::From,
)] )]
pub struct GitDir(PathBuf); pub struct GitDir(PathBuf);
impl GitDir { impl GitDir {

View file

@ -1,5 +1,5 @@
/// The hostname of a forge /// The hostname of a forge
#[derive(Clone, Debug, PartialEq, Eq, derive_more::Display)] #[derive(Clone, Default, Debug, PartialEq, Eq, derive_more::Display)]
pub struct Hostname(String); pub struct Hostname(String);
impl Hostname { impl Hostname {
pub fn new(str: impl Into<String>) -> Self { pub fn new(str: impl Into<String>) -> Self {

View file

@ -1,6 +1,6 @@
/// The alias of a repo /// The alias of a repo
/// This is the alias for the repo within `git-next-server.toml` /// This is the alias for the repo within `git-next-server.toml`
#[derive(Clone, Debug, PartialEq, Eq, Hash, derive_more::Display)] #[derive(Clone, Default, Debug, PartialEq, Eq, Hash, derive_more::Display)]
pub struct RepoAlias(String); pub struct RepoAlias(String);
impl RepoAlias { impl RepoAlias {
pub fn new(str: impl Into<String>) -> Self { pub fn new(str: impl Into<String>) -> Self {

View file

@ -1,5 +1,5 @@
/// The path for the repo within the forge. /// The path for the repo within the forge.
/// Typically this is composed of the user or organisation and the name of the repo /// Typically this is composed of the user or organisation and the name of the repo
/// e.g. `{user}/{repo}` /// e.g. `{user}/{repo}`
#[derive(Clone, Debug, PartialEq, Eq, derive_more::Constructor, derive_more::Display)] #[derive(Clone, Default, Debug, PartialEq, Eq, derive_more::Constructor, derive_more::Display)]
pub struct RepoPath(String); pub struct RepoPath(String);

View file

@ -1,3 +1,3 @@
/// The user within the forge to connect as /// The user within the forge to connect as
#[derive(Clone, Debug, PartialEq, Eq, derive_more::Constructor, derive_more::Display)] #[derive(Clone, Default, Debug, PartialEq, Eq, derive_more::Constructor, derive_more::Display)]
pub struct User(String); pub struct User(String);

View file

@ -23,9 +23,9 @@ tracing = { workspace = true }
# # gix = { workspace = true } # # gix = { workspace = true }
gix = { workspace = true } gix = { workspace = true }
# async-trait = { workspace = true } # async-trait = { workspace = true }
#
# # fs/network # fs/network
# kxio = { workspace = true } kxio = { workspace = true }
# # TOML parsing # # TOML parsing
# serde = { workspace = true } # serde = { workspace = true }
@ -45,6 +45,7 @@ secrecy = { workspace = true }
# error handling # error handling
derive_more = { workspace = true } derive_more = { workspace = true }
derive-with = { workspace = true }
# # file watcher # # file watcher
# inotify = { workspace = true } # inotify = { workspace = true }
@ -54,9 +55,9 @@ derive_more = { workspace = true }
# actix-rt = { workspace = true } # actix-rt = { workspace = true }
# tokio = { workspace = true } # tokio = { workspace = true }
# #
# [dev-dependencies] [dev-dependencies]
# # Testing # Testing
# assert2 = { workspace = true } assert2 = { workspace = true }
[lints.clippy] [lints.clippy]
nursery = { level = "warn", priority = -1 } nursery = { level = "warn", priority = -1 }

View file

@ -7,3 +7,14 @@ pub enum Error {
Lock, Lock,
} }
impl std::error::Error for Error {} impl std::error::Error for Error {}
mod gix_error {
#![cfg(not(tarpaulin_include))] // third-party library errors
use super::Error;
impl From<gix::remote::connect::Error> for Error {
fn from(gix_error: gix::remote::connect::Error) -> Self {
Self::Connect(gix_error.to_string())
}
}
}

View file

@ -6,7 +6,7 @@ use git_next_config::{
use super::{Generation, GitRemote}; use super::{Generation, GitRemote};
/// The derived information about a repo, used to interact with it /// The derived information about a repo, used to interact with it
#[derive(Clone, Debug, derive_more::Display)] #[derive(Clone, Default, Debug, derive_more::Display, derive_with::With)]
#[display("gen-{}:{}:{}/{}:{}@{}/{}@{}", generation, forge.forge_type(), #[display("gen-{}:{}:{}/{}:{}@{}/{}@{}", generation, forge.forge_type(),
forge.forge_name(), repo_alias, forge.user(), forge.hostname(), repo_path, forge.forge_name(), repo_alias, forge.user(), forge.hostname(), repo_path,
branch)] branch)]

View file

@ -1,17 +1,158 @@
//
#![cfg(not(tarpaulin_include))] // don't test mocks
use std::{
collections::HashMap,
sync::{Arc, Mutex},
};
use git_next_config::GitDir; use git_next_config::GitDir;
use crate::{ use crate::{
repository::{open::OpenRepository, Error, RepositoryLike}, repository::{
RepoDetails, open::{OpenRepository, OpenRepositoryLike},
Direction, RepositoryLike, Result,
},
GitRemote, RepoDetails,
}; };
pub struct MockRepository; use super::Error;
impl RepositoryLike for MockRepository {
fn open(&self, _gitdir: &GitDir) -> Result<OpenRepository, Error> {
Ok(OpenRepository::Mock)
}
fn git_clone(&self, _repo_details: &RepoDetails) -> Result<OpenRepository, Error> { #[derive(Debug, Default, Clone)]
Ok(OpenRepository::Mock) pub struct MockRepository(Arc<Mutex<Reality>>);
impl MockRepository {
pub fn new() -> Self {
Self(Arc::new(Mutex::new(Reality::default())))
}
pub fn can_open_repo(&mut self, gitdir: &GitDir) -> Result<MockOpenRepository> {
self.0
.lock()
.map_err(|_| Error::MockLock)
.map(|mut r| r.can_open_repo(gitdir))
}
fn open_repository(
&self,
gitdir: &GitDir,
) -> std::result::Result<MockOpenRepository, crate::repository::Error> {
self.0.lock().map_err(|_| Error::MockLock).and_then(|r| {
r.open_repository(gitdir)
.ok_or_else(|| Error::Open(format!("mock - could not open: {}", gitdir)))
})
}
fn clone_repository(
&self,
) -> std::result::Result<MockOpenRepository, crate::repository::Error> {
todo!()
}
}
impl RepositoryLike for MockRepository {
fn open(
&self,
gitdir: &GitDir,
) -> std::result::Result<OpenRepository, crate::repository::Error> {
Ok(OpenRepository::Mock(self.open_repository(gitdir)?))
}
fn git_clone(
&self,
_repo_details: &RepoDetails,
) -> std::result::Result<OpenRepository, crate::repository::Error> {
Ok(OpenRepository::Mock(self.clone_repository()?))
}
}
#[derive(Debug, Default)]
pub struct Reality {
openable_repos: HashMap<GitDir, MockOpenRepository>,
}
impl Reality {
pub fn can_open_repo(&mut self, gitdir: &GitDir) -> MockOpenRepository {
let mor = self.openable_repos.get(gitdir);
match mor {
Some(mor) => mor.clone(),
None => {
let mor = MockOpenRepository::default();
self.openable_repos.insert(gitdir.clone(), mor.clone());
mor
}
}
}
pub fn open_repository(&self, gitdir: &GitDir) -> Option<MockOpenRepository> {
self.openable_repos.get(gitdir).cloned()
}
}
#[derive(Clone, Debug, Default)]
pub struct InnerMockOpenRepository {
default_push_remote: Option<GitRemote>,
default_fetch_remote: Option<GitRemote>,
}
#[derive(Clone, Debug, Default)]
pub struct MockOpenRepository {
inner: Arc<Mutex<InnerMockOpenRepository>>,
}
impl std::ops::Deref for MockOpenRepository {
type Target = Arc<Mutex<InnerMockOpenRepository>>;
fn deref(&self) -> &Self::Target {
&self.inner
}
}
impl InnerMockOpenRepository {
pub fn has_default_remote(&mut self, direction: Direction, git_remote: GitRemote) {
match direction {
Direction::Push => self.default_push_remote.replace(git_remote),
Direction::Fetch => self.default_fetch_remote.replace(git_remote),
};
}
}
#[allow(clippy::unwrap_used)]
impl OpenRepositoryLike for MockOpenRepository {
fn find_default_remote(&self, direction: Direction) -> Option<GitRemote> {
self.inner
.lock()
.map(|inner| inner.find_default_remote(direction))
.unwrap()
}
fn fetch(&self) -> std::prelude::v1::Result<(), crate::fetch::Error> {
self.inner.lock().map(|inner| inner.fetch()).unwrap()
}
fn push(
&self,
repo_details: &RepoDetails,
branch_name: git_next_config::BranchName,
to_commit: crate::GitRef,
force: crate::push::Force,
) -> std::prelude::v1::Result<(), crate::push::Error> {
self.inner
.lock()
.map(|inner| inner.push(repo_details, branch_name, to_commit, force))
.unwrap()
}
}
impl OpenRepositoryLike for InnerMockOpenRepository {
fn find_default_remote(&self, direction: Direction) -> Option<GitRemote> {
match direction {
Direction::Push => self.default_push_remote.clone(),
Direction::Fetch => self.default_fetch_remote.clone(),
}
}
fn fetch(&self) -> std::prelude::v1::Result<(), crate::fetch::Error> {
todo!()
}
fn push(
&self,
_repo_details: &RepoDetails,
_branch_name: git_next_config::BranchName,
_to_commit: crate::GitRef,
_force: crate::push::Force,
) -> std::prelude::v1::Result<(), crate::push::Error> {
todo!()
} }
} }

View file

@ -1,31 +1,35 @@
// //
#![cfg(not(tarpaulin_include))]
mod mock; mod mock;
mod open; mod open;
mod real; mod real;
#[cfg(test)]
mod tests;
use git_next_config::GitDir; use git_next_config::GitDir;
pub use open::OpenRepository; pub use open::OpenRepository;
use crate::repository::mock::MockRepository;
use super::RepoDetails; use super::RepoDetails;
#[derive(Clone, Copy, Debug)] #[derive(Clone, Debug)]
pub enum Repository { pub enum Repository {
Real, Real,
Mock, Mock(MockRepository),
} }
pub const fn new() -> Repository { pub const fn new() -> Repository {
Repository::Real Repository::Real
} }
pub const fn mock() -> Repository { pub fn mock() -> (Repository, MockRepository) {
Repository::Mock let mock_repository = MockRepository::new();
(Repository::Mock(mock_repository.clone()), mock_repository)
} }
pub trait RepositoryLike { pub trait RepositoryLike {
fn open(&self, gitdir: &GitDir) -> Result<OpenRepository, Error>; fn open(&self, gitdir: &GitDir) -> Result<OpenRepository>;
fn git_clone(&self, repo_details: &RepoDetails) -> Result<OpenRepository, Error>; fn git_clone(&self, repo_details: &RepoDetails) -> Result<OpenRepository>;
} }
impl std::ops::Deref for Repository { impl std::ops::Deref for Repository {
type Target = dyn RepositoryLike; type Target = dyn RepositoryLike;
@ -33,7 +37,7 @@ impl std::ops::Deref for Repository {
fn deref(&self) -> &Self::Target { fn deref(&self) -> &Self::Target {
match self { match self {
Self::Real => &real::RealRepository, Self::Real => &real::RealRepository,
Self::Mock => &mock::MockRepository, Self::Mock(mock_repository) => mock_repository,
} }
} }
} }
@ -54,6 +58,8 @@ impl From<Direction> for gix::remote::Direction {
} }
} }
pub type Result<T> = core::result::Result<T, Error>;
#[derive(Debug, derive_more::Display)] #[derive(Debug, derive_more::Display)]
pub enum Error { pub enum Error {
InvalidGitDir(git_next_config::GitDir), InvalidGitDir(git_next_config::GitDir),
@ -64,20 +70,26 @@ pub enum Error {
Clone(String), Clone(String),
Open(String), Open(String),
Fetch(String), Fetch(String),
MockLock,
} }
impl std::error::Error for Error {} impl std::error::Error for Error {}
impl From<gix::clone::Error> for Error {
fn from(value: gix::clone::Error) -> Self { mod gix_errors {
Self::Clone(value.to_string()) #![cfg(not(tarpaulin_include))] // third-party library errors
} use super::Error;
} impl From<gix::clone::Error> for Error {
impl From<gix::open::Error> for Error { fn from(value: gix::clone::Error) -> Self {
fn from(value: gix::open::Error) -> Self { Self::Clone(value.to_string())
Self::Open(value.to_string()) }
} }
} impl From<gix::open::Error> for Error {
impl From<gix::clone::fetch::Error> for Error { fn from(value: gix::open::Error) -> Self {
fn from(value: gix::clone::fetch::Error) -> Self { Self::Open(value.to_string())
Self::Fetch(value.to_string()) }
}
impl From<gix::clone::fetch::Error> for Error {
fn from(value: gix::clone::fetch::Error) -> Self {
Self::Fetch(value.to_string())
}
} }
} }

View file

@ -1,4 +1,7 @@
// //
#[cfg(test)]
mod tests;
pub mod oreal; pub mod oreal;
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
@ -7,19 +10,23 @@ use git_next_config::BranchName;
use crate::{ use crate::{
fetch, push, fetch, push,
repository::{open::oreal::RealOpenRepository, Direction}, repository::{mock::MockOpenRepository, open::oreal::RealOpenRepository, Direction},
GitRef, GitRemote, RepoDetails, GitRef, GitRemote, RepoDetails,
}; };
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub enum OpenRepository { pub enum OpenRepository {
Real(oreal::RealOpenRepository), Real(oreal::RealOpenRepository),
Mock, // TODO: (#38) contain a mock model of a repo Mock(MockOpenRepository), // TODO: (#38) contain a mock model of a repo
} }
impl OpenRepository { impl OpenRepository {
pub fn new(gix_repo: gix::Repository) -> Self { pub fn real(gix_repo: gix::Repository) -> Self {
Self::Real(RealOpenRepository::new(Arc::new(Mutex::new(gix_repo)))) Self::Real(RealOpenRepository::new(Arc::new(Mutex::new(gix_repo))))
} }
#[cfg(not(tarpaulin_include))] // don't test mocks
pub const fn mock(mock: MockOpenRepository) -> Self {
Self::Mock(mock)
}
} }
pub trait OpenRepositoryLike { pub trait OpenRepositoryLike {
fn find_default_remote(&self, direction: Direction) -> Option<GitRemote>; fn find_default_remote(&self, direction: Direction) -> Option<GitRemote>;
@ -38,7 +45,7 @@ impl std::ops::Deref for OpenRepository {
fn deref(&self) -> &Self::Target { fn deref(&self) -> &Self::Target {
match self { match self {
Self::Real(real) => real, Self::Real(real) => real,
Self::Mock => todo!(), Self::Mock(mock) => mock,
} }
} }
} }

View file

@ -11,41 +11,42 @@ pub struct RealOpenRepository(Arc<Mutex<gix::Repository>>);
impl super::OpenRepositoryLike for RealOpenRepository { impl super::OpenRepositoryLike for RealOpenRepository {
fn find_default_remote(&self, direction: Direction) -> Option<GitRemote> { fn find_default_remote(&self, direction: Direction) -> Option<GitRemote> {
let Ok(repository) = self.0.lock() else { let Ok(repository) = self.0.lock() else {
#[cfg(not(tarpaulin_include))] // don't test mutex lock failure
return None; return None;
}; };
let Some(Ok(remote)) = repository.find_default_remote(direction.into()) else { let Some(Ok(remote)) = repository.find_default_remote(direction.into()) else {
#[cfg(not(tarpaulin_include))] // test is on local repo - should always have remotes
return None; return None;
}; };
let url = remote.url(direction.into())?; remote.url(direction.into()).map(Into::into)
let host = url.host()?;
let path = url.path.to_string();
let path = path.strip_prefix('/').map_or(path.as_str(), |path| path);
let path = path.strip_suffix(".git").map_or(path, |path| path);
Some(GitRemote::new(
Hostname::new(host),
RepoPath::new(path.to_string()),
))
} }
fn fetch(&self) -> Result<(), fetch::Error> { fn fetch(&self) -> Result<(), fetch::Error> {
let Ok(repository) = self.0.lock() else { let Ok(repository) = self.0.lock() else {
#[cfg(not(tarpaulin_include))] // don't test mutex lock failure
return Err(fetch::Error::Lock); return Err(fetch::Error::Lock);
}; };
let Some(Ok(remote)) = repository.find_default_remote(Direction::Fetch.into()) else { let Some(Ok(remote)) = repository.find_default_remote(Direction::Fetch.into()) else {
#[cfg(not(tarpaulin_include))] // test is on local repo - should always have remotes
return Err(fetch::Error::NoFetchRemoteFound); return Err(fetch::Error::NoFetchRemoteFound);
}; };
remote let prepared_fetch = remote
.connect(gix::remote::Direction::Fetch) .connect(gix::remote::Direction::Fetch)?
.map_err(|e| fetch::Error::Connect(e.to_string()))? .prepare_fetch(gix::progress::Discard, Default::default());
.prepare_fetch(gix::progress::Discard, Default::default()) match prepared_fetch {
.map_err(|e| fetch::Error::Fetch(e.to_string()))? Ok(fetch) => {
.receive(gix::progress::Discard, &Default::default()) fetch
.map_err(|e| fetch::Error::Fetch(e.to_string()))?; .receive(gix::progress::Discard, &Default::default())
.map_err(|e| fetch::Error::Fetch(e.to_string()))?;
}
Err(e) => Err(fetch::Error::Fetch(e.to_string()))?,
}
Ok(()) Ok(())
} }
// TODO: (#72) reimplement using `gix` // TODO: (#72) reimplement using `gix`
#[cfg(not(tarpaulin_include))] // would require writing to external service
fn push( fn push(
&self, &self,
repo_details: &RepoDetails, repo_details: &RepoDetails,
@ -100,3 +101,13 @@ impl super::OpenRepositoryLike for RealOpenRepository {
} }
} }
} }
impl From<&gix::Url> for GitRemote {
fn from(url: &gix::Url) -> Self {
let host = url.host().unwrap_or_default();
let path = url.path.to_string();
let path = path.strip_prefix('/').map_or(path.as_str(), |path| path);
let path = path.strip_suffix(".git").map_or(path, |path| path);
Self::new(Hostname::new(host), RepoPath::new(path.to_string()))
}
}

View file

@ -0,0 +1,37 @@
//
mod find_default_remote {
use assert2::let_assert;
use git_next_config::{GitDir, Hostname, RepoPath};
use crate::GitRemote;
#[test]
fn should_find_default_push_remote() {
// uses the current repo
let_assert!(Ok(cwd) = std::env::current_dir());
let gitdir = GitDir::from(cwd.join("../..")); // from ./crate/git directory to the project rook
let_assert!(Ok(repo) = crate::repository::new().open(&gitdir));
let_assert!(Some(remote) = repo.find_default_remote(crate::repository::Direction::Push));
assert_eq!(
remote,
GitRemote::new(
Hostname::new("git.kemitix.net"),
RepoPath::new("kemitix/git-next".to_string())
)
)
}
}
mod fetch {
use assert2::let_assert;
use git_next_config::GitDir;
#[test]
fn should_fetch_from_repo() {
// uses the current repo and fetches from the remote server
let_assert!(Ok(cwd) = std::env::current_dir());
let gitdir = GitDir::from(cwd.join("../.."));
let_assert!(Ok(repo) = crate::repository::new().open(&gitdir));
let_assert!(Ok(_) = repo.fetch());
}
}

View file

@ -12,7 +12,7 @@ pub struct RealRepository;
impl RepositoryLike for RealRepository { impl RepositoryLike for RealRepository {
fn open(&self, gitdir: &GitDir) -> Result<OpenRepository, Error> { fn open(&self, gitdir: &GitDir) -> Result<OpenRepository, Error> {
let gix_repo = gix::ThreadSafeRepository::open(gitdir.to_path_buf())?.to_thread_local(); let gix_repo = gix::ThreadSafeRepository::open(gitdir.to_path_buf())?.to_thread_local();
Ok(OpenRepository::new(gix_repo)) Ok(OpenRepository::real(gix_repo))
} }
fn git_clone(&self, repo_details: &RepoDetails) -> Result<OpenRepository, Error> { fn git_clone(&self, repo_details: &RepoDetails) -> Result<OpenRepository, Error> {
@ -23,6 +23,6 @@ impl RepositoryLike for RealRepository {
)? )?
.fetch_only(gix::progress::Discard, &AtomicBool::new(false))?; .fetch_only(gix::progress::Discard, &AtomicBool::new(false))?;
Ok(OpenRepository::new(gix_repo)) Ok(OpenRepository::real(gix_repo))
} }
} }

View file

@ -0,0 +1,207 @@
mod validate {
use assert2::let_assert;
use git_next_config::{ForgeDetails, GitDir, Hostname, RepoPath};
use crate::{
repository::{self, Direction},
validate, GitRemote, RepoDetails,
};
#[test]
fn should_ok_a_valid_repo() {
let repo_details = RepoDetails::default()
.with_forge(
ForgeDetails::default().with_hostname(Hostname::new("localhost".to_string())),
)
.with_repo_path(RepoPath::new("kemitix/test".to_string()));
let gitdir = GitDir::from("foo");
let remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/test".to_string()),
);
let (repository, mut reality) = repository::mock();
let_assert!(
Ok(_) = reality.can_open_repo(&gitdir).map(
#[allow(clippy::significant_drop_tightening)]
|open_repo| {
let_assert!(
Ok(_) = open_repo.lock().map(|mut open_repo| {
open_repo.has_default_remote(Direction::Push, remote.clone());
open_repo.has_default_remote(Direction::Fetch, remote);
})
);
}
)
);
let_assert!(Ok(open_repository) = repository.open(&gitdir));
let_assert!(Ok(_) = validate(&open_repository, &repo_details));
}
#[test]
fn should_fail_where_no_default_push_remote() {
let repo_details = RepoDetails::default()
.with_forge(
ForgeDetails::default().with_hostname(Hostname::new("localhost".to_string())),
)
.with_repo_path(RepoPath::new("kemitix/test".to_string()));
let gitdir = GitDir::from("foo");
let remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/test".to_string()),
);
let (repository, mut reality) = repository::mock();
let_assert!(
Ok(_) = reality.can_open_repo(&gitdir).map(
#[allow(clippy::significant_drop_tightening)]
|open_repo| {
let_assert!(
Ok(_) = open_repo.lock().map(|mut open_repo| {
// INFO: open_repo.has_default_remote(Direction::Push, remote.clone());
open_repo.has_default_remote(Direction::Fetch, remote);
})
);
}
)
);
let_assert!(Ok(open_repository) = repository.open(&gitdir));
let_assert!(Err(_) = validate(&open_repository, &repo_details));
}
#[test]
fn should_fail_where_no_default_fetch_remote() {
let repo_details = RepoDetails::default()
.with_forge(
ForgeDetails::default().with_hostname(Hostname::new("localhost".to_string())),
)
.with_repo_path(RepoPath::new("kemitix/test".to_string()));
let gitdir = GitDir::from("foo");
let remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/test".to_string()),
);
let (repository, mut reality) = repository::mock();
let_assert!(
Ok(_) = reality.can_open_repo(&gitdir).map(
#[allow(clippy::significant_drop_tightening)]
|open_repo| {
let_assert!(
Ok(_) = open_repo.lock().map(|mut open_repo| {
open_repo.has_default_remote(Direction::Push, remote);
// INFO: open_repo.has_default_remote(Direction::Fetch, remote);
})
);
}
)
);
let_assert!(Ok(open_repository) = repository.open(&gitdir));
let_assert!(Err(_) = validate(&open_repository, &repo_details));
}
#[test]
fn should_fail_where_invalid_default_push_remote() {
let repo_details = RepoDetails::default()
.with_forge(
ForgeDetails::default().with_hostname(Hostname::new("localhost".to_string())),
)
.with_repo_path(RepoPath::new("kemitix/test".to_string()));
let gitdir = GitDir::from("foo");
let remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/test".to_string()),
);
let other_remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/other".to_string()),
);
let (repository, mut reality) = repository::mock();
let_assert!(
Ok(_) = reality.can_open_repo(&gitdir).map(
#[allow(clippy::significant_drop_tightening)]
|open_repo| {
let_assert!(
Ok(_) = open_repo.lock().map(|mut open_repo| {
open_repo.has_default_remote(Direction::Push, other_remote);
open_repo.has_default_remote(Direction::Fetch, remote);
})
);
}
)
);
let_assert!(Ok(open_repository) = repository.open(&gitdir));
let_assert!(Err(_) = validate(&open_repository, &repo_details));
}
#[test]
fn should_fail_where_invalid_default_fetch_remote() {
let repo_details = RepoDetails::default()
.with_forge(
ForgeDetails::default().with_hostname(Hostname::new("localhost".to_string())),
)
.with_repo_path(RepoPath::new("kemitix/test".to_string()));
let gitdir = GitDir::from("foo");
let remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/test".to_string()),
);
let other_remote = GitRemote::new(
Hostname::new("localhost"),
RepoPath::new("kemitix/other".to_string()),
);
let (repository, mut reality) = repository::mock();
let_assert!(
Ok(_) = reality.can_open_repo(&gitdir).map(
#[allow(clippy::significant_drop_tightening)]
|open_repo| {
let_assert!(
Ok(_) = open_repo.lock().map(|mut open_repo| {
open_repo.has_default_remote(Direction::Push, remote);
open_repo.has_default_remote(Direction::Fetch, other_remote);
})
);
}
)
);
let_assert!(Ok(open_repository) = repository.open(&gitdir));
let_assert!(Err(_) = validate(&open_repository, &repo_details));
}
}
mod git_clone {
use assert2::let_assert;
use git_next_config::{ForgeDetails, GitDir, Hostname, RepoPath};
use crate::{repository::Direction, GitRemote, RepoDetails};
#[test]
fn should_clone_repo() {
let_assert!(Ok(fs) = kxio::fs::temp());
let r = crate::repository::new();
let repo_details = RepoDetails::default()
.with_forge(
ForgeDetails::default().with_hostname(Hostname::new("git.kemitix.net".to_string())),
)
.with_gitdir(GitDir::new(fs.base()))
.with_repo_path(RepoPath::new("kemitix/git-next".to_string()));
let_assert!(Ok(open_repo) = r.git_clone(&repo_details));
let_assert!(Some(remote) = open_repo.find_default_remote(Direction::Fetch));
assert_eq!(
remote,
GitRemote::new(
Hostname::new("git.kemitix.net"),
RepoPath::new("kemitix/git-next".to_string())
)
);
}
}

View file

@ -6,13 +6,13 @@ use super::{GitRemote, RepoDetails};
#[tracing::instrument(skip_all)] #[tracing::instrument(skip_all)]
pub fn validate(repository: &OpenRepository, repo_details: &RepoDetails) -> Result<()> { pub fn validate(repository: &OpenRepository, repo_details: &RepoDetails) -> Result<()> {
let git_remote = repo_details.git_remote();
let Some(push_remote) = repository.find_default_remote(Direction::Push) else { let Some(push_remote) = repository.find_default_remote(Direction::Push) else {
return Err(Error::NoDefaultPushRemote); return Err(Error::NoDefaultPushRemote);
}; };
let Some(fetch_remote) = repository.find_default_remote(Direction::Fetch) else { let Some(fetch_remote) = repository.find_default_remote(Direction::Fetch) else {
return Err(Error::NoDefaultFetchRemote); return Err(Error::NoDefaultFetchRemote);
}; };
let git_remote = repo_details.git_remote();
info!(config = %git_remote, push = %push_remote, fetch = %fetch_remote, "Check remotes match"); info!(config = %git_remote, push = %push_remote, fetch = %fetch_remote, "Check remotes match");
if git_remote != push_remote { if git_remote != push_remote {
return Err(Error::MismatchDefaultPushRemote { return Err(Error::MismatchDefaultPushRemote {

View file

@ -177,7 +177,7 @@ impl Server {
let server_storage = server_storage.clone(); let server_storage = server_storage.clone();
let webhook = webhook.clone(); let webhook = webhook.clone();
let net = self.net.clone(); let net = self.net.clone();
let repo = self.repo; let repo = self.repo.clone();
let generation = self.generation; let generation = self.generation;
move |(repo_alias, server_repo_config)| { move |(repo_alias, server_repo_config)| {
let span = tracing::info_span!("create_actor", alias = %repo_alias, config = %server_repo_config); let span = tracing::info_span!("create_actor", alias = %repo_alias, config = %server_repo_config);
@ -205,8 +205,13 @@ impl Server {
gitdir, gitdir,
); );
info!("Starting Repo Actor"); info!("Starting Repo Actor");
let actor = let actor = RepoActor::new(
RepoActor::new(repo_details, webhook.clone(), generation, net.clone(), repo); repo_details,
webhook.clone(),
generation,
net.clone(),
repo.clone(),
);
(forge_name.clone(), repo_alias, actor) (forge_name.clone(), repo_alias, actor)
} }
} }

View file

@ -13,7 +13,7 @@ fn test_name() {
panic!("fs") panic!("fs")
}; };
let net = Network::new_mock(); let net = Network::new_mock();
let repo = git::repository::mock(); let (repo, _reality) = git::repository::mock();
let repo_details = common::repo_details( let repo_details = common::repo_details(
1, 1,
Generation::new(), Generation::new(),
@ -40,7 +40,7 @@ async fn test_branches_get() {
let body = include_str!("./data-forgejo-branches-get.json"); let body = include_str!("./data-forgejo-branches-get.json");
net.add_get_response(&url, StatusCode::OK, body); net.add_get_response(&url, StatusCode::OK, body);
let net = Network::from(net); let net = Network::from(net);
let repo = git::repository::mock(); let (repo, _reality) = git::repository::mock();
let repo_details = common::repo_details( let repo_details = common::repo_details(
1, 1,