Merge pull request #69 from microsoftgraph/task/update-ci

Update Github actions config to use Pipenv to run tests and linter

Author: samwelkanda

.github/workflows/ci.yml

@@ -5,34 +5,39 @@ name: msgraph-sdk-python-core
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ dev ]
+    branches: [dev]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [3.5, 3.6, 3.7, 3.8]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -r dev_requirements.txt
-    - name: Lint with Pylint
-      run: |
-        pylint msgraphcore --disable=W --rcfile=.pylintrc
-    - name: Test with pytest
-      run: |
-        coverage run --omit 'venv/*' -m unittest discover tests/unit
-        coverage run --omit 'venv/*' -m unittest discover tests/integration
-        coverage html
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pipenv
+          pipenv install --dev
+      - name: Check code format
+        run: |
+          pipenv run yapf -dr .
+      - name: Check import order
+        run: |
+          pipenv run isort .
+      - name: Lint with Pylint
+        run: |
+          pipenv run pylint msgraphcore --disable=W --rcfile=.pylintrc
+      - name: Test with unittest
+        run: |
+          pipenv run coverage run -m unittest discover tests/unit
+          pipenv run coverage run -m unittest discover tests/integration
+          pipenv run coverage html

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=hug

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: local
+    hooks:
+      - id: yapf
+        name: yapf
+        stages: [commit]
+        language: system
+        entry: pipenv run yapf -ir .
+        types: [python]
+
+      - id: isort
+        name: isort
+        stages: [commit]
+        language: system
+        entry: pipenv run isort .
+        types: [python]
+
+      - id: pylint
+        name: pylint
+        stages: [commit]
+        language: system
+        entry: pipenv run pylint msgraphcore --disable=W --rcfile=.pylintrc
+        types: [python]

.pylintrc

@@ -144,6 +144,8 @@ disable=print-statement,
         missing-module-docstring,
         missing-class-docstring,
         missing-function-docstring,
+        C0330,
+        R0801,
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

.style.yapf

@@ -0,0 +1,5 @@
+[style]
+based_on_style = pep8
+dedent_closing_brackets = true
+each_dict_entry_on_separate_line = true
+column_limit = 100

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.linting.enabled": true,
+    "python.linting.pylintPath": "pylint",
+    "editor.formatOnSave": true,
+    "python.formatting.provider": "yapf",
+    "python.linting.pylintEnabled": true,
+}

Pipfile

@@ -5,10 +5,14 @@ name = "pypi"
 
 [packages] # Packages required to run the application
 requests = "==2.23.0"
+pre-commit = "==2.10.1"
 
 [dev-packages] # Packages required to develop the application
 coverage = "==5.0.3"
-pylint = "==2.4.4"
+pylint = "==2.6.0"
 responses = "==0.10.12"
 flit = "==2.2.0"
 azure-identity = "==1.5.0"
+isort = "==5.7.0"
+yapf = "==0.30.0"
+mypy = "==0.800"

Pipfile.lock

@@ -1,3 +1,5 @@
+[![CI Actions Status](https://github.com/microsoftgraph/msgraph-sdk-python-core/workflows/msgraph-sdk-python-core/badge.svg)](https://github.com/microsoftgraph/msgraph-sdk-python-core/actions)
+
 ## Microsoft Graph Python Client Library
 
 The Microsoft Graph Python client library is a lightweight wrapper around

README.md

@@ -14,7 +14,6 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
-
 # -- Project information -----------------------------------------------------
 
 project = 'msgraph-sdk-python'
@@ -24,14 +23,12 @@
 # The full version, including alpha/beta/rc tags
 release = '0.0.1'
 
-
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -41,7 +38,6 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -52,4 +48,4 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']

docs/conf.py

@@ -1,6 +1,7 @@
 """msgraph-core"""
 
 from msgraphcore.graph_session import GraphSession
+
 from .constants import SDK_VERSION
 
 __version__ = SDK_VERSION

msgraphcore/__init__.py

@@ -4,9 +4,9 @@
 from requests import Session
 
 from msgraphcore.constants import BASE_URL, SDK_VERSION
-from msgraphcore.middleware.middleware import MiddlewarePipeline, BaseMiddleware
 from msgraphcore.middleware.abc_token_credential import TokenCredential
 from msgraphcore.middleware.authorization import AuthorizationHandler
+from msgraphcore.middleware.middleware import BaseMiddleware, MiddlewarePipeline
 from msgraphcore.middleware.options.middleware_control import middleware_control
 
 
@@ -15,12 +15,13 @@ class GraphSession(Session):
 
     Extends Session by adding support for middleware options and middleware pipeline
     """
-    def __init__(self,
-                 credential: TokenCredential,
-                 scopes: [str] = ['.default'],
-                 middleware: list = [],
-                 api_version: str = 'v1.0'
-                 ):
+    def __init__(
+        self,
+        credential: TokenCredential,
+        scopes: [str] = ['.default'],
+        middleware: list = [],
+        api_version: str = 'v1.0'
+    ):
         super().__init__()
         self._append_sdk_version()
         self._base_url = BASE_URL + '/' + api_version
@@ -94,7 +95,7 @@ def _graph_url(self, url: str) -> str:
         :param url: user provided path
         :return: graph_url
         """
-        return self._base_url+url if (url[0] == '/') else url
+        return self._base_url + url if (url[0] == '/') else url
 
     def _register(self, middleware: [BaseMiddleware]) -> None:
         """Adds middleware to middleware_pipeline
@@ -113,7 +114,11 @@ def _append_sdk_version(self) -> None:
         """Updates sdkVersion in headers with comma-separated new values
         """
         if 'sdkVersion' in self.headers:
-            self.headers.update({'sdkVersion': 'graph-python-' + SDK_VERSION + ', '
-                                               + self.headers.get('sdkVersion')})
+            self.headers.update(
+                {
+                    'sdkVersion':
+                    'graph-python-' + SDK_VERSION + ', ' + self.headers.get('sdkVersion')
+                }
+            )
         else:
             self.headers.update({'sdkVersion': 'graph-python-' + SDK_VERSION})

msgraphcore/graph_session.py

@@ -5,4 +5,3 @@ class TokenCredential(ABC):
     @abstractmethod
     def get_token(self, *scopes, **kwargs):
         pass
-

msgraphcore/middleware/abc_token_credential.py

@@ -1,5 +1,6 @@
+from msgraphcore.constants import AUTH_MIDDLEWARE_OPTIONS
+
 from .abc_token_credential import TokenCredential
-from ..constants import AUTH_MIDDLEWARE_OPTIONS
 from .middleware import BaseMiddleware
 from .options.middleware_control import middleware_control
 

msgraphcore/middleware/authorization.py

@@ -1,7 +1,7 @@
 import ssl
-from urllib3 import PoolManager
 
 from requests.adapters import HTTPAdapter
+from urllib3 import PoolManager
 
 
 class MiddlewarePipeline(HTTPAdapter):

msgraphcore/middleware/middleware.py

@@ -1,4 +1,3 @@
-
 class AuthMiddlewareOptions:
     def __init__(self, scopes: [str]):
         self.scopes = scopes

msgraphcore/middleware/options/auth_middleware_options.py

@@ -1,5 +1,6 @@
 from msgraphcore.constants import AUTH_MIDDLEWARE_OPTIONS
-from ..options.auth_middleware_options import AuthMiddlewareOptions
+
+from .auth_middleware_options import AuthMiddlewareOptions
 
 
 class MiddlewareControl:
@@ -22,6 +23,7 @@ def wrapper(*args, **kwargs):
                 # Set middleware options, for use by middleware in the middleware pipeline
                 self.set(AUTH_MIDDLEWARE_OPTIONS, AuthMiddlewareOptions(scopes))
             return func(*args, **kwargs)
+
         return wrapper
 
     def _reset_middleware_options(self):

msgraphcore/middleware/options/middleware_control.py

@@ -0,0 +1,3 @@
+[mypy]
+files=msgraphcore
+ignore_missing_imports=true

mypy.ini

@@ -1,6 +1,8 @@
 import json
 from pprint import pprint
+
 from azure.identity import InteractiveBrowserCredential
+
 from msgraphcore import GraphSession
 
 scopes = ['user.read']
@@ -16,13 +18,12 @@ def post_sample():
                 'contentType': 'Text',
                 'content': 'The new cafeteria is open.'
             },
-            'toRecipients': [
-                {
-                    'emailAddress': {
-                        'address': 'ENTER_RECEPIENT_EMAIL_ADDRESS'
-                    }
+            'toRecipients': [{
+                'emailAddress': {
+                    'address': 'ENTER_RECEPIENT_EMAIL_ADDRESS'
                 }
-            ]}
+            }]
+        }
     }
 
     result = graph_session \
@@ -42,4 +43,3 @@ def get_sample():
 if __name__ == '__main__':
     post_sample()
     get_sample()
-

samples/samples.py

@@ -6,7 +6,9 @@
 
 class MiddlewarePipelineTest(TestCase):
     def setUp(self):
-        warnings.filterwarnings("ignore", category=ResourceWarning, message="unclosed.*<ssl.SSLSocket.*>")
+        warnings.filterwarnings(
+            "ignore", category=ResourceWarning, message="unclosed.*<ssl.SSLSocket.*>"
+        )
 
     def test_middleware_pipeline(self):
         url = 'https://proxy.apisandbox.msdn.microsoft.com/svc?url=https://graph.microsoft.com/v1.0/me'
@@ -21,6 +23,3 @@ def test_middleware_pipeline(self):
 class _CustomTokenCredential:
     def get_token(self, scopes):
         return ['{token:https://graph.microsoft.com/}']
-
-
-

tests/integration/test_middleware_pipeline.py

@@ -2,8 +2,8 @@
 
 from msgraphcore.constants import AUTH_MIDDLEWARE_OPTIONS
 from msgraphcore.middleware.authorization import AuthorizationHandler
-from msgraphcore.middleware.options.middleware_control import middleware_control
 from msgraphcore.middleware.options.auth_middleware_options import AuthMiddlewareOptions
+from msgraphcore.middleware.options.middleware_control import middleware_control
 
 
 class TestAuthorizationHandler(unittest.TestCase):
@@ -26,5 +26,3 @@ def test_auth_handler_get_scopes_does_not_overwrite_default_scopes(self):
         auth_handler.get_scopes()
 
         self.assertEqual(auth_handler.scopes, default_scopes)
-
-

tests/unit/test_auth_handler.py

@@ -1,11 +1,11 @@
 from unittest import TestCase
 
+import responses
 from requests import Session
 from requests.adapters import HTTPAdapter
-import responses
 
-from msgraphcore.graph_session import GraphSession
 from msgraphcore.constants import BASE_URL, SDK_VERSION
+from msgraphcore.graph_session import GraphSession
 
 
 class GraphSessionTest(TestCase):
@@ -26,8 +26,9 @@ def test_has_sdk_version_header(self):
         self.assertTrue('sdkVersion' in self.requests.headers)
 
     def test_updated_sdk_version(self):
-        self.assertTrue(self.requests.headers.get('sdkVersion')
-                        .startswith('graph-python-'+SDK_VERSION))
+        self.assertTrue(
+            self.requests.headers.get('sdkVersion').startswith('graph-python-' + SDK_VERSION)
+        )
 
     def test_initialized_with_middlewares(self):
         graph_session = GraphSession(self.credential)