Merge pull request #59 from AzureAD/release-0.4.3

Release 0.4.3

adal/__init__.py

@@ -27,7 +27,7 @@
 
 # pylint: disable=wrong-import-position
 
-__version__ = '0.4.2'
+__version__ = '0.4.3'
 
 import logging
 

adal/authentication_context.py

@@ -26,6 +26,7 @@
 #------------------------------------------------------------------------------
 import os
 import threading
+import warnings
 
 from .authority import Authority
 from . import argument
@@ -44,9 +45,11 @@ class AuthenticationContext(object):
         https://github.com/AzureAD/azure-activedirectory-library-for-python
     '''
 
-    def __init__(self, authority, validate_authority=None, cache=None):
-        '''Creates a new AuthenticationContext object. 
-        
+    def __init__(
+            self, authority, validate_authority=None, cache=None,
+            api_version='1.0'):
+        '''Creates a new AuthenticationContext object.
+
         By default the authority will be checked against a list of known Azure
         Active Directory authorities. If the authority is not recognized as 
         one of these well known authorities then token acquisition will fail.
@@ -62,13 +65,30 @@ def __init__(self, authority, validate_authority=None, cache=None):
             the AuthenticationContext and are not shared unless it has been
             manually passed during the construction of other
             AuthenticationContexts.
+        :param api_version: (optional) Specifies API version using on the wire.
+            Historically it has a hardcoded default value as "1.0".
+            Developers are now encouraged to set it as None explicitly,
+            which means the underlying API version will be automatically chosen.
+            In next major release, this default value will be changed to None.
         '''
         self.authority = Authority(authority, validate_authority is None or validate_authority)
         self._oauth2client = None
         self.correlation_id = None
         env_value = os.environ.get('ADAL_PYTHON_SSL_NO_VERIFY')
+        if api_version is not None:
+            warnings.warn(
+                """The default behavior of including api-version=1.0 on the wire
+                is now deprecated.
+                Future version of ADAL will change the default value to None.
+
+                To ensure a smooth transition, you are recommended to explicitly
+                set it to None in your code now, and test out the new behavior.
+
+                    context = AuthenticationContext(..., api_version=None)
+                """, DeprecationWarning)
         self._call_context = {
             'options': GLOBAL_ADAL_OPTIONS,
+            'api_version': api_version,
             'verify_ssl': None if env_value is None else not env_value # mainly for tracing through proxy
             }
         self._token_requests_with_user_code = {}

adal/log.py

@@ -79,12 +79,7 @@ def __init__(self, component_name, log_context):
         self.log_context = log_context
         self._logging = logging.getLogger(ADAL_LOGGER_NAME)
 
-    def _log_message(self, msg, **kwargs):
-        log_stack_trace = False
-        if 'log_stack_trace' in kwargs:
-            log_stack_trace = kwargs['log_stack_trace']
-            kwargs.pop('log_stack_trace')
-
+    def _log_message(self, msg, log_stack_trace=None):
         correlation_id = self.log_context.get("correlation_id", 
                                               "<no correlation id>")
 
@@ -98,13 +93,16 @@ def _log_message(self, msg, **kwargs):
         return formatted
 
     def warn(self, msg, *args, **kwargs):
-        msg = self._log_message(msg, **kwargs)
+        log_stack_trace = kwargs.pop('log_stack_trace', None)
+        msg = self._log_message(msg, log_stack_trace)
         self._logging.warning(msg, *args, **kwargs)
 
     def info(self, msg, *args, **kwargs):
-        msg = self._log_message(msg, **kwargs)
+        log_stack_trace = kwargs.pop('log_stack_trace', None)
+        msg = self._log_message(msg, log_stack_trace)
         self._logging.info(msg, *args, **kwargs)
 
     def debug(self, msg, *args, **kwargs):
-        msg = self._log_message(msg, **kwargs)
+        log_stack_trace = kwargs.pop('log_stack_trace', None)
+        msg = self._log_message(msg, log_stack_trace)
         self._logging.debug(msg, *args, **kwargs)

adal/oauth2_client.py

@@ -105,7 +105,9 @@ def __init__(self, call_context, authority):
 
     def _create_token_url(self):
         parameters = {}
-        parameters[OAuth2.Parameters.AAD_API_VERSION] = '1.0'
+        if self._call_context.get('api_version'):
+            parameters[OAuth2.Parameters.AAD_API_VERSION] = self._call_context[
+                'api_version']
 
         return urlparse('{}?{}'.format(self._token_endpoint, urlencode(parameters)))
 

setup.py

@@ -72,7 +72,7 @@
     packages=['adal'],
     install_requires=[
         'PyJWT>=1.0.0',
-        'requests>=2.0.0',
+        'requests>=2.0.0,!=2.12.*',
         'python-dateutil>=2.1.0',
         'cryptography>=1.1.0'
     ]

tests/test_api_version.py

@@ -0,0 +1,79 @@
+#------------------------------------------------------------------------------
+#
+# Copyright (c) Microsoft Corporation.
+# All rights reserved.
+#
+# This code is licensed under the MIT License.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files(the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions :
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+#------------------------------------------------------------------------------
+
+import warnings
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest
+
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
+import adal
+
+class TestAuthenticationContextApiVersionBehavior(unittest.TestCase):
+
+    def test_api_version_default_value(self):
+        with warnings.catch_warnings(record=True) as caught_warnings:
+            warnings.simplefilter("always")
+            context = adal.AuthenticationContext(
+                "https://login.windows.net/tenant")
+            self.assertEqual(context._call_context['api_version'], '1.0')
+            if len(caught_warnings) == 1:
+                # It should be len(caught_warnings)==1, but somehow it works on
+                # all my local test environment but not on Travis-CI.
+                # So we relax this check, for now.
+                self.assertIn("deprecated", str(caught_warnings[0].message))
+
+    def test_explicitly_turn_off_api_version(self):
+        with warnings.catch_warnings(record=True) as caught_warnings:
+            warnings.simplefilter("always")
+            context = adal.AuthenticationContext(
+                "https://login.windows.net/tenant", api_version=None)
+            self.assertEqual(context._call_context['api_version'], None)
+            self.assertEqual(len(caught_warnings), 0)
+
+class TestOAuth2ClientApiVersionBehavior(unittest.TestCase):
+
+    authority = mock.Mock(token_endpoint="https://example.com/token")
+
+    def test_api_version_is_set(self):
+        client = adal.oauth2_client.OAuth2Client(
+            {"api_version": "1.0", "log_context": mock.Mock()}, self.authority)
+        self.assertIn('api-version=1.0', client._create_token_url().geturl())
+
+    def test_api_version_is_not_set(self):
+        client = adal.oauth2_client.OAuth2Client(
+            {"api_version": None, "log_context": mock.Mock()}, self.authority)
+        self.assertNotIn('api-version=1.0', client._create_token_url().geturl())
+
+if __name__ == '__main__':
+    unittest.main()
+

tests/test_log.py

@@ -25,34 +25,51 @@
 #
 #------------------------------------------------------------------------------
 import json
+import logging
 import unittest
-from adal import log
+try:
+    from cStringIO import StringIO
+except ImportError:
+    from io import StringIO
+
+from adal import log as adal_logging
 from tests import util
 from tests.util import parameters as cp
 
 class TestLog(unittest.TestCase):
     def test_settings_none(self):
-        current_options = log.get_logging_options()
+        current_options = adal_logging.get_logging_options()
 
-        log.set_logging_options()
+        adal_logging.set_logging_options()
 
-        options = log.get_logging_options()
-        log.set_logging_options(current_options)
+        options = adal_logging.get_logging_options()
+        adal_logging.set_logging_options(current_options)
 
         noOptions = len(options) == 1 and options['level'] == 'ERROR'
         self.assertTrue(noOptions, 'Did not expect to find any logging options set: ' + json.dumps(options))
 
     def test_console_settings(self):
-        currentOptions = log.get_logging_options()
+        currentOptions = adal_logging.get_logging_options()
         util.turn_on_logging()
-        options = log.get_logging_options()
+        options = adal_logging.get_logging_options()
         level = options['level']
 
         # Set the looging options back to what they were before this test so that
         # future tests are logged as they should be.
-        log.set_logging_options(currentOptions)
+        adal_logging.set_logging_options(currentOptions)
 
         self.assertEqual(level, 'DEBUG', 'Logging level was not the expected value of LOGGING_LEVEL.DEBUG: {}'.format(level))
 
+    def test_logging(self):
+        log_capture_string = StringIO()
+        handler = logging.StreamHandler(log_capture_string)
+        util.turn_on_logging(handler=handler)
+
+        test_logger = adal_logging.Logger("TokenRequest", {'correlation_id':'12345'})
+        test_logger.warn('a warning', log_stack_trace=True)
+        log_contents = log_capture_string.getvalue()
+        logging.getLogger(adal_logging.ADAL_LOGGER_NAME).removeHandler(handler)
+        self.assertTrue('12345 - TokenRequest:a warning' in log_contents and 'Stack:' in log_contents)
+
 if __name__ == '__main__':
     unittest.main()