Merge pull request #530 from JrGoodle/protocol-enum

Add git protocol enum

src/clowder/__init__.py

@@ -5,7 +5,7 @@
 
 """
 
-import logging
+# import logging
 import os
 from pathlib import Path
 from typing import Optional
@@ -22,7 +22,7 @@
 
 CURRENT_DIR = Path.cwd()
 CLOWDER_CONFIG_DIR = Path.home() / '.config' / 'clowder'
-CLOWDER_CONFIG_YAML = Path(CLOWDER_CONFIG_DIR) / 'clowder.config.yaml'
+CLOWDER_CONFIG_YAML = CLOWDER_CONFIG_DIR / 'clowder.config.yaml'
 CLOWDER_DIR: Optional[Path] = None
 CLOWDER_REPO_DIR: Optional[Path] = None
 CLOWDER_REPO_VERSIONS_DIR: Optional[Path] = None

src/clowder/clowder_repo.py

@@ -14,7 +14,7 @@
 import clowder.util.formatting as fmt
 from clowder import CLOWDER_DIR, CLOWDER_REPO_DIR, CLOWDER_YAML, CURRENT_DIR
 from clowder.error import ClowderError, ClowderExit
-from clowder.git.project_repo import ProjectRepo
+from clowder.git import ProjectRepo
 from clowder.git.util import existing_git_repository
 from clowder.util.clowder_utils import link_clowder_yaml
 from clowder.util.connectivity import is_offline
@@ -127,7 +127,8 @@ def print_status(fetch: bool = False) -> None:
         print(' - Fetch upstream changes for clowder repo')
         repo.fetch(clowder_repo_remote)
 
-    project_output = repo.format_project_string('.clowder')
+    clowder_path = Path('.clowder')
+    project_output = repo.format_project_string(clowder_path)
     current_ref_output = repo.format_project_ref_string()
 
     if CLOWDER_YAML is None or not CLOWDER_YAML.is_symlink():

src/clowder/git/__init__.py

@@ -4,3 +4,17 @@
 .. codeauthor:: Joe Decapo <joe@polka.cat>
 
 """
+
+from enum import Enum, unique
+
+from .git_repo import GitRepo
+from .project_repo import ProjectRepo
+from .project_repo_recursive import ProjectRepoRecursive
+
+
+@unique
+class GitProtocol(Enum):
+    """Git protocol enum"""
+
+    SSH = "ssh"
+    HTTPS = "https"

src/clowder/git/project_repo_impl.py

@@ -17,7 +17,7 @@
 from clowder.error import ClowderGitError
 from clowder.util.file_system import remove_directory
 
-from .repo import GitRepo
+from .git_repo import GitRepo
 from .util import (
     existing_git_repository,
     not_detached

src/clowder/model/defaults.py

@@ -5,6 +5,7 @@
 
 """
 
+from clowder.git import GitProtocol
 from clowder.git.util import (
     format_git_branch,
     format_git_tag
@@ -20,7 +21,7 @@ class Defaults(object):
     :ivar Optional[str] commit: Default commit sha-1
     :ivar str remote: Default remote name
     :ivar str source: Default source name
-    :ivar str protocol: Default git protocol
+    :ivar GitProtocol protocol: Default git protocol
     :ivar int depth: Default depth
     :ivar bool recursive: Default recursive value
     :ivar str timestamp_author: Default timestamp author
@@ -33,7 +34,7 @@ def __init__(self, defaults: dict):
         :param dict defaults: Parsed YAML python object for defaults
         """
 
-        self.protocol = defaults["protocol"]
+        self.protocol = GitProtocol(defaults["protocol"])
         self.source = defaults["source"]
         self.remote = defaults.get("remote", "origin")
         self.depth = defaults.get("depth", 0)
@@ -66,7 +67,7 @@ def get_yaml(self) -> dict:
                     'remote': self.remote,
                     'source': self.source,
                     'depth': self.depth,
-                    'protocol': self.protocol}
+                    'protocol': self.protocol.value}
 
         if self.branch is not None:
             defaults['branch'] = self.branch

src/clowder/model/fork.py

@@ -11,7 +11,7 @@
 from termcolor import colored
 
 from clowder import CLOWDER_DIR
-from clowder.git.project_repo import ProjectRepo
+from clowder.git import ProjectRepo
 from clowder.git.util import (
     existing_git_repository,
     format_git_branch,
@@ -121,4 +121,4 @@ def status(self) -> str:
     def url(self) -> str:
         """Return project url"""
 
-        return git_url(self._source.protocol, self._source.url, self.name)
+        return git_url(self._source.protocol.value, self._source.url, self.name)

src/clowder/model/project.py

@@ -13,10 +13,8 @@
 
 import clowder.util.formatting as fmt
 from clowder import CLOWDER_DIR
-from clowder.error import ClowderError
-from clowder.error import ClowderExit
-from clowder.git.project_repo import ProjectRepo
-from clowder.git.project_repo_recursive import ProjectRepoRecursive
+from clowder.error import ClowderError, ClowderExit
+from clowder.git import ProjectRepo, ProjectRepoRecursive
 from clowder.git.util import (
     existing_git_repository,
     format_git_branch,
@@ -583,4 +581,4 @@ def _run_forall_command(self, command: str, env: dict, ignore_errors: bool, para
     def _url(self) -> str:
         """Return project url"""
 
-        return git_url(self.source.protocol, self.source.url, self.name)
+        return git_url(self.source.protocol.value, self.source.url, self.name)

src/clowder/model/source.py

@@ -5,6 +5,8 @@
 
 """
 
+from clowder.git import GitProtocol
+
 from .defaults import Defaults
 
 
@@ -13,6 +15,7 @@ class Source(object):
 
     :ivar str name: Source name
     :ivar str url: Source url
+    :ivar GitProtocol protocol Git protocol
     """
 
     def __init__(self, source: dict, defaults: Defaults):
@@ -24,7 +27,7 @@ def __init__(self, source: dict, defaults: Defaults):
 
         self.name = source['name']
         self.url = source['url']
-        self.protocol = source.get('protocol', defaults.protocol)
+        self.protocol = GitProtocol(source.get('protocol', defaults.protocol))
 
     def get_yaml(self) -> dict:
         """Return python object representation for saving yaml
@@ -35,4 +38,4 @@ def get_yaml(self) -> dict:
 
         return {'name': self.name,
                 'url': self.url,
-                'protocol': self.protocol}
+                'protocol': self.protocol.value}

test/unittests/test_git_utilities.py

@@ -4,11 +4,7 @@
 import sys
 import unittest
 
-from clowder.git.repo import GitRepo
-from clowder.git.util import (
-    ref_type,
-    truncate_ref
-)
+from clowder.git import GitRepo, ref_type, truncate_ref
 
 
 class GitUtilitiesTest(unittest.TestCase):