Skip to content

Commit

Permalink
Improve git error handling and refactor $path
Browse files Browse the repository at this point in the history
  • Loading branch information
@r-richardson
r-richardson committed Aug 16, 2024
1 parent bdd93d4 commit 677243a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 23 deletions.
38 changes: 21 additions & 17 deletions lib/OpenQA/Git.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ sub _prepare_git_command ($self, $args = undef) {
}

sub _format_git_error ($self, $result, $error_message) {

my $path = $self->dir;
if ($result->{stderr} or $result->{stdout}) {
$error_message .= "($path): " . $result->{stdout} . $result->{stderr};
Expand Down Expand Up @@ -97,45 +97,49 @@ sub commit ($self, $args = undef) {
return undef;
}

# Moved functions from Clone.pm

sub get_current_branch ($self) {#
sub get_current_branch ($self) { #
my @git = $self->_prepare_git_command();
my $r = run_cmd_with_log_return_error([@git, 'branch', '--show-current']);
die "Error detecting current branch for : $r->{stderr}" unless $r->{status};
die $self->_format_git_error($r, "Error detecting current branch") unless $r->{status};

Check warning on line 103 in lib/OpenQA/Git.pm

View workflow job for this annotation

GitHub Actions / Perlcritic

Useless interpolation of literal string - severity 3 

[ValuesAndExpressions::ProhibitInterpolationOfLiterals] See page 51 of PBP
return Mojo::Util::trim($r->{stdout});
}

sub _ssh_git_cmd ($self, $git_args) {
my @git = $self->_prepare_git_command();
return ['env', 'GIT_SSH_COMMAND="ssh -oBatchMode=yes"', 'git', @$git_args];
}

sub get_remote_default_branch ($self, $url) {
my @git = $self->_prepare_git_command();
my $r = run_cmd_with_log_return_error($self->_ssh_git_cmd(['ls-remote', '--symref', $url, 'HEAD']));
die "Error detecting remote default branch name for '$url': $r->{stderr}"
die $self->_format_git_error($r, "Error detecting remote default branch name for '$url'")
unless $r->{status} && $r->{stdout} =~ /refs\/heads\/(\S+)\s+HEAD/;
return $1;
}

sub git_clone_url_to_path ($self, $url, $path) {
sub git_clone_url_to_path ($self, $url, $path) {
my @git = $self->_prepare_git_command();
my $r = run_cmd_with_log_return_error($self->_ssh_git_cmd(['clone', $url, $path]));
die "Failed to clone $url into '$path': $r->{stderr}" unless $r->{status};
die $self->_format_git_error($r, "Failed to clone $url into '$path'") unless $r->{status};
}

sub git_get_origin_url ($self, $path) {
my $r = run_cmd_with_log_return_error(['git', '-C', $path, 'remote', 'get-url', 'origin']);
die "Failed to get origin url for '$path': $r->{stderr}" unless $r->{status};
sub git_get_origin_url ($self) {
my @git = $self->_prepare_git_command();
my $r = run_cmd_with_log_return_error([@git, 'remote', 'get-url', 'origin']);
die $self->_format_git_error($r, "Failed to get origin url") unless $r->{status};

Check warning on line 129 in lib/OpenQA/Git.pm

View workflow job for this annotation

GitHub Actions / Perlcritic

Useless interpolation of literal string - severity 3 

[ValuesAndExpressions::ProhibitInterpolationOfLiterals] See page 51 of PBP
return Mojo::Util::trim($r->{stdout});
}

sub git_fetch ($self, $path, $branch_arg) {
my $r = run_cmd_with_log_return_error($self->_ssh_git_cmd(['-C', $path, 'fetch', 'origin', $branch_arg]));
die "Failed to fetch from '$branch_arg': $r->{stderr}" unless $r->{status};
sub git_fetch ($self, $branch_arg) {
my @git = $self->_prepare_git_command();
my $r = run_cmd_with_log_return_error($self->_ssh_git_cmd([@git, 'fetch', 'origin', $branch_arg]));
die $self->_format_git_error($r, "Failed to fetch from '$branch_arg'") unless $r->{status};
}

sub git_reset_hard ($self, $path, $branch) {
my $r = run_cmd_with_log_return_error(['git', '-C', $path, 'reset', '--hard', "origin/$branch"]);
die "Failed to reset to 'origin/$branch': $r->{stderr}" unless $r->{status};
sub git_reset_hard ($self, $branch) {
my @git = $self->_prepare_git_command();
my $r = run_cmd_with_log_return_error([@git, 'reset', '--hard', "origin/$branch"]);
die $self->_format_git_error($r, "Failed to reset to 'origin/$branch'") unless $r->{status};
}

1;
11 changes: 5 additions & 6 deletions lib/OpenQA/Task/Git/Clone.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ sub _git_clone ($git, $job, $ctx, $path, $url) {
if (!-d $path) {
$git->git_clone_url_to_path($url, $path);
# update local branch to latest remote branch version
$git->git_fetch($path, "$requested_branch:$requested_branch")
$git->git_fetch("$requested_branch:$requested_branch")
if ($requested_branch ne $remote_default_branch);
}

my $origin_url = $git->git_get_origin_url($path);
my $origin_url = $git->git_get_origin_url;
if ($url ne $origin_url) {
$ctx->warn("Local checkout at $path has origin $origin_url but requesting to clone from $url");
return;
Expand All @@ -69,14 +69,13 @@ sub _git_clone ($git, $job, $ctx, $path, $url) {
my $current_branch = $git->get_current_branch;
if ($requested_branch eq $current_branch) {
# updating default branch (including checkout)
$git->git_fetch($path, $requested_branch);
$git->git_reset_hard($path, $requested_branch);
$git->git_fetch($requested_branch);
$git->git_reset_hard($requested_branch);
}
else {
# updating local branch to latest remote branch version
$git->git_fetch($path, "$requested_branch:$requested_branch");
$git->git_fetch("$requested_branch:$requested_branch");
}
}

1;

0 comments on commit 677243a

Please sign in to comment.