d1a88bad18
Add a new way of formatting our output in a consistent way. This turns print_list and print_dict into a formatter that has the same API as any other formatter and allows users to create their own formatters and plug them into cratonclient. This includes tests for the base level formatter and our two default formatters as well as some refactoring to allow users to specify their own --format. At the moment, however, the subcommand shells do *not* use the pluggable formatter decided by the user. That change and all of the downstream effects it has on testing is going to be *very* significant and deserves its own commit as this one is large enough. Change-Id: I6649ebce57d5ddf2d4aeb689e77e3c17ef3a2e97
70 lines
2.7 KiB
Python
70 lines
2.7 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
"""JSON formatter unit tests."""
|
|
import json
|
|
|
|
import mock
|
|
|
|
from cratonclient import crud
|
|
from cratonclient.formatters import json_format
|
|
from cratonclient.tests.unit.formatters import base
|
|
|
|
|
|
class TestValidFormatting(base.FormatterTestCase):
|
|
"""Validate the JSON formatter's console output."""
|
|
|
|
def setUp(self):
|
|
"""Initialize our instance prior to each test."""
|
|
super(TestValidFormatting, self).setUp()
|
|
self.formatter = json_format.Formatter(self.args_for())
|
|
self.patch_stdout()
|
|
|
|
def load_json(self, stdout):
|
|
"""Load JSON data from standard-out capture.
|
|
|
|
If there's an error decoding the JSON output, fail the test
|
|
automatically.
|
|
"""
|
|
try:
|
|
return json.loads(stdout)
|
|
except ValueError as err:
|
|
self.fail('Encountered a ValueError: %s' % err)
|
|
|
|
def test_instance_handling_creates_valid_json(self):
|
|
"""Verify the printed data is valid JSON."""
|
|
info = self.resource_info()
|
|
instance = crud.Resource(mock.Mock(), info, loaded=True)
|
|
self.formatter.handle(instance)
|
|
parsed = self.load_json(self.stripped_stdout())
|
|
self.assertDictEqual(info, parsed)
|
|
|
|
def test_empty_generator_handling(self):
|
|
"""Verify we simply print an empty list."""
|
|
self.formatter.handle(iter([]))
|
|
parsed = self.load_json(self.stripped_stdout())
|
|
self.assertEqual([], parsed)
|
|
|
|
def test_generator_of_a_single_resource(self):
|
|
"""Verify we print the single list appropriately."""
|
|
info = self.resource_info()
|
|
self.formatter.handle(iter([crud.Resource(mock.Mock(), info, True)]))
|
|
parsed = self.load_json(self.stripped_stdout())
|
|
self.assertListEqual([info], parsed)
|
|
|
|
def test_generator_of_more_than_one_resouurce(self):
|
|
"""Verify we handle multiple items in a generator correctly."""
|
|
info_dicts = [self.resource_info(id=i) for i in range(10)]
|
|
self.formatter.handle(crud.Resource(mock.Mock(), info, True)
|
|
for info in info_dicts)
|
|
parsed = self.load_json(self.stripped_stdout())
|
|
self.assertListEqual(info_dicts, parsed)
|