forked from aws/sagemaker-python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_git_utils.py
More file actions
468 lines (423 loc) · 18.1 KB
/
test_git_utils.py
File metadata and controls
468 lines (423 loc) · 18.1 KB
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
# Copyright 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.
from __future__ import absolute_import
import pytest
import os
import subprocess
from mock import patch, ANY
from sagemaker import git_utils
REPO_DIR = "/tmp/repo_dir"
PUBLIC_GIT_REPO = "https://github.com/aws/sagemaker-python-sdk.git"
PUBLIC_BRANCH = "test-branch-git-config"
PUBLIC_COMMIT = "ae15c9d7d5b97ea95ea451e4662ee43da3401d73"
PRIVATE_GIT_REPO = "https://github.com/testAccount/private-repo.git"
PRIVATE_BRANCH = "test-branch"
PRIVATE_COMMIT = "329bfcf884482002c05ff7f44f62599ebc9f445a"
CODECOMMIT_REPO = "https://git-codecommit.us-west-2.amazonaws.com/v1/repos/test-repo/"
CODECOMMIT_REPO_SSH = "ssh://git-codecommit.us-west-2.amazonaws.com/v1/repos/test-repo/"
CODECOMMIT_BRANCH = "master"
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
@patch("os.path.isdir", return_value=True)
@patch("os.path.exists", return_value=True)
def test_git_clone_repo_succeed(exists, isdir, isfile, mkdtemp, check_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
ret = git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
check_call.assert_any_call(["git", "clone", git_config["repo"], REPO_DIR], env=env)
check_call.assert_any_call(args=["git", "checkout", PUBLIC_BRANCH], cwd=REPO_DIR)
check_call.assert_any_call(args=["git", "checkout", PUBLIC_COMMIT], cwd=REPO_DIR)
mkdtemp.assert_called_once()
assert ret["entry_point"] == "entry_point"
assert ret["source_dir"] == "/tmp/repo_dir/source_dir"
assert ret["dependencies"] == ["/tmp/repo_dir/foo", "/tmp/repo_dir/bar"]
def test_git_clone_repo_repo_not_provided():
git_config = {"branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point_that_does_not_exist"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
with pytest.raises(ValueError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "Please provide a repo for git_config." in str(error)
def test_git_clone_repo_git_argument_wrong_format():
git_config = {
"repo": PUBLIC_GIT_REPO,
"branch": PUBLIC_BRANCH,
"commit": PUBLIC_COMMIT,
"token": 42,
}
entry_point = "entry_point"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
with pytest.raises(ValueError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "'token' must be a string." in str(error)
@patch(
"subprocess.check_call",
side_effect=subprocess.CalledProcessError(
returncode=1, cmd="git clone {} {}".format(PUBLIC_GIT_REPO, REPO_DIR)
),
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_clone_fail(mkdtemp, check_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "returned non-zero exit status" in str(error.value)
@patch(
"subprocess.check_call",
side_effect=[True, subprocess.CalledProcessError(returncode=1, cmd="git checkout banana")],
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_branch_not_exist(mkdtemp, check_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "returned non-zero exit status" in str(error.value)
@patch(
"subprocess.check_call",
side_effect=[
True,
True,
subprocess.CalledProcessError(returncode=1, cmd="git checkout {}".format(PUBLIC_COMMIT)),
],
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_commit_not_exist(mkdtemp, check_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "returned non-zero exit status" in str(error.value)
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=False)
@patch("os.path.isdir", return_value=True)
@patch("os.path.exists", return_value=True)
def test_git_clone_repo_entry_point_not_exist(exists, isdir, isfile, mkdtemp, heck_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point_that_does_not_exist"
source_dir = "source_dir"
dependencies = ["foo", "bar"]
with pytest.raises(ValueError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "Entry point does not exist in the repo." in str(error)
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
@patch("os.path.isdir", return_value=False)
@patch("os.path.exists", return_value=True)
def test_git_clone_repo_source_dir_not_exist(exists, isdir, isfile, mkdtemp, check_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point"
source_dir = "source_dir_that_does_not_exist"
dependencies = ["foo", "bar"]
with pytest.raises(ValueError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "Source directory does not exist in the repo." in str(error)
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
@patch("os.path.isdir", return_value=True)
@patch("os.path.exists", side_effect=[True, False])
def test_git_clone_repo_dependencies_not_exist(exists, isdir, isfile, mkdtemp, check_call):
git_config = {"repo": PUBLIC_GIT_REPO, "branch": PUBLIC_BRANCH, "commit": PUBLIC_COMMIT}
entry_point = "entry_point"
source_dir = "source_dir"
dependencies = ["foo", "dep_that_does_not_exist"]
with pytest.raises(ValueError) as error:
git_utils.git_clone_repo(git_config, entry_point, source_dir, dependencies)
assert "does not exist in the repo." in str(error)
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_with_username_password_no_2fa(isfile, mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"username": "username",
"password": "passw0rd!",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
ret = git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
check_call.assert_any_call(
[
"git",
"clone",
"https://username:passw0rd%[email protected]/testAccount/private-repo.git",
REPO_DIR,
],
env=env,
)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_BRANCH], cwd=REPO_DIR)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_COMMIT], cwd=REPO_DIR)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_with_token_no_2fa(isfile, mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"token": "my-token",
"2FA_enabled": False,
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
ret = git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
check_call.assert_any_call(
env=env,
)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_BRANCH], cwd=REPO_DIR)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_COMMIT], cwd=REPO_DIR)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_with_token_2fa(isfile, mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"2FA_enabled": True,
"username": "username",
"token": "my-token",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
ret = git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
check_call.assert_any_call(
env=env,
)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_BRANCH], cwd=REPO_DIR)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_COMMIT], cwd=REPO_DIR)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch("subprocess.check_call")
@patch("os.chmod")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_ssh(isfile, mkdtemp, chmod, check_call):
git_config = {"repo": PRIVATE_GIT_REPO_SSH, "branch": PRIVATE_BRANCH, "commit": PRIVATE_COMMIT}
entry_point = "entry_point"
ret = git_utils.git_clone_repo(git_config, entry_point)
chmod.assert_any_call(ANY, 0o511)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_with_token_no_2fa_unnecessary_creds_provided(isfile, mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"username": "username",
"password": "passw0rd!",
"token": "my-token",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
with pytest.warns(UserWarning) as warn:
ret = git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
assert (
"Using token for authentication, other credentials will be ignored."
in warn[0].message.args[0]
)
check_call.assert_any_call(
env=env,
)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_BRANCH], cwd=REPO_DIR)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_COMMIT], cwd=REPO_DIR)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_with_token_2fa_unnecessary_creds_provided(isfile, mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"2FA_enabled": True,
"username": "username",
"token": "my-token",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
with pytest.warns(UserWarning) as warn:
ret = git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
assert (
"Using token for authentication, other credentials will be ignored."
in warn[0].message.args[0]
)
check_call.assert_any_call(
env=env,
)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_BRANCH], cwd=REPO_DIR)
check_call.assert_any_call(args=["git", "checkout", PRIVATE_COMMIT], cwd=REPO_DIR)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch(
"subprocess.check_call",
side_effect=subprocess.CalledProcessError(
returncode=1, cmd="git clone {} {}".format(PRIVATE_GIT_REPO, REPO_DIR)
),
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_with_username_and_password_wrong_creds(mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"2FA_enabled": False,
"username": "username",
"password": "wrong-password",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
assert "returned non-zero exit status" in str(error.value)
@patch(
"subprocess.check_call",
side_effect=subprocess.CalledProcessError(
returncode=1, cmd="git clone {} {}".format(PRIVATE_GIT_REPO, REPO_DIR)
),
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_with_token_wrong_creds(mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"2FA_enabled": False,
"token": "wrong-token",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
assert "returned non-zero exit status" in str(error.value)
@patch(
"subprocess.check_call",
side_effect=subprocess.CalledProcessError(
returncode=1, cmd="git clone {} {}".format(PRIVATE_GIT_REPO, REPO_DIR)
),
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_with_and_token_2fa_wrong_creds(mkdtemp, check_call):
git_config = {
"repo": PRIVATE_GIT_REPO,
"branch": PRIVATE_BRANCH,
"commit": PRIVATE_COMMIT,
"2FA_enabled": False,
"token": "wrong-token",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
assert "returned non-zero exit status" in str(error.value)
@patch("subprocess.check_call")
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
@patch("os.path.isfile", return_value=True)
def test_git_clone_repo_codecommit_https_with_username_and_password(isfile, mkdtemp, check_call):
git_config = {
"repo": CODECOMMIT_REPO,
"branch": CODECOMMIT_BRANCH,
"username": "username",
"password": "my-codecommit-password",
}
entry_point = "entry_point"
env = os.environ.copy()
env["GIT_TERMINAL_PROMPT"] = "0"
ret = git_utils.git_clone_repo(git_config=git_config, entry_point=entry_point)
check_call.assert_any_call(
[
"git",
"clone",
"https://username:[email protected]/v1/repos/test-repo/",
REPO_DIR,
],
env=env,
)
check_call.assert_any_call(args=["git", "checkout", CODECOMMIT_BRANCH], cwd=REPO_DIR)
assert ret["entry_point"] == "/tmp/repo_dir/entry_point"
assert ret["source_dir"] is None
assert ret["dependencies"] is None
@patch(
"subprocess.check_call",
side_effect=subprocess.CalledProcessError(
returncode=128, cmd="git clone {} {}".format(CODECOMMIT_REPO_SSH, REPO_DIR)
),
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_codecommit_ssh_passphrase_required(mkdtemp, check_call):
git_config = {"repo": CODECOMMIT_REPO_SSH, "branch": CODECOMMIT_BRANCH}
entry_point = "entry_point"
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config, entry_point)
assert "returned non-zero exit status" in str(error.value)
@patch(
"subprocess.check_call",
side_effect=subprocess.CalledProcessError(
returncode=128, cmd="git clone {} {}".format(CODECOMMIT_REPO, REPO_DIR)
),
)
@patch("tempfile.mkdtemp", return_value=REPO_DIR)
def test_git_clone_repo_codecommit_https_creds_not_stored_locally(mkdtemp, check_call):
git_config = {"repo": CODECOMMIT_REPO, "branch": CODECOMMIT_BRANCH}
entry_point = "entry_point"
with pytest.raises(subprocess.CalledProcessError) as error:
git_utils.git_clone_repo(git_config, entry_point)
assert "returned non-zero exit status" in str(error.value)