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
|
#!/usr/bin/env 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.
import weakref
from unittest import mock
from cliff import lister
from cliff.tests import base
class FauxFormatter(object):
def __init__(self):
self.args = []
self.obj = weakref.proxy(self)
def emit_list(self, columns, data, stdout, args):
self.args.append((columns, data))
class ExerciseLister(lister.Lister):
data = [('a', 'A'), ('b', 'B'), ('c', 'A')]
def _load_formatter_plugins(self):
return {
'test': FauxFormatter(),
}
def take_action(self, parsed_args):
return (parsed_args.columns, self.data)
class ExerciseListerCustomSort(ExerciseLister):
need_sort_by_cliff = False
class ExerciseListerNullValues(ExerciseLister):
data = ExerciseLister.data + [(None, None)]
class ExerciseListerDifferentTypes(ExerciseLister):
data = ExerciseLister.data + [(1, 0)]
class TestLister(base.TestBase):
def test_formatter_args(self):
app = mock.Mock()
test_lister = ExerciseLister(app, [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1', 'Col2')
parsed_args.formatter = 'test'
parsed_args.sort_columns = []
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
self.assertEqual(1, len(f.args))
args = f.args[0]
self.assertEqual(list(parsed_args.columns), args[0])
data = list(args[1])
self.assertEqual([['a', 'A'], ['b', 'B'], ['c', 'A']], data)
def test_no_exist_column(self):
test_lister = ExerciseLister(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('no_exist_column',)
parsed_args.formatter = 'test'
parsed_args.sort_columns = []
with mock.patch.object(test_lister, 'take_action') as mock_take_action:
mock_take_action.return_value = (('Col1', 'Col2', 'Col3'), [])
self.assertRaises(
ValueError,
test_lister.run,
parsed_args,
)
def test_sort_by_column_cliff_side_procedure(self):
test_lister = ExerciseLister(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1', 'Col2')
parsed_args.formatter = 'test'
parsed_args.sort_columns = ['Col2', 'Col1']
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
args = f.args[0]
data = list(args[1])
self.assertEqual([['a', 'A'], ['c', 'A'], ['b', 'B']], data)
def test_sort_by_column_data_already_sorted(self):
test_lister = ExerciseListerCustomSort(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1', 'Col2')
parsed_args.formatter = 'test'
parsed_args.sort_columns = ['Col2', 'Col1']
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
args = f.args[0]
data = list(args[1])
self.assertEqual([['a', 'A'], ['b', 'B'], ['c', 'A']], data)
def test_sort_by_column_with_null(self):
test_lister = ExerciseListerNullValues(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1', 'Col2')
parsed_args.formatter = 'test'
parsed_args.sort_columns = ['Col2', 'Col1']
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
args = f.args[0]
data = list(args[1])
self.assertEqual(
[['a', 'A'], ['c', 'A'], ['b', 'B'], [None, None]], data)
def test_sort_by_column_with_different_types(self):
test_lister = ExerciseListerDifferentTypes(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1', 'Col2')
parsed_args.formatter = 'test'
parsed_args.sort_columns = ['Col2', 'Col1']
with mock.patch.object(lister.Lister, 'log') as mock_log:
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
args = f.args[0]
data = list(args[1])
# The output should be unchanged
self.assertEqual(
[['a', 'A'], ['b', 'B'], ['c', 'A'], [1, 0]], data)
# but we should have logged a warning
mock_log.warning.assert_has_calls([
mock.call("Could not sort on field '%s'; unsortable types", col)
for col in parsed_args.sort_columns
])
def test_sort_by_non_displayed_column(self):
test_lister = ExerciseLister(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1',)
parsed_args.formatter = 'test'
parsed_args.sort_columns = ['Col2']
with mock.patch.object(test_lister, 'take_action') as mock_take_action:
mock_take_action.return_value = (
('Col1', 'Col2'), [['a', 'A'], ['b', 'B'], ['c', 'A']]
)
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
args = f.args[0]
data = list(args[1])
self.assertEqual([['a'], ['c'], ['b']], data)
def test_sort_by_non_existing_column(self):
test_lister = ExerciseLister(mock.Mock(), [])
parsed_args = mock.Mock()
parsed_args.columns = ('Col1', 'Col2')
parsed_args.formatter = 'test'
parsed_args.sort_columns = ['no_exist_column']
test_lister.run(parsed_args)
f = test_lister._formatter_plugins['test']
args = f.args[0]
data = list(args[1])
self.assertEqual([['a', 'A'], ['b', 'B'], ['c', 'A']], data)
|
