Add function to checkout the jobs repository #75
Conversation
ColinKinloch
force-pushed
the
git
branch
2 times, most recently
from
587d8dd to
ff98e93
Compare
ColinKinloch
force-pushed
the
git
branch
4 times, most recently
from
082f212 to
7428588
Compare
ColinKinloch
force-pushed
the
git
branch
2 times, most recently
from
be78598 to
dbcc18f
Compare
* `clone_git_repository` to clone arbitrary repo * `Job::clone_git_repository` to clone the jobs repo
| @@ -454,3 +457,148 @@ impl Runner { | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| // TODO: Should clone_git_repository be async | |||
| // gitoxide doesn't currently have async implemented for http backend | |||
There was a problem hiding this comment.
I don't think this is viable without either async or cloning in a separate thread (which would make cancellation really tricky, though you seem to have some interrupt-related stuff wired up already); blocking an entire I/O thread for what might be a very long clone process is not workable. Should this maybe just be using libgit2 or something else instead?
| .ok_or(GitCheckoutError::MissingCommit)? | ||
| } else if let Some(reference) = head_ref { | ||
| repo | ||
| // TODO: This should be refs/heads/{reference} but it doesn't exist |
There was a problem hiding this comment.
I think this is fine, aiui refs/heads/ would only exist if you had a local tracking branch, which really isn't needed here anyway.
| if let Some(depth) = depth { | ||
| if depth > 0 { |
There was a problem hiding this comment.
| if let Some(depth) = depth { | |
| if depth > 0 { | |
| if let Some(depth) = depth.and_then(NonZeroU32::new) { |
also lets you avoid the .unwrap.
| refspec::parse::Operation::Fetch, | ||
| ) { | ||
| refspecs.push(refspec.to_owned()); | ||
| } |
There was a problem hiding this comment.
will this just silently fail on errors? depending on whether or not it's an internal fail, this should at least surface a warning or similar. (ditto for the branch that follows.)
| * * Clones to BuildDir | ||
| * * Checks out git_info.sha and fetches all in git_info.refspecs | ||
| * * Hardcoded username "gitlab-ci-token" | ||
| * * credHelperCommand? |
There was a problem hiding this comment.
this is a bit tricky to understand out-of-context, might want to add a few more details for some of these points
| } | ||
|
|
||
| let checkout_progress = progress.add_child("checkout".to_string()); | ||
| let (checkout, _outcome) = fetch.fetch_then_checkout(checkout_progress, &should_interrupt)?; |
There was a problem hiding this comment.
thought: if the goal is just to be able to read files from the repo, do we need to do an entire checkout to begin with? couldn't it clone a bare repo and then load files as-needed from there? though the apis might be harder to make for that...but it would likely also be a lot faster.
This branch adds
crate::clone_git_repositoryto clone git repos generally andJob::clone_git_repositoryto clone specifically defined by the gitlab job.clone_git_repositoryis heavily based onPrepareFetch::fetch_onlySince the gitoxide
PrepareFetchandPrepareCheckoutstructs delete the target path when they are dropped I opted to checkout the repository to a temporary directory, then move it's contents to the path provided to the target directory.This adds a rather unwieldy
GitCheckoutErrorenum. gitoxidesErrortypes triggers theresult_large_errclippy warning.This requires rust version
1.73.0or later.Fixes #21