|
1
|
|
|
#!/usr/bin/env python |
|
2
|
|
|
|
|
3
|
|
|
# Licensed to the StackStorm, Inc ('StackStorm') under one or more |
|
4
|
|
|
# contributor license agreements. See the NOTICE file distributed with |
|
5
|
|
|
# this work for additional information regarding copyright ownership. |
|
6
|
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0 |
|
7
|
|
|
# (the "License"); you may not use this file except in compliance with |
|
8
|
|
|
# the License. You may obtain a copy of the License at |
|
9
|
|
|
# |
|
10
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0 |
|
11
|
|
|
# |
|
12
|
|
|
# Unless required by applicable law or agreed to in writing, software |
|
13
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS, |
|
14
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
|
15
|
|
|
# See the License for the specific language governing permissions and |
|
16
|
|
|
# limitations under the License. |
|
17
|
|
|
|
|
18
|
|
|
import os |
|
19
|
|
|
import mock |
|
20
|
|
|
import shutil |
|
21
|
|
|
import tempfile |
|
22
|
|
|
import hashlib |
|
23
|
|
|
|
|
24
|
|
|
from lockfile import LockFile |
|
25
|
|
|
from lockfile import LockTimeout |
|
26
|
|
|
from git.repo import Repo |
|
27
|
|
|
from gitdb.exc import BadName |
|
28
|
|
|
from st2common.services import packs as pack_service |
|
29
|
|
|
from st2tests.base import BaseActionTestCase |
|
30
|
|
|
|
|
31
|
|
|
import pack_mgmt.download |
|
32
|
|
|
from pack_mgmt.download import DownloadGitRepoAction |
|
33
|
|
|
|
|
34
|
|
|
PACK_INDEX = { |
|
35
|
|
|
"test": { |
|
36
|
|
|
"version": "0.4.0", |
|
37
|
|
|
"name": "test", |
|
38
|
|
|
"repo_url": "https://github.com/StackStorm-Exchange/stackstorm-test", |
|
39
|
|
|
"author": "st2-dev", |
|
40
|
|
|
"keywords": ["some", "search", "another", "terms"], |
|
41
|
|
|
"email": "[email protected]", |
|
42
|
|
|
"description": "st2 pack to test package management pipeline" |
|
43
|
|
|
}, |
|
44
|
|
|
"test2": { |
|
45
|
|
|
"version": "0.5.0", |
|
46
|
|
|
"name": "test2", |
|
47
|
|
|
"repo_url": "https://github.com/StackStorm-Exchange/stackstorm-test2", |
|
48
|
|
|
"author": "stanley", |
|
49
|
|
|
"keywords": ["some", "special", "terms"], |
|
50
|
|
|
"email": "[email protected]", |
|
51
|
|
|
"description": "another st2 pack to test package management pipeline" |
|
52
|
|
|
}, |
|
53
|
|
|
"test3": { |
|
54
|
|
|
"version": "0.5.0", |
|
55
|
|
|
"stackstorm_version": ">=1.6.0, <2.2.0", |
|
56
|
|
|
"name": "test3", |
|
57
|
|
|
"repo_url": "https://github.com/StackStorm-Exchange/stackstorm-test3", |
|
58
|
|
|
"author": "stanley", |
|
59
|
|
|
"keywords": ["some", "special", "terms"], |
|
60
|
|
|
"email": "[email protected]", |
|
61
|
|
|
"description": "another st2 pack to test package management pipeline" |
|
62
|
|
|
} |
|
63
|
|
|
} |
|
64
|
|
|
|
|
65
|
|
|
|
|
66
|
|
|
@mock.patch.object(pack_service, 'fetch_pack_index', mock.MagicMock(return_value=(PACK_INDEX, {}))) |
|
67
|
|
|
class DownloadGitRepoActionTestCase(BaseActionTestCase): |
|
68
|
|
|
action_cls = DownloadGitRepoAction |
|
69
|
|
|
|
|
70
|
|
|
def setUp(self): |
|
71
|
|
|
super(DownloadGitRepoActionTestCase, self).setUp() |
|
72
|
|
|
|
|
73
|
|
|
clone_from = mock.patch.object(Repo, 'clone_from') |
|
74
|
|
|
|
|
75
|
|
|
self.addCleanup(clone_from.stop) |
|
76
|
|
|
self.clone_from = clone_from.start() |
|
77
|
|
|
|
|
78
|
|
|
expand_user = mock.patch.object(os.path, 'expanduser', |
|
79
|
|
|
mock.MagicMock(return_value=tempfile.mkdtemp())) |
|
80
|
|
|
|
|
81
|
|
|
self.addCleanup(expand_user.stop) |
|
82
|
|
|
self.expand_user = expand_user.start() |
|
83
|
|
|
|
|
84
|
|
|
self.repo_base = tempfile.mkdtemp() |
|
85
|
|
|
|
|
86
|
|
|
self.repo_instance = mock.MagicMock() |
|
87
|
|
|
|
|
88
|
|
|
def side_effect(url, to_path, **kwargs): |
|
89
|
|
|
# Since we have no way to pass pack name here, we would have to derive it from repo url |
|
90
|
|
|
fixture_name = url.split('/')[-1] |
|
91
|
|
|
fixture_path = os.path.join(self._get_base_pack_path(), 'tests/fixtures', fixture_name) |
|
92
|
|
|
shutil.copytree(fixture_path, to_path) |
|
93
|
|
|
return self.repo_instance |
|
94
|
|
|
|
|
95
|
|
|
self.clone_from.side_effect = side_effect |
|
96
|
|
|
|
|
97
|
|
|
def tearDown(self): |
|
98
|
|
|
shutil.rmtree(self.repo_base) |
|
99
|
|
|
shutil.rmtree(self.expand_user()) |
|
100
|
|
|
|
|
101
|
|
|
def test_run_pack_download(self): |
|
102
|
|
|
action = self.get_action_instance() |
|
103
|
|
|
result = action.run(packs=['test'], abs_repo_base=self.repo_base) |
|
104
|
|
|
temp_dir = hashlib.md5(PACK_INDEX['test']['repo_url']).hexdigest() |
|
105
|
|
|
|
|
106
|
|
|
self.assertEqual(result, {'test': 'Success.'}) |
|
107
|
|
|
self.clone_from.assert_called_once_with(PACK_INDEX['test']['repo_url'], |
|
108
|
|
|
os.path.join(os.path.expanduser('~'), temp_dir)) |
|
109
|
|
|
self.assertTrue(os.path.isfile(os.path.join(self.repo_base, 'test/pack.yaml'))) |
|
110
|
|
|
|
|
111
|
|
|
def test_run_pack_download_existing_pack(self): |
|
112
|
|
|
action = self.get_action_instance() |
|
113
|
|
|
action.run(packs=['test'], abs_repo_base=self.repo_base) |
|
114
|
|
|
self.assertTrue(os.path.isfile(os.path.join(self.repo_base, 'test/pack.yaml'))) |
|
115
|
|
|
|
|
116
|
|
|
result = action.run(packs=['test'], abs_repo_base=self.repo_base) |
|
117
|
|
|
|
|
118
|
|
|
self.assertEqual(result, {'test': 'Success.'}) |
|
119
|
|
|
|
|
120
|
|
|
def test_run_pack_download_multiple_packs(self): |
|
121
|
|
|
action = self.get_action_instance() |
|
122
|
|
|
result = action.run(packs=['test', 'test2'], abs_repo_base=self.repo_base) |
|
123
|
|
|
temp_dirs = [ |
|
124
|
|
|
hashlib.md5(PACK_INDEX['test']['repo_url']).hexdigest(), |
|
125
|
|
|
hashlib.md5(PACK_INDEX['test2']['repo_url']).hexdigest() |
|
126
|
|
|
] |
|
127
|
|
|
|
|
128
|
|
|
self.assertEqual(result, {'test': 'Success.', 'test2': 'Success.'}) |
|
129
|
|
|
self.clone_from.assert_any_call(PACK_INDEX['test']['repo_url'], |
|
130
|
|
|
os.path.join(os.path.expanduser('~'), temp_dirs[0])) |
|
131
|
|
|
self.clone_from.assert_any_call(PACK_INDEX['test2']['repo_url'], |
|
132
|
|
|
os.path.join(os.path.expanduser('~'), temp_dirs[1])) |
|
133
|
|
|
self.assertEqual(self.clone_from.call_count, 2) |
|
134
|
|
|
self.assertTrue(os.path.isfile(os.path.join(self.repo_base, 'test/pack.yaml'))) |
|
135
|
|
|
self.assertTrue(os.path.isfile(os.path.join(self.repo_base, 'test2/pack.yaml'))) |
|
136
|
|
|
|
|
137
|
|
|
@mock.patch.object(Repo, 'clone_from') |
|
138
|
|
|
def test_run_pack_download_error(self, clone_from): |
|
139
|
|
|
clone_from.side_effect = Exception('Something went terribly wrong during the clone') |
|
140
|
|
|
|
|
141
|
|
|
action = self.get_action_instance() |
|
142
|
|
|
self.assertRaises(Exception, action.run, packs=['test'], abs_repo_base=self.repo_base) |
|
143
|
|
|
|
|
144
|
|
|
def test_run_pack_download_no_tag(self): |
|
145
|
|
|
self.repo_instance.commit.side_effect = BadName |
|
146
|
|
|
|
|
147
|
|
|
action = self.get_action_instance() |
|
148
|
|
|
self.assertRaises(ValueError, action.run, packs=['test=1.2.3'], |
|
149
|
|
|
abs_repo_base=self.repo_base) |
|
150
|
|
|
|
|
151
|
|
|
def test_run_pack_lock_is_already_acquired(self): |
|
152
|
|
|
action = self.get_action_instance() |
|
153
|
|
|
temp_dir = hashlib.md5(PACK_INDEX['test']['repo_url']).hexdigest() |
|
154
|
|
|
|
|
155
|
|
|
original_acquire = LockFile.acquire |
|
156
|
|
|
|
|
157
|
|
|
def mock_acquire(self, timeout=None): |
|
158
|
|
|
original_acquire(self, timeout=0.1) |
|
159
|
|
|
|
|
160
|
|
|
LockFile.acquire = mock_acquire |
|
161
|
|
|
|
|
162
|
|
|
try: |
|
163
|
|
|
lock_file = LockFile('/tmp/%s' % (temp_dir)) |
|
164
|
|
|
|
|
165
|
|
|
# Acquire a lock (file) so acquire inside download will fail |
|
166
|
|
|
with open(lock_file.lock_file, 'w') as fp: |
|
167
|
|
|
fp.write('') |
|
168
|
|
|
|
|
169
|
|
|
expected_msg = 'Timeout waiting to acquire lock for' |
|
170
|
|
|
self.assertRaisesRegexp(LockTimeout, expected_msg, action.run, packs=['test'], |
|
171
|
|
|
abs_repo_base=self.repo_base) |
|
172
|
|
|
finally: |
|
173
|
|
|
os.unlink(lock_file.lock_file) |
|
174
|
|
|
LockFile.acquire = original_acquire |
|
175
|
|
|
|
|
176
|
|
|
def test_run_pack_lock_is_already_acquired_force_flag(self): |
|
177
|
|
|
# Lock is already acquired but force is true so it should be deleted and released |
|
178
|
|
|
action = self.get_action_instance() |
|
179
|
|
|
temp_dir = hashlib.md5(PACK_INDEX['test']['repo_url']).hexdigest() |
|
180
|
|
|
|
|
181
|
|
|
original_acquire = LockFile.acquire |
|
182
|
|
|
|
|
183
|
|
|
def mock_acquire(self, timeout=None): |
|
184
|
|
|
original_acquire(self, timeout=0.1) |
|
185
|
|
|
|
|
186
|
|
|
LockFile.acquire = mock_acquire |
|
187
|
|
|
|
|
188
|
|
|
try: |
|
189
|
|
|
lock_file = LockFile('/tmp/%s' % (temp_dir)) |
|
190
|
|
|
|
|
191
|
|
|
# Acquire a lock (file) so acquire inside download will fail |
|
192
|
|
|
with open(lock_file.lock_file, 'w') as fp: |
|
193
|
|
|
fp.write('') |
|
194
|
|
|
|
|
195
|
|
|
result = action.run(packs=['test'], abs_repo_base=self.repo_base, force=True) |
|
196
|
|
|
finally: |
|
197
|
|
|
LockFile.acquire = original_acquire |
|
198
|
|
|
|
|
199
|
|
|
self.assertEqual(result, {'test': 'Success.'}) |
|
200
|
|
|
|
|
201
|
|
|
def test_run_pack_download_v_tag(self): |
|
202
|
|
|
def side_effect(ref): |
|
203
|
|
|
if ref[0] != 'v': |
|
204
|
|
|
raise BadName() |
|
205
|
|
|
return mock.MagicMock(hexsha='abcdef') |
|
206
|
|
|
|
|
207
|
|
|
self.repo_instance.commit.side_effect = side_effect |
|
208
|
|
|
self.repo_instance.git = mock.MagicMock( |
|
209
|
|
|
branch=(lambda *args: 'master'), |
|
210
|
|
|
checkout=(lambda *args: True) |
|
211
|
|
|
) |
|
212
|
|
|
|
|
213
|
|
|
action = self.get_action_instance() |
|
214
|
|
|
result = action.run(packs=['test=1.2.3'], abs_repo_base=self.repo_base) |
|
215
|
|
|
|
|
216
|
|
|
self.assertEqual(result, {'test': 'Success.'}) |
|
217
|
|
|
|
|
218
|
|
|
@mock.patch.object(DownloadGitRepoAction, '_get_valid_versions_for_repo', |
|
219
|
|
|
mock.Mock(return_value=['1.0.0', '2.0.0'])) |
|
220
|
|
|
def test_run_pack_download_invalid_version(self): |
|
221
|
|
|
self.repo_instance.commit.side_effect = lambda ref: None |
|
222
|
|
|
|
|
223
|
|
|
action = self.get_action_instance() |
|
224
|
|
|
|
|
225
|
|
|
expected_msg = ('is not a valid version, hash, tag or branch.*?' |
|
226
|
|
|
'Available versions are: 1.0.0, 2.0.0.') |
|
227
|
|
|
self.assertRaisesRegexp(ValueError, expected_msg, action.run, |
|
228
|
|
|
packs=['test=2.2.3'], abs_repo_base=self.repo_base) |
|
229
|
|
|
|
|
230
|
|
|
def test_download_pack_stackstorm_version_identifier_check(self): |
|
231
|
|
|
action = self.get_action_instance() |
|
232
|
|
|
|
|
233
|
|
|
# Version is satisfied |
|
234
|
|
|
pack_mgmt.download.CURRENT_STACKSTROM_VERSION = '2.0.0' |
|
235
|
|
|
|
|
236
|
|
|
result = action.run(packs=['test3'], abs_repo_base=self.repo_base) |
|
237
|
|
|
self.assertEqual(result['test3'], 'Success.') |
|
238
|
|
|
|
|
239
|
|
|
# Pack requires a version which is not satisfied by current StackStorm version |
|
240
|
|
|
pack_mgmt.download.CURRENT_STACKSTROM_VERSION = '2.2.0' |
|
241
|
|
|
expected_msg = ('Pack "test3" requires StackStorm ">=1.6.0, <2.2.0", but ' |
|
242
|
|
|
'current version is "2.2.0"') |
|
243
|
|
|
self.assertRaisesRegexp(ValueError, expected_msg, action.run, packs=['test3'], |
|
244
|
|
|
abs_repo_base=self.repo_base) |
|
245
|
|
|
|
|
246
|
|
|
pack_mgmt.download.CURRENT_STACKSTROM_VERSION = '2.3.0' |
|
247
|
|
|
expected_msg = ('Pack "test3" requires StackStorm ">=1.6.0, <2.2.0", but ' |
|
248
|
|
|
'current version is "2.3.0"') |
|
249
|
|
|
self.assertRaisesRegexp(ValueError, expected_msg, action.run, packs=['test3'], |
|
250
|
|
|
abs_repo_base=self.repo_base) |
|
251
|
|
|
|
|
252
|
|
|
pack_mgmt.download.CURRENT_STACKSTROM_VERSION = '1.5.9' |
|
253
|
|
|
expected_msg = ('Pack "test3" requires StackStorm ">=1.6.0, <2.2.0", but ' |
|
254
|
|
|
'current version is "1.5.9"') |
|
255
|
|
|
self.assertRaisesRegexp(ValueError, expected_msg, action.run, packs=['test3'], |
|
256
|
|
|
abs_repo_base=self.repo_base) |
|
257
|
|
|
|
|
258
|
|
|
pack_mgmt.download.CURRENT_STACKSTROM_VERSION = '1.5.0' |
|
259
|
|
|
expected_msg = ('Pack "test3" requires StackStorm ">=1.6.0, <2.2.0", but ' |
|
260
|
|
|
'current version is "1.5.0"') |
|
261
|
|
|
self.assertRaisesRegexp(ValueError, expected_msg, action.run, packs=['test3'], |
|
262
|
|
|
abs_repo_base=self.repo_base) |
|
263
|
|
|
|
|
264
|
|
|
# Version is not met, but force=true parameter is provided |
|
265
|
|
|
pack_mgmt.download.CURRENT_STACKSTROM_VERSION = '1.5.0' |
|
266
|
|
|
result = action.run(packs=['test3'], abs_repo_base=self.repo_base, force=True) |
|
267
|
|
|
self.assertEqual(result['test3'], 'Success.') |
|
268
|
|
|
|
StackStorm /
st2
