def main(database: SchemaType, repo_root: str, ssl_cert_path: str) -> None:
"""
Invokes the main code path for running a downgrade.
This checks for user validations that the database and branches are correct and then runs the downgrade
migration.
"""
is_prod = metadata.project_id() == GCP_PROJECT_PRODUCTION
if is_prod:
logging.info("RUNNING AGAINST PRODUCTION\n")
prompt_for_confirmation("This script will run a DOWNGRADE migration.", "DOWNGRADE")
confirm_correct_db(database)
confirm_correct_git_branch(repo_root, is_prod=is_prod)
overriden_env_vars = SQLAlchemyEngineManager.update_sqlalchemy_env_vars(
database,
ssl_cert_path=ssl_cert_path,
migration_user=True,
)
# Run downgrade
try:
config = alembic.config.Config(
SQLAlchemyEngineManager.get_alembic_file(database)
)
alembic.command.downgrade(config, "-1")
except Exception as e:
logging.error("Downgrade failed to run: %s", e)
sys.exit(1)
finally:
local_postgres_helpers.restore_local_env_vars(overriden_env_vars)
def default_config(self) -> Dict[str, str]:
return {
'file':
SQLAlchemyEngineManager.get_alembic_file(self.schema_type),
'script_location':
SQLAlchemyEngineManager.get_migrations_location(self.schema_type),
}
def main(database: SchemaType, message: str, use_local_db: bool) -> None:
"""Runs the script to autogenerate migrations."""
if use_local_db:
# TODO(#4619): We should eventually move this from a local postgres instance to running
# postgres from a docker container.
if not local_postgres_helpers.can_start_on_disk_postgresql_database():
logging.error(
"pg_ctl is not installed, so the script cannot be run locally. "
"--project-id must be specified to run against staging or production."
)
logging.error("Exiting...")
sys.exit(1)
logging.info("Starting local postgres database for autogeneration...")
tmp_db_dir = local_postgres_helpers.start_on_disk_postgresql_database()
original_env_vars = (
local_postgres_helpers.update_local_sqlalchemy_postgres_env_vars())
else:
# TODO(Recidiviz/zenhub-tasks#134): This code path will throw when pointed at staging
# because we havne't created valid read-only users there just yet.
try:
original_env_vars = SQLAlchemyEngineManager.update_sqlalchemy_env_vars(
database, readonly_user=True)
except ValueError as e:
logging.warning("Error fetching SQLAlchemy credentials: %s", e)
logging.warning(
"Until readonly users are created, we cannot autogenerate migrations against staging."
)
logging.warning(
"See https://github.com/Recidiviz/zenhub-tasks/issues/134")
sys.exit(1)
try:
config = alembic.config.Config(
SQLAlchemyEngineManager.get_alembic_file(database))
if use_local_db:
upgrade(config, "head")
revision(config, autogenerate=True, message=message)
except Exception as e:
logging.error("Automigration generation failed: %s", e)
local_postgres_helpers.restore_local_env_vars(original_env_vars)
if use_local_db:
logging.info("Stopping local postgres database...")
local_postgres_helpers.stop_and_clear_on_disk_postgresql_database(
tmp_db_dir)
def main(database: SchemaType, repo_root: str, ssl_cert_path: str,
dry_run: bool):
"""
Invokes the main code path for running migrations.
This checks for user validations that the database and branches are correct and then runs existing pending
migrations.
"""
requires_ssl = SQLAlchemyEngineManager.database_requires_ssl(
metadata.project_id())
if requires_ssl and not ssl_cert_path:
logging.error(
'Specifying an argument to --ssl-cert-path is required for the specified database.'
)
logging.error('Exiting...')
sys.exit(1)
if dry_run:
if not local_postgres_helpers.can_start_on_disk_postgresql_database():
logging.error('pg_ctl is not installed. Cannot perform a dry-run.')
logging.error('Exiting...')
sys.exit(1)
logging.info('Creating a dry-run...\n')
is_prod = metadata.project_id() == GCP_PROJECT_PRODUCTION
dbname = SQLAlchemyEngineManager.get_stripped_cloudsql_instance_id(
database)
if is_prod:
logging.info('RUNNING AGAINST PRODUCTION\n')
db_check = input(
f'Running new migrations on {dbname}. Please type "{dbname}" to confirm. (Anything else exits):\n'
)
if db_check != dbname:
logging.warning('\nConfirmation aborted.')
sys.exit(1)
# Get user to validate git branch
try:
repo = Repository(repo_root)
except Exception as e:
logging.error('improper project root provided: %s', e)
sys.exit(1)
current_branch = repo.head.shorthand
if is_prod and not current_branch.startswith('releases/'):
logging.error(
'Migrations run against production must be from a release branch. The current branch is %s.',
current_branch)
sys.exit(1)
branch_check = input(
f'\nThis script will execute all migrations on this branch ({current_branch}) that have not yet been run '
f'against {dbname}. Please type "{current_branch}" to confirm your branch. (Anything else exits):\n'
)
if branch_check != current_branch:
logging.warning('\nConfirmation aborted.')
sys.exit(1)
# Fetch secrets
if dry_run:
overriden_env_vars = local_postgres_helpers.update_local_sqlalchemy_postgres_env_vars(
)
else:
overriden_env_vars = SQLAlchemyEngineManager.update_sqlalchemy_env_vars(
database, ssl_cert_path=ssl_cert_path)
# Run migrations
try:
if dry_run:
logging.info(
'Starting local postgres database for migrations dry run')
db_dir = local_postgres_helpers.start_on_disk_postgresql_database()
config = alembic.config.Config(
SQLAlchemyEngineManager.get_alembic_file(database))
alembic.command.upgrade(config, 'head')
except Exception as e:
logging.error('Migrations failed to run: %s', e)
sys.exit(1)
finally:
local_postgres_helpers.restore_local_env_vars(overriden_env_vars)
if dry_run:
try:
logging.info('Stopping local postgres database')
local_postgres_helpers.stop_and_clear_on_disk_postgresql_database(
db_dir)
except Exception as e2:
logging.error('Error cleaning up postgres: %s', e2)
def main(
database: SchemaType, repo_root: str, ssl_cert_path: str, dry_run: bool
) -> None:
"""
Invokes the main code path for running migrations.
This checks for user validations that the database and branches are correct and then runs existing pending
migrations.
"""
if dry_run:
if not local_postgres_helpers.can_start_on_disk_postgresql_database():
logging.error("pg_ctl is not installed. Cannot perform a dry-run.")
logging.error("Exiting...")
sys.exit(1)
logging.info("Creating a dry-run...\n")
else:
if not ssl_cert_path:
logging.error(
"SSL certificates are required when running against live databases"
)
logging.error("Exiting...")
sys.exit(1)
logging.info("Using SSL certificate path: %s", ssl_cert_path)
is_prod = metadata.project_id() == GCP_PROJECT_PRODUCTION
if is_prod:
logging.info("RUNNING AGAINST PRODUCTION\n")
confirm_correct_db(database)
confirm_correct_git_branch(repo_root, is_prod=is_prod)
if dry_run:
overriden_env_vars = (
local_postgres_helpers.update_local_sqlalchemy_postgres_env_vars()
)
else:
overriden_env_vars = SQLAlchemyEngineManager.update_sqlalchemy_env_vars(
database,
ssl_cert_path=ssl_cert_path,
migration_user=True,
)
# Run migrations
try:
if dry_run:
logging.info("Starting local postgres database for migrations dry run")
db_dir = local_postgres_helpers.start_on_disk_postgresql_database()
config = alembic.config.Config(
SQLAlchemyEngineManager.get_alembic_file(database)
)
alembic.command.upgrade(config, "head")
except Exception as e:
logging.error("Migrations failed to run: %s", e)
sys.exit(1)
finally:
local_postgres_helpers.restore_local_env_vars(overriden_env_vars)
if dry_run:
try:
logging.info("Stopping local postgres database")
local_postgres_helpers.stop_and_clear_on_disk_postgresql_database(
db_dir
)
except Exception as e2:
logging.error("Error cleaning up postgres: %s", e2)