Merge branch 'load-repo-info' (resolve #5)

Author: hackebrot

src/labels/cli.py

@@ -3,18 +3,27 @@
 import sys
 import typing
 
+import attr
 import click
 from requests.auth import HTTPBasicAuth
 
-from labels import __version__
+from labels import __version__, utils
 from labels.exceptions import LabelsException
-from labels.github import Client, Label
+from labels.github import Client, Label, Repository
 from labels.io import write_labels, read_labels
 from labels.log import create_logger
 
 Labels_Dict = typing.Dict[str, Label]
 
 
+@attr.s(auto_attribs=True)
+class LabelsContext:
+    """Extra context for label CLI commands."""
+
+    client: Client
+    repository: typing.Optional[Repository] = None
+
+
 @click.group()
 @click.pass_context
 @click.version_option(__version__, "-V", "--version", prog_name="labels")
@@ -45,13 +54,49 @@ def labels(ctx, username: str, token: str, verbose: bool) -> None:
     else:
         logger.setLevel(logging.INFO)
 
-    ctx.obj = Client(HTTPBasicAuth(username, token))
+    ctx.obj = LabelsContext(Client(HTTPBasicAuth(username, token)))
+
+
+@click.pass_obj
+def default_owner(labels_context: LabelsContext) -> str:
+    """Load repository owner information from the local working tree."""
+    if labels_context.repository is None:
+        repository = utils.load_repository_info()
+        if repository is None:
+            raise click.BadParameter("Unable to load repository information.")
+        labels_context.repository = repository
+    return labels_context.repository.owner
+
+
+@click.pass_obj
+def default_repo(labels_context: LabelsContext) -> str:
+    """Load repository name information from the local working tree."""
+    if labels_context.repository is None:
+        repository = utils.load_repository_info()
+        if repository is None:
+            raise click.BadParameter("Unable to load repository information.")
+        labels_context.repository = repository
+    return labels_context.repository.name
 
 
 @labels.command("fetch")
 @click.pass_obj
-@click.option("-o", "--owner", help="GitHub owner name", type=str, required=True)
-@click.option("-r", "--repo", help="GitHub repository name", type=str, required=True)
+@click.option(
+    "-o",
+    "--owner",
+    help="GitHub owner name",
+    type=str,
+    default=default_owner,
+    required=True,
+)
+@click.option(
+    "-r",
+    "--repo",
+    help="GitHub repository name",
+    type=str,
+    default=default_repo,
+    required=True,
+)
 @click.option(
     "-f",
     "--filename",
@@ -60,13 +105,16 @@ def labels(ctx, username: str, token: str, verbose: bool) -> None:
     type=click.Path(),
     required=True,
 )
-def fetch_cmd(client: Client, owner: str, repo: str, filename: str) -> None:
+def fetch_cmd(context: LabelsContext, owner: str, repo: str, filename: str) -> None:
     """Fetch labels for a GitHub repository.
 
     This will write the labels information to disk to the specified filename.
     """
+
+    repository = Repository(owner, repo)
+
     try:
-        labels = client.list_labels(owner, repo)
+        labels = context.client.list_labels(repository)
     except LabelsException as exc:
         click.echo(str(exc))
         sys.exit(1)
@@ -79,8 +127,22 @@ def fetch_cmd(client: Client, owner: str, repo: str, filename: str) -> None:
 
 @labels.command("sync")
 @click.pass_obj
-@click.option("-o", "--owner", help="GitHub owner name", type=str, required=True)
-@click.option("-r", "--repo", help="GitHub repository name", type=str, required=True)
+@click.option(
+    "-o",
+    "--owner",
+    help="GitHub owner name",
+    type=str,
+    default=default_owner,
+    required=True,
+)
+@click.option(
+    "-r",
+    "--repo",
+    help="GitHub repository name",
+    type=str,
+    default=default_repo,
+    required=True,
+)
 @click.option("-n", "--dryrun", help="Do not modify remote labels", is_flag=True)
 @click.option(
     "-f",
@@ -91,7 +153,7 @@ def fetch_cmd(client: Client, owner: str, repo: str, filename: str) -> None:
     required=True,
 )
 def sync_cmd(
-    client: Client, owner: str, repo: str, filename: str, dryrun: bool
+    context: LabelsContext, owner: str, repo: str, filename: str, dryrun: bool
 ) -> None:
     """Sync labels with a GitHub repository.
 
@@ -105,8 +167,10 @@ def sync_cmd(
 
     local_labels = read_labels(filename)
 
+    repository = Repository(owner, repo)
+
     try:
-        remote_labels = {l.name: l for l in client.list_labels(owner, repo)}
+        remote_labels = {l.name: l for l in context.client.list_labels(repository)}
     except LabelsException as exc:
         click.echo(str(exc), err=True)
         sys.exit(1)
@@ -152,21 +216,21 @@ def sync_cmd(
 
     for name in labels_to_delete.keys():
         try:
-            client.delete_label(owner, repo, name=name)
+            context.client.delete_label(repository, name=name)
         except LabelsException as exc:
             click.echo(str(exc), err=True)
             failures.append(name)
 
     for name, label in labels_to_update.items():
         try:
-            client.edit_label(owner, repo, name=name, label=label)
+            context.client.edit_label(repository, name=name, label=label)
         except LabelsException as exc:
             click.echo(str(exc), err=True)
             failures.append(name)
 
     for name, label in labels_to_create.items():
         try:
-            client.create_label(owner, repo, label=label)
+            context.client.create_label(repository, label=label)
         except LabelsException as exc:
             click.echo(str(exc), err=True)
             failures.append(name)

src/labels/github.py

@@ -7,6 +7,14 @@
 from labels.exceptions import GitHubException
 
 
+@attr.s(auto_attribs=True, frozen=True)
+class Repository:
+    """Represents a GitHub repository."""
+
+    owner: str
+    name: str
+
+
 def not_read_only(attr: attr.Attribute, value: typing.Any) -> bool:
     """Filter for attr that checks for a leading underscore."""
     return not attr.name.startswith("_")
@@ -48,17 +56,17 @@ def __init__(
         self.session = requests.Session()
         self.session.auth = auth
 
-    def list_labels(self, owner: str, repo: str) -> typing.List[Label]:
+    def list_labels(self, repo: Repository) -> typing.List[Label]:
         """Return the list of Labels from the repository.
 
         GitHub API docs:
         https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository
         """
         logger = logging.getLogger("labels")
-        logger.debug(f"Requesting labels for {owner}/{repo}")
+        logger.debug(f"Requesting labels for {repo.owner}/{repo.name}")
 
         response = self.session.get(
-            f"{self.base_url}/repos/{owner}/{repo}/labels",
+            f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels",
             headers={"Accept": "application/vnd.github.symmetra-preview+json"},
         )
 
@@ -71,17 +79,17 @@ def list_labels(self, owner: str, repo: str) -> typing.List[Label]:
 
         return [Label(**data) for data in response.json()]
 
-    def get_label(self, owner: str, repo: str, *, name: str) -> Label:
+    def get_label(self, repo: Repository, *, name: str) -> Label:
         """Return a single Label from the repository.
 
         GitHub API docs:
         https://developer.github.com/v3/issues/labels/#get-a-single-label
         """
         logger = logging.getLogger("labels")
-        logger.debug(f"Requesting label '{name}' for {owner}/{repo}")
+        logger.debug(f"Requesting label '{name}' for {repo.owner}/{repo.name}")
 
         response = self.session.get(
-            f"{self.base_url}/repos/{owner}/{repo}/labels/{name}",
+            f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels/{name}",
             headers={"Accept": "application/vnd.github.symmetra-preview+json"},
         )
 
@@ -94,17 +102,17 @@ def get_label(self, owner: str, repo: str, *, name: str) -> Label:
 
         return Label(**response.json())
 
-    def create_label(self, owner: str, repo: str, *, label: Label) -> Label:
+    def create_label(self, repo: Repository, *, label: Label) -> Label:
         """Create a new Label for the repository.
 
         GitHub API docs:
         https://developer.github.com/v3/issues/labels/#create-a-label
         """
         logger = logging.getLogger("labels")
-        logger.debug(f"Creating label '{label.name}' for {owner}/{repo}")
+        logger.debug(f"Creating label '{label.name}' for {repo.owner}/{repo.name}")
 
         response = self.session.post(
-            f"{self.base_url}/repos/{owner}/{repo}/labels",
+            f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels",
             headers={"Accept": "application/vnd.github.symmetra-preview+json"},
             json=label.params_dict,
         )
@@ -118,17 +126,17 @@ def create_label(self, owner: str, repo: str, *, label: Label) -> Label:
 
         return Label(**response.json())
 
-    def edit_label(self, owner: str, repo: str, *, name: str, label: Label) -> Label:
+    def edit_label(self, repo: Repository, *, name: str, label: Label) -> Label:
         """Update a GitHub issue label.
 
         GitHub API docs:
         https://developer.github.com/v3/issues/labels/#update-a-label
         """
         logger = logging.getLogger("labels")
-        logger.debug(f"Editing label '{name}' for {owner}/{repo}")
+        logger.debug(f"Editing label '{name}' for {repo.owner}/{repo.name}")
 
         response = self.session.patch(
-            f"{self.base_url}/repos/{owner}/{repo}/labels/{name}",
+            f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels/{name}",
             headers={"Accept": "application/vnd.github.symmetra-preview+json"},
             json=label.params_dict,
         )
@@ -142,17 +150,17 @@ def edit_label(self, owner: str, repo: str, *, name: str, label: Label) -> Label
 
         return Label(**response.json())
 
-    def delete_label(self, owner: str, repo: str, *, name: str) -> None:
+    def delete_label(self, repo: Repository, *, name: str) -> None:
         """Delete a GitHub issue label.
 
         GitHub API docs:
         https://developer.github.com/v3/issues/labels/#delete-a-label
         """
         logger = logging.getLogger("labels")
-        logger.debug(f"Deleting label '{name}' for {owner}/{repo}")
+        logger.debug(f"Deleting label '{name}' for {repo.owner}/{repo.name}")
 
         response = self.session.delete(
-            f"{self.base_url}/repos/{owner}/{repo}/labels/{name}"
+            f"{self.base_url}/repos/{repo.owner}/{repo.name}/labels/{name}"
         )
 
         if response.status_code != 204:

src/labels/log.py

@@ -7,7 +7,10 @@ class ContextFilter(logging.Filter):
     """Logging filter to add the click command to the record."""
 
     def filter(self, record: logging.LogRecord) -> bool:
-        ctx = click.get_current_context()
+        ctx = click.get_current_context(silent=True)
+        if not ctx:
+            return False
+
         setattr(record, "cmd", ctx.command.name)
         return True
 

src/labels/utils.py

@@ -0,0 +1,36 @@
+import re
+import shlex
+import subprocess
+import typing
+
+
+from labels.github import Repository
+
+
+REMOTE_REGEX = re.compile(
+    r"^(https|git)(:\/\/|@)github\.com[\/:](?P<owner>[^\/:]+)\/(?P<name>.+).git$"
+)
+
+
+def load_repository_info(remote_name: str = "origin") -> typing.Optional[Repository]:
+    """Load repository information from the local working tree.
+
+    HTTPS url format -> 'https://github.com/owner/name.git'
+    SSH   url format -> '[email protected]:owner/name.git'
+    """
+
+    proc = subprocess.run(
+        shlex.split(f"git remote get-url {remote_name}"),
+        stdout=subprocess.PIPE,
+        encoding="utf-8",
+    )
+
+    if proc.returncode != 0:
+        return None
+
+    match = REMOTE_REGEX.match(proc.stdout.strip())
+
+    if match is None:
+        return None
+
+    return Repository(owner=match.group("owner"), name=match.group("name"))