summaryrefslogtreecommitdiffstats
path: root/ci/github-script/check-target-branch-policy.test.ts
blob: 1dd5d28e768f40f2b556416cd20d7ac8e56dab66 (plain)
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
import assert from 'node:assert/strict'
import test from 'node:test'
import { evaluateTargetBranchPolicy } from './check-target-branch-policy.ts'

type DecisionFacts = {
  base: string
  head: string
  maxRebuildCount: number
  rebuildsAllTests: boolean
  onlyChangedFile: string | null
}

type Decision =
  | 'mass-rebuild'
  | 'nixos-rebuild'
  | 'possible-mass-rebuild'
  | 'skip-development-merge'
  | 'dismiss'

const defaults: DecisionFacts = {
  base: 'master',
  head: 'topic-branch',
  maxRebuildCount: 0,
  rebuildsAllTests: false,
  onlyChangedFile: null,
}

const cases: Array<{
  name: string
  facts: Partial<DecisionFacts>
  expected: Decision
}> = [
  {
    name: 'allows fewer than 500 rebuilds on master',
    facts: { maxRebuildCount: 499 },
    expected: 'dismiss',
  },
  {
    name: 'flags 500 rebuilds on master as a possible mass rebuild',
    facts: { maxRebuildCount: 500 },
    expected: 'possible-mass-rebuild',
  },
  {
    name: 'flags 999 rebuilds on master as a possible mass rebuild',
    facts: { maxRebuildCount: 999 },
    expected: 'possible-mass-rebuild',
  },
  {
    name: 'flags 1000 rebuilds on master as a mass rebuild',
    facts: { maxRebuildCount: 1000 },
    expected: 'mass-rebuild',
  },
  {
    name: 'flags a mass rebuild on staging-nixos',
    facts: { base: 'staging-nixos', maxRebuildCount: 24_000 },
    expected: 'mass-rebuild',
  },
  {
    name: 'flags a mass rebuild on a release staging-nixos branch',
    facts: { base: 'staging-nixos-26.05', maxRebuildCount: 1000 },
    expected: 'mass-rebuild',
  },
  {
    name: 'allows mass rebuilds on staging',
    facts: { base: 'staging', maxRebuildCount: 1000 },
    expected: 'dismiss',
  },
  {
    name: 'flags a mass rebuild on a release branch',
    facts: { base: 'release-26.05', maxRebuildCount: 1000 },
    expected: 'mass-rebuild',
  },
  {
    name: 'flags NixOS test rebuilds on master',
    facts: { rebuildsAllTests: true },
    expected: 'nixos-rebuild',
  },
  {
    name: 'flags NixOS test rebuilds on a release branch',
    facts: { base: 'release-26.05', rebuildsAllTests: true },
    expected: 'nixos-rebuild',
  },
  {
    name: 'allows NixOS test rebuilds on staging-nixos',
    facts: { base: 'staging-nixos', rebuildsAllTests: true },
    expected: 'dismiss',
  },
  {
    name: 'does not flag a possible mass rebuild when staging-nixos rebuilds all NixOS tests',
    facts: {
      base: 'staging-nixos',
      maxRebuildCount: 500,
      rebuildsAllTests: true,
    },
    expected: 'dismiss',
  },
  {
    name: 'flags other possible mass rebuilds on staging-nixos',
    facts: { base: 'staging-nixos', maxRebuildCount: 500 },
    expected: 'possible-mass-rebuild',
  },
  {
    name: 'skips staging into master',
    facts: {
      head: 'staging',
      maxRebuildCount: 24_000,
    },
    expected: 'skip-development-merge',
  },
  {
    name: 'skips staging-nixos into master',
    facts: {
      head: 'staging-nixos',
      maxRebuildCount: 24_000,
    },
    expected: 'skip-development-merge',
  },
  {
    name: 'skips master into staging-nixos',
    facts: {
      base: 'staging-nixos',
      head: 'master',
      maxRebuildCount: 24_000,
    },
    expected: 'skip-development-merge',
  },
  {
    name: 'checks staging into staging-nixos',
    facts: {
      base: 'staging-nixos',
      head: 'staging',
      maxRebuildCount: 24_000,
    },
    expected: 'mass-rebuild',
  },
  {
    name: 'skips release staging-nixos into its release branch',
    facts: {
      base: 'release-26.05',
      head: 'staging-nixos-26.05',
      maxRebuildCount: 24_000,
    },
    expected: 'skip-development-merge',
  },
  {
    name: 'skips a release branch into its staging-nixos branch',
    facts: {
      base: 'staging-nixos-26.05',
      head: 'release-26.05',
      maxRebuildCount: 24_000,
    },
    expected: 'skip-development-merge',
  },
  {
    name: 'checks release staging into its staging-nixos branch',
    facts: {
      base: 'staging-nixos-26.05',
      head: 'staging-26.05',
      maxRebuildCount: 24_000,
    },
    expected: 'mass-rebuild',
  },
  {
    name: 'kernels-org exemption suppresses a possible mass rebuild',
    facts: {
      maxRebuildCount: 999,
      onlyChangedFile: 'pkgs/os-specific/linux/kernel/kernels-org.json',
    },
    expected: 'dismiss',
  },
  {
    name: 'kernels-org exemption suppresses a definite mass rebuild',
    facts: {
      maxRebuildCount: 1000,
      onlyChangedFile: 'pkgs/os-specific/linux/kernel/kernels-org.json',
    },
    expected: 'dismiss',
  },
  {
    name: 'kernels-org exemption suppresses a NixOS test rebuild',
    facts: {
      rebuildsAllTests: true,
      onlyChangedFile: 'pkgs/os-specific/linux/kernel/kernels-org.json',
    },
    expected: 'dismiss',
  },
  {
    name: 'xanmod kernel exemption suppresses a possible mass rebuild',
    facts: {
      maxRebuildCount: 999,
      onlyChangedFile: 'pkgs/os-specific/linux/kernel/xanmod-kernels.nix',
    },
    expected: 'dismiss',
  },
  {
    name: 'xanmod kernel exemption suppresses a definite mass rebuild',
    facts: {
      maxRebuildCount: 1000,
      onlyChangedFile: 'pkgs/os-specific/linux/kernel/xanmod-kernels.nix',
    },
    expected: 'dismiss',
  },
  {
    name: 'xanmod kernel exemption suppresses a NixOS test rebuild',
    facts: {
      rebuildsAllTests: true,
      onlyChangedFile: 'pkgs/os-specific/linux/kernel/xanmod-kernels.nix',
    },
    expected: 'dismiss',
  },
  {
    name: 'Home Assistant exemption suppresses a mass rebuild',
    facts: {
      head: 'wip-home-assistant',
      maxRebuildCount: 1500,
    },
    expected: 'dismiss',
  },
  {
    name: 'does not exempt a Home Assistant update above 1500 rebuilds',
    facts: { head: 'wip-home-assistant', maxRebuildCount: 1501 },
    expected: 'mass-rebuild',
  },
  {
    name: 'Home Assistant exemption does not suppress a NixOS test rebuild',
    facts: {
      head: 'wip-home-assistant',
      maxRebuildCount: 1500,
      rebuildsAllTests: true,
    },
    expected: 'nixos-rebuild',
  },
]

for (const { name, facts, expected } of cases) {
  test(name, () => {
    assert.equal(
      evaluateTargetBranchPolicy({ ...defaults, ...facts }).decision,
      expected,
    )
  })
}