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
|
# Copyright 2016 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
from awscli.testutils import BaseAWSCommandParamsTest
class TestGenerateCliSkeletonInput(BaseAWSCommandParamsTest):
def test_generate_cli_skeleton_s3api(self):
cmdline = 's3api delete-object --generate-cli-skeleton'
stdout, _, rc = self.run_cmd(cmdline)
self.assertEqual(rc, 0)
loaded_skeleton = json.loads(stdout)
self.assertEqual(loaded_skeleton['Bucket'], '')
self.assertEqual(loaded_skeleton['BypassGovernanceRetention'], True)
self.assertEqual(loaded_skeleton['Key'], '')
self.assertEqual(loaded_skeleton['MFA'], '')
self.assertEqual(loaded_skeleton['RequestPayer'], 'requester')
def test_generate_cli_skeleton_sqs(self):
cmdline = 'sqs change-message-visibility --generate-cli-skeleton'
stdout, _, rc = self.run_cmd(cmdline)
self.assertEqual(rc, 0)
loaded_skeleton = json.loads(stdout)
self.assertEqual(loaded_skeleton['QueueUrl'], '')
self.assertEqual(loaded_skeleton['ReceiptHandle'], '')
self.assertEqual(loaded_skeleton['VisibilityTimeout'], 0)
def test_generate_cli_skeleton_iam(self):
cmdline = 'iam create-group --generate-cli-skeleton'
stdout, _, rc = self.run_cmd(cmdline)
self.assertEqual(rc, 0)
loaded_skeleton = json.loads(stdout)
self.assertEqual(loaded_skeleton['Path'], '')
self.assertEqual(loaded_skeleton['GroupName'], '')
class TestGenerateCliSkeletonYamlInput(BaseAWSCommandParamsTest):
def test_generate_cli_skeleton_s3api(self):
cmdline = 's3api delete-object --generate-cli-skeleton yaml-input'
stdout, _, rc = self.run_cmd(cmdline)
self.assertEqual(rc, 0)
loaded_skeleton = self.yaml.load(stdout)
self.assertEqual(loaded_skeleton['Bucket'], '')
self.assertEqual(loaded_skeleton['BypassGovernanceRetention'], True)
self.assertEqual(loaded_skeleton['Key'], '')
self.assertEqual(loaded_skeleton['MFA'], '')
self.assertEqual(loaded_skeleton['RequestPayer'], 'requester')
def test_generate_cli_skeleton_sqs(self):
stdout, _, rc = self.run_cmd(
'sqs change-message-visibility --generate-cli-skeleton yaml-input'
)
self.assertEqual(rc, 0)
loaded_skeleton = self.yaml.load(stdout)
self.assertEqual(loaded_skeleton['QueueUrl'], '')
self.assertEqual(loaded_skeleton['ReceiptHandle'], '')
self.assertEqual(loaded_skeleton['VisibilityTimeout'], 0)
def test_generate_cli_skeleton_iam(self):
cmdline = 'iam create-group --generate-cli-skeleton yaml-input'
stdout, _, rc = self.run_cmd(cmdline)
self.assertEqual(rc, 0)
loaded_skeleton = self.yaml.load(stdout)
self.assertEqual(loaded_skeleton['Path'], '')
self.assertEqual(loaded_skeleton['GroupName'], '')
def test_contains_comments(self):
# Choose a command that we know will have comments as there are
# required parameters and required parameters always are labeled
# with required.
cmdline = 's3api delete-object --generate-cli-skeleton yaml-input'
stdout, _, rc = self.run_cmd(cmdline)
self.assertIn("Bucket: '' # [REQUIRED]", stdout)
class TestGenerateCliSkeletonOutput(BaseAWSCommandParamsTest):
def test_generate_cli_skeleton_output(self):
cmdline = 'ec2 describe-regions --generate-cli-skeleton output'
stdout, _, _ = self.run_cmd(cmdline)
# The format of the response should be a json blob with the
# following structure:
# {
# "Regions": [
# {
# "RegionName": "RegionName",
# "Endpoint": "Endpoint"
# }
# ]
# }
#
# We assert only components of the response in case members
# are added in the future that would break an exactly equals
# assertion
skeleton_output = json.loads(stdout)
self.assertIn('Regions', skeleton_output)
self.assertEqual(
skeleton_output['Regions'][0]['RegionName'], 'RegionName'
)
self.assertEqual(skeleton_output['Regions'][0]['Endpoint'], 'Endpoint')
def test_can_pass_in_input_parameters(self):
cmdline = 'ec2 describe-regions --generate-cli-skeleton output '
cmdline += ' --region-names us-east-1'
stdout, _, _ = self.assert_params_for_cmd(
cmdline, {'RegionNames': ['us-east-1']}
)
# Make sure the output has the proper mocked response as well.
skeleton_output = json.loads(stdout)
self.assertIn('Regions', skeleton_output)
self.assertEqual(
skeleton_output['Regions'][0]['RegionName'], 'RegionName'
)
self.assertEqual(skeleton_output['Regions'][0]['Endpoint'], 'Endpoint')
def test_when_no_output_shape(self):
cmdline = 'ec2 attach-internet-gateway '
cmdline += '--internet-gateway-id igw-c0a643a9 --vpc-id vpc-a01106 '
cmdline += '--generate-cli-skeleton output'
stdout, _, _ = self.assert_params_for_cmd(
cmdline,
{'InternetGatewayId': 'igw-c0a643a9', 'VpcId': 'vpc-a01106'},
)
# There should be no output as the command has no output shape
self.assertEqual('', stdout)
def test_can_handle_timestamps(self):
cmdline = 's3api list-buckets --generate-cli-skeleton output'
stdout, _, _ = self.run_cmd(cmdline)
skeleton_output = json.loads(stdout)
# The CreationDate has the type of timestamp
self.assertEqual(
skeleton_output['Buckets'][0]['CreationDate'],
'1970-01-01T00:00:00',
)
def test_can_handle_lists_with_strings_that_have_a_min_length(self):
cmdline = 'dynamodb list-tables --generate-cli-skeleton output'
stdout, _, _ = self.run_cmd(cmdline)
skeleton_output = json.loads(stdout)
self.assertEqual(skeleton_output['TableNames'], ['TableName'])
def test_respects_formatting(self):
cmdline = 'ec2 describe-regions --generate-cli-skeleton output '
cmdline += ' --query Regions[].RegionName --output text'
stdout, _, _ = self.run_cmd(cmdline)
self.assertEqual(stdout, 'RegionName\n')
def test_validates_at_command_line_level(self):
cmdline = 'ec2 start-instances --generate-cli-skeleton output'
stdout, stderr, _ = self.run_cmd(cmdline, expected_rc=252)
self.assertIn('required', stderr)
self.assertIn('--instance-ids', stderr)
self.assertEqual('', stdout)
def test_validates_at_client_level(self):
cmdline = 'ec2 describe-instances --generate-cli-skeleton output '
# Note: The for --filters instead of Value the key should be Values
# which should throw a validation error.
cmdline += '--filters Name=instance-id,Value=foo'
stdout, stderr, _ = self.run_cmd(cmdline, expected_rc=252)
self.assertIn('Unknown parameter in Filters[0]', stderr)
self.assertEqual('', stdout)
|
