getpopper · ivotron · Jul 23, 2019 · Jul 18, 2019 · Jul 23, 2019
diff --git a/.travis.yml b/.travis.yml
@@ -12,7 +12,10 @@ before_install:
 - ci/scripts/install_scripts.sh
 - pip install git+https://github.com/virtuald/pyhcl.git@0.3.12#egg=pyhcl
 install:
+- pip install coverage
 - pip install cli/
 script:
-- python -m unittest discover --start-directory cli/
+- coverage run -m unittest discover --start-directory cli/
 - popper run
+after_success:
+- bash <(curl -s https://codecov.io/bash)
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 [![Downloads](https://pepy.tech/badge/popper)](https://pepy.tech/project/popper)
 [![Build Status](https://travis-ci.org/systemslab/popper.svg?branch=master)](https://travis-ci.org/systemslab/popper)
+[![codecov](https://codecov.io/gh/systemslab/popper/branch/master/graph/badge.svg)](https://codecov.io/gh/systemslab/popper)
 [![Join the chat at https://gitter.im/systemslab/popper](https://badges.gitter.im/systemslab/popper.svg)](https://gitter.im/falsifiable-us/popper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![PyPI version](https://badge.fury.io/py/popper.svg)](https://badge.fury.io/py/popper)
 [![GitHub license](https://img.shields.io/github/license/systemslab/popper.svg)](https://github.com/systemslab/popper/blob/master/LICENSE)

diff --git a/cli/popper/utils.py b/cli/popper/utils.py
@@ -2,7 +2,6 @@
 import re
 import sys
 import threading
-from collections import defaultdict
 
 import yaml
 import click
@@ -23,14 +22,14 @@ def setup_cache():
 
 
 def decode(line):
-    """Make treatment of stdout Python 2/3 compatible"""
+    """Make treatment of stdout Python 2/3 compatible."""
     if isinstance(line, bytes):
         return line.decode('utf-8')
     return line
 
 
 def get_items(dict_object):
-    """Python 2/3 compatible way of iterating over a dictionary"""
+    """Python 2/3 compatible way of iterating over a dictionary."""
     for key in dict_object:
         yield key, dict_object[key]
 
@@ -83,10 +82,16 @@ def g(*args, **kwargs):
 def find_default_wfile(wfile=None):
     """
     Used to find `main.workflow` in $PWD or in `.github`
-    And returns error if not found
+    And returns error if not found.
+
+    Args:
+        wfile (str): The path to a workflow file.
+        The default value of this is None, when the
+        function searches for `main.workflow` or
+        `.github/main.workflow'.
 
     Returns:
-        path of wfile
+        str: Path of wfile.
     """
     if not wfile:
         if os.path.isfile("main.workflow"):
@@ -100,18 +105,17 @@ def find_default_wfile(wfile=None):
                                                ".github/main.workflow"))
     if not os.path.isfile(wfile):
         log.fail("File {} not found.".format(wfile))
-        exit(1)
 
     return wfile
 
 
 def find_recursive_wfile():
     """
     Used to search for `.workflow` files in $PWD and
-    then recursively in sub directories
+    then recursively in sub directories.
 
     Returns:
-        list of path of workflow files
+        list: List of path of workflow files.
     """
     wfile_list = list()
     for root, _, files in os.walk('.'):
@@ -123,42 +127,21 @@ def find_recursive_wfile():
     return wfile_list
 
 
-def get_gh_headers():
-    """Method for  getting the headers required for making authorized
-    GitHub API requests.
-    Returns:
-        headers (dict): a dictionary representing HTTP-headers and their
-        values.
-    """
-    gh_token = os.environ.get('POPPER_GITHUB_API_TOKEN', None)
-
-    headers = {}
-
-    if gh_token:
-        headers = {
-            'Authorization': 'token ' + gh_token
-        }
-
-    return headers
-
-
 def make_gh_request(url, err=True, msg=None):
-    """Method for making GET requests to GitHub API
+    """Method for making GET requests to GitHub API.
     Args:
         url (str): URL on which the API request is to be made.
         err (bool): Checks if an error message needs to be printed or not.
         msg (str): Error message to be printed for a failed request.
     Returns:
-        Response object: contains a server's response to an HTTP request.
+        Response object: Contains a server's response to an HTTP request.
     """
     if not msg:
         msg = (
-            "Unable to connect. If your network is working properly, you might"
-            " have reached Github's API request limit. Try adding a Github API"
-            " token to the 'POPPER_GITHUB_API_TOKEN' variable."
+            "Unable to connect. Please check your network connection."
         )
 
-    response = requests.get(url, headers=get_gh_headers())
+    response = requests.get(url)
     if err and response.status_code != 200:
         log.fail(msg)
     else:
@@ -169,7 +152,7 @@ def read_search_sources():
     """Method to fetch the list of actions.
 
     Returns:
-        list : The list of actions.
+        list: The list of actions.
     """
     response = make_gh_request(
         'https://raw.githubusercontent.com/systemslab/popper/'
@@ -178,16 +161,16 @@ def read_search_sources():
     return yaml.load(response.text, Loader=yaml.FullLoader)
 
 
-def fetch_metadata(update_cache):
+def fetch_metadata(update_cache=False):
     """Fetch metatdata of the repositories from the
     search_sources on which to run the search.
 
     Args:
-        update_cache (bool) : Flag variable to decide whether to update
+        update_cache (bool): Flag variable to decide whether to update
         the cache or not.
 
     Returns:
-        dict : All metadata related to the actions.
+        dict: All metadata related to the actions.
     """
     cache_file = setup_cache()
 
@@ -210,7 +193,7 @@ def fetch_metadata(update_cache):
             _, _, user, repo, path_to_action, version = scm.parse(url)
             source_list.append((user, repo, path_to_action, version))
 
-        metadata = defaultdict(dict)
+        metadata = dict()
         with click.progressbar(
                 source_list,
                 show_eta=False,
@@ -235,32 +218,32 @@ def fetch_repo_metadata(user, repo, path_to_action, version):
     """Returns the metadata for a repo.
 
     Args:
-        user (str) : The user to which the actions belongs to.
-        repo (str) : The parent repository name.
+        user (str): The user to which the actions belongs to.
+        repo (str): The parent repository name.
         path_to_action (str): The path to the action from the root.
-        version (str) : The branch where the action resides.
+        version (str): The branch where the action resides.
 
     Returns:
-        dict : Metadata of the repo.
+        dict: Metadata of the repo.
     """
     readme = fetch_readme_for_repo(user, repo, path_to_action, version)
     meta = dict()
     meta['repo_readme'] = readme
     return meta
 
 
-def fetch_readme_for_repo(user, repo, path_to_action, version):
+def fetch_readme_for_repo(user, repo, path_to_action, version=None):
     """Method to fetch the README for the repo
     if present.
 
     Args:
-        user (str) : The user to which the actions belongs to.
-        repo (str) : The parent repository name.
+        user (str): The user to which the actions belongs to.
+        repo (str): The parent repository name.
         path_to_action (str): The path to the action from the root.
-        version (str) : The branch where the action resides.
+        version (str): The branch where the action resides.
 
     Returns:
-        str : The contents of the README file.
+        str: The contents of the README file.
 
     """
     if not version:
@@ -272,4 +255,14 @@ def fetch_readme_for_repo(user, repo, path_to_action, version):
 
 
 def sanitized_name(name):
+    """Clean an action name and change it to
+    proper format. It replaces all the unwanted
+    characters with `_`.
+
+    Args:
+        name (str): The crude action name.
+
+    Returns:
+        str: The sanitized action name.
+    """
     return re.sub('[^a-zA-Z0-9_.-]', '_', name)
diff --git a/cli/setup.py b/cli/setup.py
@@ -14,6 +14,7 @@
     packages=['popper', 'popper.commands'],
     include_package_data=True,
     install_requires=[
+        'requests-mock',
         'requests',
         'GitPython',
         'future; python_version == "2.7"',