Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions src/azure-cli-core/azure/cli/core/_output.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,43 @@
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------

import errno

import knack.output
from knack.log import get_logger
from knack.util import CommandResultItem

logger = get_logger(__name__)


class AzOutputProducer(knack.output.OutputProducer):

def check_valid_format_type(self, format_type):
return format_type in self._FORMAT_DICT

def out(self, obj, formatter=None, out_file=None):
if formatter == knack.output.format_tsv and hasattr(out_file, 'buffer'):
if not isinstance(obj, CommandResultItem):
raise TypeError('Expected {} got {}'.format(CommandResultItem.__name__, type(obj)))

output = formatter(obj)
try:
out_file.buffer.write(output.encode(out_file.encoding or 'utf-8'))
out_file.flush()
except IOError as ex:
if ex.errno == errno.EPIPE:
pass
else:
raise
except UnicodeEncodeError:
logger.warning("Unable to encode the output with %s encoding. Unsupported characters are discarded.",
out_file.encoding)
out_file.buffer.write(output.encode('ascii', 'ignore'))
out_file.flush()
return

super().out(obj, formatter=formatter, out_file=out_file)


def get_output_format(cli_ctx):
return cli_ctx.invocation.data.get("output", None)
Expand Down
34 changes: 34 additions & 0 deletions src/azure-cli-core/azure/cli/core/tests/test_output.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@


class TestCoreCLIOutput(unittest.TestCase):
@staticmethod
def _create_translating_stream():
import io
return io.TextIOWrapper(io.BytesIO(), encoding='utf-8', newline='\r\n')

def test_create_AzOutputProducer(self):
from azure.cli.core._output import AzOutputProducer
from azure.cli.core.mock import DummyCli
Expand Down Expand Up @@ -41,6 +46,35 @@ def test_yaml_output_with_ordered_dict(self):
yaml_output = output_producer.get_formatter('yaml')(CommandResultItem(result=OrderedDict(account_dict)))
self.assertEqual(account_dict, yaml.safe_load(yaml_output))

def test_tsv_output_uses_lf_line_endings(self):
from azure.cli.core._output import AzOutputProducer
from azure.cli.core.mock import DummyCli
from knack.util import CommandResultItem

output_producer = AzOutputProducer(DummyCli())
out_file = self._create_translating_stream()

output_producer.out(CommandResultItem(result=['topic1', 'topic2']),
formatter=output_producer.get_formatter('tsv'),
out_file=out_file)

self.assertEqual(b'topic1\ntopic2\n', out_file.buffer.getvalue())

def test_json_output_preserves_stream_translation(self):
from azure.cli.core._output import AzOutputProducer
from azure.cli.core.mock import DummyCli
from knack.util import CommandResultItem

output_producer = AzOutputProducer(DummyCli())
out_file = self._create_translating_stream()

output_producer.out(CommandResultItem(result=[{'name': 'topic1'}]),
formatter=output_producer.get_formatter('json'),
out_file=out_file)

out_file.flush()
self.assertIn(b'\r\n', out_file.buffer.getvalue())


if __name__ == '__main__':
unittest.main()
Loading