forked from evergreen-ci/evergreen
-
Notifications
You must be signed in to change notification settings - Fork 0
/
globals.go
969 lines (831 loc) · 25.1 KB
/
globals.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
package evergreen
import (
"os"
"time"
"github.com/evergreen-ci/utility"
"github.com/mongodb/grip"
"github.com/pkg/errors"
)
const (
User = "mci"
GithubPatchUser = "github_pull_request"
HostRunning = "running"
HostTerminated = "terminated"
HostUninitialized = "initializing"
HostBuilding = "building"
HostStarting = "starting"
HostProvisioning = "provisioning"
HostProvisionFailed = "provision failed"
HostQuarantined = "quarantined"
HostDecommissioned = "decommissioned"
HostStopping = "stopping"
HostStopped = "stopped"
HostExternalUserName = "external"
HostStatusSuccess = "success"
HostStatusFailed = "failed"
// Task Statuses used in the database models
// TaskInactive is not assigned to any new tasks, but can be found
// in the database and is used in the UI.
TaskInactive = "inactive"
// TaskUnstarted is assigned to a display task after cleaning up one of
// its execution tasks. This indicates that the display task is
// pending a rerun
TaskUnstarted = "unstarted"
// TaskUndispatched indicates either
// 1. a task is not scheduled to run (when Task.Activated == false)
// 2. a task is scheduled to run (when Task.Activated == true)
TaskUndispatched = "undispatched"
TaskUnscheduled = "unscheduled"
// TaskWillRun is a subset of TaskUndispatched and is only used in the UI
TaskWillRun = "will-run"
// TaskStarted indicates a task is running on an agent
TaskStarted = "started"
// TaskDispatched indicates that an agent has received the task, but
// the agent has not yet told Evergreen that it's running the task
TaskDispatched = "dispatched"
// The task statuses below indicate that a task has finished.
TaskSucceeded = "success"
// These statuses indicate the types of failures that are stored in
// Task.Status field, build TaskCache and TaskEndDetails.
TaskFailed = "failed"
TaskSystemFailed = "system-failed"
TaskTestTimedOut = "test-timed-out"
TaskSetupFailed = "setup-failed"
// This is not an official task status; however it is used by the front end to distinguish aborted and failing tasks
// Tasks can be filtered on the front end by `aborted` status
TaskAborted = "aborted"
TaskStatusBlocked = "blocked"
TaskStatusPending = "pending"
// This is not an official task status; it is used by the front end to indicate that there is a linked issue in the annotation
TaskKnownIssue = "known-issue"
// Task Command Types
CommandTypeTest = "test"
CommandTypeSystem = "system"
CommandTypeSetup = "setup"
// Task descriptions
TaskDescriptionHeartbeat = "heartbeat"
TaskDescriptionStranded = "stranded"
TaskDescriptionNoResults = "expected test results, but none attached"
// Task Statuses that are currently used only by the UI, and in tests
// (these may be used in old tasks)
TaskSystemUnresponse = "system-unresponsive"
TaskSystemTimedOut = "system-timed-out"
TaskTimedOut = "task-timed-out"
// TaskConflict is used only in communication with the Agent
TaskConflict = "task-conflict"
TestFailedStatus = "fail"
TestSilentlyFailedStatus = "silentfail"
TestSkippedStatus = "skip"
TestSucceededStatus = "pass"
BuildStarted = "started"
BuildCreated = "created"
BuildFailed = "failed"
BuildSucceeded = "success"
VersionStarted = "started"
VersionCreated = "created"
VersionFailed = "failed"
VersionSucceeded = "success"
PatchCreated = "created"
PatchStarted = "started"
PatchSucceeded = "succeeded"
PatchFailed = "failed"
PatchAllOutcomes = "*"
PushLogPushing = "pushing"
PushLogSuccess = "success"
HostTypeStatic = "static"
MergeTestStarted = "started"
MergeTestSucceeded = "succeeded"
MergeTestFailed = "failed"
EnqueueFailed = "failed to enqueue"
// maximum task (zero based) execution number
MaxTaskExecution = 9
// maximum task priority
MaxTaskPriority = 100
DisabledTaskPriority = int64(-1)
// LogMessage struct versions
LogmessageFormatTimestamp = 1
LogmessageCurrentVersion = LogmessageFormatTimestamp
DefaultEvergreenConfig = ".evergreen.yml"
EvergreenHome = "EVGHOME"
MongodbUrl = "MONGO_URL"
MongodbAuthFile = "MONGO_CREDS_FILE"
// Special logging output targets
LocalLoggingOverride = "LOCAL"
StandardOutputLoggingOverride = "STDOUT"
DefaultTaskActivator = ""
StepbackTaskActivator = "stepback"
APIServerTaskActivator = "apiserver"
// Restart Types
RestartVersions = "versions"
RestartTasks = "tasks"
RestRoutePrefix = "rest"
APIRoutePrefix = "api"
AgentAPIVersion = 2
APIRoutePrefixV2 = "/rest/v2"
AgentMonitorTag = "agent-monitor"
HostFetchTag = "host-fetch"
DegradedLoggingPercent = 10
SetupScriptName = "setup.sh"
TempSetupScriptName = "setup-temp.sh"
PowerShellSetupScriptName = "setup.ps1"
PowerShellTempSetupScriptName = "setup-temp.ps1"
RoutePaginatorNextPageHeaderKey = "Link"
PlannerVersionLegacy = "legacy"
PlannerVersionTunable = "tunable"
DispatcherVersionLegacy = "legacy"
DispatcherVersionRevised = "revised"
DispatcherVersionRevisedWithDependencies = "revised-with-dependencies"
// maximum turnaround we want to maintain for all hosts for a given distro
MaxDurationPerDistroHost = 30 * time.Minute
MaxDurationPerDistroHostWithContainers = 2 * time.Minute
// Spawn hosts
SpawnHostExpireDays = 30
HostExpireDays = 10
ExpireOnFormat = "2006-01-02"
DefaultMaxSpawnHostsPerUser = 3
DefaultSpawnHostExpiration = 24 * time.Hour
SpawnHostNoExpirationDuration = 7 * 24 * time.Hour
MaxSpawnHostExpirationDurationHours = 24 * time.Hour * 14
UnattachedVolumeExpiration = 24 * time.Hour * 30
DefaultMaxVolumeSizePerUser = 500
DefaultUnexpirableHostsPerUser = 1
DefaultUnexpirableVolumesPerUser = 1
// host resource tag names
TagName = "name"
TagDistro = "distro"
TagEvergreenService = "evergreen-service"
TagUsername = "username"
TagOwner = "owner"
TagMode = "mode"
TagStartTime = "start-time"
TagExpireOn = "expire-on"
FinderVersionLegacy = "legacy"
FinderVersionParallel = "parallel"
FinderVersionPipeline = "pipeline"
FinderVersionAlternate = "alternate"
HostAllocatorDeficit = "deficit"
HostAllocatorUtilization = "utilization"
HostAllocatorRoundDown = "round-down"
HostAllocatorRoundUp = "round-up"
HostAllocatorRoundDefault = ""
HostAllocatorWaitsOverThreshFeedback = "waits-over-thresh-feedback"
HostAllocatorNoFeedback = "no-feedback"
HostAllocatorUseDefaultFeedback = ""
HostsOverallocatedTerminate = "terminate-hosts-when-overallocated"
HostsOverallocatedIgnore = "no-terminations-when-overallocated"
HostsOverallocatedUseDefault = ""
// CommitQueueAlias and GithubPRAlias are special aliases to specify variants and tasks for commit queue and GitHub PR patches
CommitQueueAlias = "__commit_queue"
GithubPRAlias = "__github"
GithubChecksAlias = "__github_checks"
GitTagAlias = "__git_tag"
MergeTaskVariant = "commit-queue-merge"
MergeTaskName = "merge-patch"
MergeTaskGroup = "merge-task-group"
DefaultJasperPort = 2385
GlobalGitHubTokenExpansion = "global_github_oauth_token"
VSCodePort = 2021
// DefaultTaskSyncAtEndTimeout is the default timeout for task sync at the
// end of a patch.
DefaultTaskSyncAtEndTimeout = time.Hour
DefaultShutdownWaitSeconds = 10
RetryGenerateTasksError = "error saving config in `generate.tasks`"
)
var InternalAliases []string = []string{
CommitQueueAlias,
GithubPRAlias,
GithubChecksAlias,
GitTagAlias,
}
var TaskFailureStatuses []string = []string{
TaskTimedOut,
TaskFailed,
TaskSystemFailed,
TaskTestTimedOut,
TaskSetupFailed,
TaskSystemUnresponse,
TaskSystemTimedOut,
}
var TaskUnstartedStatuses []string = []string{
TaskInactive,
TaskUnstarted,
TaskUndispatched,
}
func IsUnstartedTaskStatus(status string) bool {
return utility.StringSliceContains(TaskUnstartedStatuses, status)
}
func IsFinishedTaskStatus(status string) bool {
if status == TaskSucceeded ||
IsFailedTaskStatus(status) {
return true
}
return false
}
func IsFailedTaskStatus(status string) bool {
return utility.StringSliceContains(TaskFailureStatuses, status)
}
func IsFinishedPatchStatus(status string) bool {
return status == PatchFailed || status == PatchSucceeded
}
func IsFinishedBuildStatus(status string) bool {
return status == BuildFailed || status == BuildSucceeded
}
func IsFinishedVersionStatus(status string) bool {
return status == VersionFailed || status == VersionSucceeded
}
func VersionStatusToPatchStatus(versionStatus string) (string, error) {
switch versionStatus {
case VersionCreated:
return PatchCreated, nil
case VersionStarted:
return PatchStarted, nil
case VersionFailed:
return PatchFailed, nil
case VersionSucceeded:
return PatchSucceeded, nil
default:
return "", errors.New("unknown version status")
}
}
// evergreen package names
const (
UIPackage = "EVERGREEN_UI"
RESTV2Package = "EVERGREEN_REST_V2"
MonitorPackage = "EVERGREEN_MONITOR"
)
const (
AuthTokenCookie = "mci-token"
TaskHeader = "Task-Id"
TaskSecretHeader = "Task-Secret"
HostHeader = "Host-Id"
HostSecretHeader = "Host-Secret"
PodHeader = "Pod-Id"
PodSecretHeader = "Pod-Secret"
ContentTypeHeader = "Content-Type"
ContentTypeValue = "application/json"
ContentLengthHeader = "Content-Length"
APIUserHeader = "Api-User"
APIKeyHeader = "Api-Key"
)
const (
CredentialsCollection = "credentials"
CAName = "evergreen"
)
// cloud provider related constants
const (
ProviderNameEc2Auto = "ec2-auto"
ProviderNameEc2OnDemand = "ec2-ondemand"
ProviderNameEc2Spot = "ec2-spot"
ProviderNameEc2Fleet = "ec2-fleet"
ProviderNameDocker = "docker"
ProviderNameDockerMock = "docker-mock"
ProviderNameGce = "gce"
ProviderNameStatic = "static"
ProviderNameOpenstack = "openstack"
ProviderNameVsphere = "vsphere"
ProviderNameMock = "mock"
// Default EC2 region where hosts should be spawned
DefaultEC2Region = "us-east-1"
// This is Amazon's EBS type default
DefaultEBSType = "gp2"
// This may be a temporary default
DefaultEBSAvailabilityZone = "us-east-1a"
)
var (
// Providers where hosts can be created and terminated automatically.
ProviderSpawnable = []string{
ProviderNameEc2OnDemand,
ProviderNameEc2Spot,
ProviderNameEc2Auto,
ProviderNameEc2Fleet,
ProviderNameGce,
ProviderNameOpenstack,
ProviderNameVsphere,
ProviderNameMock,
ProviderNameDocker,
}
// Providers that are spawnable by users
ProviderUserSpawnable = []string{
ProviderNameEc2OnDemand,
ProviderNameEc2Spot,
ProviderNameEc2Auto,
ProviderNameEc2Fleet,
ProviderNameGce,
ProviderNameOpenstack,
ProviderNameVsphere,
}
ProviderContainer = []string{
ProviderNameDocker,
}
SystemVersionRequesterTypes = []string{
RepotrackerVersionRequester,
TriggerRequester,
GitTagRequester,
}
ProviderSpotEc2Type = []string{
ProviderNameEc2Auto,
ProviderNameEc2Spot,
ProviderNameEc2Fleet,
}
)
const (
DefaultServiceConfigurationFileName = "/etc/mci_settings.yml"
DefaultDatabaseUrl = "mongodb://localhost:27017"
DefaultDatabaseName = "mci"
DefaultDatabaseWriteMode = "majority"
DefaultDatabaseReadMode = "majority"
// database and config directory, set to the testing version by default for safety
NotificationsFile = "mci-notifications.yml"
ClientDirectory = "clients"
// version requester types
PatchVersionRequester = "patch_request"
GithubPRRequester = "github_pull_request"
GitTagRequester = "git_tag_request"
RepotrackerVersionRequester = "gitter_request"
TriggerRequester = "trigger_request"
MergeTestRequester = "merge_test"
AdHocRequester = "ad_hoc"
)
const (
GenerateTasksCommandName = "generate.tasks"
HostCreateCommandName = "host.create"
S3PushCommandName = "s3.push"
S3PullCommandName = "s3.pull"
)
type SenderKey int
const (
SenderGithubStatus = SenderKey(iota)
SenderEvergreenWebhook
SenderSlack
SenderJIRAIssue
SenderJIRAComment
SenderEmail
SenderGeneric
)
func (k SenderKey) Validate() error {
switch k {
case SenderGithubStatus, SenderEvergreenWebhook, SenderSlack, SenderJIRAComment, SenderJIRAIssue,
SenderEmail, SenderGeneric:
return nil
default:
return errors.New("invalid sender defined")
}
}
func (k SenderKey) String() string {
switch k {
case SenderGithubStatus:
return "github-status"
case SenderEmail:
return "email"
case SenderEvergreenWebhook:
return "webhook"
case SenderSlack:
return "slack"
case SenderJIRAComment:
return "jira-comment"
case SenderJIRAIssue:
return "jira-issue"
case SenderGeneric:
return "generic"
default:
return "<error:unknown>"
}
}
// Recognized architectures, should be in the form ${GOOS}_${GOARCH}.
const (
ArchDarwinAmd64 = "darwin_amd64"
ArchDarwinArm64 = "darwin_arm64"
ArchLinux386 = "linux_386"
ArchLinuxPpc64le = "linux_ppc64le"
ArchLinuxS390x = "linux_s390x"
ArchLinuxArm64 = "linux_arm64"
ArchLinuxAmd64 = "linux_amd64"
ArchWindows386 = "windows_386"
ArchWindowsAmd64 = "windows_amd64"
)
// NameTimeFormat is the format in which to log times like instance start time.
const NameTimeFormat = "20060102150405"
var (
PatchRequesters = []string{
PatchVersionRequester,
GithubPRRequester,
MergeTestRequester,
}
// UpHostStatus is a list of all host statuses that are considered up.
UpHostStatus = []string{
HostRunning,
HostUninitialized,
HostBuilding,
HostStarting,
HostProvisioning,
HostProvisionFailed,
HostStopping,
HostStopped,
}
StartedHostStatus = []string{
HostBuilding,
HostStarting,
}
// ProvisioningHostStatus describes hosts that have started,
// but have not yet completed the provisioning process.
ProvisioningHostStatus = []string{
HostStarting,
HostProvisioning,
HostProvisionFailed,
HostBuilding,
}
// DownHostStatus is a list of all host statuses that are considered down.
DownHostStatus = []string{
HostTerminated,
HostQuarantined,
HostDecommissioned,
}
// NotRunningStatus is a list of host statuses from before the host starts running.
NotRunningStatus = []string{
HostUninitialized,
HostBuilding,
HostProvisioning,
HostStarting,
}
// Hosts in "initializing" status aren't actually running yet:
// they're just intents, so this list omits that value.
ActiveStatus = []string{
HostRunning,
HostBuilding,
HostStarting,
HostProvisioning,
HostProvisionFailed,
HostStopping,
HostStopped,
}
// Set of host status values that can be user set via the API
ValidUserSetStatus = []string{
HostRunning,
HostTerminated,
HostQuarantined,
HostDecommissioned,
}
// Set of valid PlannerSettings.Version strings that can be user set via the API
ValidTaskPlannerVersions = []string{
PlannerVersionLegacy,
PlannerVersionTunable,
}
// Set of valid DispatchSettings.Version strings that can be user set via the API
ValidTaskDispatcherVersions = []string{
DispatcherVersionLegacy,
DispatcherVersionRevised,
DispatcherVersionRevisedWithDependencies,
}
// Set of valid FinderSettings.Version strings that can be user set via the API
ValidTaskFinderVersions = []string{
FinderVersionLegacy,
FinderVersionParallel,
FinderVersionPipeline,
FinderVersionAlternate,
}
// Set of valid Host Allocators types
ValidHostAllocators = []string{
HostAllocatorUtilization,
}
ValidHostAllocatorRoundingRules = []string{
HostAllocatorRoundDown,
HostAllocatorRoundUp,
HostAllocatorRoundDefault,
}
ValidDefaultHostAllocatorRoundingRules = []string{
HostAllocatorRoundDown,
HostAllocatorRoundUp,
}
ValidHostAllocatorFeedbackRules = []string{
HostAllocatorWaitsOverThreshFeedback,
HostAllocatorNoFeedback,
HostAllocatorUseDefaultFeedback,
}
ValidDefaultHostAllocatorFeedbackRules = []string{
HostAllocatorWaitsOverThreshFeedback,
HostAllocatorNoFeedback,
}
ValidHostsOverallocatedRules = []string{
HostsOverallocatedUseDefault,
HostsOverallocatedIgnore,
HostsOverallocatedTerminate,
}
ValidDefaultHostsOverallocatedRules = []string{
HostsOverallocatedIgnore,
HostsOverallocatedTerminate,
}
// constant arrays for db update logic
AbortableStatuses = []string{TaskStarted, TaskDispatched}
CompletedStatuses = []string{TaskSucceeded, TaskFailed}
UncompletedStatuses = []string{TaskStarted, TaskUnstarted, TaskUndispatched, TaskDispatched, TaskConflict}
SyncStatuses = []string{TaskSucceeded, TaskFailed}
ValidCommandTypes = []string{CommandTypeSetup, CommandTypeSystem, CommandTypeTest}
// Map from valid architectures to display names
ValidArchDisplayNames = map[string]string{
ArchWindowsAmd64: "Windows 64-bit",
ArchLinuxPpc64le: "Linux PowerPC 64-bit",
ArchLinuxS390x: "Linux zSeries",
ArchLinuxArm64: "Linux ARM 64-bit",
ArchWindows386: "Windows 32-bit",
ArchDarwinAmd64: "OSX 64-bit",
ArchDarwinArm64: "OSX ARM 64-bit",
ArchLinuxAmd64: "Linux 64-bit",
ArchLinux386: "Linux 32-bit",
}
)
// FindEvergreenHome finds the directory of the EVGHOME environment variable.
func FindEvergreenHome() string {
// check if env var is set
root := os.Getenv(EvergreenHome)
if len(root) > 0 {
return root
}
grip.Errorf("%s is unset", EvergreenHome)
return ""
}
// IsSystemActivator returns true when the task activator is Evergreen.
func IsSystemActivator(caller string) bool {
return caller == DefaultTaskActivator || caller == APIServerTaskActivator
}
func IsPatchRequester(requester string) bool {
return requester == PatchVersionRequester || IsGitHubPatchRequester(requester)
}
func IsGitHubPatchRequester(requester string) bool {
return requester == GithubPRRequester || requester == MergeTestRequester
}
func IsGitTagRequester(requester string) bool {
return requester == GitTagRequester
}
func ShouldConsiderBatchtime(requester string) bool {
return !IsPatchRequester(requester) && requester != AdHocRequester && requester != GitTagRequester
}
// Permissions-related constants
func PermissionsDisabledForTests() bool {
return PermissionSystemDisabled
}
const (
SuperUserResourceType = "super_user"
ProjectResourceType = "project"
DistroResourceType = "distro"
AllProjectsScope = "all_projects"
UnrestrictedProjectsScope = "unrestricted_projects"
RestrictedProjectsScope = "restricted_projects"
AllDistrosScope = "all_distros"
)
type PermissionLevel struct {
Description string `json:"description"`
Value int `json:"value"`
}
var (
UnauthedUserRoles = []string{"unauthorized_project"}
ValidResourceTypes = []string{SuperUserResourceType, ProjectResourceType, DistroResourceType}
// SuperUserPermissions resource ID.
SuperUserPermissionsID = "super_user"
// Admin permissions.
PermissionAdminSettings = "admin_settings"
PermissionProjectCreate = "project_create"
PermissionDistroCreate = "distro_create"
PermissionRoleModify = "modify_roles"
// Project permissions.
PermissionProjectSettings = "project_settings"
PermissionProjectVariables = "project_variables"
PermissionGitTagVersions = "project_git_tags"
PermissionTasks = "project_tasks"
PermissionAnnotations = "project_task_annotations"
PermissionPatches = "project_patches"
PermissionLogs = "project_logs"
// Distro permissions.
PermissionDistroSettings = "distro_settings"
PermissionHosts = "distro_hosts"
)
// permission levels
var (
AdminSettingsEdit = PermissionLevel{
Description: "Edit admin settings",
Value: 10,
}
ProjectCreate = PermissionLevel{
Description: "Create new projects",
Value: 10,
}
DistroCreate = PermissionLevel{
Description: "Create new distros",
Value: 10,
}
RoleModify = PermissionLevel{
Description: "Modify system roles and permissions",
Value: 10,
}
ProjectSettingsEdit = PermissionLevel{
Description: "Edit project settings",
Value: 20,
}
ProjectSettingsView = PermissionLevel{
Description: "View project settings",
Value: 10,
}
ProjectSettingsNone = PermissionLevel{
Description: "No project settings permissions",
Value: 0,
}
GitTagVersionsCreate = PermissionLevel{
Description: "Create versions with git tags",
Value: 10,
}
GitTagVersionsNone = PermissionLevel{
Description: "Not able to create versions with git tags",
Value: 0,
}
AnnotationsModify = PermissionLevel{
Description: "Modify annotations",
Value: 20,
}
AnnotationsView = PermissionLevel{
Description: "View annotations",
Value: 10,
}
AnnotationsNone = PermissionLevel{
Description: "No annotations permissions",
Value: 0,
}
TasksAdmin = PermissionLevel{
Description: "Full tasks permissions",
Value: 30,
}
TasksBasic = PermissionLevel{
Description: "Basic modifications to tasks",
Value: 20,
}
TasksView = PermissionLevel{
Description: "View tasks",
Value: 10,
}
TasksNone = PermissionLevel{
Description: "Not able to view or edit tasks",
Value: 0,
}
PatchSubmit = PermissionLevel{
Description: "Submit and edit patches",
Value: 10,
}
PatchNone = PermissionLevel{
Description: "Not able to view or submit patches",
Value: 0,
}
LogsView = PermissionLevel{
Description: "View logs",
Value: 10,
}
LogsNone = PermissionLevel{
Description: "Not able to view logs",
Value: 0,
}
DistroSettingsAdmin = PermissionLevel{
Description: "Remove distro and edit distro settings",
Value: 30,
}
DistroSettingsEdit = PermissionLevel{
Description: "Edit distro settings",
Value: 20,
}
DistroSettingsView = PermissionLevel{
Description: "View distro settings",
Value: 10,
}
DistroSettingsNone = PermissionLevel{
Description: "No distro settings permissions",
Value: 0,
}
HostsEdit = PermissionLevel{
Description: "Edit hosts",
Value: 20,
}
HostsView = PermissionLevel{
Description: "View hosts",
Value: 10,
}
HostsNone = PermissionLevel{
Description: "No hosts permissions",
Value: 0,
}
)
// GetDisplayNameForPermissionKey gets the display name associated with a permission key
func GetDisplayNameForPermissionKey(permissionKey string) string {
switch permissionKey {
case PermissionProjectSettings:
return "Project Settings"
case PermissionTasks:
return "Tasks"
case PermissionAnnotations:
return "Task Annotations"
case PermissionPatches:
return "Patches"
case PermissionGitTagVersions:
return "Git Tag Versions"
case PermissionLogs:
return "Logs"
case PermissionDistroSettings:
return "Distro Settings"
case PermissionHosts:
return "Distro Hosts"
default:
return ""
}
}
// GetPermissionLevelsForPermissionKey gets all permissions associated with a permission key
func GetPermissionLevelsForPermissionKey(permissionKey string) []PermissionLevel {
switch permissionKey {
case PermissionProjectSettings:
return []PermissionLevel{
ProjectSettingsEdit,
ProjectSettingsView,
ProjectSettingsNone,
}
case PermissionTasks:
return []PermissionLevel{
TasksAdmin,
TasksBasic,
TasksView,
TasksNone,
}
case PermissionAnnotations:
return []PermissionLevel{
AnnotationsModify,
AnnotationsView,
AnnotationsNone,
}
case PermissionPatches:
return []PermissionLevel{
PatchSubmit,
PatchNone,
}
case PermissionGitTagVersions:
return []PermissionLevel{
GitTagVersionsCreate,
GitTagVersionsNone,
}
case PermissionLogs:
return []PermissionLevel{
LogsView,
LogsNone,
}
case PermissionDistroSettings:
return []PermissionLevel{
DistroSettingsEdit,
DistroSettingsView,
DistroSettingsNone,
}
case PermissionHosts:
return []PermissionLevel{
HostsEdit,
HostsView,
HostsNone,
}
default:
return []PermissionLevel{}
}
}
// If adding a new type of permissions, i.e. a new array of permission keys, then you must:
// 1. Add a new field in the APIPermissions model for those permissions.
// 2. Populate the value of that APIPermissions field with the getPermissions function in rest/route/permissions.go
var ProjectPermissions = []string{
PermissionProjectSettings,
PermissionTasks,
PermissionAnnotations,
PermissionPatches,
PermissionGitTagVersions,
PermissionLogs,
}
var DistroPermissions = []string{
PermissionDistroSettings,
PermissionHosts,
}
var SuperuserPermissions = []string{
PermissionAdminSettings,
PermissionProjectCreate,
PermissionDistroCreate,
PermissionRoleModify,
}
// Evergreen log types
const (
LogTypeAgent = "agent_log"
LogTypeTask = "task_log"
LogTypeSystem = "system_log"
)
// PodPlatform represents recognized platforms for pods.
type PodPlatform string
const (
// PodPlatformLinux is the platform to run pods with Linux containers.
PodPlatformLinux PodPlatform = "linux"
// PodPlatformWindows is the platform to run pods with Windows containers.
PodPlatformWindows PodPlatform = "windows"
)
// Validate checks that the given pod platform is recognized.
func (p PodPlatform) Validate() error {
switch p {
case PodPlatformLinux, PodPlatformWindows:
return nil
default:
return errors.Errorf("unrecognized pod platform '%s'", p)
}
}