src/release-notes/tests/yaml.ts

import { readFile } from 'fs/promises'
import walk from 'walk-sync'
import path from 'path'

import { beforeAll, describe, expect, test } from 'vitest'
import yaml from 'js-yaml'

import { liquid } from '@/content-render/index'
import { getDataByLanguage } from '@/data-directory/lib/get-data'
import { allVersions } from '@/versions/lib/all-versions'

interface ReleaseNoteContent {
  intro: string
  sections: {
    [key: string]: Array<string | { [prop: string]: string }>
  }
  currentWeek?: boolean
}

const ghesReleaseNoteRootPath = 'data/release-notes'
const yamlWalkOptions = {
  globs: ['**/*.yml'],
  directories: false,
  includeBasePath: true,
}
const yamlFileList = walk(ghesReleaseNoteRootPath, yamlWalkOptions).sort()

describe('lint enterprise release notes', () => {
  if (yamlFileList.length < 1) return
  describe.each(yamlFileList)('%s', (yamlAbsPath) => {
    let yamlContent: ReleaseNoteContent
    const relativePath = path.relative('', yamlAbsPath)

    beforeAll(async () => {
      const fileContents = await readFile(yamlAbsPath, 'utf8')
      yamlContent = yaml.load(fileContents) as ReleaseNoteContent
    })

    test('contains valid liquid', async () => {
      const { intro, sections } = yamlContent
      let toLint: Record<string, string> = { intro }
      for (const key in sections) {
        const section = sections[key]
        const label = `sections.${key}`
        for (const part of section) {
          if (Array.isArray(part)) {
            toLint = { ...toLint, ...{ [label]: section.join('\n') } }
          } else {
            for (const prop in section) {
              const value = section[prop]
              if (typeof value === 'string') {
                toLint = { ...toLint, ...{ [`${label}.${prop}`]: value } }
              }
            }
          }
        }
      }

      // Create context with site data for rendering liquid variables
      const context = {
        currentLanguage: 'en',
        currentVersionObj: allVersions['free-pro-team@latest'],
        site: {
          data: {
            reusables: getDataByLanguage('reusables', 'en'),
            variables: getDataByLanguage('variables', 'en'),
            ui: getDataByLanguage('ui', 'en'),
          },
        },
      }

      for (const key in toLint) {
        if (!toLint[key]) continue
        // First check if liquid parses correctly
        expect(() => liquid.parse(toLint[key]), `${key} contains invalid liquid`).not.toThrow()
        // Then check if liquid renders correctly with context
        await expect(
          liquid.parseAndRender(toLint[key], context),
          `${key} contains liquid that fails to render`,
        ).resolves.not.toThrow()
      }
    })

    const currentWeeksFound: string[] = []
    test('does not have more than one yaml file with currentWeek set to true', () => {
      if (!yamlAbsPath.includes('data/release-notes/github-ae')) return
      if (yamlContent.currentWeek) currentWeeksFound.push(relativePath)
      const errorMessage = `Found more than one file with currentWeek set to true: ${currentWeeksFound.join(
        '\n',
      )}`
      expect(currentWeeksFound.length, errorMessage).not.toBeGreaterThan(1)
    })
  })
})