From 454d5532ed239c67cd502d3b374fafb5739326e8 Mon Sep 17 00:00:00 2001 From: Jon Wayne Parrott Date: Mon, 8 Aug 2016 14:52:13 -0700 Subject: [PATCH] Re-configuring App engine tests. --- .coveragerc | 1 + tests/conftest.py | 34 +++-------- tests/contrib/appengine/__init__.py | 0 tests/contrib/appengine/conftest.py | 61 +++++++++++++++++++ .../{ => appengine}/test__appengine_ndb.py | 2 +- .../contrib/{ => appengine}/test_appengine.py | 4 +- tox.ini | 28 ++------- 7 files changed, 79 insertions(+), 51 deletions(-) create mode 100644 tests/contrib/appengine/__init__.py create mode 100644 tests/contrib/appengine/conftest.py rename tests/contrib/{ => appengine}/test__appengine_ndb.py (98%) rename tests/contrib/{ => appengine}/test_appengine.py (99%) diff --git a/.coveragerc b/.coveragerc index 0151e07fd..e3fff2265 100644 --- a/.coveragerc +++ b/.coveragerc @@ -1,6 +1,7 @@ [report] omit = */samples/* + */conftest.py # Don't report coverage over platform-specific modules. oauth2client/contrib/_fcntl_opener.py oauth2client/contrib/_win32_opener.py diff --git a/tests/conftest.py b/tests/conftest.py index 5d53edd8d..70453a83b 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -12,35 +12,19 @@ # See the License for the specific language governing permissions and # limitations under the License. -"""Common testing tools for OAuth2Client tests.""" +"""Py.test hooks.""" -import sys +from oauth2client import _helpers -from six.moves import reload_module -from oauth2client import util +def pytest_addoption(parser): + """Adds the --gae-sdk option to py.test. - -def set_up_gae_environment(gae_sdk_path): - """Set up appengine SDK third-party imports.""" - if 'google' in sys.modules: - # Some packages, such as protobuf, clobber the google - # namespace package. This prevents that. - reload_module(sys.modules['google']) - - # This sets up google-provided libraries. - sys.path.insert(0, gae_sdk_path) - import dev_appserver - dev_appserver.fix_sys_path() - - # Fixes timezone and other os-level items. - import google.appengine.tools.os_compat # noqa: unused import + This is used to enable the GAE tests. This has to be in this conftest.py + due to the way py.test collects conftest files.""" + parser.addoption('--gae-sdk') def pytest_configure(config): - """Pytest hook function for setting up test session.""" - # Set up Google SDK modules unless specified not to - if not config.option.no_gae: - set_up_gae_environment(config.option.sdk_path) - # Default of POSITIONAL_WARNING is too verbose for testing - util.positional_parameters_enforcement = util.POSITIONAL_EXCEPTION + """Py.test hook called before loading tests.""" + _helpers.positional_parameters_enforcement = _helpers.POSITIONAL_EXCEPTION diff --git a/tests/contrib/appengine/__init__.py b/tests/contrib/appengine/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tests/contrib/appengine/conftest.py b/tests/contrib/appengine/conftest.py new file mode 100644 index 000000000..b06bd1354 --- /dev/null +++ b/tests/contrib/appengine/conftest.py @@ -0,0 +1,61 @@ +# Copyright 2016 Google Inc. All rights reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +"""App Engine py.test configuration.""" + +import sys + +from six.moves import reload_module + + +def set_up_gae_environment(sdk_path): + """Set up appengine SDK third-party imports. + + The App Engine SDK does terrible things to the global interpreter state. + Because of this, this stuff can't be neatly undone. As such, it can't be + a fixture. + """ + if 'google' in sys.modules: + # Some packages, such as protobuf, clobber the google + # namespace package. This prevents that. + reload_module(sys.modules['google']) + + # This sets up google-provided libraries. + sys.path.insert(0, sdk_path) + import dev_appserver + dev_appserver.fix_sys_path() + + # Fixes timezone and other os-level items. + import google.appengine.tools.os_compat # noqa: unused import + + +def pytest_configure(config): + """Configures the App Engine SDK imports on py.test startup.""" + if config.getoption('gae_sdk') is not None: + set_up_gae_environment(config.getoption('gae_sdk')) + + +def pytest_ignore_collect(path, config): + """Runs when py.test discovers tests. + + Return True to skip collection. Skips App Engine tests when --gae-sdk + is not specified. + """ + if 'contrib/appengine' in str(path): + if config.getoption('gae_sdk') is None: + return True + else: + return False + else: + return False diff --git a/tests/contrib/test__appengine_ndb.py b/tests/contrib/appengine/test__appengine_ndb.py similarity index 98% rename from tests/contrib/test__appengine_ndb.py rename to tests/contrib/appengine/test__appengine_ndb.py index 41e380576..3a111e193 100644 --- a/tests/contrib/test__appengine_ndb.py +++ b/tests/contrib/appengine/test__appengine_ndb.py @@ -24,7 +24,7 @@ from oauth2client.contrib import appengine -DATA_DIR = os.path.join(os.path.dirname(__file__), '..', 'data') +DATA_DIR = os.path.join(os.path.dirname(__file__), '..', '..', 'data') def datafile(filename): diff --git a/tests/contrib/test_appengine.py b/tests/contrib/appengine/test_appengine.py similarity index 99% rename from tests/contrib/test_appengine.py rename to tests/contrib/appengine/test_appengine.py index b6d2dad68..6890b64eb 100644 --- a/tests/contrib/test_appengine.py +++ b/tests/contrib/appengine/test_appengine.py @@ -37,11 +37,11 @@ from oauth2client import client from oauth2client import clientsecrets from oauth2client.contrib import appengine -from .. import http_mock +from ... import http_mock __author__ = 'jcgregorio@google.com (Joe Gregorio)' -DATA_DIR = os.path.join(os.path.dirname(__file__), '..', 'data') +DATA_DIR = os.path.join(os.path.dirname(__file__), '..', '..', 'data') DEFAULT_RESP = """\ { "access_token": "foo_access_token", diff --git a/tox.ini b/tox.ini index 874750181..7947bbae3 100644 --- a/tox.ini +++ b/tox.ini @@ -8,7 +8,6 @@ basedeps = mock>=1.3.0 pyopenssl>=0.14 webtest pytest - pytest-beds flask unittest2 sqlalchemy @@ -20,28 +19,20 @@ setenv = pypy: with_gmp=no DJANGO_SETTINGS_MODULE=tests.contrib.django_util.settings commands = - py.test \ - --no-gae \ - --ignore=tests/contrib/test_appengine.py \ - --ignore=tests/contrib/test__appengine_ndb.py \ - {posargs} + py.test {posargs} [coverbase] basepython = python2.7 commands = py.test \ - --no-gae \ --cov=oauth2client \ - --cov=tests \ - --ignore=tests/contrib/test_appengine.py \ - --ignore=tests/contrib/test__appengine_ndb.py + --cov=tests py.test \ --cov=oauth2client \ --cov=tests \ --cov-append \ - --sdk-path={env:GAE_PYTHONPATH:google_appengine} \ - tests/contrib/test_appengine.py \ - tests/contrib/test__appengine_ndb.py + --gae-sdk={env:GAE_PYTHONPATH} \ + tests/contrib/appengine deps = {[testenv]deps} coverage pytest-cov @@ -51,9 +42,6 @@ basepython = python2.6 commands = py.test \ - --no-gae \ - --ignore=tests/contrib/test_appengine.py \ - --ignore=tests/contrib/test__appengine_ndb.py \ --ignore=tests/contrib/test_keyring_storage.py \ --ignore=oauth2client/contrib/django_util \ --ignore=tests/contrib/django_util \ @@ -65,9 +53,6 @@ basepython = python3.3 commands = py.test \ - --no-gae \ - --ignore=tests/contrib/test_appengine.py \ - --ignore=tests/contrib/test__appengine_ndb.py \ --ignore=tests/contrib/test_django_orm.py \ --ignore=tests/contrib/test_django_settings.py \ --ignore=oauth2client/contrib/django_util \ @@ -110,10 +95,7 @@ commands = {toxinidir}/scripts/build_docs.sh basepython = python2.7 deps = {[testenv]basedeps} commands = - py.test \ - --sdk-path={env:GAE_PYTHONPATH:google_appengine} \ - tests/contrib/test_appengine.py \ - tests/contrib/test__appengine_ndb.py + py.test --gae-sdk={env:GAE_PYTHONPATH} tests/contrib/appengine [testenv:system-tests] basepython =