def test_set_run_custom_default_command(self):
"""
Application calls the default command.
"""
application = Application()
application.set_auto_exit(False)
command = FooCommand()
application.add(command)
application.set_default_command(command.get_name())
tester = ApplicationTester(application)
tester.run([])
self.assertEqual(
'interact called\ncalled\n',
tester.get_display()
)
application = CustomDefaultCommandApplication()
application.set_auto_exit(False)
tester = ApplicationTester(application)
tester.run([])
self.assertEqual(
'interact called\ncalled\n',
tester.get_display()
)
def test_render_exception(self):
"""
Application.render_exception() displays formatted exception.
"""
application = Application()
application.set_auto_exit(False)
application.get_terminal_width = self.mock().MagicMock(return_value=120)
tester = ApplicationTester(application)
tester.run([('command', 'foo')], {'decorated': False})
self.assertEqual(
self.open_fixture('application_renderexception1.txt'),
tester.get_display()
)
tester.run([('command', 'foo')],
{'decorated': False, 'verbosity': Output.VERBOSITY_VERBOSE})
self.assertRegex(
tester.get_display(),
'Exception trace'
)
tester.run([('command', 'list'), ('--foo', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_renderexception2.txt'),
tester.get_display()
)
application.add(Foo3Command())
tester = ApplicationTester(application)
tester.run([('command', 'foo3:bar')], {'decorated': False})
self.assertEqual(
self.open_fixture('application_renderexception3.txt'),
tester.get_display()
)
tester = ApplicationTester(application)
tester.run([('command', 'foo3:bar')], {'decorated': True})
self.assertEqual(
self.open_fixture('application_renderexception3decorated.txt'),
tester.get_display()
)
application = Application()
application.set_auto_exit(False)
application.get_terminal_width = self.mock().MagicMock(return_value=31)
tester = ApplicationTester(application)
tester.run([('command', 'foo')], {'decorated': False})
self.assertEqual(
self.open_fixture('application_renderexception4.txt'),
tester.get_display()
)
def test_silent_help(app: Application):
app.catch_exceptions(False)
tester = ApplicationTester(app)
tester.execute("-h -q", decorated=False)
assert tester.io.fetch_output() == ""
def test_render_exception(self):
"""
Application.render_exception() displays formatted exception.
"""
application = Application()
application.set_auto_exit(False)
os.environ['COLUMNS'] = '120'
tester = ApplicationTester(application)
tester.run([('command', 'foo')], {'decorated': False})
self.assertEqual(self.open_fixture('application_renderexception1.txt'),
tester.get_display())
tester.run([('command', 'foo')], {
'decorated': False,
'verbosity': Output.VERBOSITY_VERBOSE
})
self.assertRegex(tester.get_display(), 'Exception trace')
tester.run([('command', 'list'), ('--foo', True)],
{'decorated': False})
self.assertEqual(self.open_fixture('application_renderexception2.txt'),
tester.get_display())
application.add(Foo3Command())
tester = ApplicationTester(application)
tester.run([('command', 'foo3:bar')], {'decorated': False})
self.assertEqual(self.open_fixture('application_renderexception3.txt'),
tester.get_display())
tester = ApplicationTester(application)
tester.run([('command', 'foo3:bar')], {'decorated': True})
self.assertEqual(
self.open_fixture('application_renderexception3decorated.txt'),
tester.get_display())
application = Application()
application.set_auto_exit(False)
os.environ['COLUMNS'] = '31'
tester = ApplicationTester(application)
tester.run([('command', 'foo')], {'decorated': False})
self.assertEqual(self.open_fixture('application_renderexception4.txt'),
tester.get_display())
def test_application_accepts_command(self):
app = application
tester = ApplicationTester(app)
tester.execute("")
self.assertTrue(re.search("Console Tool", tester.io.fetch_output()))
self.assertTrue(
re.search("Display the manual of a command",
tester.io.fetch_output()))
self.assertEqual(0, tester.status_code)
def test_silent_help(self):
"""
Silent help should return nothing
"""
application = Application()
application.set_auto_exit(False)
application.set_catch_exceptions(False)
tester = ApplicationTester(application)
tester.run([('-h', True), ('-q', True)], {'decorated': False})
self.assertEqual('', tester.get_display())
def test_application_accepts_watch_command(self):
app = application
tester = ApplicationTester(app)
tester.execute("watch --help")
self.assertTrue(
re.search(r"<folder>\s+Which folder do you want to watch?",
tester.io.fetch_output()))
self.assertTrue(
re.search(r"<command>\s+What command to run?",
tester.io.fetch_output()))
self.assertEqual(0, tester.status_code)
def setUp(self):
self.application = Application()
self.application.set_auto_exit(False)
self.application.register('foo')\
.add_argument('foo')\
.set_code(lambda c: c.line('foo'))
self.tester = ApplicationTester(self.application)
self.tester.run(
[('command', 'foo'), ('foo', 'bar')], {
'interactive': False,
'decorated': False,
'verbosity': Output.VERBOSITY_VERBOSE
})
def test_set_run_custom_single_command(self):
command = FooCommand()
application = Application()
application.set_auto_exit(False)
application.add(command)
application.set_default_command(command.get_name(), True)
tester = ApplicationTester(application)
tester.run([])
self.assertIn('called', tester.get_display())
tester.run([('--help', True)])
self.assertIn('The foo:bar command', tester.get_display())
def test_application_with_plugins_disabled(mocker: MockerFixture):
mocker.patch(
"entrypoints.get_group_all",
return_value=[
EntryPoint("my-plugin", "tests.console.test_application",
"AddCommandPlugin")
],
)
app = Application()
tester = ApplicationTester(app)
tester.execute("--no-plugins")
assert re.search(r"\s+foo\s+Foo Command", tester.io.fetch_output()) is None
assert tester.status_code == 0
def test_find_alternative_commands_with_question(self):
application = Application()
application.set_auto_exit(False)
os.environ['COLUMNS'] = '120'
os.environ['SHELL_INTERACTIVE'] = '1'
application.add(FooCommand())
application.add(Foo1Command())
application.add(Foo2Command())
tester = ApplicationTester(application)
tester.set_inputs(['1\n'])
tester.run([('command', 'f:b')], {'interactive': True})
self.assertEqual(
self.open_fixture('application_unknown_command_question.txt'),
tester.get_display(True))
def test_application_execute_plugin_command(mocker: MockerFixture):
mocker.patch(
"entrypoints.get_group_all",
return_value=[
EntryPoint("my-plugin", "tests.console.test_application",
"AddCommandPlugin")
],
)
app = Application()
tester = ApplicationTester(app)
tester.execute("foo")
assert tester.io.fetch_output() == "foo called\n"
assert tester.status_code == 0
def test_set_catch_exceptions(self):
application = Application()
application.set_auto_exit(False)
os.environ['COLUMNS'] = '120'
tester = ApplicationTester(application)
application.set_catch_exceptions(True)
tester.run([('command', 'foo')], {'decorated': False})
self.assertEqual(self.open_fixture('application_renderexception1.txt'),
tester.get_display())
application.set_catch_exceptions(False)
try:
tester.run([('command', 'foo')], {'decorated': False})
self.fail('.set_catch_exceptions() sets the catch exception flag')
except Exception as e:
self.assertEqual('Command "foo" is not defined.', str(e))
def test_application_execute_plugin_command_with_plugins_disabled(mocker):
mocker.patch(
"entrypoints.get_group_all",
return_value=[
EntryPoint("my-plugin", "tests.console.test_application",
"AddCommandPlugin")
],
)
app = Application()
tester = ApplicationTester(app)
tester.execute("foo --no-plugins")
assert "" == tester.io.fetch_output()
assert '\nThe command "foo" does not exist.\n' == tester.io.fetch_error()
assert 1 == tester.status_code
def test_application_verify_source_cache_flag(disable_cache: bool):
app = Application()
tester = ApplicationTester(app)
command = "debug info"
if disable_cache:
command = f"{command} --no-cache"
assert not app._poetry
tester.execute(command)
assert app.poetry.pool.repositories
for repo in app.poetry.pool.repositories:
assert repo._disable_cache == disable_cache
def test_set_catch_exceptions(self):
application = Application()
application.set_auto_exit(False)
application.get_terminal_width = self.mock().MagicMock(return_value=120)
tester = ApplicationTester(application)
application.set_catch_exceptions(True)
tester.run([('command', 'foo')], {'decorated': False})
self.assertEqual(
self.open_fixture('application_renderexception1.txt'),
tester.get_display()
)
application.set_catch_exceptions(False)
try:
tester.run([('command', 'foo')], {'decorated': False})
self.fail('.set_catch_exceptions() sets the catch exception flag')
except Exception as e:
self.assertEqual('Command "foo" is not defined.', str(e))
def test_set_catch_exceptions(app: Application, environ: Dict[str, str]):
app.auto_exits(False)
os.environ["COLUMNS"] = "120"
tester = ApplicationTester(app)
app.catch_exceptions(True)
assert app.are_exceptions_caught()
tester.execute("foo", decorated=False)
assert tester.io.fetch_output() == ""
assert (
tester.io.fetch_error()
== FIXTURES_PATH.joinpath("application_exception1.txt").read_text()
)
app.catch_exceptions(False)
with pytest.raises(CommandNotFoundException):
tester.execute("foo", decorated=False)
def tester(app: Application):
app.catch_exceptions(False)
return ApplicationTester(app)
def test_run(self):
application = Application()
application.set_auto_exit(False)
application.set_catch_exceptions(False)
command = Foo1Command()
application.add(command)
sys.argv = ['cli.py', 'foo:bar1']
application.run()
self.assertEqual(
'ArgvInput',
command.input.__class__.__name__
)
self.assertEqual(
'ConsoleOutput',
command.output.__class__.__name__
)
application = Application()
application.set_auto_exit(False)
application.set_catch_exceptions(False)
self.ensure_static_command_help(application)
tester = ApplicationTester(application)
tester.run([], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run1.txt'),
tester.get_display()
)
tester.run([('--help', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run2.txt'),
tester.get_display()
)
tester.run([('-h', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run2.txt'),
tester.get_display()
)
tester.run([('command', 'list'), ('--help', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run3.txt'),
tester.get_display()
)
tester.run([('command', 'list'), ('-h', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run3.txt'),
tester.get_display()
)
tester.run([('--ansi', True)])
self.assertTrue(tester.get_output().is_decorated())
tester.run([('--no-ansi', True)])
self.assertFalse(tester.get_output().is_decorated())
tester.run([('--version', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run4.txt'),
tester.get_display()
)
tester.run([('-V', True)], {'decorated': False})
self.assertEqual(
self.open_fixture('application_run4.txt'),
tester.get_display()
)
tester.run([('command', 'list'), ('--quiet', True)])
self.assertEqual(
'',
tester.get_display()
)
tester.run([('command', 'list'), ('-q', True)])
self.assertEqual(
'',
tester.get_display()
)
tester.run([('command', 'list'), ('--verbose', True)])
self.assertEqual(
Output.VERBOSITY_VERBOSE,
tester.get_output().get_verbosity()
)
tester.run([('command', 'list'), ('-v', True)])
self.assertEqual(
Output.VERBOSITY_VERBOSE,
tester.get_output().get_verbosity()
)
application = Application()
application.set_auto_exit(False)
application.set_catch_exceptions(False)
application.add(FooCommand())
tester = ApplicationTester(application)
tester.run([('command', 'foo:bar'), ('--no-interaction', True)], {'decorated': False})
self.assertEqual(
'called\n',
tester.get_display()
)
tester.run([('command', 'foo:bar'), ('-n', True)], {'decorated': False})
self.assertEqual(
'called\n',
tester.get_display()
)
def tester(app):
return ApplicationTester(app)
def app_tester(app: PoetryTestApplication) -> ApplicationTester:
return ApplicationTester(app)
def tester() -> ApplicationTester:
app = Application()
tester = ApplicationTester(app)
return tester