kallithea Changeset - eb486c0c3114

Changeset - eb486c0c3114

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

Mads Kiilerich (mads) - 6 years ago 2020-07-20 19:46:30
mads@kiilerich.com

Grafted from: b697b8941e73

scm: refactor install_git_hooks

Rename, simplify, and negate some logic to make the flow more readable to me
and give better logging.

For example, "force_create" were more about "force overwrite". Calling it
"force" is more precise.

4 files changed with 18 insertions and 22 deletions:

kallithea/lib/utils.py

kallithea/model/repo.py

kallithea/model/scm.py

kallithea/tests/vcs/test_git.py

0 comments (0 inline, 0 general)

kallithea/lib/utils.py

➞

Show inline comments

@@ @@ -497,13 +497,13 @@ def repo2db_mapper(initial_repo_dict, re @@
                 # update repository server-info
                 log.debug('Running update server info')
                 git_repo._update_server_info()
             new_repo.update_changeset_cache()
         elif install_git_hooks:
             if db_repo.repo_type == 'git':
-                ScmModel().install_git_hooks(db_repo.scm_instance, force_create=overwrite_git_hooks)
+                ScmModel().install_git_hooks(db_repo.scm_instance, force=overwrite_git_hooks)
     removed = []
     # remove from database those repositories that are not in the filesystem
     for repo in sa.query(Repository).all():
         if repo.repo_name not in initial_repo_dict:
             if remove_obsolete:

kallithea/model/repo.py

➞

Show inline comments

@@ @@ -663,13 +663,13 @@ class RepoModel(object): @@
                 baseui.setconfig('hooks', k, None)
             repo = backend(repo_path, create=True, src_url=clone_uri, baseui=baseui)
         elif repo_type == 'git':
             repo = backend(repo_path, create=True, src_url=clone_uri, bare=True)
             # add kallithea hook into this repo
-            ScmModel().install_git_hooks(repo=repo)
             ScmModel().install_git_hooks(repo)
         else:
             raise Exception('Not supported repo_type %s expected hg/git' % repo_type)
         log.debug('Created repo %s with %s backend',
                   repo_name, repo_type)
         return repo

kallithea/model/scm.py

➞

Show inline comments

@@ @@ -688,18 +688,18 @@ class ScmModel(object): @@
         # example, when using uwsgi, it will point at the uwsgi program itself.
         # FIXME This may not work on Windows and may need a shell wrapper script.
         return (kallithea.CONFIG.get('git_hook_interpreter')
                 or sys.executable
                 or '/usr/bin/env python3')
-    def install_git_hooks(self, repo, force_create=False):
+    def install_git_hooks(self, repo, force=False):
         """
         Creates a kallithea hook inside a git repository
         :param repo: Instance of VCS repo
-        :param force_create: Create even if same name hook exists
+        :param force: Overwrite existing non-Kallithea hooks
         """
         hooks_path = os.path.join(repo.path, 'hooks')
         if not repo.bare:
             hooks_path = os.path.join(repo.path, '.git', 'hooks')
         if not os.path.isdir(hooks_path):
@@ @@ -713,42 +713,38 @@ class ScmModel(object): @@
         tmpl_pre += pkg_resources.resource_string(
             'kallithea', os.path.join('config', 'pre_receive_tmpl.py')
+        )
         for h_type, tmpl in [('pre', tmpl_pre), ('post', tmpl_post)]:
             hook_file = os.path.join(hooks_path, '%s-receive' % h_type)
-            has_hook = False
+            other_hook = False
             log.debug('Installing git hook in repo %s', repo)
             if os.path.exists(hook_file):
                 # let's take a look at this hook, maybe it's kallithea ?
                 log.debug('hook exists, checking if it is from kallithea')
                 with open(hook_file, 'rb') as f:
                     data = f.read()
                     matches = re.search(br'^KALLITHEA_HOOK_VER\s*=\s*(.*)$', data, flags=re.MULTILINE)
                     if matches:
                         try:
                             ver = matches.groups()[0]
                             log.debug('Found Kallithea hook - it has KALLITHEA_HOOK_VER %r', ver)
                             has_hook = True
                         except Exception:
                             log.error(traceback.format_exc())
                         ver = matches.groups()[0]
                         log.debug('Found Kallithea hook - it has KALLITHEA_HOOK_VER %r', ver)
                     else:
                         log.debug('Found non-Kallithea hook at %s', hook_file)
                         other_hook = True
             if other_hook and not force:
                 log.warning('skipping overwriting hook file %s', hook_file)
             else:
                 # there is no hook in this dir, so we want to create one
                 has_hook = True
             if has_hook or force_create:
                 log.debug('writing %s hook file !', h_type)
                 try:
                     with open(hook_file, 'wb') as f:
                         tmpl = tmpl.replace(b'_TMPL_', safe_bytes(kallithea.__version__))
                         f.write(tmpl)
                     os.chmod(hook_file, 0o755)
                 except IOError as e:
                     log.error('error writing %s: %s', hook_file, e)
             else:
                 log.debug('skipping writing hook file')
                     log.error('error writing hook %s: %s', hook_file, e)
 def AvailableRepoGroupChoices(repo_group_perm_level, extras=()):
     """Return group_id,string tuples with choices for all the repo groups where
     the user has the necessary permissions.

kallithea/tests/vcs/test_git.py

➞

Show inline comments

@@ @@ -791,13 +791,13 @@ class TestGitHooks(object): @@
         """
         for hook, hook_path in self.kallithea_hooks.items():
             if os.path.exists(hook_path):
                 os.remove(hook_path)
-        ScmModel().install_git_hooks(repo=self.repo)
         ScmModel().install_git_hooks(self.repo)
         for hook, hook_path in self.kallithea_hooks.items():
             assert os.path.exists(hook_path)
     def test_kallithea_hooks_updated(self):
         """
@@ @@ -805,13 +805,13 @@ class TestGitHooks(object): @@
         """
         for hook, hook_path in self.kallithea_hooks.items():
             with open(hook_path, "w") as f:
                 f.write("KALLITHEA_HOOK_VER=0.0.0\nJUST_BOGUS")
-        ScmModel().install_git_hooks(repo=self.repo)
         ScmModel().install_git_hooks(self.repo)
         for hook, hook_path in self.kallithea_hooks.items():
             with open(hook_path) as f:
                 assert "JUST_BOGUS" not in f.read()
     def test_custom_hooks_untouched(self):
@@ @@ -820,13 +820,13 @@ class TestGitHooks(object): @@
         """
         for hook, hook_path in self.kallithea_hooks.items():
             with open(hook_path, "w") as f:
                 f.write("#!/bin/bash\n#CUSTOM_HOOK")
-        ScmModel().install_git_hooks(repo=self.repo)
         ScmModel().install_git_hooks(self.repo)
         for hook, hook_path in self.kallithea_hooks.items():
             with open(hook_path) as f:
                 assert "CUSTOM_HOOK" in f.read()
     def test_custom_hooks_forced_update(self):
@@ @@ -835,11 +835,11 @@ class TestGitHooks(object): @@
         """
         for hook, hook_path in self.kallithea_hooks.items():
             with open(hook_path, "w") as f:
                 f.write("#!/bin/bash\n#CUSTOM_HOOK")
-        ScmModel().install_git_hooks(repo=self.repo, force_create=True)
+        ScmModel().install_git_hooks(self.repo, force=True)
         for hook, hook_path in self.kallithea_hooks.items():
             with open(hook_path) as f:
                 assert "KALLITHEA_HOOK_VER" in f.read()

0 comments (0 inline, 0 general)