diff --git a/src/azure-cli/azure/cli/command_modules/appservice/_help.py b/src/azure-cli/azure/cli/command_modules/appservice/_help.py index eea863ae35d..1e540e56c4e 100644 --- a/src/azure-cli/azure/cli/command_modules/appservice/_help.py +++ b/src/azure-cli/azure/cli/command_modules/appservice/_help.py @@ -1971,6 +1971,64 @@ text: az webapp create-remote-connection --name MyWebApp --resource-group MyResourceGroup """ +helps['webapp exec'] = """ +type: command +short-summary: Open an interactive shell session or run a command in a Linux web app container. +long-summary: | + Interact with your Linux web app container in two modes: + - 'shell' (default): open an interactive shell session in your main app container. + - 'execute': fire-and-forget a command in your main app container; returns immediately, no output. + + Only supported for Linux App Service plans. + + 'shell' mode: Open an interactive shell in your app's main container. + A session ends automatically after 3 hours of inactivity, + and may also end if the underlying instance is reimaged or platform components are updated. + + 'execute' mode: Fire-and-forget a command in the main app container. A 'succeeded' result means the command was accepted. + It does not confirm the command ran or completed, and no logs, output, or exit code are returned. For immediate output, use 'shell' mode. + The CLI reports failure only if the command (or the shell) could not be started. + This makes execute mode well-suited to background or long-running work. + The process runs detached and lives for the lifetime of the container (or until it finishes on its own). + Use --command to run a single program, e.g. "npm start". + Use --shell-command to run a shell command line where shell operators (|, &&, >, etc.) work, e.g. "cat log.txt | grep error > out.txt". + Check the parameters and examples below, including how to capture output to a file. +examples: + - name: Run a direct command in the container + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "mkdir /home/site/newdir" + - name: Run a shell command and redirect output to a file + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --shell-command "echo hello > /home/LogFiles/out.txt 2>&1" + - name: Run a command in a specific working directory + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --cwd /home/site --command "touch newfile.txt" + - name: Run a Python script in the container + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "python3 /home/site/wwwroot/script.py" + - name: Run a shell command with a non-default shell + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --shell /bin/sh --shell-command "echo hi | grep h" + - name: Execute a command on a specific instance + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "touch newfile.txt" --instance MyInstanceId + - name: Execute a command on all instances + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode execute --command "touch newfile.txt" --instance all + - name: Execute a command on a deployment slot + text: > + az webapp exec -g MyResourceGroup -n MyWebapp -s staging --mode execute --command "touch newfile.txt" + - name: Start an interactive shell session with the web app container + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode shell + - name: Start an interactive shell session on a specific instance + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode shell --instance MyInstanceId + - name: Start an interactive shell session using a specific shell + text: > + az webapp exec -g MyResourceGroup -n MyWebapp --mode shell --shell /bin/sh +""" + helps['webapp delete'] = """ type: command short-summary: Delete a web app. diff --git a/src/azure-cli/azure/cli/command_modules/appservice/_params.py b/src/azure-cli/azure/cli/command_modules/appservice/_params.py index 45ef30f76d3..3639f47467b 100644 --- a/src/azure-cli/azure/cli/command_modules/appservice/_params.py +++ b/src/azure-cli/azure/cli/command_modules/appservice/_params.py @@ -1608,3 +1608,33 @@ def load_arguments(self, _): c.argument('environment_name', help="Name of the environment of static site") with self.argument_context('staticwebapp enterprise-edge') as c: c.argument("no_register", help="Don't try to register the Microsoft.CDN provider. Registration can be done manually with: az provider register --wait --namespace Microsoft.CDN. For more details, please review the documentation available at https://go.microsoft.com/fwlink/?linkid=2184995 .", default=False) + with self.argument_context('webapp exec') as c: + c.argument('name', arg_type=webapp_name_arg_type, id_part=None, help='Name of the web app.') + c.argument('exec_command', options_list=['--command'], + help='[Execute mode] A command to run directly in the container, without a shell. ' + 'Quote the whole command (e.g. --command "python /home/site/app.py --port 8080"). ' + 'Shell operators (>, |, &&, etc.) are not interpreted - use --shell-command for those. ' + 'Mutually exclusive with --shell-command.') + c.argument('shell_command', options_list=['--shell-command'], + help='[Execute mode] A command line to run through a shell, so shell operators (|, &&, >, etc.) work ' + '(e.g. --shell-command "echo hi > /home/LogFiles/out.txt"). ' + 'Runs as " -c "; the shell defaults to ' + '/bin/bash and can be overridden with --shell. Mutually exclusive with --command.') + c.argument('mode', + help="Execution mode. 'shell' (default): Starts an interactive shell session with the main " + "web app container. 'execute': Starts command execution and returns immediately without " + "returning command output.", + arg_type=get_enum_type(['shell', 'execute']), default='shell') + c.argument('working_directory', options_list=['--working-directory', '--cwd'], + help="[Execute mode] Working directory for command execution. " + "Defaults to the container's working directory.") + c.argument('instance', options_list=['--instance', '-i'], + help='Webapp instance(s) to target. Specify a comma-separated list of instance IDs ' + '(use "az webapp list-instances" to get IDs) or "all" for all instances. Defaults to a random instance. ' + 'Specifying multiple instances (a comma-separated list or "all") is supported only in \'execute\' mode.') + c.argument('shell', options_list=['--shell'], + help="Absolute path of the shell to use (e.g. /bin/sh); defaults to /bin/bash. " + "In 'shell' mode it is the interactive shell to launch; in 'execute' mode it is " + "the shell used to run --shell-command.") + c.argument('slot', options_list=['--slot', '-s'], + help='Name of the web app slot. Default to the production slot if not specified.') diff --git a/src/azure-cli/azure/cli/command_modules/appservice/commands.py b/src/azure-cli/azure/cli/command_modules/appservice/commands.py index 31be90a3615..cea6f1510f3 100644 --- a/src/azure-cli/azure/cli/command_modules/appservice/commands.py +++ b/src/azure-cli/azure/cli/command_modules/appservice/commands.py @@ -129,11 +129,14 @@ def load_command_table(self, _): logicapp_custom = CliCommandType(operations_tmpl='azure.cli.command_modules.appservice.logicapp.custom#{}') + webapp_exec_custom = CliCommandType(operations_tmpl='azure.cli.command_modules.appservice.webapp_exec#{}') + with self.command_group('webapp', webapp_sdk) as g: g.custom_command('create', 'create_webapp', exception_handler=ex_handler_factory(), validator=validate_vnet_integration) g.custom_command('up', 'webapp_up', exception_handler=ex_handler_factory(), validator=validate_webapp_up, deprecate_info=g.deprecate(redirect='webapp create and webapp deploy')) g.custom_command('ssh', 'ssh_webapp', exception_handler=ex_handler_factory(), is_preview=True) + g.custom_command('exec', 'webapp_exec', custom_command_type=webapp_exec_custom, exception_handler=ex_handler_factory(), is_preview=True) g.custom_command('list', 'list_webapp', table_transformer=transform_web_list_output) g.custom_show_command('show', 'show_app', table_transformer=transform_web_output) g.custom_command('delete', 'delete_webapp') diff --git a/src/azure-cli/azure/cli/command_modules/appservice/custom.py b/src/azure-cli/azure/cli/command_modules/appservice/custom.py index fe3ec65ac8b..7d47ed3a796 100644 --- a/src/azure-cli/azure/cli/command_modules/appservice/custom.py +++ b/src/azure-cli/azure/cli/command_modules/appservice/custom.py @@ -50,7 +50,7 @@ from azure.cli.core.azclierror import (InvalidArgumentValueError, MutuallyExclusiveArgumentError, ResourceNotFoundError, RequiredArgumentMissingError, ValidationError, CLIInternalError, UnclassifiedUserFault, AzureResponseError, AzureInternalError, - ArgumentUsageError, FileOperationError) + ArgumentUsageError, FileOperationError, AzureConnectionError) from .tunnel import TunnelServer diff --git a/src/azure-cli/azure/cli/command_modules/appservice/tests/latest/test_webapp_exec_thru_mock.py b/src/azure-cli/azure/cli/command_modules/appservice/tests/latest/test_webapp_exec_thru_mock.py new file mode 100644 index 00000000000..73f309d446f --- /dev/null +++ b/src/azure-cli/azure/cli/command_modules/appservice/tests/latest/test_webapp_exec_thru_mock.py @@ -0,0 +1,436 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------------------------- + +import codecs +import io +import unittest +from unittest import mock + +import requests +import websocket + +from azure.cli.core.azclierror import ( + ResourceNotFoundError, + ValidationError, + AzureConnectionError, + AzureResponseError, + CLIInternalError, +) +from azure.cli.core.profiles import ResourceType + +from azure.cli.command_modules.appservice.webapp_exec import ( + webapp_exec, + _resolve_target_instances, + _build_execute_invocation, + _execute_command_on_instance, + _parse_server_message, + _friendly_exec_error_message, + _read_from_server, + _start_shell_session, +) + +_MODULE = 'azure.cli.command_modules.appservice.webapp_exec' + + +def _get_test_cmd(): + """Return a mock CLI context (`cmd`) to pass as the first argument of `webapp_exec`.""" + from azure.cli.core.mock import DummyCli + from azure.cli.core import AzCommandsLoader + from azure.cli.core.commands import AzCliCommand + cli_ctx = DummyCli() + loader = AzCommandsLoader(cli_ctx, resource_type=ResourceType.MGMT_APPSERVICE) + cmd = AzCliCommand(loader, 'test', None) + cmd.command_kwargs = {'resource_type': ResourceType.MGMT_APPSERVICE} + cmd.cli_ctx = cli_ctx + return cmd + + +def _instance(name): + """Return a mock instance object as `list_instances` yields.""" + inst = mock.Mock() + inst.name = name + return inst + + +class WebappExecValidationTest(unittest.TestCase): + """Validate the parameter-checking branches of webapp_exec.""" + + def setUp(self): + # Set up default mocks so webapp_exec sees an existing Linux site + site_op_patcher = mock.patch(_MODULE + '._generic_site_operation', return_value=mock.Mock()) + is_linux_patcher = mock.patch(_MODULE + '.is_linux_webapp', return_value=True) + self.site_op = site_op_patcher.start() + self.is_linux = is_linux_patcher.start() + self.addCleanup(site_op_patcher.stop) + self.addCleanup(is_linux_patcher.stop) + self.cmd = _get_test_cmd() + + def test_site_not_found_raises(self): + self.site_op.return_value = None + with self.assertRaisesRegex(ResourceNotFoundError, "Unable to find web app"): + webapp_exec(self.cmd, 'rg', 'app') + + def test_non_linux_site_raises(self): + self.is_linux.return_value = False + with self.assertRaisesRegex(ValidationError, "not a Linux web app"): + webapp_exec(self.cmd, 'rg', 'app') + + def test_execute_mode_requires_command(self): + with self.assertRaisesRegex(ValidationError, "Either --command or --shell-command is required"): + webapp_exec(self.cmd, 'rg', 'app', mode='execute') + + def test_execute_mode_rejects_blank_shell_command(self): + with self.assertRaisesRegex(ValidationError, "--shell-command must not be empty"): + webapp_exec(self.cmd, 'rg', 'app', mode='execute', shell_command=' ') + + def test_execute_mode_rejects_command_and_shell_command_together(self): + with self.assertRaisesRegex(ValidationError, "either --command or --shell-command, not both"): + webapp_exec(self.cmd, 'rg', 'app', mode='execute', exec_command='ls', shell_command='ls') + + def test_execute_mode_rejects_shell_without_shell_command(self): + with self.assertRaisesRegex(ValidationError, "--shell is only valid together with --shell-command"): + webapp_exec(self.cmd, 'rg', 'app', mode='execute', exec_command='ls', shell='/bin/sh') + + def test_shell_mode_rejects_command(self): + with self.assertRaisesRegex(ValidationError, r"--command is only supported in 'execute' mode"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', exec_command='ls') + + def test_shell_mode_rejects_shell_command(self): + with self.assertRaisesRegex(ValidationError, r"--shell-command is only supported in 'execute' mode"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', shell_command='ls') + + def test_shell_mode_rejects_working_directory(self): + with self.assertRaisesRegex(ValidationError, r"--working-directory is only supported in 'execute' mode"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', working_directory='/home') + + def test_shell_mode_rejects_all_instances(self): + with self.assertRaisesRegex(ValidationError, "single instance"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', instance='all') + + def test_shell_mode_rejects_instance_list(self): + with self.assertRaisesRegex(ValidationError, "single instance"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', instance='i1,i2') + + def test_shell_mode_rejects_relative_shell_path(self): + with self.assertRaisesRegex(ValidationError, "absolute path"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', shell='bash') + + def test_shell_mode_rejects_overlong_shell_path(self): + with self.assertRaisesRegex(ValidationError, "too long"): + webapp_exec(self.cmd, 'rg', 'app', mode='shell', shell='/' + 'a' * 300) + + def test_invalid_mode_raises(self): + with self.assertRaisesRegex(ValidationError, "Invalid mode"): + webapp_exec(self.cmd, 'rg', 'app', mode='bogus') + + @mock.patch(_MODULE + '._start_shell_session') + @mock.patch(_MODULE + '._resolve_target_instances', return_value=[None]) + @mock.patch(_MODULE + '.get_scm_site_headers', return_value={}) + @mock.patch(_MODULE + '._get_scm_url', return_value='https://app.scm.azurewebsites.net') + def test_shell_mode_happy_path_starts_session(self, _scm, _headers, _resolve, start_session): + result = webapp_exec(self.cmd, 'rg', 'app', mode='shell') + self.assertIsNone(result) + start_session.assert_called_once() + + @mock.patch(_MODULE + '._execute_in_parallel', return_value=[{'status': 'success'}]) + @mock.patch(_MODULE + '._resolve_target_instances', return_value=[None]) + @mock.patch(_MODULE + '.get_scm_site_headers', return_value={}) + @mock.patch(_MODULE + '._get_scm_url', return_value='https://app.scm.azurewebsites.net') + def test_execute_mode_happy_path_runs_in_parallel(self, _scm, _headers, _resolve, run_parallel): + result = webapp_exec(self.cmd, 'rg', 'app', mode='execute', exec_command='ls') + self.assertEqual(result, [{'status': 'success'}]) + run_parallel.assert_called_once() + + @mock.patch(_MODULE + '._execute_in_parallel', return_value=[{'status': 'success'}]) + @mock.patch(_MODULE + '._resolve_target_instances', return_value=[None]) + @mock.patch(_MODULE + '.get_scm_site_headers', return_value={}) + @mock.patch(_MODULE + '._get_scm_url', return_value='https://app.scm.azurewebsites.net') + def test_execute_mode_shell_command_happy_path(self, _scm, _headers, _resolve, run_parallel): + result = webapp_exec(self.cmd, 'rg', 'app', mode='execute', + shell_command='echo hi > /home/LogFiles/out.txt') + self.assertEqual(result, [{'status': 'success'}]) + run_parallel.assert_called_once() + + @mock.patch(_MODULE + '._execute_in_parallel', + return_value=[{'instance': 'default', 'status': 'failed', 'error': 'boom'}]) + @mock.patch(_MODULE + '._resolve_target_instances', return_value=[None]) + @mock.patch(_MODULE + '.get_scm_site_headers', return_value={}) + @mock.patch(_MODULE + '._get_scm_url', return_value='https://app.scm.azurewebsites.net') + def test_execute_mode_failed_instance_raises(self, _scm, _headers, _resolve, _run_parallel): + with self.assertRaisesRegex(AzureResponseError, "failed on 1 of 1 instance"): + webapp_exec(self.cmd, 'rg', 'app', mode='execute', exec_command='ls') + + +class BuildExecuteInvocationTest(unittest.TestCase): + """Validate how --command / --shell-command map to the backend (command, args) argv pair.""" + + def test_command_is_split_into_executable_and_args(self): + command, args = _build_execute_invocation('python /home/app.py --port 8080', None, None) + self.assertEqual(command, 'python') + self.assertEqual(args, ['/home/app.py', '--port', '8080']) + + def test_command_respects_quoting(self): + command, args = _build_execute_invocation('touch "my file.txt"', None, None) + self.assertEqual(command, 'touch') + self.assertEqual(args, ['my file.txt']) + + def test_shell_command_wraps_in_default_shell(self): + command, args = _build_execute_invocation(None, 'echo hi | grep h', None) + self.assertEqual(command, '/bin/bash') + self.assertEqual(args, ['-c', 'echo hi | grep h']) + + def test_shell_command_honors_custom_shell(self): + command, args = _build_execute_invocation(None, 'echo hi', '/bin/sh') + self.assertEqual(command, '/bin/sh') + self.assertEqual(args, ['-c', 'echo hi']) + + def test_empty_command_raises(self): + with self.assertRaisesRegex(ValidationError, "must not be empty"): + _build_execute_invocation(' ', None, None) + + def test_unbalanced_quotes_raises(self): + with self.assertRaisesRegex(ValidationError, "Could not parse --command"): + _build_execute_invocation('echo "unterminated', None, None) + + def test_single_token_command_has_no_args(self): + command, args = _build_execute_invocation('nginx', None, None) + self.assertEqual(command, 'nginx') + self.assertEqual(args, []) + + def test_shell_operators_pass_through_as_literal_args(self): + command, args = _build_execute_invocation('myprog >&>>&&&&>', None, None) + self.assertEqual(command, 'myprog') + self.assertEqual(args, ['>&>>&&&&>']) + + def test_shell_command_empty_shell_falls_back_to_default(self): + command, args = _build_execute_invocation(None, 'echo hi', '') + self.assertEqual(command, '/bin/bash') + self.assertEqual(args, ['-c', 'echo hi']) + + +class ResolveTargetInstancesTest(unittest.TestCase): + """Validate _resolve_target_instances instance-selection logic.""" + + def setUp(self): + self.cmd = _get_test_cmd() + + @mock.patch(_MODULE + '.list_instances') + def test_none_returns_single_default(self, list_mock): + # No instance requested -> a single unpinned target; no list_instances call needed. + self.assertEqual(_resolve_target_instances(self.cmd, 'rg', 'app', None, None), [None]) + list_mock.assert_not_called() + + @mock.patch(_MODULE + '.list_instances', return_value=[_instance('b'), _instance('a')]) + def test_all_returns_sorted_names(self, _list_mock): + self.assertEqual(_resolve_target_instances(self.cmd, 'rg', 'app', 'all', None), ['a', 'b']) + + @mock.patch(_MODULE + '.list_instances', return_value=[]) + def test_all_with_no_instances_raises(self, _list_mock): + with self.assertRaisesRegex(ValidationError, "No instances found"): + _resolve_target_instances(self.cmd, 'rg', 'app', 'all', None) + + @mock.patch(_MODULE + '.list_instances', return_value=[_instance('i1'), _instance('i2')]) + def test_valid_comma_list_returns_requested(self, _list_mock): + self.assertEqual(_resolve_target_instances(self.cmd, 'rg', 'app', 'i1, i2', None), ['i1', 'i2']) + + @mock.patch(_MODULE + '.list_instances', return_value=[_instance('i1')]) + def test_invalid_instance_raises(self, _list_mock): + with self.assertRaisesRegex(ValidationError, "not valid for this web app"): + _resolve_target_instances(self.cmd, 'rg', 'app', 'i1,nope', None) + + +class ParseServerMessageTest(unittest.TestCase): + """Validate _parse_server_message body handling.""" + + def test_none_body_returns_none(self): + self.assertIsNone(_parse_server_message(None)) + + def test_empty_and_whitespace_body_returns_none(self): + self.assertIsNone(_parse_server_message('')) + self.assertIsNone(_parse_server_message(' \n')) + + def test_json_message_field_is_extracted(self): + self.assertEqual(_parse_server_message('{"Message": "hello"}'), 'hello') + + def test_json_dict_without_message_returns_none(self): + self.assertIsNone(_parse_server_message('{"Other": "x"}')) + + def test_non_json_text_returned_verbatim(self): + self.assertEqual(_parse_server_message('non json text'), 'non json text') + + def test_json_non_dict_returned_as_text(self): + self.assertEqual(_parse_server_message('[1, 2]'), '[1, 2]') + + def test_bytes_body_is_decoded(self): + self.assertEqual(_parse_server_message(b'{"Message": "hi"}'), 'hi') + + +class FriendlyExecErrorMessageTest(unittest.TestCase): + """Validate _friendly_exec_error_message fallback behavior.""" + + def test_empty_body_uses_fallback(self): + self.assertEqual( + _friendly_exec_error_message(''), + "The request could not be completed. Please try again later.") + + def test_message_passthrough(self): + self.assertEqual(_friendly_exec_error_message('{"Message": "denied"}'), 'denied') + + +class ExecuteCommandOnInstanceTest(unittest.TestCase): + """Validate _execute_command_on_instance request building and response handling.""" + + @mock.patch('requests.post', autospec=True) + def test_success_returns_parsed_message(self, post_mock): + post_mock.return_value = mock.Mock(status_code=202, text='{"Message": "done"}') + result = _execute_command_on_instance('https://scm', {}, {}, 'ls') + self.assertEqual(result, 'done') + + @mock.patch('requests.post', autospec=True) + def test_body_omits_optional_fields_when_absent(self, post_mock): + post_mock.return_value = mock.Mock(status_code=202, text='') + _execute_command_on_instance('https://scm', {}, {}, 'ls') + self.assertEqual(post_mock.call_args.kwargs['json'], {'Command': 'ls'}) + + @mock.patch('requests.post', autospec=True) + def test_body_includes_args_and_working_directory(self, post_mock): + post_mock.return_value = mock.Mock(status_code=202, text='') + _execute_command_on_instance('https://scm', {}, {}, 'bash', args=['-c', 'pwd'], working_directory='/home') + self.assertEqual( + post_mock.call_args.kwargs['json'], + {'Command': 'bash', 'Args': ['-c', 'pwd'], 'WorkingDirectory': '/home'}) + + @mock.patch('requests.post', autospec=True) + def test_non_202_raises_internal_error_with_message(self, post_mock): + post_mock.return_value = mock.Mock(status_code=500, text='{"Message": "Internal Error"}') + with self.assertRaisesRegex(CLIInternalError, "Internal Error"): + _execute_command_on_instance('https://scm', {}, {}, 'ls') + + @mock.patch('requests.post', autospec=True) + def test_non_202_empty_body_uses_fallback_message(self, post_mock): + post_mock.return_value = mock.Mock(status_code=500, text='') + with self.assertRaisesRegex(CLIInternalError, "could not be completed"): + _execute_command_on_instance('https://scm', {}, {}, 'ls') + + @mock.patch('requests.post', autospec=True) + def test_request_exception_raises_connection_error(self, post_mock): + post_mock.side_effect = requests.exceptions.ConnectTimeout('timed out') + with self.assertRaisesRegex(AzureConnectionError, "Could not connect"): + _execute_command_on_instance('https://scm', {}, {}, 'ls') + + +class ReadFromServerTest(unittest.TestCase): + """Validate _read_from_server opcode handling and UTF-8 decoding.""" + + @staticmethod + def _run(frames): + # Mock WebSocket frames containing shell output from the server. Pass frames through + # _read_from_server and return the parsed output for testing _read_from_server. + import threading + ws = mock.Mock() + ws.recv_data.side_effect = list(frames) + closed = threading.Event() + decoder = codecs.getincrementaldecoder('utf-8')('replace') + # Redirect stdout to an in-memory buffer to capture what _read_from_server prints. + out = io.StringIO() + with mock.patch('sys.stdout', out): + _read_from_server(ws, closed, decoder) + return out.getvalue(), closed + + def test_text_frame_written_to_stdout(self): + out, closed = self._run([ + (websocket.ABNF.OPCODE_TEXT, b'hello'), + (websocket.ABNF.OPCODE_CLOSE, b''), + ]) + self.assertEqual(out, 'hello') + self.assertTrue(closed.is_set()) + + def test_binary_frame_written_to_stdout(self): + out, _closed = self._run([ + (websocket.ABNF.OPCODE_BINARY, b'hi'), + (websocket.ABNF.OPCODE_CLOSE, b''), + ]) + self.assertEqual(out, 'hi') + + def test_ping_and_pong_frames_are_skipped(self): + out, _closed = self._run([ + (websocket.ABNF.OPCODE_PING, b'x'), + (websocket.ABNF.OPCODE_PONG, b'y'), + (websocket.ABNF.OPCODE_TEXT, b'ok'), + (websocket.ABNF.OPCODE_CLOSE, b''), + ]) + self.assertEqual(out, 'ok') + + def test_close_frame_stops_before_writing(self): + out, closed = self._run([ + (websocket.ABNF.OPCODE_CLOSE, b''), + ]) + self.assertEqual(out, '') + self.assertTrue(closed.is_set()) + + def test_multibyte_utf8_split_across_frames_is_decoded(self): + # 'e-acute' is bytes 0xC3 0xA9; deliver the two bytes in separate frames. + out, _closed = self._run([ + (websocket.ABNF.OPCODE_BINARY, b'\xc3'), + (websocket.ABNF.OPCODE_BINARY, b'\xa9'), + (websocket.ABNF.OPCODE_CLOSE, b''), + ]) + self.assertEqual(out, '\u00e9') + + +class ShellSessionConnectTest(unittest.TestCase): + """Validate _start_shell_session URL/cookie building and handshake error mapping.""" + + def setUp(self): + # Stub every post-connect step so only the connection setup runs. + patchers = [ + mock.patch(_MODULE + '._read_from_server'), + mock.patch(_MODULE + '._send_terminal_resize'), + mock.patch(_MODULE + '._send_to_server_windows'), + mock.patch(_MODULE + '._send_to_server_non_windows'), + mock.patch(_MODULE + '._enable_windows_vt_output', return_value=None), + mock.patch('websocket.create_connection'), + ] + started = [p.start() for p in patchers] + for patcher in patchers: + self.addCleanup(patcher.stop) + # Save a reference to the create_connection mock so each test can + # check the parameters used when called (URL, headers, and cookie) + self.create_conn = started[-1] + + def test_builds_wss_url_and_forwards_headers(self): + headers = {'Authorization': 'Bearer token'} + _start_shell_session('https://scm.example', headers) + self.assertEqual(self.create_conn.call_args.args[0], 'wss://scm.example/exec/shell') + self.assertEqual(self.create_conn.call_args.kwargs['header'], headers) + + def test_shell_param_is_appended_and_url_encoded(self): + _start_shell_session('https://scm.example', {}, shell='/bin/bash') + self.assertEqual( + self.create_conn.call_args.args[0], + 'wss://scm.example/exec/shell?shell=%2Fbin%2Fbash') + + def test_cookies_are_formatted_into_cookie_string(self): + _start_shell_session('https://scm.example', {}, cookies={'ARRAffinity': 'abc'}) + self.assertEqual(self.create_conn.call_args.kwargs['cookie'], 'ARRAffinity=abc') + + def test_no_cookies_sends_none(self): + _start_shell_session('https://scm.example', {}) + self.assertIsNone(self.create_conn.call_args.kwargs['cookie']) + + def test_bad_handshake_raises_internal_error(self): + self.create_conn.side_effect = websocket.WebSocketBadStatusException( + 'Handshake status 403', 403, resp_body='{"Message": "Access denied"}') + with self.assertRaisesRegex(CLIInternalError, 'Access denied'): + _start_shell_session('https://scm.example', {}) + + def test_connection_failure_raises_connection_error(self): + self.create_conn.side_effect = OSError('refused') + with self.assertRaisesRegex(AzureConnectionError, 'Could not connect'): + _start_shell_session('https://scm.example', {}) + + +if __name__ == '__main__': + unittest.main() diff --git a/src/azure-cli/azure/cli/command_modules/appservice/webapp_exec.py b/src/azure-cli/azure/cli/command_modules/appservice/webapp_exec.py new file mode 100644 index 00000000000..188d64be849 --- /dev/null +++ b/src/azure-cli/azure/cli/command_modules/appservice/webapp_exec.py @@ -0,0 +1,534 @@ +# -------------------------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------------------------- + +from knack.log import get_logger +from knack.util import CLIError + +from azure.cli.core.azclierror import (ResourceNotFoundError, ValidationError, AzureConnectionError, + AzureResponseError, CLIInternalError) + +from ._appservice_utils import _generic_site_operation +from .custom import _get_scm_url, get_scm_site_headers, list_instances +from .utils import is_linux_webapp + +logger = get_logger(__name__) + +_MAX_SHELL_PATH_LENGTH = 256 + +# Windows special key codes and ANSI escape sequences. +_WINDOWS_KEY_MAP = { + 72: b'\x1b[A', # Up + 80: b'\x1b[B', # Down + 77: b'\x1b[C', # Right + 75: b'\x1b[D', # Left + 71: b'\x1b[H', # Home + 79: b'\x1b[F', # End + 82: b'\x1b[2~', # Insert + 83: b'\x1b[3~', # Delete + 73: b'\x1b[5~', # Page Up + 81: b'\x1b[6~', # Page Down + 59: b'\x1bOP', # F1 + 60: b'\x1bOQ', # F2 + 61: b'\x1bOR', # F3 + 62: b'\x1bOS', # F4 + 63: b'\x1b[15~', # F5 + 64: b'\x1b[17~', # F6 + 65: b'\x1b[18~', # F7 + 66: b'\x1b[19~', # F8 + 67: b'\x1b[20~', # F9 + 68: b'\x1b[21~', # F10 + 133: b'\x1b[23~', # F11 + 134: b'\x1b[24~', # F12 + 115: b'\x1b[1;5D', # Ctrl+Left + 116: b'\x1b[1;5C', # Ctrl+Right + 141: b'\x1b[1;5A', # Ctrl+Up + 145: b'\x1b[1;5B', # Ctrl+Down +} + + +def webapp_exec(cmd, + resource_group_name, + name, + exec_command=None, + shell_command=None, + mode='shell', + working_directory=None, + instance=None, + shell=None, + slot=None): + # Validate Linux App + webapp = _generic_site_operation(cmd.cli_ctx, resource_group_name, name, 'get', slot) + if not webapp: + raise ResourceNotFoundError( + "Unable to find web app '{}' in resource group '{}'.".format(name, resource_group_name)) + + if not is_linux_webapp(webapp): + raise ValidationError("Site is not a Linux web app. 'az webapp exec' is only supported for Linux web apps.") + + # Validate parameters + if shell: + if not shell.startswith('/'): + raise ValidationError("--shell must be an absolute path (e.g. /bin/sh).") + if len(shell) > _MAX_SHELL_PATH_LENGTH: + raise ValidationError( + "--shell path is too long (max {} characters).".format(_MAX_SHELL_PATH_LENGTH)) + + if mode.lower() == 'execute': + if exec_command and shell_command: + raise ValidationError("Specify either --command or --shell-command, not both.") + if not exec_command and not shell_command: + raise ValidationError("Either --command or --shell-command is required for 'execute' mode.") + if shell_command is not None and not shell_command.strip(): + raise ValidationError("--shell-command must not be empty.") + if shell and not shell_command: + raise ValidationError("--shell is only valid together with --shell-command in 'execute' mode.") + elif mode.lower() == 'shell': + if exec_command: + raise ValidationError("--command is only supported in 'execute' mode.") + if shell_command: + raise ValidationError("--shell-command is only supported in 'execute' mode.") + if working_directory: + raise ValidationError("--working-directory is only supported in 'execute' mode.") + if instance and (instance.lower() == 'all' or ',' in instance): + raise ValidationError( + "Shell mode supports a single instance. Specify one instance, or omit to use a random one.") + else: + raise ValidationError("Invalid mode '{}'. Supported modes: execute, shell.".format(mode)) + + # Get scm site and authorization + scm_url = _get_scm_url(cmd, resource_group_name, name, slot) + headers = get_scm_site_headers(cmd.cli_ctx, name, resource_group_name, slot) + + # Resolve target instances (shared by both modes) + target_instances = _resolve_target_instances(cmd, resource_group_name, name, instance, slot) + + # Shell mode — single interactive session + if mode.lower() == 'shell': + target = target_instances[0] + cookies = {} + if target: + cookies['ARRAffinity'] = target + _start_shell_session(scm_url, headers, cookies, shell=shell) + return None + + # Execute mode - run the command on each resolved instance in parallel. + command, command_args = _build_execute_invocation(exec_command, shell_command, shell) + logger.warning( + "Execute mode is fire-and-forget: a 'succeeded' result means the command was accepted, " + "not that it ran or finished. No output is returned - it is best for background or " + "long-running work; for immediate output, use '--mode shell'. " + "See 'az webapp exec --help' for how to capture output.") + args_list = [(target, scm_url, headers, command, command_args, working_directory) + for target in target_instances] + results = _execute_in_parallel(_run_execute_on_instance, args_list) + + failed = [r for r in results if r.get('status') == 'failed'] + if failed: + raise AzureResponseError( + "Command execution failed on {} of {} instance(s). See the messages above for details." + .format(len(failed), len(results))) + + return results + + +def _resolve_target_instances(cmd, resource_group_name, name, instance, slot): + if instance is None: + return [None] + + instance_names = set(i.name for i in list_instances(cmd, resource_group_name, name, slot=slot)) + + if instance.lower() == 'all': + if not instance_names: + raise ValidationError("No instances found for this web app.") + return sorted(instance_names) + + requested = [i.strip() for i in instance.split(',')] + invalid = [i for i in requested if i not in instance_names] + if invalid: + raise ValidationError( + "The following instances are not valid for this web app: {}. Valid instances: {}".format( + ', '.join(invalid), ', '.join(sorted(instance_names)))) + return requested + + +def _build_execute_invocation(exec_command, shell_command, shell): + # Parse the user's input into the (command, args) argv pair. + if shell_command: + shell_path = shell or '/bin/bash' + logger.warning("Running shell command with %s: %s", shell_path, shell_command) + return shell_path, ['-c', shell_command] + + import shlex + try: + tokens = shlex.split(exec_command) + except ValueError as ex: + raise ValidationError( + "Could not parse --command: {}. Check for unbalanced quotes.".format(ex)) + if not tokens: + raise ValidationError("--command must not be empty.") + logger.warning("Running command: %s | arguments: %s", tokens[0], tokens[1:]) + return tokens[0], tokens[1:] + + +def _run_execute_on_instance(target, scm_url, headers, command, args, working_directory): + # Run the command on a single instance and return a result dict. Never raises: + # a CLIError from one instance is captured so it can't abort the others. + cookies = {} + if target is not None: + cookies['ARRAffinity'] = target + label = target or 'default' + try: + result = _execute_command_on_instance(scm_url, headers, cookies, command, args, working_directory) + logger.warning("Instance '%s' succeeded%s", label, ": {}".format(result) if result else ".") + return {'instance': label, 'status': 'success', 'result': result} + except CLIError as e: + logger.warning("Instance '%s' failed: %s", label, e) + return {'instance': label, 'status': 'failed', 'error': str(e)} + + +def _execute_in_parallel(fn, args_list, max_workers=10): + # Run fn(*args) for each arg tuple on a thread pool + import concurrent.futures + max_workers = min(max_workers, len(args_list)) + with concurrent.futures.ThreadPoolExecutor(max_workers=max_workers) as executor: + futures = [executor.submit(fn, *args) for args in args_list] + return [f.result() for f in futures] + + +# --- shell mode --- + + +def _start_shell_session(scm_url, headers, cookies=None, shell=None): + import codecs + import platform + import threading + import websocket + + ws_url = scm_url.replace('https://', 'wss://') + '/exec/shell' + if shell: + import urllib.parse + ws_url += '?shell=' + urllib.parse.quote(shell, safe='') + + cookie_str = '; '.join(f'{k}={v}' for k, v in cookies.items()) if cookies else None + + # Request Websocket connection with 30s timeout + try: + ws = websocket.create_connection( + ws_url, + header=headers, + cookie=cookie_str, + timeout=30 + ) + except websocket.WebSocketBadStatusException as ex: + # The server rejected the upgrade handshake + raise CLIInternalError(_friendly_exec_error_message(getattr(ex, 'resp_body', None))) + except (OSError, websocket.WebSocketException) as ex: + raise AzureConnectionError("Could not connect to the web app: {}".format(ex)) + + # Clear the 30s connect timeout so the read_from_server loop blocks indefinitely + ws.settimeout(None) + + logger.info("Connected to %s", ws_url) + print("Connected to the web app container.") + print("This session ends after 3 hours of inactivity, and may also end if the " + "container restarts or the host undergoes maintenance.") + print("Press Ctrl+C twice to exit.\n") + + # Enable ANSI rendering on Windows consoles. No-op on Unix / redirected stdout. + vt_state = _enable_windows_vt_output() + + # Incremental UTF-8 decoder: a multi-byte char can split across frames, so it buffers the + # partial bytes until the next frame completes them. Replace invalid char as a fallback. + decoder = codecs.getincrementaldecoder('utf-8')('replace') + + # Run two loops until one sets closed. + # 1. _read_from_server: server output -> stdout + # 2. _send_to_server : stdin -> server + closed = threading.Event() + + # 1. server -> stdout, on a background thread + threading.Thread( + target=_read_from_server, + args=(ws, closed, decoder), + daemon=True).start() + + # Send starting terminal size so the remote PTY matches. + _send_terminal_resize(ws) + + # 2. stdin -> server, blocks the main thread until the session ends + if platform.system() == 'Windows': + _send_to_server_windows(ws, closed) + else: + _send_to_server_non_windows(ws, closed) + + # Send loop returned: signal the read thread to stop, then clean up. + closed.set() + + # Restore the original Windows console output mode, if changed. + if vt_state is not None: + import ctypes + ctypes.windll.kernel32.SetConsoleMode(vt_state[0], vt_state[1]) + try: + ws.close() + except Exception: # pylint: disable=broad-except + pass + + +def _enable_windows_vt_output(): + # Enable ANSI escape processing on the Windows stdout console. + # Server output contains ANSI escape sequences (colors, cursor movement from + # vim/top/htop). Modern Windows Terminal renders these by default, but classic + # conhost/cmd.exe shows them as raw codes unless ENABLE_VIRTUAL_TERMINAL_PROCESSING + # is set on stdout's console mode. Returns (handle, old_mode) so the caller can restore + # the original mode, or None when not applicable (non-Windows, or stdout is redirected/not a console). + + import platform + if platform.system() != 'Windows': + return None + import ctypes + kernel32 = ctypes.windll.kernel32 + + stdout_handle = kernel32.GetStdHandle(-11) # STD_OUTPUT_HANDLE + # GetConsoleMode returns 0 when stdout isn't a real console (e.g. redirected to a file). + old_mode = ctypes.c_uint32() + if not kernel32.GetConsoleMode(stdout_handle, ctypes.byref(old_mode)): + return None + + # OR in the VT bit, preserving the other mode flags. + kernel32.SetConsoleMode(stdout_handle, old_mode.value | 0x0004) # ENABLE_VIRTUAL_TERMINAL_PROCESSING + return stdout_handle, old_mode.value + + +def _read_from_server(ws, closed, decoder): + # Runs on a background thread: stream server output -> stdout until the socket closes. + import sys + import websocket + try: + while not closed.is_set(): + opcode, data = ws.recv_data() + # Stop on a close frame + if opcode == websocket.ABNF.OPCODE_CLOSE: + break + # Print shell output (text, binary). + if opcode not in (websocket.ABNF.OPCODE_TEXT, websocket.ABNF.OPCODE_BINARY): + continue + text = decoder.decode(data) + try: + sys.stdout.write(text) + except UnicodeEncodeError: + enc = getattr(sys.stdout, 'encoding', None) or 'utf-8' + sys.stdout.write(text.encode(enc, 'replace').decode(enc, 'replace')) + sys.stdout.flush() + except (websocket.WebSocketConnectionClosedException, OSError): + pass + finally: + closed.set() + + +def _send_terminal_resize(ws): + # Send the current terminal size to the server as a JSON text frame. + import os + import json + import websocket + try: + size = os.get_terminal_size() + ws.send(json.dumps({"width": size.columns, "height": size.lines})) + except (OSError, websocket.WebSocketConnectionClosedException): + # No console attached (stdout redirected) or the session is already gone. + pass + + +def _send_to_server_windows(ws, closed): + import os + import time + import ctypes + import msvcrt + import websocket as ws_module + + # Clear the ENABLE_PROCESSED_INPUT flag from stdin's console mode so a Ctrl+C is processed as + # a raw byte and forwarded to the remote shell, instead of interrupting az locally; restored on exit. + kernel32 = ctypes.windll.kernel32 + stdin_handle = kernel32.GetStdHandle(-10) # STD_INPUT_HANDLE + old_mode = ctypes.c_uint32() + kernel32.GetConsoleMode(stdin_handle, ctypes.byref(old_mode)) + kernel32.SetConsoleMode(stdin_handle, old_mode.value & ~0x0001) + + last_ctrl_c = 0 + + # Set up for terminal window resizing + try: + last_size = os.get_terminal_size() + except OSError: + last_size = None + last_resize_check = time.time() + + try: + while not closed.is_set(): + now = time.time() + + # Poll the console size every ~1s and notify the server when it changes + if now - last_resize_check >= 1.0: + last_resize_check = now + try: + current_size = os.get_terminal_size() + except OSError: + current_size = None + if current_size is not None and current_size != last_size: + last_size = current_size + _send_terminal_resize(ws) + + # kbhit() is a non-blocking peek: returns True when a key is waiting in the console input buffer. + # If no key is waiting, sleep 0.05 seconds + if not msvcrt.kbhit(): + time.sleep(0.05) + continue + + # If key is waiting: Drain every key queued into one buffer and send a single frame. + buf = bytearray() + exit_session = False + while msvcrt.kbhit(): + ch = msvcrt.getwch() + # If Ctrl+C twice within 2s, exit the session. Otherwise, send to server. + if ch == '\x03': + now = time.time() + if now - last_ctrl_c < 2: + exit_session = True + break + last_ctrl_c = now + buf += b'\x03' + elif ch == '\r': # Enter: Windows gives CR, Unix shells expect LF + buf += b'\n' + elif ch == '\x08': # Backspace: Windows gives BS, Unix shells expect DEL (0x7f) + buf += b'\x7f' + elif ch in ('\x00', '\xe0'): # Special key prefix: the next getwch() is the key code + escape = _WINDOWS_KEY_MAP.get(ord(msvcrt.getwch())) + if escape: + buf += escape + else: + # If key is first half of a UTF-16 non-BMP char (e.g. emoji), read the + # second half and fuse pair into one real character. + if 0xD800 <= ord(ch) <= 0xDBFF and msvcrt.kbhit(): + ch += msvcrt.getwch() + ch = ch.encode('utf-16-le', 'surrogatepass').decode('utf-16-le', 'replace') + buf += ch.encode('utf-8', 'replace') + + if buf: + ws.send(bytes(buf), opcode=ws_module.ABNF.OPCODE_BINARY) + if exit_session: + break + except (ws_module.WebSocketConnectionClosedException, OSError) as ex: + logger.info("Shell session closed: %s", ex) + finally: + kernel32.SetConsoleMode(stdin_handle, old_mode.value) + + +def _send_to_server_non_windows(ws, closed): + import sys + import os + import tty + import termios + import time + import signal + import select + import threading + import websocket as ws_module + + fd = sys.stdin.fileno() + old_settings = termios.tcgetattr(fd) + last_ctrl_c = 0 + + # Set up for terminal window resizing + resize_needed = threading.Event() + + def on_sigwinch(_signum, _frame): + resize_needed.set() + + # On SIGWINCH (terminal resize), run on_sigwinch to signal resize_needed. + # This will eventually allow send_terminal_resize to be called and send resize request to server. + signal.signal(signal.SIGWINCH, on_sigwinch) + + try: + # Raw mode: pass keystrokes straight to the remote shell (no local echo/buffering). + tty.setraw(fd) + while not closed.is_set(): + if resize_needed.is_set(): + resize_needed.clear() + _send_terminal_resize(ws) + + # Wait for input on fd (stdin). If nothing for 0.1s, loop back to re-check if the session closed. + ready, _, _ = select.select([fd], [], [], 0.1) + if not ready: + continue + data = os.read(fd, 4096) + if not data: + break + if b'\x03' in data: # Ctrl+C + now = time.time() + if now - last_ctrl_c < 2: + break # Ctrl+C twice in 2 seconds will end the session + last_ctrl_c = now + ws.send(data, opcode=ws_module.ABNF.OPCODE_BINARY) + except (ws_module.WebSocketConnectionClosedException, OSError) as ex: + logger.info("Shell session closed: %s", ex) + finally: + # Reset defaults: stop listening for resize signals, restore terminal out of raw mode. + signal.signal(signal.SIGWINCH, signal.SIG_DFL) + termios.tcsetattr(fd, termios.TCSADRAIN, old_settings) + + +# --- execute mode --- + + +def _execute_command_on_instance(scm_url, headers, cookies, command, args=None, working_directory=None): + import requests + + exec_url = f"{scm_url}/exec/execute" + + body = {"Command": command} + if args: + body["Args"] = args + if working_directory: + body["WorkingDirectory"] = working_directory + + try: + response = requests.post( + exec_url, + json=body, + headers=headers, + cookies=cookies, + timeout=30 + ) + except requests.exceptions.RequestException as ex: + # No HTTP response: refused/timed-out connection, DNS/TLS/proxy error, etc. + raise AzureConnectionError("Could not connect to the web app: {}".format(ex)) + + if response.status_code == 202: + return _parse_server_message(response.text) + raise CLIInternalError(_friendly_exec_error_message(response.text)) + + +# --- shared helpers --- + + +def _friendly_exec_error_message(body): + return _parse_server_message(body) or "The request could not be completed. Please try again later." + + +def _parse_server_message(body): + # Return the server-authored message from a response body, or None if empty. + import json + if not body: + return None + text = body.decode('utf-8', errors='ignore') if isinstance(body, (bytes, bytearray)) else str(body) + text = text.strip() + if not text: + return None + try: + parsed = json.loads(text) + if isinstance(parsed, dict): + return parsed.get('Message') or None + except ValueError: # includes json.JSONDecodeError + pass + return text