-
Notifications
You must be signed in to change notification settings - Fork 1k
/
project_command_builder_test.go
2136 lines (2015 loc) · 59.6 KB
/
project_command_builder_test.go
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
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package events_test
import (
"os"
"path/filepath"
"strings"
"testing"
"github.com/hashicorp/go-version"
. "github.com/petergtz/pegomock/v4"
terraform_mocks "github.com/runatlantis/atlantis/server/core/terraform/mocks"
"github.com/runatlantis/atlantis/server/core/config"
"github.com/runatlantis/atlantis/server/core/config/valid"
"github.com/runatlantis/atlantis/server/events"
"github.com/runatlantis/atlantis/server/events/command"
"github.com/runatlantis/atlantis/server/events/mocks"
"github.com/runatlantis/atlantis/server/events/models"
vcsmocks "github.com/runatlantis/atlantis/server/events/vcs/mocks"
"github.com/runatlantis/atlantis/server/logging"
"github.com/runatlantis/atlantis/server/metrics"
. "github.com/runatlantis/atlantis/testing"
)
var defaultUserConfig = struct {
SkipCloneNoChanges bool
EnableRegExpCmd bool
EnableAutoMerge bool
EnableParallelPlan bool
EnableParallelApply bool
AutoDetectModuleFiles string
AutoplanFileList string
RestrictFileList bool
SilenceNoProjects bool
IncludeGitUntrackedFiles bool
AutoDiscoverMode string
}{
SkipCloneNoChanges: false,
EnableRegExpCmd: false,
EnableAutoMerge: false,
EnableParallelPlan: false,
EnableParallelApply: false,
AutoDetectModuleFiles: "",
AutoplanFileList: "**/*.tf,**/*.tfvars,**/*.tfvars.json,**/terragrunt.hcl,**/.terraform.lock.hcl",
RestrictFileList: false,
SilenceNoProjects: false,
IncludeGitUntrackedFiles: true,
AutoDiscoverMode: "auto",
}
func ChangedFiles(dirStructure map[string]interface{}, parent string) []string {
var files []string
for k, v := range dirStructure {
switch v := v.(type) {
case map[string]interface{}:
files = append(files, ChangedFiles(v, k)...)
default:
files = append(files, filepath.Join(parent, k))
}
}
return files
}
func TestDefaultProjectCommandBuilder_BuildAutoplanCommands(t *testing.T) {
// expCtxFields define the ctx fields we're going to assert on.
// Since we're focused on autoplanning here, we don't validate all the
// fields so the tests are more obvious and targeted.
type expCtxFields struct {
ProjectName string
RepoRelDir string
Workspace string
}
defaultTestDirStructure := map[string]interface{}{
"main.tf": nil,
}
cases := []struct {
Description string
AtlantisYAML string
ServerSideYAML string
TestDirStructure map[string]interface{}
exp []expCtxFields
}{
{
Description: "simple atlantis.yaml",
AtlantisYAML: `
version: 3
projects:
- dir: .
`,
TestDirStructure: defaultTestDirStructure,
exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: ".",
Workspace: "default",
},
},
},
{
Description: "some projects disabled",
AtlantisYAML: `
version: 3
projects:
- dir: .
autoplan:
enabled: false
- dir: .
workspace: myworkspace
autoplan:
when_modified: ["main.tf"]
- dir: .
name: myname
workspace: myworkspace2
`,
TestDirStructure: defaultTestDirStructure,
exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: ".",
Workspace: "myworkspace",
},
{
ProjectName: "myname",
RepoRelDir: ".",
Workspace: "myworkspace2",
},
},
},
{
Description: "some projects disabled",
AtlantisYAML: `
version: 3
projects:
- dir: .
autoplan:
enabled: false
- dir: .
workspace: myworkspace
autoplan:
when_modified: ["main.tf"]
- dir: .
workspace: myworkspace2
`,
TestDirStructure: defaultTestDirStructure,
exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: ".",
Workspace: "myworkspace",
},
{
ProjectName: "",
RepoRelDir: ".",
Workspace: "myworkspace2",
},
},
},
{
Description: "no projects modified",
AtlantisYAML: `
version: 3
projects:
- dir: mydir
`,
TestDirStructure: defaultTestDirStructure,
exp: nil,
},
{
Description: "workspaces from subdirectories detected",
TestDirStructure: map[string]interface{}{
"work": map[string]interface{}{
"main.tf": `
terraform {
cloud {
organization = "atlantis-test"
workspaces {
name = "test-workspace1"
}
}
}`,
},
"test": map[string]interface{}{
"main.tf": `
terraform {
cloud {
organization = "atlantis-test"
workspaces {
name = "test-workspace12"
}
}
}`,
},
},
exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: "work",
Workspace: "test-workspace1",
},
{
ProjectName: "",
RepoRelDir: "test",
Workspace: "test-workspace12",
},
},
},
{
Description: "workspaces in parent directory are detected",
TestDirStructure: map[string]interface{}{
"main.tf": `
terraform {
cloud {
organization = "atlantis-test"
workspaces {
name = "test-workspace"
}
}
}`,
},
exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: ".",
Workspace: "test-workspace",
},
},
},
}
logger := logging.NewNoopLogger(t)
scope, _, _ := metrics.NewLoggingScope(logger, "atlantis")
userConfig := defaultUserConfig
terraformClient := terraform_mocks.NewMockClient()
When(terraformClient.ListAvailableVersions(Any[logging.SimpleLogging]())).ThenReturn([]string{}, nil)
for _, c := range cases {
t.Run(c.Description, func(t *testing.T) {
RegisterMockTestingT(t)
tmpDir := DirStructure(t, c.TestDirStructure)
workingDir := mocks.NewMockWorkingDir()
When(workingDir.Clone(Any[models.Repo](), Any[models.PullRequest](), Any[string]())).ThenReturn(tmpDir, false, nil)
vcsClient := vcsmocks.NewMockClient()
When(vcsClient.GetModifiedFiles(
Any[logging.SimpleLogging](), Any[models.Repo](), Any[models.PullRequest]())).ThenReturn(ChangedFiles(c.TestDirStructure, ""), nil)
if c.AtlantisYAML != "" {
err := os.WriteFile(filepath.Join(tmpDir, valid.DefaultAtlantisFile), []byte(c.AtlantisYAML), 0600)
Ok(t, err)
}
globalCfgArgs := valid.GlobalCfgArgs{}
builder := events.NewProjectCommandBuilder(
false,
&config.ParserValidator{},
&events.DefaultProjectFinder{},
vcsClient,
workingDir,
events.NewDefaultWorkingDirLocker(),
valid.NewGlobalCfgFromArgs(globalCfgArgs),
&events.DefaultPendingPlanFinder{},
&events.CommentParser{ExecutableName: "atlantis"},
userConfig.SkipCloneNoChanges,
userConfig.EnableRegExpCmd,
userConfig.EnableAutoMerge,
userConfig.EnableParallelPlan,
userConfig.EnableParallelApply,
userConfig.AutoDetectModuleFiles,
userConfig.AutoplanFileList,
userConfig.RestrictFileList,
userConfig.SilenceNoProjects,
userConfig.IncludeGitUntrackedFiles,
userConfig.AutoDiscoverMode,
scope,
logger,
terraformClient,
)
ctxs, err := builder.BuildAutoplanCommands(&command.Context{
PullRequestStatus: models.PullReqStatus{
Mergeable: true,
},
Log: logger,
Scope: scope,
})
Ok(t, err)
Equals(t, len(c.exp), len(ctxs))
for i, actCtx := range ctxs {
expCtx := c.exp[i]
Equals(t, expCtx.ProjectName, actCtx.ProjectName)
Equals(t, expCtx.RepoRelDir, actCtx.RepoRelDir)
Equals(t, expCtx.Workspace, actCtx.Workspace)
}
})
}
}
// Test building a plan and apply command for one project.
func TestDefaultProjectCommandBuilder_BuildSinglePlanApplyCommand(t *testing.T) {
cases := []struct {
Description string
AtlantisYAML string
Cmd events.CommentCommand
Silenced bool
ExpCommentArgs []string
ExpWorkspace string
ExpDir string
ExpProjectName string
ExpErr string
ExpApplyReqs []string
EnableAutoMergeUserCfg bool
AutoDiscoverModeUserCfg string
EnableParallelPlanUserCfg bool
EnableParallelApplyUserCfg bool
ExpAutoMerge bool
ExpParallelPlan bool
ExpParallelApply bool
ExpNoProjects bool
}{
{
Description: "no atlantis.yaml",
Cmd: events.CommentCommand{
RepoRelDir: ".",
Flags: []string{"commentarg"},
Name: command.Plan,
Workspace: "myworkspace",
},
AtlantisYAML: "",
ExpCommentArgs: []string{`\c\o\m\m\e\n\t\a\r\g`},
ExpWorkspace: "myworkspace",
ExpDir: ".",
ExpApplyReqs: []string{},
},
{
Description: "no atlantis.yaml with project flag",
Cmd: events.CommentCommand{
RepoRelDir: ".",
Name: command.Plan,
ProjectName: "myproject",
},
AtlantisYAML: "",
ExpErr: "cannot specify a project name unless an atlantis.yaml file exists to configure projects",
},
{
Description: "simple atlantis.yaml",
Cmd: events.CommentCommand{
RepoRelDir: ".",
Name: command.Plan,
Workspace: "myworkspace",
},
AtlantisYAML: `
version: 3
projects:
- dir: .
workspace: myworkspace
apply_requirements: [approved]`,
ExpApplyReqs: []string{"approved"},
ExpWorkspace: "myworkspace",
ExpDir: ".",
},
{
Description: "atlantis.yaml wrong dir",
Cmd: events.CommentCommand{
RepoRelDir: ".",
Name: command.Plan,
Workspace: "myworkspace",
},
AtlantisYAML: `
version: 3
projects:
- dir: notroot
workspace: myworkspace
apply_requirements: [approved]`,
ExpWorkspace: "myworkspace",
ExpDir: ".",
ExpApplyReqs: []string{},
},
{
Description: "atlantis.yaml wrong workspace",
Cmd: events.CommentCommand{
RepoRelDir: ".",
Name: command.Plan,
Workspace: "myworkspace",
},
AtlantisYAML: `
version: 3
projects:
- dir: .
workspace: notmyworkspace
apply_requirements: [approved]`,
ExpErr: "running commands in workspace \"myworkspace\" is not allowed because this directory is only configured for the following workspaces: notmyworkspace",
},
{
Description: "atlantis.yaml with projectname",
Cmd: events.CommentCommand{
Name: command.Plan,
ProjectName: "myproject",
},
AtlantisYAML: `
version: 3
projects:
- name: myproject
dir: .
workspace: myworkspace
apply_requirements: [approved]`,
ExpApplyReqs: []string{"approved"},
ExpProjectName: "myproject",
ExpWorkspace: "myworkspace",
ExpDir: ".",
},
{
Description: "atlantis.yaml with mergeable apply requirement",
Cmd: events.CommentCommand{
Name: command.Plan,
ProjectName: "myproject",
},
AtlantisYAML: `
version: 3
projects:
- name: myproject
dir: .
workspace: myworkspace
apply_requirements: [mergeable]`,
ExpApplyReqs: []string{"mergeable"},
ExpProjectName: "myproject",
ExpWorkspace: "myworkspace",
ExpDir: ".",
},
{
Description: "atlantis.yaml with mergeable and approved apply requirements",
Cmd: events.CommentCommand{
Name: command.Plan,
ProjectName: "myproject",
},
AtlantisYAML: `
version: 3
projects:
- name: myproject
dir: .
workspace: myworkspace
apply_requirements: [mergeable, approved]`,
ExpApplyReqs: []string{"mergeable", "approved"},
ExpProjectName: "myproject",
ExpWorkspace: "myworkspace",
ExpDir: ".",
},
{
Description: "atlantis.yaml with multiple dir/workspaces matching",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: ".",
Workspace: "myworkspace",
},
AtlantisYAML: `
version: 3
projects:
- name: myproject
dir: .
workspace: myworkspace
apply_requirements: [approved]
- name: myproject2
dir: .
workspace: myworkspace
`,
ExpErr: "must specify project name: more than one project defined in atlantis.yaml matched dir: \".\" workspace: \"myworkspace\"",
},
{
Description: "atlantis.yaml with project flag not matching",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: ".",
Workspace: "default",
ProjectName: "notconfigured",
},
AtlantisYAML: `
version: 3
projects:
- dir: .
`,
ExpErr: "no project with name \"notconfigured\" is defined in atlantis.yaml",
},
{
Description: "atlantis.yaml with project flag not matching but silenced",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: ".",
Workspace: "default",
ProjectName: "notconfigured",
},
AtlantisYAML: `
version: 3
projects:
- dir: .
`,
Silenced: true,
ExpNoProjects: true,
},
{
Description: "atlantis.yaml with ParallelPlan Set to true",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: ".",
Workspace: "default",
ProjectName: "myproject",
},
AtlantisYAML: `
version: 3
parallel_plan: true
projects:
- name: myproject
dir: .
workspace: myworkspace
`,
ExpParallelPlan: true,
ExpParallelApply: false,
ExpDir: ".",
ExpWorkspace: "myworkspace",
ExpProjectName: "myproject",
ExpApplyReqs: []string{},
},
{
Description: "atlantis.yaml with ParallelPlan/apply and Automerge not set, but set in user conf",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: ".",
Workspace: "default",
ProjectName: "myproject",
},
AtlantisYAML: `
version: 3
projects:
- name: myproject
dir: .
workspace: myworkspace
`,
EnableAutoMergeUserCfg: true,
EnableParallelPlanUserCfg: true,
EnableParallelApplyUserCfg: true,
ExpAutoMerge: true,
ExpParallelPlan: true,
ExpParallelApply: true,
ExpDir: ".",
ExpWorkspace: "myworkspace",
ExpProjectName: "myproject",
ExpApplyReqs: []string{},
},
{
Description: "atlantis.yaml with ParallelPlan/apply and Automerge set to false, but set to true in user conf",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: ".",
Workspace: "default",
ProjectName: "myproject",
},
AtlantisYAML: `
version: 3
automerge: false
parallel_plan: false
parallel_apply: false
projects:
- name: myproject
dir: .
workspace: myworkspace
`,
EnableAutoMergeUserCfg: true,
EnableParallelPlanUserCfg: true,
EnableParallelApplyUserCfg: true,
ExpAutoMerge: false,
ExpParallelPlan: false,
ExpParallelApply: false,
ExpDir: ".",
ExpWorkspace: "myworkspace",
ExpProjectName: "myproject",
ExpApplyReqs: []string{},
},
}
logger := logging.NewNoopLogger(t)
scope, _, _ := metrics.NewLoggingScope(logger, "atlantis")
userConfig := defaultUserConfig
for _, c := range cases {
// NOTE: we're testing both plan and apply here.
for _, cmdName := range []command.Name{command.Plan, command.Apply} {
t.Run(c.Description+"_"+cmdName.String(), func(t *testing.T) {
RegisterMockTestingT(t)
tmpDir := DirStructure(t, map[string]interface{}{
"main.tf": nil,
})
workingDir := mocks.NewMockWorkingDir()
When(workingDir.Clone(Any[models.Repo](), Any[models.PullRequest](), Any[string]())).ThenReturn(tmpDir, false, nil)
When(workingDir.GetWorkingDir(Any[models.Repo](), Any[models.PullRequest](), Any[string]())).ThenReturn(tmpDir, nil)
vcsClient := vcsmocks.NewMockClient()
When(vcsClient.GetModifiedFiles(
Any[logging.SimpleLogging](), Any[models.Repo](), Any[models.PullRequest]())).ThenReturn([]string{"main.tf"}, nil)
if c.AtlantisYAML != "" {
err := os.WriteFile(filepath.Join(tmpDir, valid.DefaultAtlantisFile), []byte(c.AtlantisYAML), 0600)
Ok(t, err)
}
globalCfgArgs := valid.GlobalCfgArgs{
AllowAllRepoSettings: true,
}
terraformClient := terraform_mocks.NewMockClient()
When(terraformClient.ListAvailableVersions(Any[logging.SimpleLogging]())).ThenReturn([]string{}, nil)
builder := events.NewProjectCommandBuilder(
false,
&config.ParserValidator{},
&events.DefaultProjectFinder{},
vcsClient,
workingDir,
events.NewDefaultWorkingDirLocker(),
valid.NewGlobalCfgFromArgs(globalCfgArgs),
&events.DefaultPendingPlanFinder{},
&events.CommentParser{ExecutableName: "atlantis"},
userConfig.SkipCloneNoChanges,
userConfig.EnableRegExpCmd,
c.EnableAutoMergeUserCfg,
c.EnableParallelPlanUserCfg,
c.EnableParallelApplyUserCfg,
userConfig.AutoDetectModuleFiles,
userConfig.AutoplanFileList,
userConfig.RestrictFileList,
c.Silenced,
userConfig.IncludeGitUntrackedFiles,
c.AutoDiscoverModeUserCfg,
scope,
logger,
terraformClient,
)
var actCtxs []command.ProjectContext
var err error
cmd := c.Cmd
if cmdName == command.Plan {
actCtxs, err = builder.BuildPlanCommands(&command.Context{
Log: logger,
Scope: scope,
}, &cmd)
} else {
actCtxs, err = builder.BuildApplyCommands(&command.Context{Log: logger, Scope: scope}, &cmd)
}
if c.ExpErr != "" {
ErrEquals(t, c.ExpErr, err)
return
}
Ok(t, err)
if c.ExpNoProjects {
Equals(t, 0, len(actCtxs))
return
}
Equals(t, 1, len(actCtxs))
actCtx := actCtxs[0]
Equals(t, c.ExpDir, actCtx.RepoRelDir)
Equals(t, c.ExpWorkspace, actCtx.Workspace)
Equals(t, c.ExpCommentArgs, actCtx.EscapedCommentArgs)
Equals(t, c.ExpProjectName, actCtx.ProjectName)
Equals(t, c.ExpApplyReqs, actCtx.ApplyRequirements)
Equals(t, c.ExpAutoMerge, actCtx.AutomergeEnabled)
Equals(t, c.ExpParallelPlan, actCtx.ParallelPlanEnabled)
Equals(t, c.ExpParallelApply, actCtx.ParallelApplyEnabled)
})
}
}
}
// Test building a plan and apply command for one project
// with the RestrictFileList
func TestDefaultProjectCommandBuilder_BuildSinglePlanApplyCommand_WithRestrictFileList(t *testing.T) {
cases := []struct {
Description string
AtlantisYAML string
DirectoryStructure map[string]interface{}
ModifiedFiles []string
Cmd events.CommentCommand
ExpErr string
}{
{
Description: "planning a file outside of the changed files",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: "directory-1",
Workspace: "default",
},
DirectoryStructure: map[string]interface{}{
"directory-1": map[string]interface{}{
"main.tf": nil,
},
"directory-2": map[string]interface{}{
"main.tf": nil,
},
},
ModifiedFiles: []string{"directory-2/main.tf"},
ExpErr: "the dir \"directory-1\" is not in the plan list of this pull request",
},
{
Description: "planning a file of the changed files",
Cmd: events.CommentCommand{
Name: command.Plan,
RepoRelDir: "directory-1",
Workspace: "default",
},
DirectoryStructure: map[string]interface{}{
"directory-1": map[string]interface{}{
"main.tf": nil,
},
"directory-2": map[string]interface{}{
"main.tf": nil,
},
},
ModifiedFiles: []string{"directory-1/main.tf"},
},
{
Description: "planning a project outside of the requested changed files",
Cmd: events.CommentCommand{
Name: command.Plan,
Workspace: "default",
ProjectName: "project-1",
},
AtlantisYAML: `
version: 3
projects:
- name: project-1
dir: directory-1
- name: project-2
dir: directory-2
`,
DirectoryStructure: map[string]interface{}{
"directory-1": map[string]interface{}{
"main.tf": nil,
},
"directory-2": map[string]interface{}{
"main.tf": nil,
},
},
ModifiedFiles: []string{"directory-2/main.tf"},
ExpErr: "the following directories are present in the pull request but not in the requested project:\ndirectory-2",
},
{
Description: "planning a project defined in the requested changed files",
Cmd: events.CommentCommand{
Name: command.Plan,
Workspace: "default",
ProjectName: "project-1",
},
AtlantisYAML: `
version: 3
projects:
- name: project-1
dir: directory-1
- name: project-2
dir: directory-2
`,
DirectoryStructure: map[string]interface{}{
"directory-1": map[string]interface{}{
"main.tf": nil,
},
"directory-2": map[string]interface{}{
"main.tf": nil,
},
},
ModifiedFiles: []string{"directory-1/main.tf"},
},
}
logger := logging.NewNoopLogger(t)
scope, _, _ := metrics.NewLoggingScope(logger, "atlantis")
userConfig := defaultUserConfig
userConfig.RestrictFileList = true
for _, c := range cases {
t.Run(c.Description+"_"+command.Plan.String(), func(t *testing.T) {
RegisterMockTestingT(t)
tmpDir := DirStructure(t, c.DirectoryStructure)
workingDir := mocks.NewMockWorkingDir()
When(workingDir.Clone(Any[models.Repo](), Any[models.PullRequest](), Any[string]())).ThenReturn(tmpDir, false, nil)
When(workingDir.GetWorkingDir(Any[models.Repo](), Any[models.PullRequest](), Any[string]())).ThenReturn(tmpDir, nil)
vcsClient := vcsmocks.NewMockClient()
When(vcsClient.GetModifiedFiles(
Any[logging.SimpleLogging](), Any[models.Repo](), Any[models.PullRequest]())).ThenReturn(c.ModifiedFiles, nil)
if c.AtlantisYAML != "" {
err := os.WriteFile(filepath.Join(tmpDir, valid.DefaultAtlantisFile), []byte(c.AtlantisYAML), 0600)
Ok(t, err)
}
globalCfgArgs := valid.GlobalCfgArgs{
AllowAllRepoSettings: true,
}
terraformClient := terraform_mocks.NewMockClient()
When(terraformClient.ListAvailableVersions(Any[logging.SimpleLogging]())).ThenReturn([]string{}, nil)
builder := events.NewProjectCommandBuilder(
false,
&config.ParserValidator{},
&events.DefaultProjectFinder{},
vcsClient,
workingDir,
events.NewDefaultWorkingDirLocker(),
valid.NewGlobalCfgFromArgs(globalCfgArgs),
&events.DefaultPendingPlanFinder{},
&events.CommentParser{ExecutableName: "atlantis"},
userConfig.SkipCloneNoChanges,
userConfig.EnableRegExpCmd,
userConfig.EnableAutoMerge,
userConfig.EnableParallelPlan,
userConfig.EnableParallelApply,
userConfig.AutoDetectModuleFiles,
userConfig.AutoplanFileList,
userConfig.RestrictFileList,
userConfig.SilenceNoProjects,
userConfig.IncludeGitUntrackedFiles,
userConfig.AutoDiscoverMode,
scope,
logger,
terraformClient,
)
var actCtxs []command.ProjectContext
var err error
cmd := c.Cmd
actCtxs, err = builder.BuildPlanCommands(&command.Context{
Log: logger,
Scope: scope,
}, &cmd)
if c.ExpErr != "" {
ErrEquals(t, c.ExpErr, err)
return
}
Ok(t, err)
Equals(t, 1, len(actCtxs))
})
}
}
func TestDefaultProjectCommandBuilder_BuildPlanCommands(t *testing.T) {
// expCtxFields define the ctx fields we're going to assert on.
// Since we're focused on autoplanning here, we don't validate all the
// fields so the tests are more obvious and targeted.
type expCtxFields struct {
ProjectName string
RepoRelDir string
Workspace string
Automerge bool
AutoDiscover valid.AutoDiscover
ExpParallelPlan bool
ExpParallelApply bool
}
cases := map[string]struct {
AutoMergeUserCfg bool
ParallelPlanEnabledUserCfg bool
ParallelApplyEnabledUserCfg bool
DirStructure map[string]interface{}
AtlantisYAML string
ModifiedFiles []string
Exp []expCtxFields
}{
"no atlantis.yaml": {
DirStructure: map[string]interface{}{
"project1": map[string]interface{}{
"main.tf": nil,
},
"project2": map[string]interface{}{
"main.tf": nil,
},
},
ModifiedFiles: []string{"project1/main.tf", "project2/main.tf"},
Exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: "project1",
Workspace: "default",
},
{
ProjectName: "",
RepoRelDir: "project2",
Workspace: "default",
},
},
},
"no projects in atlantis.yaml with parallel operations in atlantis.yaml": {
DirStructure: map[string]interface{}{
"project1": map[string]interface{}{
"main.tf": nil,
},
"project2": map[string]interface{}{
"main.tf": nil,
},
},
AtlantisYAML: `
version: 3
automerge: true
parallel_plan: true
parallel_apply: true
`,
ModifiedFiles: []string{"project1/main.tf", "project2/main.tf"},
Exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: "project1",
Workspace: "default",
Automerge: true,
ExpParallelApply: true,
ExpParallelPlan: true,
},
{
ProjectName: "",
RepoRelDir: "project2",
Workspace: "default",
Automerge: true,
ExpParallelApply: true,
ExpParallelPlan: true,
},
},
},
"no projects in atlantis.yaml with parallel operations and automerge not in atlantis.yaml, but in user conf": {
DirStructure: map[string]interface{}{
"project1": map[string]interface{}{
"main.tf": nil,
},
"project2": map[string]interface{}{
"main.tf": nil,
},
},
AtlantisYAML: `
version: 3
`,
AutoMergeUserCfg: true,
ParallelPlanEnabledUserCfg: true,
ParallelApplyEnabledUserCfg: true,
ModifiedFiles: []string{"project1/main.tf", "project2/main.tf"},
Exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: "project1",
Workspace: "default",
Automerge: true,
ExpParallelApply: true,
ExpParallelPlan: true,
},
{
ProjectName: "",
RepoRelDir: "project2",
Workspace: "default",
Automerge: true,
ExpParallelApply: true,
ExpParallelPlan: true,
},
},
},
"no projects in atlantis.yaml with parallel operations and automerge set to false in atlantis.yaml and true in user conf": {
DirStructure: map[string]interface{}{
"project1": map[string]interface{}{
"main.tf": nil,
},
"project2": map[string]interface{}{
"main.tf": nil,
},
},
AtlantisYAML: `
version: 3
automerge: false
parallel_plan: false
parallel_apply: false
`,
AutoMergeUserCfg: true,
ParallelPlanEnabledUserCfg: true,
ParallelApplyEnabledUserCfg: true,
ModifiedFiles: []string{"project1/main.tf", "project2/main.tf"},
Exp: []expCtxFields{
{
ProjectName: "",
RepoRelDir: "project1",
Workspace: "default",
Automerge: false,
ExpParallelApply: false,
ExpParallelPlan: false,
},
{
ProjectName: "",
RepoRelDir: "project2",
Workspace: "default",
Automerge: false,
ExpParallelApply: false,
ExpParallelPlan: false,
},
},
},
"no modified files": {
DirStructure: map[string]interface{}{
"main.tf": nil,
},
ModifiedFiles: []string{},