forked from github/evergreen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_dependabot_file.py
622 lines (556 loc) · 21.2 KB
/
test_dependabot_file.py
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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
# pylint: disable=too-many-public-methods
"""Tests for the dependabot_file.py functions."""
import unittest
from unittest.mock import MagicMock
import github3
import yaml
from dependabot_file import add_existing_ecosystem_to_exempt_list, build_dependabot_file
class TestDependabotFile(unittest.TestCase):
"""
Test the dependabot_file.py functions.
"""
def test_not_found_error(self):
"""Test that the dependabot.yml file is built correctly with no package manager"""
repo = MagicMock()
response = MagicMock()
response.status_code = 404
repo.file_contents.side_effect = github3.exceptions.NotFoundError(resp=response)
result = build_dependabot_file(repo, False, [], {}, None, "", "", [])
self.assertEqual(result, None)
def test_build_dependabot_file_with_schedule_day(self):
"""Test that the dependabot.yml file is built correctly with weekly schedule day"""
repo = MagicMock()
filename_list = ["Gemfile", "Gemfile.lock"]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'bundler'
directory: '/'
schedule:
interval: 'weekly'
day: 'tuesday'
"""
result = build_dependabot_file(
repo, False, [], {}, None, "weekly", "tuesday", []
)
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_bundler(self):
"""Test that the dependabot.yml file is built correctly with bundler"""
repo = MagicMock()
filename_list = ["Gemfile", "Gemfile.lock"]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'bundler'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_existing_config_bundler_no_update(self):
"""Test that the dependabot.yml file is built correctly with bundler"""
repo = MagicMock()
repo.file_contents.side_effect = lambda f, filename="Gemfile": f == filename
# expected_result is None because the existing config already contains the all applicable ecosystems
expected_result = None
existing_config = MagicMock()
existing_config.decoded = b'---\nversion: 2\nupdates:\n - package-ecosystem: "bundler"\n\
directory: "/"\n schedule:\n interval: "weekly"\n commit-message:\n prefix: "chore(deps)"\n'
result = build_dependabot_file(
repo, False, [], {}, existing_config, "weekly", "", []
)
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_2_space_indent_existing_config_bundler_with_update(
self,
):
"""Test that the dependabot.yml file is built correctly with bundler"""
repo = MagicMock()
repo.file_contents.side_effect = lambda f, filename="Gemfile": f == filename
# expected_result maintains existing ecosystem with custom configuration
# and adds new ecosystem
expected_result = """---
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
commit-message:
prefix: "chore(deps)"
- package-ecosystem: 'bundler'
directory: '/'
schedule:
interval: 'weekly'
"""
existing_config = MagicMock()
existing_config.decoded = b'---\nversion: 2\nupdates:\n - package-ecosystem: "pip"\n directory: "/"\n\
schedule:\n interval: "weekly"\n commit-message:\n prefix: "chore(deps)"\n'
result = build_dependabot_file(
repo, False, [], {}, existing_config, "weekly", "", []
)
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_2_space_indent_existing_config_bundler_with_update_and_no_newline(
self,
):
"""Test that the dependabot.yml file is built correctly with bundler"""
repo = MagicMock()
repo.file_contents.side_effect = lambda f, filename="Gemfile": f == filename
# expected_result maintains existing ecosystem with custom configuration
# and adds new ecosystem
expected_result = """---
version: 2
updates:
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "weekly"
commit-message:
prefix: "chore(deps)"
- package-ecosystem: 'bundler'
directory: '/'
schedule:
interval: 'weekly'
"""
existing_config = MagicMock()
existing_config.decoded = b'---\nversion: 2\nupdates:\n - package-ecosystem: "pip"\n directory: "/"\n\
schedule:\n interval: "weekly"\n commit-message:\n prefix: "chore(deps)"'
result = build_dependabot_file(
repo, False, [], {}, existing_config, "weekly", "", []
)
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_weird_space_indent_existing_config_bundler_with_update(
self,
):
"""Test that the dependabot.yml file is built correctly with bundler"""
repo = MagicMock()
repo.file_contents.side_effect = lambda f, filename="Gemfile": f == filename
# expected_result maintains existing ecosystem with custom configuration
# and adds new ecosystem
existing_config = MagicMock()
existing_config.decoded = b'---\nversion: 2\nupdates:\n- package-ecosystem: "pip"\n directory: "/"\n\
schedule:\n interval: "weekly"\n commit-message:\n prefix: "chore(deps)"\n'
result = build_dependabot_file(
repo, False, [], {}, existing_config, "weekly", "", []
)
self.assertEqual(result, None)
def test_build_dependabot_file_with_npm(self):
"""Test that the dependabot.yml file is built correctly with npm"""
repo = MagicMock()
filename_list = ["package.json", "package-lock.json", "yarn.lock"]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_pip(self):
"""Test that the dependabot.yml file is built correctly with pip"""
repo = MagicMock()
filename_list = [
"requirements.txt",
"Pipfile",
"Pipfile.lock",
"pyproject.toml",
"poetry.lock",
]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'pip'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_cargo(self):
"""Test that the dependabot.yml file is built correctly with Cargo"""
repo = MagicMock()
filename_list = [
"Cargo.toml",
"Cargo.lock",
]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'cargo'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_gomod(self):
"""Test that the dependabot.yml file is built correctly with Go module"""
repo = MagicMock()
repo.file_contents.side_effect = lambda filename: filename == "go.mod"
expected_result = """---
version: 2
updates:
- package-ecosystem: 'gomod'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_composer(self):
"""Test that the dependabot.yml file is built correctly with Composer"""
repo = MagicMock()
filename_list = [
"composer.json",
"composer.lock",
]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'composer'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_hex(self):
"""Test that the dependabot.yml file is built correctly with Hex"""
repo = MagicMock()
filename_list = [
"mix.exs",
"mix.lock",
]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'mix'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_nuget(self):
"""Test that the dependabot.yml file is built correctly with NuGet"""
repo = MagicMock()
repo.file_contents.side_effect = lambda filename: filename.endswith(".csproj")
expected_result = """---
version: 2
updates:
- package-ecosystem: 'nuget'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_docker(self):
"""Test that the dependabot.yml file is built correctly with Docker"""
repo = MagicMock()
repo.file_contents.side_effect = lambda filename: filename == "Dockerfile"
expected_result = """---
version: 2
updates:
- package-ecosystem: 'docker'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_maven(self):
"""Test that the dependabot.yml file is built correctly with maven"""
repo = MagicMock()
repo.file_contents.side_effect = lambda filename: filename == "pom.xml"
expected_result = """---
version: 2
updates:
- package-ecosystem: 'maven'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_terraform_with_files(self):
"""Test that the dependabot.yml file is built correctly with Terraform"""
repo = MagicMock()
response = MagicMock()
response.status_code = 404
repo.file_contents.side_effect = github3.exceptions.NotFoundError(resp=response)
repo.directory_contents.side_effect = lambda path: (
[("main.tf", None)] if path == "/" else []
)
expected_result = """---
version: 2
updates:
- package-ecosystem: 'terraform'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_terraform_without_files(self):
"""Test that the dependabot.yml file is built correctly with Terraform"""
repo = MagicMock()
response = MagicMock()
response.status_code = 404
repo.file_contents.side_effect = github3.exceptions.NotFoundError(resp=response)
# Test absence of Terraform files
repo.directory_contents.side_effect = lambda path: [] if path == "/" else []
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertIsNone(result)
# Test empty repository
response = MagicMock()
response.status_code = 404
repo.directory_contents.side_effect = github3.exceptions.NotFoundError(
resp=response
)
result = build_dependabot_file(repo, False, [], {}, None, "weekly", "", [])
self.assertIsNone(result)
def test_build_dependabot_file_with_github_actions(self):
"""Test that the dependabot.yml file is built correctly with GitHub Actions"""
repo = MagicMock()
response = MagicMock()
response.status_code = 404
repo.file_contents.side_effect = github3.exceptions.NotFoundError(resp=response)
repo.directory_contents.side_effect = lambda path: (
[("test.yml", None)] if path == ".github/workflows" else []
)
expected_result = """---
version: 2
updates:
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(repo, False, [], None, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_github_actions_without_files(self):
"""Test that the dependabot.yml file is None when no YAML files are found in the .github/workflows/ directory."""
repo = MagicMock()
response = MagicMock()
response.status_code = 404
repo.file_contents.side_effect = github3.exceptions.NotFoundError(resp=response)
repo.directory_contents.side_effect = github3.exceptions.NotFoundError(
resp=response
)
result = build_dependabot_file(repo, False, [], None, None, "weekly", "", [])
self.assertEqual(result, None)
def test_build_dependabot_file_with_groups(self):
"""Test that the dependabot.yml file is built correctly with grouped dependencies"""
repo = MagicMock()
repo.file_contents.side_effect = lambda filename: filename == "Dockerfile"
expected_result = """---
version: 2
updates:
- package-ecosystem: 'docker'
directory: '/'
schedule:
interval: 'weekly'
groups:
production-dependencies:
dependency-type: 'production'
development-dependencies:
dependency-type: 'development'
"""
result = build_dependabot_file(repo, True, [], {}, None, "weekly", "", [])
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_exempt_ecosystems(self):
"""Test that the dependabot.yml file is built correctly with exempted ecosystems"""
repo = MagicMock()
repo.file_contents.side_effect = lambda filename: filename == "Dockerfile"
result = build_dependabot_file(
repo, False, ["docker"], {}, None, "weekly", "", []
)
self.assertEqual(result, None)
def test_build_dependabot_file_with_repo_specific_exempt_ecosystems(self):
"""Test that the dependabot.yml file is built correctly with exempted ecosystems"""
repo = MagicMock()
repo.full_name = "test/test"
repo.file_contents.side_effect = lambda filename: filename == "Dockerfile"
result = build_dependabot_file(
repo, False, [], {"test/test": ["docker"]}, None, "weekly", "", []
)
self.assertEqual(result, None)
def test_add_existing_ecosystem_to_exempt_list(self):
"""Test that existing ecosystems are added to the exempt list"""
exempt_ecosystems = ["npm", "pip", "github-actions"]
existing_config = MagicMock()
existing_config.decoded = yaml.dump(
{
"updates": [
{"package-ecosystem": "npm"},
{"package-ecosystem": "pip"},
{"package-ecosystem": "bundler"},
]
}
).encode()
add_existing_ecosystem_to_exempt_list(exempt_ecosystems, existing_config)
# Check new ecosystem is added to exempt list
self.assertIn("bundler", exempt_ecosystems)
# Keep existing ecosystems in exempt list
for ecosystem in exempt_ecosystems:
self.assertIn(ecosystem, exempt_ecosystems)
def test_build_dependabot_file_for_multiple_repos_with_few_existing_config(self):
"""
Test the case where there are multiple repos with few existing dependabot config
"""
existing_config_repo = MagicMock()
existing_config_repo.file_contents.side_effect = (
lambda f, filename="Gemfile": f == filename
)
existing_config = MagicMock()
existing_config.decoded = b'---\nversion: 2\nupdates:\n - package-ecosystem: "bundler"\n\
directory: "/"\n schedule:\n interval: "weekly"\n commit-message:\n prefix: "chore(deps)"\n'
exempt_ecosystems = []
result = build_dependabot_file(
existing_config_repo,
False,
exempt_ecosystems,
{},
existing_config,
"weekly",
"",
[],
)
self.assertEqual(result, None)
no_existing_config_repo = MagicMock()
filename_list = ["package.json", "package-lock.json", "yarn.lock"]
for filename in filename_list:
no_existing_config_repo.file_contents.side_effect = (
lambda f, filename=filename: f == filename
)
expected_result = """---
version: 2
updates:
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(
no_existing_config_repo,
False,
exempt_ecosystems,
{},
None,
"weekly",
"",
[],
)
self.assertEqual(result, expected_result)
def test_check_multiple_repos_with_no_dependabot_config(self):
"""
Test the case where there is a single repo
"""
mock_repo_1 = MagicMock()
mock_repo_1.file_contents.side_effect = lambda filename: filename == "go.mod"
expected_result = """---
version: 2
updates:
- package-ecosystem: 'gomod'
directory: '/'
schedule:
interval: 'weekly'
"""
exempt_ecosystems = []
result = build_dependabot_file(
mock_repo_1, False, exempt_ecosystems, {}, None, "weekly", "", []
)
self.assertEqual(result, expected_result)
no_existing_config_repo = MagicMock()
filename_list = ["package.json", "package-lock.json", "yarn.lock"]
for filename in filename_list:
no_existing_config_repo.file_contents.side_effect = (
lambda f, filename=filename: f == filename
)
expected_result = """---
version: 2
updates:
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: 'weekly'
"""
result = build_dependabot_file(
no_existing_config_repo,
False,
exempt_ecosystems,
{},
None,
"weekly",
"",
[],
)
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_label(self):
"""Test that the dependabot.yml file is built correctly with one label set"""
repo = MagicMock()
filename_list = ["Gemfile", "Gemfile.lock"]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'bundler'
directory: '/'
schedule:
interval: 'weekly'
labels:
- "dependencies"
"""
result = build_dependabot_file(
repo, False, [], {}, None, "weekly", "", ["dependencies"]
)
self.assertEqual(result, expected_result)
def test_build_dependabot_file_with_labels(self):
"""Test that the dependabot.yml file is built correctly with multiple labels set"""
repo = MagicMock()
filename_list = ["Gemfile", "Gemfile.lock"]
for filename in filename_list:
repo.file_contents.side_effect = lambda f, filename=filename: f == filename
expected_result = """---
version: 2
updates:
- package-ecosystem: 'bundler'
directory: '/'
schedule:
interval: 'weekly'
labels:
- "dependencies"
- "test1"
- "test2"
"""
result = build_dependabot_file(
repo,
False,
[],
{},
None,
"weekly",
"",
["dependencies", "test1", "test2"],
)
self.assertEqual(result, expected_result)
if __name__ == "__main__":
unittest.main()