feat:improve behavior

cunla · cunla · commit b7785de4e3bd · 2024-01-28T11:06:15.000-05:00
diff --git a/README.md b/README.md
@@ -12,13 +12,13 @@ versions of the actions.
 
 ```text
 ./.github/workflows/test.yml:
-	actions/checkout                  v3 ==> v3.5.3
-	release-drafter/release-drafter    v5 ==> v5.24.0
-	actions/setup-python              v4 ==> v4.7.0
+	actions/checkout                  v2 ==> v3
+	release-drafter/release-drafter    v5
+	actions/setup-python              v4
 ./.github/workflows/publish.yml:
-	pypa/gh-action-pypi-publish    release/v1 ==> v1.8.8
-	actions/checkout                  v3 ==> v3.5.3
-	actions/setup-python              v4 ==> v4.7.0
+	pypa/gh-action-pypi-publish       v1
+	actions/checkout                  v2 ==> v3
+	actions/setup-python              v3 ==> v4
 ```
 
 # Supported use cases
@@ -27,11 +27,14 @@ versions of the actions.
 Usage: github-actions-cli [OPTIONS] COMMAND [ARGS]...
 
 Options:
-  -repo TEXT           Repository to analyze, can be a local directory or a
-                       {OWNER}/{REPO} format  [default: .]
-  --github-token TEXT  GitHub token to use, by default will use GITHUB_TOKEN
-                       environment variable
-  --help               Show this message and exit.
+  --repo TEXT               Repository to analyze, can be a local directory or
+                            a {OWNER}/{REPO} format  [default: .]
+  --github-token TEXT       GitHub token to use, by default will use
+                            GITHUB_TOKEN environment variable
+  --compare-exact-versions  Compare versions using all semantic and not only
+                            major versions, e.g., v1 will be upgraded to
+                            v1.2.3
+  --help                    Show this message and exit.
 
 Commands:
   list-actions    List actions in a workflow
@@ -59,21 +62,26 @@ flag, it will create a commit updating the workflows to the latest.
 Parameters:
 
 ```text
-Usage: cli.py update-actions [OPTIONS]
+Usage: github-actions-cli update-actions [OPTIONS]
 
   Show actions required updates in repository workflows
 
 Options:
-  -u, --update      Do not update, list only
-  -commit-msg TEXT  Commit msg, only relevant when remote repo
+  -u, --update      Update actions in workflows (For remote repos: make
+                    changes and commit, for local repos: update files)
+  -commit-msg TEXT  Commit msg, only relevant when remote repo  [default:
+                    chore(ci):update actions]
+  --help            Show this message and exit.
 ```
 
-## `list-workflows` List all workflows path and name in a specified repository.
+If you want the check to compare exact versions and not only major versions, use the `--compare-exact-versions` flag.
+
+## `list-workflows` List all workflow paths and names in a specified repository.
 
 Example:
 
 ```shell
-github-actions-cli -repo cunla/fakeredis list-workflows
+github-actions-cli --repo cunla/fakeredis list-workflows
 ```
 
 will return:
@@ -90,7 +98,7 @@ Given a repo and a workflow path, return all actions in the workflow.
 Example:
 
 ```shell
-github-actions-cli -repo cunla/fakeredis list-actions .github/workflows/test.yml
+github-actions-cli --repo cunla/fakeredis list-actions .github/workflows/test.yml
 ```
 
 Result
diff --git a/gha_cli/cli.py b/gha_cli/cli.py
@@ -2,7 +2,7 @@
 import logging
 import os
 from collections import namedtuple
-from typing import Optional, List, Set, Dict, Union
+from typing import Optional, List, Set, Dict, Union, Any
 
 import click
 import yaml
@@ -17,33 +17,33 @@
 FLAG_COMPARE_EXACT_VERSION = False
 
 
+def compare_versions(v1: str, v2: str) -> int:
+    """Compare two versions, return 1 if v1 > v2, 0 if v1 == v2, -1 if v1 < v2
+    """
+    if v1.startswith('v'):
+        v1 = v1[1:]
+    if v2.startswith('v'):
+        v2 = v2[1:]
+    v1 = v1.split('.')
+    v2 = v2.split('.')
+    compare_count = max(len(v1), len(v2)) if FLAG_COMPARE_EXACT_VERSION else 1
+    for i in range(compare_count):
+        v1_i = int(v1[i]) if i < len(v1) else 0
+        v2_i = int(v2[i]) if i < len(v2) else 0
+        if v1_i > v2_i:
+            return 1
+        if v1_i < v2_i:
+            return -1
+    return 0
+
+
 class GithubActionsTools(object):
-    workflows: dict[str, dict[str, Workflow]] = dict()  # repo_name -> [path -> workflow]
+    _wf_cache: dict[str, dict[str, Union[Workflow, Any]]] = dict()  # repo_name -> [path -> workflow/yaml]
     actions_latest_release: dict[str, str] = dict()  # action_name@current_release -> latest_release_tag
 
     def __init__(self, github_token: str):
         self.client = Github(login_or_token=github_token)
 
-    @staticmethod
-    def compare_versions(v1: str, v2: str) -> int:
-        """Compare two versions, return 1 if v1 > v2, 0 if v1 == v2, -1 if v1 < v2
-        """
-        if v1.startswith('v'):
-            v1 = v1[1:]
-        if v2.startswith('v'):
-            v2 = v2[1:]
-        v1 = v1.split('.')
-        v2 = v2.split('.')
-        compare_count = max(len(v1), len(v2)) if FLAG_COMPARE_EXACT_VERSION else 1
-        for i in range(compare_count):
-            v1_i = int(v1[i]) if i < len(v1) else 0
-            v2_i = int(v2[i]) if i < len(v2) else 0
-            if v1_i > v2_i:
-                return 1
-            if v1_i < v2_i:
-                return -1
-        return 0
-
     @staticmethod
     def is_local_repo(repo_name: str) -> bool:
         return os.path.exists(repo_name) and os.path.exists(os.path.join(repo_name, '.git'))
@@ -56,44 +56,8 @@ def list_full_paths(path: str) -> set[str]:
                 for file in os.listdir(path)
                 if file.endswith(('.yml', '.yaml'))}
 
-    def get_github_workflows(self, repo_name: str) -> Set[str]:
-        if repo_name in self.workflows:
-            return set(self.workflows[repo_name].keys())
-        # local
-        if self.is_local_repo(repo_name):
-            return self.list_full_paths(os.path.join(repo_name, '.github', 'workflows'))
-        if repo_name.startswith('.'):
-            click.secho(f'{repo_name} is not a local repo and does not start with owner/repo', fg='red', err=True)
-            exit(1)
-        # Remote
-        repo = self.client.get_repo(repo_name)
-        self.workflows[repo_name] = {
-            wf.path: wf
-            for wf in repo.get_workflows()
-            if wf.path.startswith('.github/')}
-        return set(self.workflows[repo_name].keys())
-
-    def _get_workflow_content(self, repo_name: str, workflow_path: str) -> Union[str, bytes]:
-        workflow_paths = self.get_github_workflows(repo_name)
-
-        if self.is_local_repo(repo_name):
-            if not os.path.exists(workflow_path):
-                click.echo(
-                    f'f{workflow_path} not found in workflows for repository {repo_name}, '
-                    f'possible values: {workflow_paths}', err=True)
-            with open(workflow_path) as f:
-                return f.read()
-
-        if workflow_path not in workflow_paths:
-            click.echo(
-                f'f{workflow_path} not found in workflows for repository {repo_name}, '
-                f'possible values: {workflow_paths}', err=True)
-        repo = self.client.get_repo(repo_name)
-        workflow_content = repo.get_contents(workflow_path)
-        return workflow_content.decoded_content
-
     def get_workflow_actions(self, repo_name: str, workflow_path: str) -> Set[str]:
-        workflow_content = self._get_workflow_content(repo_name, workflow_path)
+        workflow_content = self._get_workflow_file_content(repo_name, workflow_path)
         workflow = yaml.load(workflow_content, Loader=yaml.CLoader)
         res = set()
         for job in workflow.get('jobs', dict()).values():
@@ -103,21 +67,20 @@ def get_workflow_actions(self, repo_name: str, workflow_path: str) -> Set[str]:
         return res
 
     def check_for_updates(self, action_name: str) -> Optional[str]:
-        """Check whether an action has update, and return the latest version if it does
-        syntax for uses:
+        """Check whether an action has an update, and return the latest version if it does syntax for uses:
         https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_iduses
         """
         if '@' not in action_name:
             return None
         repo_name, current_version = action_name.split('@')
         repo = self.client.get_repo(repo_name)
         latest_release = repo.get_latest_release()
-        if GithubActionsTools.compare_versions(latest_release.tag_name, current_version):
+        if compare_versions(latest_release.tag_name, current_version):
             return latest_release.tag_name
         return None
 
     def get_repo_actions_latest(self, repo_name: str) -> Dict[str, List[ActionVersion]]:
-        workflow_paths = self.get_github_workflows(repo_name)
+        workflow_paths = self._get_github_workflow_filenames(repo_name)
         res = dict()
         for path in workflow_paths:
             res[path] = list()
@@ -134,12 +97,21 @@ def get_repo_actions_latest(self, repo_name: str) -> Dict[str, List[ActionVersio
                 res[path].append(ActionVersion(action_name, curr_version, latest))
         return res
 
+    def get_repo_workflow_names(self, repo_name: str) -> Dict[str, str]:
+        workflow_paths = self._get_github_workflow_filenames(repo_name)
+        res = dict()
+        for path in workflow_paths:
+            content = self._get_workflow_file_content(repo_name, path)
+            yaml_content = yaml.load(content, Loader=yaml.CLoader)
+            res[path] = yaml_content.get('name', path)
+        return res
+
     def update_actions(
             self, repo_name: str, workflow_path: str,
             updates: List[ActionVersion],
             commit_msg: str,
     ) -> None:
-        workflow_content = self._get_workflow_content(repo_name, workflow_path)
+        workflow_content = self._get_workflow_file_content(repo_name, workflow_path)
         if isinstance(workflow_content, bytes):
             workflow_content = workflow_content.decode()
         for update in updates:
@@ -170,6 +142,42 @@ def _update_workflow_content(
         click.secho(f'Committed changes to workflow in {repo_name}:{workflow_path}', fg='cyan')
         return res
 
+    def _get_github_workflow_filenames(self, repo_name: str) -> Set[str]:
+        if repo_name in self._wf_cache:
+            return set(self._wf_cache[repo_name].keys())
+        # local
+        if self.is_local_repo(repo_name):
+            return self.list_full_paths(os.path.join(repo_name, '.github', 'workflows'))
+        if repo_name.startswith('.'):
+            click.secho(f'{repo_name} is not a local repo and does not start with owner/repo', fg='red', err=True)
+            raise ValueError(f'{repo_name} is not a local repo and does not start with owner/repo')
+        # Remote
+        repo = self.client.get_repo(repo_name)
+        self._wf_cache[repo_name] = {
+            wf.path: wf
+            for wf in repo.get_workflows()
+            if wf.path.startswith('.github/')}
+        return set(self._wf_cache[repo_name].keys())
+
+    def _get_workflow_file_content(self, repo_name: str, workflow_path: str) -> Union[str, bytes]:
+        workflow_paths = self._get_github_workflow_filenames(repo_name)
+
+        if self.is_local_repo(repo_name):
+            if not os.path.exists(workflow_path):
+                click.echo(
+                    f'f{workflow_path} not found in workflows for repository {repo_name}, '
+                    f'possible values: {workflow_paths}', err=True)
+            with open(workflow_path) as f:
+                return f.read()
+
+        if workflow_path not in workflow_paths:
+            click.echo(
+                f'f{workflow_path} not found in workflows for repository {repo_name}, '
+                f'possible values: {workflow_paths}', err=True)
+        repo = self.client.get_repo(repo_name)
+        workflow_content = repo.get_contents(workflow_path)
+        return workflow_content.decoded_content
+
 
 GITHUB_ACTION_NOT_PROVIDED_MSG = """GitHub connection token not provided.
 You might not be able to make the changes to remote repositories.
@@ -203,18 +211,19 @@ def cli(ctx, repo: str, github_token: Optional[str], compare_exact_versions: boo
 @cli.command(help='Show actions required updates in repository workflows')
 @click.option(
     '-u', '--update', is_flag=True, default=False,
-    help='Update actions in workflows (For remote repos: make changes and commit, for local repos: update files',)
+    help='Update actions in workflows (For remote repos: make changes and commit, for local repos: update files', )
 @click.option(
     '-commit-msg',
     default='chore(ci):update actions', type=str, show_default=True,
     help='Commit msg, only relevant when remote repo')
 @click.pass_context
 def update_actions(ctx, update: bool, commit_msg: str):
     gh, repo = ctx.obj['gh'], ctx.obj['repo']
+    workflow_names = (gh.get_repo_workflow_names(repo))
     workflow_action_versions = gh.get_repo_actions_latest(repo)
-    for workflow in workflow_action_versions:
-        click.secho(f'{workflow}:', fg='blue')
-        for action in workflow_action_versions[workflow]:
+    for workflow_path, workflow_name in workflow_names.items():
+        click.secho(f'{workflow_path} ({click.style(workflow_name, fg="bright_cyan")}):', fg='bright_blue')
+        for action in workflow_action_versions[workflow_path]:
             s = f'\t{action.name:30} {action.current:>5}'
             if action.latest:
                 old_version = action.current.split('.')
@@ -240,9 +249,9 @@ def list_actions(ctx, workflow: str):
 @cli.command(help='List workflows in repository')
 @click.pass_context
 def list_workflows(ctx):
-    workflow_paths = ctx.obj['gh'].get_github_workflows(ctx.obj['repo'])
-    for path in workflow_paths:
-        click.echo(f'{path}')
+    workflow_paths = (ctx.obj['gh'].get_repo_workflow_names(ctx.obj['repo']))
+    for path, name in workflow_paths.items():
+        click.echo(f'{path} - {name}')
 
 
 if __name__ == '__main__':
