Normalize CRLF in the gate guard parsing; cover it with a test

Author: dmerand

bin/check-ci-gates.js

@@ -13,7 +13,8 @@ import {MANIFEST_JOB_IDS} from './ci-gates.js'
 // (up to the next top-level key) and allow a trailing comment after the id. Job
 // keys are always bare (their mapping is on following lines), so nested keys —
 // indented deeper than 2 spaces — and `key: value` anchors are naturally excluded.
-export function parseJobIds(workflow) {
+export function parseJobIds(workflowText) {
+  const workflow = workflowText.replace(/\r\n/g, '\n')
   const jobsAt = workflow.search(/^jobs:/m)
   if (jobsAt === -1) return []
   const afterHeader = workflow.slice(jobsAt).replace(/^jobs:.*\n/, '')
@@ -24,9 +25,13 @@ export function parseJobIds(workflow) {
 
 // Pure and testable: given the two YAML texts and the manifest job ids, return the
 // list of human-readable problems (empty when everything is in sync).
-export function findProblems({workflow, devYml, manifestJobIds}) {
+export function findProblems({workflow: workflowText, devYml: devYmlText, manifestJobIds}) {
   const problems = []
 
+  // Normalize line endings so the parsing below is robust to CRLF working trees.
+  const workflow = workflowText.replace(/\r\n/g, '\n')
+  const devYml = devYmlText.replace(/\r\n/g, '\n')
+
   const workflowJobIds = parseJobIds(workflow)
   const manifestSet = new Set(manifestJobIds)
   const workflowSet = new Set(workflowJobIds)

bin/check-ci-gates.test.js

@@ -52,3 +52,10 @@ test('parseJobIds tolerates comments and ignores non-job lines', () => {
 test('parseJobIds returns empty when there is no jobs block', () => {
   assert.deepEqual(parseJobIds('name: t\non: push\n'), [])
 })
+
+test('CRLF line endings are handled', () => {
+  const wf = workflow(['a', 'b']).replace(/\n/g, '\r\n')
+  assert.deepEqual(parseJobIds(wf), ['a', 'b'])
+  const {problems} = findProblems({workflow: wf, devYml: devYml().replace(/\n/g, '\r\n'), manifestJobIds: ['a', 'b']})
+  assert.deepEqual(problems, [])
+})