Merge pull request #369 from nexB/test-cleanup

Improve tests and other refactorings

Author: pombredanne

.gitignore

@@ -47,3 +47,5 @@ docs/_build
 /.cache/
 /.settings/
 /tcl/
+/.python-version
+/.tox/

.travis.yml

@@ -8,7 +8,7 @@ install:
     - ./configure etc/conf/dev
 
 script:
-    - bin/py.test -vvs tests
+    - bin/py.test -vvs
 
 notifications:
     irc:

about.cfg

@@ -1,11 +1,12 @@
+about_resource: irc-notify.py
 name: irc-notify.py
 version: def54f8166089b733d166665fdabcad4cdc526d8
 download_url: https://raw.githubusercontent.com/gridsync/gridsync/def54f8166089b733d166665fdabcad4cdc526d8/misc/irc-notify.py
 description: Quick and dirty IRC notification script.
 homepage_url: https://github.com/gridsync/gridsync
 owner: Christopher R. Wood
 copyright: Copyright (C) 2015-2016 Christopher R. Wood
-dje_license_key: gpl-2.0-plus
+license_expression: gpl-2.0-plus
 license_text_file: gpl-2.0.LICENSE
 notice_text: |
     This program is free software; you can redistribute it and/or modify it under the

etc/scripts/irc-notify.py.ABOUT

@@ -10,24 +10,23 @@ release = clean --all sdist --formats=bztar,zip bdist_wheel
 [tool:pytest]
 norecursedirs =
     .git
+    .cache
+    .settings
     bin
     dist
+    dist
     build
     _build
-    dist
-    local
-    ci
     docs
     man
     share
-    samples
-    .cache
-    .settings
+    example
     etc
     Include
     include
     Lib
     lib
+    local
     Scripts
     thirdparty
     tmp

setup.cfg

@@ -68,9 +68,15 @@ def read(*names, **kwargs):
     ],
     install_requires=[
         'jinja2 >= 2.9, < 3.0',
+
         'click >= 6.7, < 7.0',
+
         "backports.csv ; python_version<'3.6'",
-        'PyYAML >= 3.0, < 4.0',
+
+        # required by saneyaml
+        'PyYAML >= 3.11, <=3.13',
+        'saneyaml',
+
         'boolean.py >= 3.5, < 4.0',
         'license_expression >= 0.94, < 1.0',
     ],
@@ -79,7 +85,7 @@ def read(*names, **kwargs):
     },
     entry_points={
         'console_scripts': [
-            'about=attributecode.cmd:cli',
+            'about=attributecode.cmd:about',
         ]
     },
 )

setup.py

@@ -20,16 +20,19 @@
 
 from collections import namedtuple
 import logging
+import os
 
 try:
-    unicode  # Python 2
-except NameError:
-    unicode = str  # Python 3 #NOQA
+    # Python 2
+    unicode  # NOQA
+except NameError:  # pragma: nocover
+    # Python 3
+    unicode = str  # NOQA
 
+import saneyaml
 
 __version__ = '3.3.0'
 
-
 __about_spec_version__ = '3.1'
 
 __copyright__ = """
@@ -53,39 +56,46 @@ class Error(namedtuple('Error', ['severity', 'message'])):
     def __new__(self, severity, message):
         if message:
             if isinstance(message, unicode):
-                message = clean_string(message)
+                message = self._clean_string(message)
             else:
-                message = clean_string(unicode(repr(message), encoding='utf-8'))
+                message = self._clean_string(unicode(repr(message), encoding='utf-8'))
                 message = message.strip('"')
 
         return super(Error, self).__new__(
             Error, severity, message)
 
     def __repr__(self, *args, **kwargs):
         sev = severities[self.severity]
-        msg = clean_string(repr(self.message))
+        msg = self._clean_string(repr(self.message))
         return 'Error(%(sev)s, %(msg)s)' % locals()
 
-
-def clean_string(s):
-    """
-    Return a cleaned string for `s`, stripping eventual "u" prefixes
-    from unicode representations.
-    """
-    if not s:
+    def to_dict(self, *args, **kwargs):
+        """
+        Return an ordered mapping of self.
+        """
+        return self._asdict()
+
+    @staticmethod
+    def _clean_string(s):
+        """
+        Return a cleaned string for `s`, stripping eventual "u" prefixes
+        from unicode representations.
+        """
+        if not s:
+            return s
+        if s.startswith(('u"', "u'")):
+            s = s.lstrip('u')
+        s = s.replace('[u"', '["')
+        s = s.replace("[u'", "['")
+        s = s.replace("(u'", "('")
+        s = s.replace("(u'", "('")
+        s = s.replace("{u'", "{'")
+        s = s.replace("{u'", "{'")
+        s = s.replace(" u'", " '")
+        s = s.replace(" u'", " '")
+        s = s.replace("\\\\", "\\")
         return s
-    if s.startswith(('u"', "u'")):
-        s = s.lstrip('u')
-    s = s.replace('[u"', '["')
-    s = s.replace("[u'", "['")
-    s = s.replace("(u'", "('")
-    s = s.replace("(u'", "('")
-    s = s.replace("{u'", "{'")
-    s = s.replace("{u'", "{'")
-    s = s.replace(" u'", " '")
-    s = s.replace(" u'", " '")
-    s = s.replace("\\\\", "\\")
-    return s
+
 
 # modeled after the logging levels
 CRITICAL = 50
@@ -97,10 +107,14 @@ def clean_string(s):
 
 
 severities = {
-    CRITICAL : u'CRITICAL',
-    ERROR : u'ERROR',
-    WARNING : u'WARNING',
-    INFO : u'INFO',
-    DEBUG : u'DEBUG',
-    NOTSET : u'NOTSET'
-    }
+    CRITICAL : 'CRITICAL',
+    ERROR : 'ERROR',
+    WARNING : 'WARNING',
+    INFO : 'INFO',
+    DEBUG : 'DEBUG',
+    NOTSET : 'NOTSET'
+}
+
+
+DEFAULT_MAPPING = os.path.join(os.path.abspath(
+    os.path.dirname(__file__)), 'mapping.config')

src/attributecode/__init__.py

@@ -19,6 +19,6 @@
 from __future__ import unicode_literals
 
 
-if __name__ == '__main__':
+if __name__ == '__main__': # pragma: nocover
     from attributecode import cmd
     cmd.cli()

src/attributecode/__main__.py

@@ -20,28 +20,35 @@
 
 import json
 
-try:  # Python 2
-    from urllib import urlencode, quote
-    from urllib2 import urlopen, Request, HTTPError
-except ImportError:  # Python 3
-    from urllib.parse import urlencode, quote
-    from urllib.request import urlopen, Request
-    from urllib.error import HTTPError
-
 from attributecode import ERROR
 from attributecode import Error
+from attributecode.util import python2
+
+
+if python2:  # pragma: nocover
+    from urllib import quote  # NOQA
+    from urllib import urlencode  # NOQA
+    from urllib2 import HTTPError  # NOQA
+    from urllib2 import Request  # NOQA
+    from urllib2 import urlopen  # NOQA
+else:  # pragma: nocover
+    from urllib.parse import quote  # NOQA
+    from urllib.parse import urlencode  # NOQA
+    from urllib.request import Request  # NOQA
+    from urllib.request import urlopen  # NOQA
+    from urllib.error import HTTPError  # NOQA
 
 
 """
 API call helpers
 """
 
 
-def request_license_data(url, api_key, license_key):
+# FIXME: args should start with license_key
+def request_license_data(api_url, api_key, license_key):
     """
-    Return a dictionary of license data.
-    Send a request to a given API URL to gather license data for
-    license_key, authenticating through an api_key.
+    Return a tuple of (dictionary of license data, list of errors) given a
+    `license_key`. Send a request to `api_url` authenticating with `api_key`.
     """
     headers = {
         'Authorization': 'Token %s' % api_key,
@@ -52,9 +59,10 @@ def request_license_data(url, api_key, license_key):
         'format': 'json'
     }
 
-    url = url.rstrip('/')
-    encoded_payload = urlencode(payload)
-    full_url = '%(url)s/?%(encoded_payload)s' % locals()
+    api_url = api_url.rstrip('/')
+    payload = urlencode(payload)
+
+    full_url = '%(api_url)s/?%(payload)s' % locals()
     # handle special characters in URL such as space etc.
     quoted_url = quote(full_url, safe="%/:=&?~#+!$,;'@()*[]")
 
@@ -64,10 +72,12 @@ def request_license_data(url, api_key, license_key):
         request = Request(quoted_url, headers=headers)
         response = urlopen(request)
         response_content = response.read().decode('utf-8')
+        # FIXME: this should be an ordered dict
         license_data = json.loads(response_content)
         if not license_data['results']:
             msg = u"Invalid 'license': %s" % license_key
             errors.append(Error(ERROR, msg))
+
     except HTTPError as http_e:
         # some auth problem
         if http_e.code == 403:
@@ -80,20 +90,29 @@ def request_license_data(url, api_key, license_key):
             # this exception.
             msg = u"Invalid 'license': %s" % license_key
             errors.append(Error(ERROR, msg))
+
     except Exception as e:
         errors.append(Error(ERROR, str(e)))
+
     finally:
-        license_data = license_data.get('results')[0] if license_data.get('count') == 1 else {}
+        if license_data.get('count') == 1:
+            license_data = license_data.get('results')[0]
+        else:
+            license_data = {}
 
     return license_data, errors
 
 
-def get_license_details_from_api(url, api_key, license_key):
+# FIXME: args should start with license_key
+def get_license_details_from_api(api_url, api_key, license_key):
     """
-    Return the license_text of a given license_key using an API request.
-    Return an empty string if the text is not available.
+    Return a tuple of license data given a `license_key` using the `api_url`
+    authenticating with `api_key`.
+    The details are a tuple of (license_name, license_key, license_text, errors)
+    where errors is a list of strings.
+    Missing values are provided as empty strings.
     """
-    license_data, errors = request_license_data(url, api_key, license_key)
+    license_data, errors = request_license_data(api_url, api_key, license_key)
     license_name = license_data.get('name', '')
     license_text = license_data.get('full_text', '')
     license_key = license_data.get('key', '')