1 files changed, 86 insertions, 0 deletions
diff --git a/spec/frontend/content_editor/markdown_processing_spec_helper.js b/spec/frontend/content_editor/markdown_processing_spec_helper.js
new file mode 100644
index 00000000000..bb7ec0030a2
--- /dev/null
+++ b/spec/frontend/content_editor/markdown_processing_spec_helper.js
@@ -0,0 +1,86 @@
+import fs from 'fs';
+import jsYaml from 'js-yaml';
+import { memoize } from 'lodash';
+import { createContentEditor } from '~/content_editor';
+import { setTestTimeoutOnce } from 'helpers/timeout';
+
+const getFocusedMarkdownExamples = memoize(
+  () => process.env.FOCUSED_MARKDOWN_EXAMPLES?.split(',') || [],
+);
+
+const includeExample = ({ name }) => {
+  const focusedMarkdownExamples = getFocusedMarkdownExamples();
+  if (!focusedMarkdownExamples.length) {
+    return true;
+  }
+  return focusedMarkdownExamples.includes(name);
+};
+
+const getPendingReason = (pendingStringOrObject) => {
+  if (!pendingStringOrObject) {
+    return null;
+  }
+  if (typeof pendingStringOrObject === 'string') {
+    return pendingStringOrObject;
+  }
+  if (pendingStringOrObject.frontend) {
+    return pendingStringOrObject.frontend;
+  }
+
+  return null;
+};
+
+const loadMarkdownApiExamples = (markdownYamlPath) => {
+  const apiMarkdownYamlText = fs.readFileSync(markdownYamlPath);
+  const apiMarkdownExampleObjects = jsYaml.safeLoad(apiMarkdownYamlText);
+
+  return apiMarkdownExampleObjects
+    .filter(includeExample)
+    .map(({ name, pending, markdown, html }) => [
+      name,
+      { pendingReason: getPendingReason(pending), markdown, html },
+    ]);
+};
+
+const testSerializesHtmlToMarkdownForElement = async ({ markdown, html }) => {
+  const contentEditor = createContentEditor({
+    // Overwrite renderMarkdown to always return this specific html
+    renderMarkdown: () => html,
+  });
+
+  await contentEditor.setSerializedContent(markdown);
+
+  // This serializes the ContentEditor document, which was based on the HTML, to markdown
+  const serializedContent = contentEditor.getSerializedContent();
+
+  // Assert that the markdown we ended up with after sending it through all the ContentEditor
+  // plumbing matches the original markdown from the YAML.
+  expect(serializedContent).toBe(markdown);
+};
+
+// describeMarkdownProcesssing
+//
+// This is used to dynamically generate examples (for both CE and EE) to ensure
+// we generate same markdown that was provided to Markdown API.
+//
+// eslint-disable-next-line jest/no-export
+export const describeMarkdownProcessing = (description, markdownYamlPath) => {
+  const examples = loadMarkdownApiExamples(markdownYamlPath);
+
+  describe(description, () => {
+    describe.each(examples)('%s', (name, { pendingReason, ...example }) => {
+      const exampleName = 'correctly serializes HTML to markdown';
+      if (pendingReason) {
+        it.todo(`${exampleName}: ${pendingReason}`);
+        return;
+      }
+
+      it(exampleName, async () => {
+        if (name === 'frontmatter_toml') {
+          setTestTimeoutOnce(2000);
+        }
+        await testSerializesHtmlToMarkdownForElement(example);
+      });
+    });
+  });
+};