annotations.ts

import { describe, expect, test } from 'vitest'
import cheerio from 'cheerio'

import { getDOM } from '@/tests/helpers/e2etest'

describe('annotations', () => {
  test('code-snippet-with-hashbang', async () => {
    const $: cheerio.Root = await getDOM('/get-started/foo/code-snippet-with-hashbang')
    const annotations = $('#article-contents .annotate')

    // Check http://localhost:4000/en/get-started/foo/code-snippet-with-hashbang
    // to understand the confidence in the assertions.

    // This fixture page has 2 bash annotations and 1 yaml
    expect(annotations.length).toBe(2 + 1)

    // First code snippet block
    {
      const annotation = annotations.eq(0)
      expect(annotation.find('.annotate-header').length).toBe(1)
      expect(annotation.find('.annotate-beside').length).toBe(1)
      expect(annotation.find('.annotate-inline').length).toBe(1)
      expect(annotation.find('.annotate-row').length).toBe(3)
      const notes = $('.annotate-row .annotate-note p', annotation)
      const noteTexts = notes.map((_, el) => $(el).text()).get()
      expect(noteTexts).toEqual(["Let's get started", 'This is just a sample', 'End of the script'])
    }
    // Second code snippet block
    {
      const annotation = annotations.eq(1)
      expect(annotation.find('.annotate-header').length).toBe(1)
      expect(annotation.find('.annotate-beside').length).toBe(1)
      expect(annotation.find('.annotate-inline').length).toBe(1)
      expect(annotation.find('.annotate-row').length).toBe(2)
      const notes = $('.annotate-row .annotate-note p', annotation)
      const noteTexts = notes.map((_, el) => $(el).text()).get()
      expect(noteTexts).toEqual(['Has to start with a comment.', 'This is the if statement'])
    }
    // Yaml code snippet that starts with an empty comment
    {
      const annotation = annotations.eq(2)
      expect(annotation.find('.annotate-header').length).toBe(1)
      expect(annotation.find('.annotate-beside').length).toBe(1)
      expect(annotation.find('.annotate-inline').length).toBe(1)
      expect(annotation.find('.annotate-row').length).toBe(3)
      const notes = $('.annotate-row .annotate-note p', annotation)
      const noteTexts = notes.map((_, el) => $(el).text()).get()
      expect(noteTexts).toEqual([
        'Configures this workflow to run every time a change is pushed to the branch called release.',
        "This job checks out the repository contents ...\nAnd here's the second comment line.",
      ])
    }
  })
})