# -*- coding: utf-8 -*- # # Copyright 2021 Google LLC # # 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 # # https://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. from __future__ import absolute_import import nox ALEMBIC_CONF = """ [alembic] script_location = test_migration prepend_sys_path = . sqlalchemy.url = spanner:///projects/appdev-soda-spanner-staging/instances/sqlalchemy-dialect-test/databases/compliance-test [post_write_hooks] [loggers] keys = root,sqlalchemy,alembic [handlers] keys = console [formatters] keys = generic [logger_root] level = WARN handlers = console qualname = [logger_sqlalchemy] level = WARN handlers = qualname = sqlalchemy.engine [logger_alembic] level = INFO handlers = qualname = alembic [handler_console] class = StreamHandler args = (sys.stderr,) level = NOTSET formatter = generic [formatter_generic] format = %(levelname)-5.5s [%(name)s] %(message)s datefmt = %H:%M:%S """ UPGRADE_CODE = """def upgrade(): op.create_table( 'account', sa.Column('id', sa.Integer, primary_key=True), sa.Column('name', sa.String(50), nullable=False), sa.Column('description', sa.Unicode(200)), )""" BLACK_VERSION = "black==19.10b0" BLACK_PATHS = ["google", "test", "noxfile.py", "setup.py"] DEFAULT_PYTHON_VERSION = "3.8" @nox.session(python=DEFAULT_PYTHON_VERSION) def lint(session): """Run linters. Returns a failure if the linters find linting errors or sufficiently serious code quality issues. """ session.install("flake8", BLACK_VERSION) session.run( "black", "--check", *BLACK_PATHS, ) session.run( "flake8", "google", "test", "--max-line-length=88", ) @nox.session(python=DEFAULT_PYTHON_VERSION) def blacken(session): """Run black. Format code to uniform standard. This currently uses Python 3.6 due to the automated Kokoro run of synthtool. That run uses an image that doesn't have 3.6 installed. Before updating this check the state of the `gcp_ubuntu_config` we use for that Kokoro run. """ session.install(BLACK_VERSION) session.run( "black", *BLACK_PATHS, ) @nox.session(python=DEFAULT_PYTHON_VERSION) def lint_setup_py(session): """Verify that setup.py is valid (including RST check).""" session.install("docutils", "pygments") session.run("python", "setup.py", "check", "--restructuredtext", "--strict") @nox.session(python=DEFAULT_PYTHON_VERSION) def compliance_test(session): """Run SQLAlchemy dialect compliance test suite.""" session.install("pytest") session.install("sqlalchemy") session.install( "git+https://github.com/googleapis/python-spanner.git#egg=google-cloud-spanner" ) session.install("-e", ".") session.run("python", "create_test_database.py") session.run("pytest", "-v") @nox.session(python=DEFAULT_PYTHON_VERSION) def migration_test(session): """Migrate with SQLAlchemy and Alembic and check the result.""" import glob import os import shutil session.install("pytest") session.install("sqlalchemy") session.install("google-cloud-spanner") session.install("-e", ".") session.install("alembic") session.run("alembic", "init", "test_migration") # setting testing configurations os.remove("alembic.ini") with open("alembic.ini", "w") as f: f.write(ALEMBIC_CONF) session.run("alembic", "revision", "-m", "migration_for_test") files = glob.glob("test_migration/versions/*.py") # updating the upgrade-script code with open(files[0], "r") as f: script_code = f.read() script_code = script_code.replace("""def upgrade():\n pass""", UPGRADE_CODE) with open(files[0], "w") as f: f.write(script_code) os.remove("test_migration/env.py") shutil.copyfile("test_migration_env.py", "test_migration/env.py") # running the test migration session.run("alembic", "upgrade", "head") # clearing the migration data os.remove("alembic.ini") shutil.rmtree("test_migration") session.run("python", "migration_test_cleanup.py")