chore: import upstream snapshot with attribution

tools/challenge-parser/parser/plugins/add-quizzes.test.js

@@ -0,0 +1,285 @@
+import { describe, beforeAll, beforeEach, it, expect } from 'vitest';
+import parseFixture from './../__fixtures__/parse-fixture';
+import addQuizzes from './add-quizzes';
+
+describe('add-quizzes plugin', () => {
+  let mockQuizzesAST;
+  let chineseQuizzesAST;
+  let quizzesWithAudioAST;
+  let quizzesWithAudioInvalidJsonAST;
+  let quizzesWithAudioMissingFilenameAST;
+  let quizzesWithAudioTranscriptNotArrayAST;
+  let quizzesWithAudioEmptyTranscriptAST;
+  let quizzesWithAudioMissingTranscriptAST;
+  let quizzesWithAudioTranscriptMissingCharacterAST;
+  let quizzesWithAudioTranscriptMissingTextAST;
+  let quizzesWithAudioNotJsonCodeBlockAST;
+  const plugin = addQuizzes();
+  let file = { data: {} };
+
+  beforeAll(async () => {
+    mockQuizzesAST = await parseFixture('with-quizzes.md');
+    chineseQuizzesAST = await parseFixture('with-chinese-quizzes.md');
+    quizzesWithAudioAST = await parseFixture('with-quizzes-audio.md');
+    quizzesWithAudioInvalidJsonAST = await parseFixture(
+      'with-quizzes-audio-invalid-json.md'
+    );
+    quizzesWithAudioMissingFilenameAST = await parseFixture(
+      'with-quizzes-audio-missing-filename.md'
+    );
+    quizzesWithAudioTranscriptNotArrayAST = await parseFixture(
+      'with-quizzes-audio-transcript-not-array.md'
+    );
+    quizzesWithAudioEmptyTranscriptAST = await parseFixture(
+      'with-quizzes-audio-empty-transcript.md'
+    );
+    quizzesWithAudioMissingTranscriptAST = await parseFixture(
+      'with-quizzes-audio-missing-transcript.md'
+    );
+    quizzesWithAudioTranscriptMissingCharacterAST = await parseFixture(
+      'with-quizzes-audio-transcript-missing-character.md'
+    );
+    quizzesWithAudioTranscriptMissingTextAST = await parseFixture(
+      'with-quizzes-audio-transcript-missing-text.md'
+    );
+    quizzesWithAudioNotJsonCodeBlockAST = await parseFixture(
+      'with-quizzes-audio-not-json-code-block.md'
+    );
+  });
+
+  beforeEach(() => {
+    file = { data: {} };
+  });
+
+  it('returns a function', () => {
+    expect(typeof plugin).toEqual('function');
+  });
+
+  it('adds a `quizzes` property to `file.data`', () => {
+    plugin(mockQuizzesAST, file);
+
+    expect('quizzes' in file.data).toBe(true);
+  });
+
+  it('should generate a quizzes array from a quizzes challenge AST', () => {
+    expect.assertions(44);
+    plugin(mockQuizzesAST, file);
+
+    const quizzes = file.data.quizzes;
+    expect(Array.isArray(quizzes)).toBe(true);
+    expect(quizzes.length).toBe(2);
+
+    quizzes.forEach(quiz => {
+      expect(quiz).toHaveProperty('questions');
+      expect(Array.isArray(quiz.questions)).toBe(true);
+
+      const questions = quiz.questions;
+      expect(questions.length).toBe(2);
+
+      questions.forEach(question => {
+        expect(question).toHaveProperty('text');
+        expect(typeof question.text).toBe('string');
+        expect(question).toHaveProperty('answer');
+        expect(typeof question.answer).toBe('string');
+        expect(question).toHaveProperty('distractors');
+        expect(Array.isArray(question.distractors)).toBe(true);
+
+        const distractors = question.distractors;
+
+        distractors.forEach(distractor => {
+          expect(typeof distractor).toBe('string');
+        });
+      });
+    });
+  });
+
+  it('should match the quizzes snapshot', () => {
+    plugin(mockQuizzesAST, file);
+    expect(file.data).toMatchSnapshot();
+  });
+
+  it('should render Chinese hanzi (pinyin) in quizzes when lang is zh-CN and the text contains hanzi (pinyin) format', () => {
+    const zhFile = { data: { lang: 'zh-CN' } };
+    plugin(chineseQuizzesAST, zhFile);
+    const quizzes = zhFile.data.quizzes;
+    expect(Array.isArray(quizzes)).toBe(true);
+    expect(quizzes.length).toBe(1);
+
+    const firstQuiz = quizzes[0];
+    const firstQuestion = firstQuiz.questions[0];
+
+    // Quiz 1, Question 1
+    expect(firstQuestion.text).toBe(
+      '<p>Quiz 1, question 1 with <ruby>中文<rp>(</rp><rt>zhōng wén</rt><rp>)</rp></ruby></p>'
+    );
+    expect(firstQuestion.distractors[0]).toBe(
+      '<p>Quiz 1, question 1, distractor 1 with <ruby>中文<rp>(</rp><rt>zhōng wén</rt><rp>)</rp></ruby></p>'
+    );
+    expect(firstQuestion.distractors[1]).toBe(
+      '<p>Quiz 1, question 1, distractor 2 with <ruby>中文<rp>(</rp><rt>zhōng wén</rt><rp>)</rp></ruby></p>'
+    );
+    expect(firstQuestion.distractors[2]).toBe(
+      '<p>Quiz 1, question 1, distractor 3 with <ruby>中文<rp>(</rp><rt>zhōng wén</rt><rp>)</rp></ruby></p>'
+    );
+    expect(firstQuestion.answer).toBe(
+      '<p>Quiz 1, question 1, answer with <ruby>中文<rp>(</rp><rt>zhōng wén</rt><rp>)</rp></ruby></p>'
+    );
+    expect(firstQuestion.audioData.transcript).toEqual([
+      {
+        character: 'Wang Hua',
+        text: '<ruby>你好<rp>(</rp><rt>nǐ hǎo</rt><rp>)</rp></ruby>。'
+      }
+    ]);
+  });
+
+  it('should render Chinese in quizzes when lang is zh-CN and the text does not contain hanzi (pinyin) format', () => {
+    const zhFile = { data: { lang: 'zh-CN' } };
+    plugin(chineseQuizzesAST, zhFile);
+    const quizzes = zhFile.data.quizzes;
+
+    const firstQuiz = quizzes[0];
+    const secondQuestion = firstQuiz.questions[1];
+    const thirdQuestion = firstQuiz.questions[2];
+
+    // Quiz 1, Question 2
+    expect(secondQuestion.text).toBe(
+      '<p>Quiz 1, question 2 with <span class="highlighted-text">中文</span></p>'
+    );
+    expect(secondQuestion.distractors[0]).toBe(
+      '<p>Quiz 1, question 2, distractor 1 with <span class="highlighted-text">中文</span></p>'
+    );
+    expect(secondQuestion.distractors[1]).toBe(
+      '<p>Quiz 1, question 2, distractor 2 with <span class="highlighted-text">中文</span></p>'
+    );
+    expect(secondQuestion.distractors[2]).toBe(
+      '<p>Quiz 1, question 2, distractor 3 with <span class="highlighted-text">中文</span></p>'
+    );
+    expect(secondQuestion.answer).toBe(
+      '<p>Quiz 1, question 2, answer with <span class="highlighted-text">中文</span></p>'
+    );
+
+    // Quiz 1, Question 3
+    expect(thirdQuestion.text).toBe(
+      '<p>Quiz 1, question 3 with <span class="highlighted-text">zhōng wén</span></p>'
+    );
+    expect(thirdQuestion.distractors[0]).toBe(
+      '<p>Quiz 1, question 3, distractor 1 with <span class="highlighted-text">zhōng wén</span></p>'
+    );
+    expect(thirdQuestion.distractors[1]).toBe(
+      '<p>Quiz 1, question 3, distractor 2 with <span class="highlighted-text">zhōng wén</span></p>'
+    );
+    expect(thirdQuestion.distractors[2]).toBe(
+      '<p>Quiz 1, question 3, distractor 3 with <span class="highlighted-text">zhōng wén</span></p>'
+    );
+    expect(thirdQuestion.answer).toBe(
+      '<p>Quiz 1, question 3, answer with <span class="highlighted-text">zhōng wén</span></p>'
+    );
+  });
+
+  it('should parse audio sections in quiz questions', () => {
+    plugin(quizzesWithAudioAST, file);
+    const quizzes = file.data.quizzes;
+
+    expect(Array.isArray(quizzes)).toBe(true);
+    expect(quizzes.length).toBe(1);
+
+    const firstQuiz = quizzes[0];
+    const firstQuestion = firstQuiz.questions[0];
+    const secondQuestion = firstQuiz.questions[1];
+    const thirdQuestion = firstQuiz.questions[2];
+
+    // First question has audio with timestamps
+    expect(firstQuestion).toHaveProperty('audioData');
+    expect(firstQuestion.audioData.audio.filename).toBe(
+      'audio-with-timestamps.mp3'
+    );
+    expect(firstQuestion.audioData.audio.startTimestamp).toBe(1.5);
+    expect(firstQuestion.audioData.audio.finishTimestamp).toBe(3.8);
+    expect(firstQuestion.audioData.transcript).toEqual([
+      {
+        character: 'Maria',
+        text: 'Hello, how are you?'
+      },
+      {
+        character: 'Tom',
+        text: "I'm doing well, thank you."
+      }
+    ]);
+    expect(firstQuestion.text).toBe(
+      '<p>Quiz 1, question 1 with audio timestamps</p>'
+    );
+    expect(firstQuestion.distractors.length).toBe(3);
+    expect(firstQuestion.answer).toBe('<p>Quiz 1, question 1, answer</p>');
+
+    // Second question has audio without timestamps
+    expect(secondQuestion).toHaveProperty('audioData');
+    expect(secondQuestion.audioData.audio.filename).toBe('audio-full-file.mp3');
+    expect(secondQuestion.audioData.audio.startTimestamp).toBeUndefined();
+    expect(secondQuestion.audioData.audio.finishTimestamp).toBeUndefined();
+    expect(secondQuestion.audioData.transcript).toEqual([
+      {
+        character: 'Speaker',
+        text: 'This is the full audio transcript.'
+      }
+    ]);
+    expect(secondQuestion.text).toBe(
+      '<p>Quiz 1, question 2 with audio but no timestamps</p>'
+    );
+
+    // Third question has no audio
+    expect(thirdQuestion.audioData).toBeUndefined();
+    expect(thirdQuestion.text).toBe('<p>Quiz 1, question 3 without audio</p>');
+  });
+
+  it('should throw error for audio section not in JSON code block', () => {
+    expect(() => plugin(quizzesWithAudioNotJsonCodeBlockAST, file)).toThrow(
+      '--audio-- section must contain a ```json code block'
+    );
+  });
+
+  it('should throw error for invalid JSON in audio section', () => {
+    expect(() => plugin(quizzesWithAudioInvalidJsonAST, file)).toThrow(
+      '--audio-- section must contain valid JSON'
+    );
+  });
+
+  it('should throw error for missing audio filename', () => {
+    expect(() => plugin(quizzesWithAudioMissingFilenameAST, file)).toThrow(
+      '--audio-- section must contain audio.filename'
+    );
+  });
+
+  it('should throw error for transcript not being an array', () => {
+    expect(() => plugin(quizzesWithAudioTranscriptNotArrayAST, file)).toThrow(
+      '--audio-- section must contain transcript as an array'
+    );
+  });
+
+  it('should throw error for empty transcript array', () => {
+    expect(() => plugin(quizzesWithAudioEmptyTranscriptAST, file)).toThrow(
+      '--audio-- section transcript array cannot be empty'
+    );
+  });
+
+  it('should throw error for missing transcript', () => {
+    expect(() => plugin(quizzesWithAudioMissingTranscriptAST, file)).toThrow(
+      '--audio-- section must contain transcript as an array'
+    );
+  });
+
+  it('should throw error for transcript line missing character', () => {
+    expect(() =>
+      plugin(quizzesWithAudioTranscriptMissingCharacterAST, file)
+    ).toThrow(
+      '--audio-- transcript line 0 must have character and text properties'
+    );
+  });
+
+  it('should throw error for transcript line missing text', () => {
+    expect(() =>
+      plugin(quizzesWithAudioTranscriptMissingTextAST, file)
+    ).toThrow(
+      '--audio-- transcript line 0 must have character and text properties'
+    );
+  });
+});