Merge pull request #1937 from AlexeySachkov/private/asachkov/v3-markdown-tests

Add tests for our markdown parser/renderer

package.json

@@ -18,8 +18,8 @@
     "lint:dry": "eslint **/*.{js,jsx}",
     "circleci": "npm test && eslint **/*.{js,jsx} --max-warnings=0",
     "verify": "npm run lint && npm test",
-    "test": "pico-check",
-    "test:dev": "pico-check -v -w",
+    "test": "jest",
+    "test:dev": "jest --verbose --watch",
     "phb": "node scripts/phb.js",
     "prod": "set NODE_ENV=production && npm run build",
     "postinstall": "npm run buildall",
@@ -30,8 +30,11 @@
   "eslintIgnore": [
     "build/*"
   ],
-  "pico-check": {
-    "require": "./tests/test.init.js"
+  "jest": {
+    "modulePaths": [
+      "mode_modules",
+      "shared"
+    ]
   },
   "babel": {
     "presets": [
@@ -79,6 +82,6 @@
   "devDependencies": {
     "eslint": "^8.6.0",
     "eslint-plugin-react": "^7.28.0",
-    "pico-check": "^2.2.0"
+    "jest": "^27.4.5"
   }
 }

tests/basic.test.js

@@ -1,7 +0,0 @@
-const test = require('pico-check');
-
-test('Just setting up a spot for future tests', (t)=>{
-	t.pass();
-});
-
-module.exports = test;

tests/markdown/basic.test.js

@@ -0,0 +1,15 @@
+/* eslint-disable max-lines */
+
+const Markdown = require('naturalcrit/markdown.js');
+
+test('Escapes <script> tag', function() {
+	const source = '<script></script>';
+	const rendered = Markdown.render(source);
+	expect(rendered).toMatch('&lt;script&gt;&lt;/script&gt;');
+});
+
+test('Processes the markdown within an HTML block if its just a class wrapper', function() {
+	const source = '<div>*Bold text*</div>';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<div> <p><em>Bold text</em></p>\n </div>');
+});

tests/markdown/mustache-span.test.js

@@ -0,0 +1,128 @@
+/* eslint-disable max-lines */
+
+const Markdown = require('naturalcrit/markdown.js');
+
+test('Renders a mustache span with text only', function() {
+	const source = '{{ text}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block ">text</span>');
+});
+
+test('Renders a mustache span with text only, but with spaces', function() {
+	const source = '{{ this is a text}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block ">this is a text</span>');
+});
+
+test('Renders an empty mustache span', function() {
+	const source = '{{}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "></span>');
+});
+
+test('Renders a mustache span with just a space', function() {
+	const source = '{{ }}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "></span>');
+});
+
+test('Renders a mustache span with a few spaces only', function() {
+	const source = '{{     }}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "></span>');
+});
+
+test('Renders a mustache span with text and class', function() {
+	const source = '{{my-class text}}';
+	const rendered = Markdown.render(source);
+	// FIXME: why do we have those two extra spaces after closing "?
+	expect(rendered).toBe('<span class="inline-block my-class"  >text</span>');
+});
+
+test('Renders a mustache span with text and two classes', function() {
+	const source = '{{my-class,my-class2 text}}';
+	const rendered = Markdown.render(source);
+	// FIXME: why do we have those two extra spaces after closing "?
+	expect(rendered).toBe('<span class="inline-block my-class my-class2"  >text</span>');
+});
+
+test('Renders a mustache span with text with spaces and class', function() {
+	const source = '{{my-class this is a text}}';
+	const rendered = Markdown.render(source);
+	// FIXME: why do we have those two extra spaces after closing "?
+	expect(rendered).toBe('<span class="inline-block my-class"  >this is a text</span>');
+});
+
+test('Renders a mustache span with text and id', function() {
+	const source = '{{#my-span text}}';
+	const rendered = Markdown.render(source);
+	// FIXME: why do we have that one extra space after closing "?
+	expect(rendered).toBe('<span class="inline-block " id="my-span" >text</span>');
+});
+
+test('Renders a mustache span with text and two ids', function() {
+	const source = '{{#my-span,#my-favorite-span text}}';
+	const rendered = Markdown.render(source);
+	// FIXME: do we need to report an error here somehow?
+	expect(rendered).toBe('<span class="inline-block " id="my-span" >text</span>');
+});
+
+test('Renders a mustache span with text and css property', function() {
+	const source = '{{color:red text}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "  style="color:red;">text</span>');
+});
+
+test('Renders a mustache span with text and two css properties', function() {
+	const source = '{{color:red,padding:5px text}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "  style="color:red; padding:5px;">text</span>');
+});
+
+test('Renders a mustache span with text and css property which contains quotes', function() {
+	const source = '{{font:"trebuchet ms" text}}';
+	const rendered = Markdown.render(source);
+	// FIXME: is it correct to remove quotes surrounding css property value?
+	expect(rendered).toBe('<span class="inline-block "  style="font:trebuchet ms;">text</span>');
+});
+
+test('Renders a mustache span with text and two css properties which contains quotes', function() {
+	const source = '{{font:"trebuchet ms",padding:"5px 10px" text}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "  style="font:trebuchet ms; padding:5px 10px;">text</span>');
+});
+
+
+test('Renders a mustache span with text with quotes and css property which contains quotes', function() {
+	const source = '{{font:"trebuchet ms" text "with quotes"}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block "  style="font:trebuchet ms;">text “with quotes”</span>');
+});
+
+test('Renders a mustache span with text, id, class and a couple of css properties', function() {
+	const source = '{{pen,#author,color:orange,font-family:"trebuchet ms" text}}';
+	const rendered = Markdown.render(source);
+	expect(rendered).toBe('<span class="inline-block pen" id="author" style="color:orange; font-family:trebuchet ms;">text</span>');
+});
+
+// TODO: add tests for ID with accordance to CSS spec:
+//
+// From https://drafts.csswg.org/selectors/#id-selectors:
+//
+// > An ID selector consists of a “number sign” (U+0023, #) immediately followed by the ID value, which must be a CSS identifier.
+//
+// From: https://www.w3.org/TR/CSS21/syndata.html#value-def-identifier:
+//
+// > In CSS, identifiers (including element names, classes, and IDs in selectors) can contain only the characters [a-zA-Z0-9]
+// > and ISO 10646 characters U+00A0 and higher, plus the hyphen (-) and the underscore (_);
+// > they cannot start with a digit, two hyphens, or a hyphen followed by a digit.
+// > Identifiers can also contain escaped characters and any ISO 10646 character as a numeric code (see next item).
+// > For instance, the identifier "B&W?" may be written as "B\&W\?" or "B\26 W\3F".
+// > Note that Unicode is code-by-code equivalent to ISO 10646 (see [UNICODE] and [ISO10646]).
+
+// TODO: add tests for class with accordance to CSS spec:
+//
+// From: https://drafts.csswg.org/selectors/#class-html:
+//
+// > The class selector is given as a full stop (. U+002E) immediately followed by an identifier.
+

tests/test.init.js

@@ -1 +0,0 @@
-//Set up configs and DB connectiosna nd what not in here