-
Notifications
You must be signed in to change notification settings - Fork 71
Expand file tree
/
Copy pathtest_jobs.py
More file actions
executable file
·672 lines (554 loc) · 35.5 KB
/
Copy pathtest_jobs.py
File metadata and controls
executable file
·672 lines (554 loc) · 35.5 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
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
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
"""Basic Job Test."""
from unittest.mock import MagicMock, patch
from django.contrib.contenttypes.models import ContentType
from nautobot.apps.testing import TransactionTestCase, create_job_result_and_run_job
from nautobot.dcim.models import Device
from nautobot.extras.choices import DynamicGroupTypeChoices
from nautobot.extras.models import DynamicGroup, GitRepository, GraphQLQuery, JobLogEntry
from nautobot_golden_config import jobs
from nautobot_golden_config.models import GoldenConfigSetting
from nautobot_golden_config.tests.conftest import (
create_device,
create_orphan_device,
dgs_gc_settings_and_job_repo_objects,
)
from nautobot_golden_config.utilities import constant
@patch("nautobot_golden_config.nornir_plays.config_backup.run_backup", MagicMock(return_value="foo"))
@patch.object(jobs, "ensure_git_repository")
class GCReposBackupTestCase(TransactionTestCase):
"""Test the repos to sync and commit are working for backup job."""
databases = ("default", "job_logs")
def setUp(self) -> None:
"""Setup test data."""
self.device = create_device(name="foobaz")
self.device2 = create_orphan_device(name="foobaz2")
dgs_gc_settings_and_job_repo_objects()
super().setUp()
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", True)
def test_backup_job_repos_one_setting(self, mock_ensure_git_repository):
"""Test backup job repo-types are backup only."""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="BackupJob", device=Device.objects.filter(name=self.device.name)
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: backup_repository")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Backup Configurations job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", True)
def test_backup_job_repos_two_setting(self, mock_ensure_git_repository):
"""Test backup job repo-types are backup only."""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs",
name="BackupJob",
device=Device.objects.all(),
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: backup_repository")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Backup Configurations job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
def test_backup_job_repos_one_setting_backup_disabled(self, mock_ensure_git_repository):
"""Test backup job repo-types are backup only."""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_BACKUP)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="BackupJob", device=Device.objects.filter(name=self.device.name)
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: ")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="run")
self.assertEqual(log_entries.last().message, "Backups are disabled in application settings.")
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
def test_backup_job_repos_two_setting_backup_disabled(self, mock_ensure_git_repository):
"""Test backup job repo-types are backup only."""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_BACKUP)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="BackupJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: ")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="run")
self.assertEqual(log_entries.last().message, "Backups are disabled in application settings.")
@patch("nautobot_golden_config.nornir_plays.config_intended.run_template", MagicMock(return_value="foo"))
@patch.object(jobs, "ensure_git_repository")
class GCReposIntendedTestCase(TransactionTestCase):
"""Test the repos to sync and commit are working for intended job."""
databases = ("default", "job_logs")
def setUp(self) -> None:
"""Setup test data."""
self.device = create_device(name="foobaz")
self.device2 = create_orphan_device(name="foobaz2")
dgs_gc_settings_and_job_repo_objects()
super().setUp()
def test_intended_job_repos_one_setting(self, mock_ensure_git_repository):
"""Test intended job one GC setting enabled_intended enabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs",
name="IntendedJob",
device=Device.objects.filter(name=self.device.name),
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: intended_repository, jinja_repository")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Generate Intended Configurations job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
def test_intended_job_repos_two_setting(self, mock_ensure_git_repository):
"""Test intended job two GC setting enabled_intended enabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="IntendedJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: intended_repository, jinja_repository")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Generate Intended Configurations job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_intended_job_repos_one_setting_intended_disabled(self, mock_ensure_git_repository):
"""Test intended job one GC setting enabled_intended disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_INTENDED)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs",
name="IntendedJob",
device=Device.objects.filter(name=self.device.name),
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: ")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="run")
self.assertEqual(log_entries.last().message, "Intended Generation is disabled in application settings.")
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_intended_job_repos_two_setting_intended_disabled(self, mock_ensure_git_repository):
"""Test intended job two GC setting enabled_intended disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_INTENDED)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="IntendedJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: ")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="run")
self.assertEqual(log_entries.last().message, "Intended Generation is disabled in application settings.")
@patch("nautobot_golden_config.nornir_plays.config_compliance.run_compliance", MagicMock(return_value="foo"))
@patch.object(jobs, "ensure_git_repository")
class GCReposComplianceTestCase(TransactionTestCase):
"""Test the repos to sync and commit are working for compliance job."""
databases = ("default", "job_logs")
def setUp(self) -> None:
"""Setup test data."""
self.device = create_device(name="foobaz")
self.device2 = create_orphan_device(name="foobaz2")
dgs_gc_settings_and_job_repo_objects()
super().setUp()
def test_compliance_job_repos_one_setting(self, mock_ensure_git_repository):
"""Test compliance job one GC setting enabled_compliance enabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs",
name="ComplianceJob",
device=Device.objects.filter(name=self.device.name),
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message, "Repository types to sync: backup_repository, intended_repository"
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Perform Configuration Compliance job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
def test_compliance_job_repos_two_setting(self, mock_ensure_git_repository):
"""Test compliance job two GC setting enabled_compliance enabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="ComplianceJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message, "Repository types to sync: backup_repository, intended_repository"
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Perform Configuration Compliance job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_COMPLIANCE", False)
def test_compliance_job_repos_one_setting_compliance_disabled(self, mock_ensure_git_repository):
"""Test compliance job one GC setting enabled_compliance disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_COMPLIANCE)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs",
name="ComplianceJob",
device=Device.objects.filter(name=self.device.name),
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: ")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="run")
self.assertEqual(log_entries.last().message, "Compliance is disabled in application settings.")
@patch("nautobot_golden_config.utilities.constant.ENABLE_COMPLIANCE", False)
def test_compliance_job_repos_two_setting_compliance_disabled(self, mock_ensure_git_repository):
"""Test compliance job two GC setting enabled_compliance disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_COMPLIANCE)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="ComplianceJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(log_entries.first().message, "Repository types to sync: ")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="run")
self.assertEqual(log_entries.last().message, "Compliance is disabled in application settings.")
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
def test_compliance_job_repos_backup_disabled(self, mock_ensure_git_repository):
"""Test compliance job one GC setting enabled_backup disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_BACKUP)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="ComplianceJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message, "Repository types to sync: backup_repository, intended_repository"
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Perform Configuration Compliance job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_compliance_job_repos_intended_disabled(self, mock_ensure_git_repository):
"""Test compliance job one GC setting enabled_intended disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_INTENDED)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="ComplianceJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message, "Repository types to sync: backup_repository, intended_repository"
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Perform Configuration Compliance job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_compliance_job_repos_both_disabled(self, mock_ensure_git_repository):
"""Test compliance job one GC setting both disabled"""
mock_ensure_git_repository.return_value = True
self.assertFalse(constant.ENABLE_BACKUP)
self.assertFalse(constant.ENABLE_INTENDED)
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="ComplianceJob", device=Device.objects.all()
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message, "Repository types to sync: backup_repository, intended_repository"
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Perform Configuration Compliance job execution.")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 0)
@patch("nautobot_golden_config.nornir_plays.config_backup.run_backup", MagicMock(return_value="foo"))
@patch("nautobot_golden_config.nornir_plays.config_intended.run_template", MagicMock(return_value="foo"))
@patch("nautobot_golden_config.nornir_plays.config_compliance.run_compliance", MagicMock(return_value="foo"))
@patch.object(jobs, "ensure_git_repository")
class GCReposRunAllSingleTestCase(TransactionTestCase):
"""Test the repos to sync and commit are working for run all single job."""
databases = ("default", "job_logs")
def setUp(self) -> None:
"""Setup test data."""
self.device = create_device(name="foobaz")
dgs_gc_settings_and_job_repo_objects()
super().setUp()
def test_run_all_job_single_repos(self, mock_ensure_git_repository):
"""Test run all job single on one GC setting enabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllGoldenConfig", device=self.device.id
)
self.assertTrue(constant.ENABLE_BACKUP)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Single Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
def test_run_all_job_single_repos_backup_disabled(self, mock_ensure_git_repository):
"""Test run all job single on one GC backup_disabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllGoldenConfig", device=self.device.id
)
self.assertFalse(constant.ENABLE_BACKUP)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Single Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_run_all_job_single_repos_intended_disabled(self, mock_ensure_git_repository):
"""Test run all job single on one GC intended_disabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllGoldenConfig", device=self.device.id
)
self.assertFalse(constant.ENABLE_INTENDED)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Single Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_run_all_job_single_repos_both_disabled(self, mock_ensure_git_repository):
"""Test run all job single on one GC both_disabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllGoldenConfig", device=self.device.id
)
self.assertFalse(constant.ENABLE_BACKUP)
self.assertFalse(constant.ENABLE_INTENDED)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 1")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Single Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 0)
@patch("nautobot_golden_config.nornir_plays.config_backup.run_backup", MagicMock(return_value="foo"))
@patch("nautobot_golden_config.nornir_plays.config_intended.run_template", MagicMock(return_value="foo"))
@patch("nautobot_golden_config.nornir_plays.config_compliance.run_compliance", MagicMock(return_value="foo"))
@patch.object(jobs, "ensure_git_repository")
class GCReposRunAllMultipleTestCase(TransactionTestCase):
"""Test the repos to sync and commit are working for run all multiple job."""
databases = ("default", "job_logs")
def setUp(self) -> None:
"""Setup test data."""
self.device = create_device(name="foobaz")
self.device2 = create_orphan_device(name="foobaz2")
dgs_gc_settings_and_job_repo_objects()
super().setUp()
def test_run_all_job_multiple_repos(self, mock_ensure_git_repository):
"""Test run all job multiple on one GC setting enabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllDevicesGoldenConfig", device=Device.objects.all()
)
self.assertTrue(constant.ENABLE_BACKUP)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Multiple Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
def test_run_all_job_multiple_repos_backup_disabled(self, mock_ensure_git_repository):
"""Test run all job multiple on one GC backup_disabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllDevicesGoldenConfig", device=Device.objects.all()
)
self.assertFalse(constant.ENABLE_BACKUP)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Multiple Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_run_all_job_multiple_repos_intended_disabled(self, mock_ensure_git_repository):
"""Test run all job multiple on one GC intended_disabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllDevicesGoldenConfig", device=Device.objects.all()
)
self.assertFalse(constant.ENABLE_INTENDED)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Multiple Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 1)
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", False)
@patch("nautobot_golden_config.utilities.constant.ENABLE_INTENDED", False)
def test_run_all_job_multiple_repos_both_disabled(self, mock_ensure_git_repository):
"""Test run all job multiple on one GC both_disabled"""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs", name="AllDevicesGoldenConfig", device=Device.objects.all()
)
self.assertFalse(constant.ENABLE_BACKUP)
self.assertFalse(constant.ENABLE_INTENDED)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Syncs")
self.assertEqual(
log_entries.first().message,
"Repository types to sync: backup_repository, intended_repository, jinja_repository",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="Get Job Filter")
self.assertEqual(log_entries.count(), 2)
self.assertEqual(log_entries.last().message, "In scope device count for this job: 2")
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(
log_entries.first().message,
"Finished the Execute All Golden Configuration Jobs - Multiple Device job execution.",
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC Repo Commit and Push")
self.assertEqual(log_entries.count(), 0)
@patch("nautobot_golden_config.nornir_plays.config_backup.run_backup", MagicMock(return_value="foo"))
@patch.object(jobs, "ensure_git_repository")
class GCReposStaticGroupTestCase(TransactionTestCase):
"""Test that jobs succeed when a device belongs to a static DynamicGroup."""
databases = ("default", "job_logs")
def setUp(self) -> None:
"""Setup test data reproducing issue #1029: static group alongside dynamic filter group."""
self.device = create_device(name="static-device")
dgs_gc_settings_and_job_repo_objects()
ct_device = ContentType.objects.get_for_model(Device)
static_group = DynamicGroup.objects.create(
name="static-dg",
content_type=ct_device,
group_type=DynamicGroupTypeChoices.TYPE_STATIC,
)
static_group.add_members([self.device])
GoldenConfigSetting.objects.create(
name="static_group_setting",
slug="static_group_setting",
weight=2000,
backup_path_template="test/backup",
intended_path_template="test/intended",
jinja_path_template="{{jinja_path}}",
backup_test_connectivity=True,
dynamic_group=static_group,
sot_agg_query=GraphQLQuery.objects.get(name="GC-SoTAgg-Query-1"),
backup_repository=GitRepository.objects.get(name="test-backup-repo-1"),
)
super().setUp()
@patch("nautobot_golden_config.utilities.constant.ENABLE_BACKUP", True)
def test_backup_job_with_static_group_does_not_crash(self, mock_ensure_git_repository):
"""Backup job must not raise RuntimeError when device is in a static group."""
mock_ensure_git_repository.return_value = True
job_result = create_job_result_and_run_job(
module="nautobot_golden_config.jobs",
name="BackupJob",
device=Device.objects.filter(name=self.device.name),
)
log_entries = JobLogEntry.objects.filter(job_result=job_result, grouping="GC After Run")
self.assertEqual(log_entries.first().message, "Finished the Backup Configurations job execution.")