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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
# http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file 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 json
import ruamel.yaml as yaml
from awscli.clidriver import AWSCLIEntryPoint
from awscli.testutils import (
BaseAWSCommandParamsTest,
FileCreator,
create_clidriver,
if_windows,
mock,
skip_if_windows,
)
class TestOutput(BaseAWSCommandParamsTest):
def setUp(self):
super(TestOutput, self).setUp()
self.files = FileCreator()
self.patch_popen = mock.patch('awscli.utils.Popen')
self.mock_popen = self.patch_popen.start()
self.patch_tty = mock.patch('awscli.utils.is_a_tty')
self.mock_is_a_tty = self.patch_tty.start()
self.mock_is_a_tty.return_value = True
self.cmdline = 'ec2 describe-regions'
self.parsed_response = {
"Regions": [
{
"Endpoint": "ec2.ap-south-1.amazonaws.com",
"RegionName": "ap-south-1",
},
]
}
self.expected_content = self.get_expected_content(self.parsed_response)
def tearDown(self):
super(TestOutput, self).tearDown()
self.files.remove_all()
self.patch_popen.stop()
self.patch_tty.stop()
def get_expected_content(self, response):
content = json.dumps(response, indent=4)
content += '\n'
return content
def write_cli_pager_config(self, pager):
config_file = self.files.create_file(
'config', '[default]\n' 'cli_pager = %s\n' % pager
)
self.environ['AWS_CONFIG_FILE'] = config_file
self.driver = create_clidriver()
self.entry_point = AWSCLIEntryPoint(self.driver)
def assert_content_to_pager(
self, expected_pager, expected_content, expected_less_flags=None
):
actual_pager = self.mock_popen.call_args[1]['args']
if isinstance(actual_pager, list):
actual_pager = ' '.join(actual_pager)
self.assertEqual(expected_pager, actual_pager)
self.assertEqual(expected_content, self.get_content_sent_to_popen())
if expected_less_flags:
actual_env = self.mock_popen.call_args[1]['env']
self.assertEqual(expected_less_flags, actual_env['LESS'])
def get_content_sent_to_popen(self):
content = ''
popen_stdin = self.mock_popen.return_value.stdin
for write_call in popen_stdin.write.call_args_list:
content += write_call[0][0]
return content
def test_no_cli_pager_disable_outputs_to_pager(self):
self.run_cmd(self.cmdline + ' --no-cli-pager')
self.assertFalse(self.mock_popen.called)
def test_outputs_to_pager(self):
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager=mock.ANY, expected_content=self.expected_content
)
def test_does_not_output_to_pager_if_not_tty(self):
self.mock_is_a_tty.return_value = False
stdout, _, _ = self.run_cmd(self.cmdline)
self.assertFalse(self.mock_popen.called)
self.assertEqual(stdout, self.expected_content)
@skip_if_windows('less is not used for windows')
def test_outputs_to_less_non_windows(self):
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='less',
expected_content=self.expected_content,
expected_less_flags='FRX',
)
@if_windows('more is only used for windows')
def test_outputs_to_more_for_windows(self):
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='more',
expected_content=self.expected_content,
)
def test_respects_aws_pager_env_var(self):
self.environ['AWS_PAGER'] = 'mypager'
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='mypager',
expected_content=self.expected_content,
)
def test_respects_cli_pager_config_var(self):
self.write_cli_pager_config('mypager')
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='mypager',
expected_content=self.expected_content,
)
def test_respects_pager_env_var(self):
self.environ['PAGER'] = 'mypager'
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='mypager',
expected_content=self.expected_content,
)
def test_no_pager_if_configured_to_empty_str(self):
self.environ['AWS_PAGER'] = ''
stdout, _, _ = self.run_cmd(self.cmdline)
self.assertFalse(self.mock_popen.called)
self.assertEqual(stdout, self.expected_content)
def test_aws_pager_env_var_beats_cli_pager_config_var(self):
self.environ['AWS_PAGER'] = 'envpager'
self.write_cli_pager_config('configpager')
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='envpager',
expected_content=self.expected_content,
)
def test_aws_pager_env_var_beats_pager_env_var(self):
self.write_cli_pager_config('configpager')
self.environ['PAGER'] = 'envpager'
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='configpager',
expected_content=self.expected_content,
)
def test_cli_pager_config_var_beats_pager_env_var(self):
self.environ['AWS_PAGER'] = 'awspager'
self.environ['PAGER'] = 'envpager'
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='awspager',
expected_content=self.expected_content,
)
def test_respects_less_env_var(self):
self.environ['AWS_PAGER'] = 'less'
self.environ['LESS'] = 'S'
self.run_cmd(self.cmdline)
self.assert_content_to_pager(
expected_pager='less',
expected_content=self.expected_content,
expected_less_flags='S',
)
def test_raises_exception_when_pager_cannot_be_opened(self):
self.environ['AWS_PAGER'] = 'no-exists'
pager_error_message = 'Cannot open no-exists'
self.mock_popen.side_effect = FileNotFoundError(pager_error_message)
_, stderr, _ = self.run_cmd(self.cmdline, expected_rc=253)
self.assertIn('Unable to redirect output to pager', stderr)
self.assertIn(pager_error_message, stderr)
class TestYAMLStream(BaseAWSCommandParamsTest):
def assert_yaml_response_equal(self, response, expected):
with self.assertRaises(ValueError):
json.loads(response)
loaded = self.yaml.load(response)
self.assertEqual(loaded, expected)
def test_yaml_stream_single_response(self):
cmdline = 'dynamodb list-tables --output yaml-stream --no-paginate'
self.parsed_responses = [{'TableNames': ['MyTable']}]
stdout, _, _ = self.run_cmd(cmdline)
self.assert_yaml_response_equal(stdout, [{'TableNames': ['MyTable']}])
def test_yaml_stream_paginated_response(self):
cmdline = 'dynamodb list-tables --output yaml-stream'
self.parsed_responses = [
{'TableNames': ['MyTable'], 'LastEvaluatedTableName': 'MyTable'},
{'TableNames': ['MyTable2']},
]
stdout, _, _ = self.run_cmd(cmdline)
self.assert_yaml_response_equal(
stdout,
[
{
'TableNames': ['MyTable'],
'LastEvaluatedTableName': 'MyTable',
},
{'TableNames': ['MyTable2']},
],
)
def test_yaml_stream_removes_response_metadata(self):
cmdline = 'dynamodb list-tables --output yaml-stream --no-paginate'
self.parsed_responses = [
{
'TableNames': ['MyTable'],
'ResponseMetadata': {'RequestId': 'id'},
}
]
stdout, _, _ = self.run_cmd(cmdline)
self.assert_yaml_response_equal(stdout, [{'TableNames': ['MyTable']}])
def test_yaml_stream_removes_response_metadata_for_all_responses(self):
cmdline = 'dynamodb list-tables --output yaml-stream'
self.parsed_responses = [
{
'TableNames': ['MyTable'],
'LastEvaluatedTableName': 'MyTable',
'ResponseMetadata': {'RequestId': 'id'},
},
{
'TableNames': ['MyTable2'],
'ResponseMetadata': {'RequestId': 'id2'},
},
]
stdout, _, _ = self.run_cmd(cmdline)
self.assert_yaml_response_equal(
stdout,
[
{
'TableNames': ['MyTable'],
'LastEvaluatedTableName': 'MyTable',
},
{'TableNames': ['MyTable2']},
],
)
def test_yaml_stream_uses_query(self):
cmdline = (
'dynamodb list-tables --output yaml-stream --no-paginate '
'--query TableNames'
)
self.parsed_responses = [{'TableNames': ['MyTable']}]
stdout, _, _ = self.run_cmd(cmdline)
self.assert_yaml_response_equal(stdout, [['MyTable']])
def test_yaml_stream_uses_query_across_each_response(self):
cmdline = (
'dynamodb list-tables --output yaml-stream --query TableNames'
)
self.parsed_responses = [
{'TableNames': ['MyTable'], 'LastEvaluatedTableName': 'MyTable'},
{'TableNames': ['MyTable2']},
]
stdout, _, _ = self.run_cmd(cmdline)
self.assert_yaml_response_equal(stdout, [['MyTable'], ['MyTable2']])
def test_yaml_stream_with_empty_response(self):
cmdline = 's3api delete-bucket --bucket mybucket --output yaml-stream'
self.parsed_responses = [{}]
stdout, _, _ = self.run_cmd(cmdline)
self.assertEqual(stdout, '')
|
