3diy
/
moonraker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update_manager: Don't use github's API to check repo version 

The remote version info can be retrieved by simply doing a git fetch, then running "git rev-parse" and "git describe" on the desired remote branch.

Signed-off-by: Eric Callahan <arksine.code@gmail.com>
This commit is contained in:
Arksine 2020-12-28 18:09:10 -05:00
parent 9993b1e656
commit 9501d72059
1 changed files with 37 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
moonraker/plugins/update_manager.py
View File

@ -23,10 +23,8 @@ MOONRAKER_PATH = os.path.normpath(os.path.join(
# TODO: May want to attempt to look up the disto for the correct # TODO: May want to attempt to look up the disto for the correct
# klippy install script or have the user configure it # klippy install script or have the user configure it
APT_CMD = "sudo DEBIAN_FRONTEND=noninteractive apt-get" APT_CMD = "sudo DEBIAN_FRONTEND=noninteractive apt-get"
REPO_PREFIX = "https://api.github.com/repos"
REPO_DATA = { REPO_DATA = {
'moonraker': { 'moonraker': {
'repo_url': f"{REPO_PREFIX}/arksine/moonraker/branches/master",
'origin': "https://github.com/arksine/moonraker.git", 'origin': "https://github.com/arksine/moonraker.git",
'install_script': "scripts/install-moonraker.sh", 'install_script': "scripts/install-moonraker.sh",
'requirements': "scripts/moonraker-requirements.txt", 'requirements': "scripts/moonraker-requirements.txt",
@ -36,7 +34,6 @@ REPO_DATA = {
'site_pkg_path': "lib/python3.7/site-packages", 'site_pkg_path': "lib/python3.7/site-packages",
}, },
'klipper': { 'klipper': {
'repo_url': f"{REPO_PREFIX}/kevinoconnor/klipper/branches/master",
'origin': "https://github.com/kevinoconnor/klipper.git", 'origin': "https://github.com/kevinoconnor/klipper.git",
'install_script': "scripts/install-octopi.sh", 'install_script': "scripts/install-octopi.sh",
'requirements': "scripts/klippy-requirements.txt", 'requirements': "scripts/klippy-requirements.txt",
@ -198,16 +195,15 @@ class GitUpdater:
self.execute_cmd = umgr.execute_cmd self.execute_cmd = umgr.execute_cmd
self.execute_cmd_with_response = umgr.execute_cmd_with_response self.execute_cmd_with_response = umgr.execute_cmd_with_response
self.notify_update_response = umgr.notify_update_response self.notify_update_response = umgr.notify_update_response
self.github_request = umgr.github_request
self.name = name self.name = name
self.repo_path = path self.repo_path = path
self.env = env self.env = env
self.version = self.cur_hash = self.remote_hash = "?" self.version = self.cur_hash = "?"
self.remote_version = self.remote_hash = "?"
self.init_evt = Event() self.init_evt = Event()
self.debug = umgr.repo_debug self.debug = umgr.repo_debug
self.remote = "origin" self.remote = "origin"
self.branch = "master" self.branch = "master"
self.github_url = None
self.is_valid = self.is_dirty = self.detached = False self.is_valid = self.is_dirty = self.detached = False
IOLoop.current().spawn_callback(self.refresh) IOLoop.current().spawn_callback(self.refresh)
@ -255,13 +251,13 @@ class GitUpdater:
await self.init_evt.wait(to) await self.init_evt.wait(to)
async def refresh(self): async def refresh(self):
await self._check_local_version() await self._check_version()
await self._check_remote_version()
self.init_evt.set() self.init_evt.set()
async def _check_local_version(self): async def _check_version(self):
self.is_valid = self.detached = False self.is_valid = self.detached = False
self.cur_hash = self.branch = self.remote = "?" self.cur_hash = self.branch = self.remote = "?"
self.version = self.remote_version = "?"
try: try:
blist = await self.execute_cmd_with_response( blist = await self.execute_cmd_with_response(
f"git -C {self.repo_path} branch --list") f"git -C {self.repo_path} branch --list")
@ -270,6 +266,7 @@ class GitUpdater:
return return
branch = None branch = None
for b in blist.split("\n"): for b in blist.split("\n"):
b = b.strip()
if b[0] == "*": if b[0] == "*":
branch = b[2:] branch = b[2:]
break break
@ -287,35 +284,47 @@ class GitUpdater:
self.remote = await self.execute_cmd_with_response( self.remote = await self.execute_cmd_with_response(
f"git -C {self.repo_path} config --get" f"git -C {self.repo_path} config --get"
f" branch.{self.branch}.remote") f" branch.{self.branch}.remote")
await self.execute_cmd(
f"git -C {self.repo_path} fetch {self.remote} --prune -q",
retries=3)
remote_url = await self.execute_cmd_with_response( remote_url = await self.execute_cmd_with_response(
f"git -C {self.repo_path} remote get-url {self.remote}") f"git -C {self.repo_path} remote get-url {self.remote}")
hash = await self.execute_cmd_with_response( cur_hash = await self.execute_cmd_with_response(
f"git -C {self.repo_path} rev-parse HEAD") f"git -C {self.repo_path} rev-parse HEAD")
remote_hash = await self.execute_cmd_with_response(
f"git -C {self.repo_path} rev-parse "
f"{self.remote}/{self.branch}")
repo_version = await self.execute_cmd_with_response( repo_version = await self.execute_cmd_with_response(
f"git -C {self.repo_path} describe --always " f"git -C {self.repo_path} describe --always "
"--tags --long --dirty") "--tags --long --dirty")
remote_version = await self.execute_cmd_with_response(
f"git -C {self.repo_path} describe {self.remote}/{self.branch}"
" --always --tags --long")
except Exception: except Exception:
self._log_exc("Error retreiving git info") self._log_exc("Error retreiving git info")
return return
self.is_dirty = repo_version.endswith("dirty") self.is_dirty = repo_version.endswith("dirty")
tag_version = "?" versions = []
ver_match = re.match(r"v\d+\.\d+\.\d-\d+", repo_version) for ver in [repo_version, remote_version]:
if ver_match: tag_version = "?"
tag_version = ver_match.group() ver_match = re.match(r"v\d+\.\d+\.\d-\d+", ver)
self.version = tag_version if ver_match:
self.cur_hash = hash tag_version = ver_match.group()
logging.info( versions.append(tag_version)
f"Repo Detected:\nPath: {self.path}\nRemote: {self.remote}\n" self.version, self.remote_version = versions
f"Branch: {self.branch}\nHEAD SHA: {self.cur_hash}\n" self.cur_hash = cur_hash.strip()
f"Version: {repo_version}") self.remote_hash = remote_hash.strip()
url_info = re.match(r"https://github.com/(.*)/", remote_url) self._log_info(
if url_info is not None: f"Repo Detected:\nPath: {self.repo_path}\nRemote: {self.remote}\n"
user = url_info.group(1) f"Branch: {self.branch}\nRemote URL: {remote_url}\n"
self.github_url = f"{REPO_PREFIX}/{user}/{self.name}" \ f"Current SHA: {self.cur_hash}\n"
f"/branches/{self.branch}" f"Remote SHA: {self.remote_hash}\nVersion: {self.version}\n"
f"Remote Version: {self.remote_version}\n"
f"Is Dirty: {self.is_dirty}\nIs Detached: {self.detached}")
if self.debug: if self.debug:
self.is_valid = True self.is_valid = True
self._log_info("Debug enabled, bypassing official repo check")
elif self.branch == "master" and self.remote == "origin": elif self.branch == "master" and self.remote == "origin":
if self.detached: if self.detached:
self._log_info("Detached HEAD detected, repo invalid") self._log_info("Detached HEAD detected, repo invalid")
@ -324,39 +333,21 @@ class GitUpdater:
if remote_url[-4:] != ".git": if remote_url[-4:] != ".git":
remote_url += ".git" remote_url += ".git"
if remote_url == REPO_DATA[self.name]['origin']: if remote_url == REPO_DATA[self.name]['origin']:
self.github_url = REPO_DATA[name]['repo_url']
self.is_valid = True self.is_valid = True
self._log_info("Validity check for git repo passed") self._log_info("Validity check for git repo passed")
else: else:
self._log_info(f"Invalid git origin '{origin}'") self._log_info(f"Invalid git origin url '{remote_url}'")
else: else:
self._log_info( self._log_info(
"Git repo not on offical remote/branch: " "Git repo not on offical remote/branch: "
f"{self.remote}/{self.branch}") f"{self.remote}/{self.branch}")
async def _check_remote_version(self):
if self.github_url is None:
return
try:
branch_info = await self.github_request(self.github_url)
except Exception:
raise self._log_exc(f"Error retreiving github info")
commit_hash = branch_info.get('commit', {}).get('sha', None)
if commit_hash is None:
self.is_valid = False
self.upstream_version = "?"
raise self._log_exc(f"Invalid github response", False)
self._log_info(f"Received latest commit hash: {commit_hash}")
self.remote_hash = commit_hash
async def update(self, update_deps=False): async def update(self, update_deps=False):
if not self.is_valid: if not self.is_valid:
raise self._log_exc("Update aborted, repo is not valid", False) raise self._log_exc("Update aborted, repo is not valid", False)
if self.is_dirty: if self.is_dirty:
raise self._log_exc( raise self._log_exc(
"Update aborted, repo is has been modified", False) "Update aborted, repo is has been modified", False)
if self.remote_hash == "?":
await self._check_remote_version()
if self.remote_hash == self.cur_hash: if self.remote_hash == self.cur_hash:
# No need to update # No need to update
return return
@ -385,7 +376,7 @@ class GitUpdater:
elif need_env_rebuild: elif need_env_rebuild:
await self._update_virtualenv(True) await self._update_virtualenv(True)
# Refresh local repo state # Refresh local repo state
await self._check_local_version() await self._check_version()
if self.name == "moonraker": if self.name == "moonraker":
# Launch restart async so the request can return # Launch restart async so the request can return
# before the server restarts # before the server restarts
@ -479,6 +470,7 @@ class GitUpdater:
'remote_alias': self.remote, 'remote_alias': self.remote,
'branch': self.branch, 'branch': self.branch,
'version': self.version, 'version': self.version,
'remote_version': self.remote_version,
'current_hash': self.cur_hash, 'current_hash': self.cur_hash,
'remote_hash': self.remote_hash, 'remote_hash': self.remote_hash,
'is_dirty': self.is_dirty, 'is_dirty': self.is_dirty,