1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
|
import os
import sys
from alembic import command
from alembic import testing
from alembic import util
from alembic.environment import EnvironmentContext
from alembic.migration import MigrationContext
from alembic.script import ScriptDirectory
from alembic.testing import config
from alembic.testing import eq_
from alembic.testing import is_
from alembic.testing import mock
from alembic.testing.assertions import expect_raises_message
from alembic.testing.env import _get_staging_directory
from alembic.testing.env import _no_sql_testing_config
from alembic.testing.env import _sqlite_file_db
from alembic.testing.env import _sqlite_testing_config
from alembic.testing.env import clear_staging_env
from alembic.testing.env import staging_env
from alembic.testing.env import write_script
from alembic.testing.fixtures import capture_context_buffer
from alembic.testing.fixtures import TestBase
class EnvironmentTest(TestBase):
def setUp(self):
staging_env()
self.cfg = _no_sql_testing_config()
def tearDown(self):
clear_staging_env()
def _fixture(self, **kw):
script = ScriptDirectory.from_config(self.cfg)
env = EnvironmentContext(self.cfg, script, **kw)
return env
def test_x_arg(self):
env = self._fixture()
self.cfg.cmd_opts = mock.Mock(x="y=5")
eq_(env.get_x_argument(), "y=5")
def test_x_arg_asdict(self):
env = self._fixture()
self.cfg.cmd_opts = mock.Mock(x=["y=5"])
eq_(env.get_x_argument(as_dictionary=True), {"y": "5"})
def test_x_arg_no_opts(self):
env = self._fixture()
eq_(env.get_x_argument(), [])
def test_x_arg_no_opts_asdict(self):
env = self._fixture()
eq_(env.get_x_argument(as_dictionary=True), {})
def test_x_arg_empty_value(self):
env = self._fixture()
self.cfg.cmd_opts = mock.Mock(x=["y"])
eq_(env.get_x_argument(as_dictionary=True), {"y": ""})
def test_tag_arg(self):
env = self._fixture(tag="x")
eq_(env.get_tag_argument(), "x")
def test_migration_context_has_config(self):
env = self._fixture()
env.configure(url="sqlite://")
ctx = env._migration_context
is_(ctx.config, self.cfg)
ctx = MigrationContext(ctx.dialect, None, {})
is_(ctx.config, None)
def test_sql_mode_parameters(self):
env = self._fixture()
a_rev = "arev"
env.script.generate_revision(a_rev, "revision a", refresh=True)
write_script(
env.script,
a_rev,
"""\
"Rev A"
revision = '{}'
down_revision = None
from alembic import op
def upgrade():
op.execute('''
do some SQL thing with a % percent sign %
''')
""".format(
a_rev
),
)
with capture_context_buffer(transactional_ddl=True) as buf:
command.upgrade(self.cfg, "arev", sql=True)
assert "do some SQL thing with a % percent sign %" in buf.getvalue()
@config.requirements.legacy_engine
@testing.uses_deprecated(
r"The Engine.execute\(\) function/method is considered legacy"
)
def test_error_on_passing_engine(self):
env = self._fixture()
engine = _sqlite_file_db()
a_rev = "arev"
env.script.generate_revision(a_rev, "revision a", refresh=True)
write_script(
env.script,
a_rev,
"""\
"Rev A"
revision = '%s'
down_revision = None
from alembic import op
def upgrade():
pass
def downgrade():
pass
"""
% a_rev,
)
migration_fn = mock.MagicMock()
def upgrade(rev, context):
migration_fn(rev, context)
return env.script._upgrade_revs(a_rev, rev)
with expect_raises_message(
util.CommandError,
r"'connection' argument to configure\(\) is "
r"expected to be a sqlalchemy.engine.Connection ",
):
env.configure(
connection=engine, fn=upgrade, transactional_ddl=False
)
class CWDTest(TestBase):
def setUp(self):
self.env = staging_env()
self.cfg = _sqlite_testing_config()
def tearDown(self):
clear_staging_env()
@testing.combinations(
(
".",
None,
["."],
),
("/tmp/foo:/tmp/bar", None, ["/tmp/foo", "/tmp/bar"]),
("/tmp/foo:/tmp/bar", ":", ["/tmp/foo", "/tmp/bar"]),
("/tmp/foo /tmp/bar", None, ["/tmp/foo", "/tmp/bar"]),
("/tmp/foo,/tmp/bar", None, ["/tmp/foo", "/tmp/bar"]),
(". /tmp/foo", None, [".", "/tmp/foo"]),
(". /tmp/foo", "space", [".", "/tmp/foo"]),
)
def test_sys_path_prepend(self, config_value, path_separator, expected):
if path_separator is not None:
self.cfg.set_main_option("path_separator", path_separator)
self.cfg.set_main_option("prepend_sys_path", config_value)
if path_separator is None:
with testing.expect_deprecated(
"No path_separator found in configuration;"
):
script = ScriptDirectory.from_config(self.cfg)
else:
script = ScriptDirectory.from_config(self.cfg)
env = EnvironmentContext(self.cfg, script)
target = os.path.abspath(_get_staging_directory())
def assert_(heads, context):
eq_(
[os.path.abspath(p) for p in sys.path[0 : len(expected)]],
[os.path.abspath(p) for p in expected],
)
return []
p = [p for p in sys.path if os.path.abspath(p) != target]
with mock.patch.object(sys, "path", p):
env.configure(url="sqlite://", fn=assert_)
with env:
script.run_env()
|