mirror of
https://github.com/truenas/scale-build.git
synced 2025-12-23 20:39:30 +00:00
d69ab76764
Once a package has completed checkout, we are not printing another statement showing that the package's checkout process is complete as otherwise with packages being checkout in parallel, it reduces visibility as to what is still active and what isn't.
94 lines
3.9 KiB
Python
94 lines
3.9 KiB
Python
import logging
|
|
import os
|
|
import shutil
|
|
|
|
from scale_build.config import BRANCH_OVERRIDES, TRUENAS_BRANCH_OVERRIDE, TRY_BRANCH_OVERRIDE
|
|
from scale_build.exceptions import CallError
|
|
from scale_build.utils.git_utils import (
|
|
branch_checked_out_locally, branch_exists_in_repository, create_branch,
|
|
retrieve_git_remote_and_sha, retrieve_git_branch, update_git_manifest
|
|
)
|
|
from scale_build.utils.logger import LoggingContext
|
|
from scale_build.utils.paths import GIT_LOG_PATH
|
|
from scale_build.utils.run import run
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class GitPackageMixin:
|
|
|
|
def branch_out(self, new_branch_name, base_branch_override=None):
|
|
create_branch(self.source_path, base_branch_override or self.branch, new_branch_name)
|
|
|
|
def branch_exists_in_remote(self, branch):
|
|
return branch_exists_in_repository(self.origin, branch)
|
|
|
|
def branch_checked_out_locally(self, branch):
|
|
return branch_checked_out_locally(self.source_path, branch)
|
|
|
|
def retrieve_current_remote_origin_and_sha(self):
|
|
if self.exists:
|
|
return retrieve_git_remote_and_sha(self.source_path)
|
|
else:
|
|
return {'url': None, 'sha': None}
|
|
|
|
def update_git_manifest(self):
|
|
info = self.retrieve_current_remote_origin_and_sha()
|
|
update_git_manifest(info['url'], info['sha'])
|
|
|
|
def checkout(self, branch_override=None):
|
|
origin_url = self.retrieve_current_remote_origin_and_sha()['url']
|
|
branch = branch_override or self.branch
|
|
if branch == self.existing_branch and self.origin == origin_url:
|
|
logger.debug('Updating git repo [%s] (%s)', self.name, GIT_LOG_PATH)
|
|
with LoggingContext('git-checkout', 'w'):
|
|
run(['git', '-C', self.source_path, 'fetch', 'origin'])
|
|
run(['git', '-C', self.source_path, 'checkout', branch])
|
|
run(['git', '-C', self.source_path, 'reset', '--hard', f'origin/{branch}'])
|
|
else:
|
|
logger.debug('Checking out git repo [%s] (%s)', self.name, GIT_LOG_PATH)
|
|
if os.path.exists(self.source_path):
|
|
shutil.rmtree(self.source_path)
|
|
with LoggingContext('git-checkout', 'w'):
|
|
run(['git', 'clone', '--recurse', self.origin, self.source_path])
|
|
run(['git', '-C', self.source_path, 'checkout', branch])
|
|
|
|
self.update_git_manifest()
|
|
logger.info('%r checkout complete', self.name)
|
|
|
|
@property
|
|
def existing_branch(self):
|
|
if not self.exists:
|
|
return None
|
|
return retrieve_git_branch(self.source_path)
|
|
|
|
def get_branch_override(self):
|
|
# We prioritise TRUENAS_BRANCH_OVERRIDE over any individual branch override
|
|
# keeping in line with the behavior we used to have before
|
|
gh_override = TRUENAS_BRANCH_OVERRIDE or BRANCH_OVERRIDES.get(self.name)
|
|
|
|
# TRY_BRANCH_OVERRIDE is a special use-case. It allows setting a branch name to be used
|
|
# during the checkout phase, only if it exists on the remote.
|
|
#
|
|
# This is useful for PR builds and testing where you want to use defaults for most repos
|
|
# but need to test building of a series of repos with the same experimental branch
|
|
#
|
|
if TRY_BRANCH_OVERRIDE:
|
|
retries = 3
|
|
while retries:
|
|
try:
|
|
if branch_exists_in_repository(self.origin, TRY_BRANCH_OVERRIDE):
|
|
gh_override = TRY_BRANCH_OVERRIDE
|
|
except CallError:
|
|
retries -= 1
|
|
logger.debug(
|
|
'Failed to determine if %r branch exists for %r. Trying again', TRY_BRANCH_OVERRIDE, self.origin
|
|
)
|
|
if not retries:
|
|
logger.debug('Unable to determine if %r branch exists in 3 attempts.', TRY_BRANCH_OVERRIDE)
|
|
else:
|
|
break
|
|
|
|
return gh_override
|