Merge pull request #50 from hpe-container-platform-community/add_flake8_hpecp_to_travis

add flake8 checks

Author: snowch

.travis.yml

@@ -13,7 +13,7 @@ install:
 
 script:
   - tox
-  - coverage run --source hpecp setup.py test
+  - coverage run --source hpecp,bin setup.py test
   - coverage report -m
   - python --version 2>&1 | grep '2.7' || python setup.py install # (don't run on 2.7)
   - python --version 2>&1 | grep '2.7' || echo q | ./bin/hpecp --help # check cli outputs help and doesn't return an error (don't run on 2.7)
@@ -23,13 +23,31 @@ after_success:
 
 jobs:
   include:
+    - stage: coverage_library
+      name: "Code coverage LIBRARY (./hpecp)"
+      python: 3.8
+      install:
+        - pip3 install coverage
+      script:
+        - coverage erase
+        - coverage run --source hpecp setup.py test
+        - coverage report -m --fail-under 68
+    - stage: coverage_cli
+      name: "Code coverage CLI (./bin)"
+      python: 3.8
+      install:
+        - pip3 install coverage
+      script:
+        - coverage erase
+        - coverage run --source bin setup.py test
+        - coverage report -m --fail-under 32
     - stage: flake8
       name: "Flake8 code checks"
       python: 3.8
       install:
         - pip3 install flake8 # TODO: install 'flake8-docstrings'
       script:
-        - flake8 bin/ # TODO: add docstring 'flake8 --docstring-convention numpy hpecp/ bin/ tests/'
+        - flake8 bin/ hpecp/ # TODO: add docstring 'flake8 --docstring-convention numpy hpecp/ bin/ tests/'
     - stage: format
       name: "Check code formatting"
       python: 3.8

.vscode/settings.json

@@ -20,11 +20,14 @@
     "python.testing.nosetestsEnabled": false,
     "python.linting.pylintEnabled": false,
     "python.linting.flake8Enabled": true,
+    "python.linting.flake8Args": [
+        "per-file-ignores=hpecp/__init__.py:F401"
+    ],
     "python.linting.enabled": true,
     "python.formatting.provider": "black",
     "python.pythonPath": "/bin/python3",
     "python.envFile": "${workspaceFolder}/gitpod.env",
     "editor.formatOnSave": true,
     "files.insertFinalNewline": true,
     "git.alwaysSignOff": true
-}
+}

hpecp/catalog.py

@@ -266,7 +266,8 @@ def tabulate(
 
         self.display_columns = columns
 
-        # FIXME: https://github.com/hpe-container-platform-community/hpecp-python-library/issues/5
+        # FIXME:
+        # https://github.com/hpe-container-platform-community/hpecp-python-library/issues/5
         if display_headers:
             return tabulate(self, headers=columns, tablefmt=style)
         else:

hpecp/client.py

@@ -72,7 +72,8 @@ class ContainerPlatformClient(object):
         use_ssl : bool:
             Connect to HPECP using SSL: True|False
         verify_ssl : bool|str
-            See "https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification"
+            See "https://requests.readthedocs.io/en/master/user/advanced/
+            #ssl-cert-verification"
         warn_ssl : bool
             Disable ssl warnings
 
@@ -244,25 +245,25 @@ def create_from_env(cls):
         """
 
         if "HPECP_USERNAME" in os.environ:
-            HPECP_USERNAME = os.environ[HPECP_USERNAME]
+            HPECP_USERNAME = os.environ["HPECP_USERNAME"]
 
         if "HPECP_PASSWORD" in os.environ:
-            HPECP_PASSWORD = os.environ[HPECP_PASSWORD]
+            HPECP_PASSWORD = os.environ["HPECP_PASSWORD"]
 
         if "HPECP_API_HOST" in os.environ:
-            HPECP_API_HOST = os.environ[HPECP_API_HOST]
+            HPECP_API_HOST = os.environ["HPECP_API_HOST"]
 
         if "HPECP_API_PORT" in os.environ:
-            HPECP_API_PORT = os.environ[HPECP_API_PORT]
+            HPECP_API_PORT = os.environ["HPECP_API_PORT"]
 
         if "HPECP_USE_SSL" in os.environ:
-            HPECP_USE_SSL = os.environ[HPECP_USE_SSL]
+            HPECP_USE_SSL = os.environ["HPECP_USE_SSL"]
 
         if "HPECP_VERIFY_SSL" in os.environ:
-            HPECP_VERIFY_SSL = os.environ[HPECP_VERIFY_SSL]
+            HPECP_VERIFY_SSL = os.environ["HPECP_VERIFY_SSL"]
 
-        if "HPECP_warn_ssl" in os.environ:
-            HPECP_warn_ssl = os.environ[HPECP_warn_ssl]
+        if "HPECP_WARN_SSL" in os.environ:
+            HPECP_WARN_SSL = os.environ["HPECP_WARN_SSL"]
 
         return cls(
             username=HPECP_USERNAME,
@@ -271,7 +272,7 @@ def create_from_env(cls):
             api_port=HPECP_API_PORT,
             use_ssl=HPECP_USE_SSL,
             verify_ssl=HPECP_VERIFY_SSL,
-            warn_ssl=HPECP_warn_ssl,
+            warn_ssl=HPECP_WARN_SSL,
         )
 
     def __init__(
@@ -781,17 +782,21 @@ def catalog(self):
     @property
     def role(self):
         """
-        This attribute is a reference to an object of type `.role.RoleController`.
+        This attribute is a reference to an object of type
+        `.role.RoleController`.
 
-        See the class :py:class:`.role.RoleController` for the methods available.
+        See the class :py:class:`.role.RoleController` for the methods
+        available.
 
         Example::
 
             client = ContainerPlatformClient(...)
             client.create_session()
             client.role.get()
 
-        This example calls the method :py:meth:`get() <.role.RoleController.get>` in :py:class:`.role.RoleController`.
+        This example calls the method :py:meth:`get()
+        <.role.RoleController.get>`
+        in :py:class:`.role.RoleController`.
         """
 
         return self._role

hpecp/config.py

@@ -20,18 +20,6 @@
 
 from __future__ import absolute_import
 
-from .logger import Logger
-
-from datetime import datetime, timedelta
-import time
-import requests
-import json
-
-try:
-    from urllib import quote  # Python 2.X
-except ImportError:
-    from urllib.parse import quote  # Python 3+
-
 
 class ConfigController:
     def __init__(self, client):
@@ -40,8 +28,7 @@ def __init__(self, client):
     def auth(self, data):
         """
         Example::
-        
-            data = { 
+            data = {
                 "external_identity_server":  {
                     "bind_pwd":"5ambaPwd@",
                     "user_attribute":"sAMAccountName",
@@ -52,7 +39,7 @@ def auth(self, data):
                     "base_dn":"CN=Users,DC=samdom,DC=example,DC=com",
                     "verify_peer": False,
                     "type":"Active Directory",
-                    "port":636 
+                    "port":636
                 }
             }
         """

hpecp/gateway.py

@@ -533,7 +533,8 @@ def tabulate(
 
         self.display_columns = columns
 
-        # FIXME https://github.com/hpe-container-platform-community/hpecp-python-library/issues/5
+        # FIXME
+        # https://github.com/hpe-container-platform-community/hpecp-python-library/issues/5
         if display_headers:
             return tabulate(self, headers=columns, tablefmt=style)
         else: