path: root/src/creole_test_main.c

#include "creole.h"

#include <stdio.h>
#include <string.h>

#define COUNT(arr) (sizeof(arr)/sizeof((arr)[0]))

#define strneq(a, b, n) (strncmp(a, b, n) == 0)

struct {
	const char *name, *input, *output;
} tests[] = {
	{
		.name    =  "Empty input produces no output",
		.input   =  "",
		.output  =  ""
	},
	{
		.name    =  "Basic paragraph markup",
		.input   =  "Basic paragraph test with <, >, & and \"",
		.output  =  "<p>Basic paragraph test with &lt;, &gt;, &amp; and &quot;</p>"
	},
	{
		.name    =  "Two paragraphs next to each other.",
		.input   =  "Hello,\n\nworld!",
		.output  =  "<p>Hello,</p><p>world!</p>"
	},
	{
		.name    =  "h1",
		.input   =  "= Header =",
		.output  =  "<h1>Header</h1>"
	},
	{
		.name    =  "h2",
		.input   =  "== Header =",
		.output  =  "<h2>Header</h2>"
	},
	{
		.name    =  "h3",
		.input   =  "=== Header =",
		.output  =  "<h3>Header</h3>"
	},
	{
		.name    =  "h4",
		.input   =  "==== Header =",
		.output  =  "<h4>Header</h4>"
	},
	{
		.name    =  "h5",
		.input   =  "===== Header",
		.output  =  "<h5>Header</h5>"
	},
	{
		.name    =  "h6",
		.input   =  "====== Header =",
		.output  =  "<h6>Header</h6>"
	},
	{
		.name    =  ">h6",
		.input   =  "======= Header =",
		.output  =  "<p>======= Header =</p>"
	},
	{
		.name    =  "Unnamed link",
		.input   =  "[[MyPage]]",
		.output  =  "<p><a href=\"MyPage\">MyPage</a></p>"
	},
	{
		.name    =  "Named link",
		.input   =  "[[MyPage|My page]]",
		.output  =  "<p><a href=\"MyPage\">My page</a></p>"
	},
	{
		.name    =  "Link with markup in name",
		.input   =  "[[https://example.com|a **cool** link]]",
		.output  =  "<p><a href=\"https://example.com\">a <strong>cool</strong> link</a></p>"
	},
	{
		.name    =  "Markup in link address is ignored",
		.input   =  "[[https://**example**.com/{{wad}}]]",
		.output  =  "<p><a href=\"https://**example**.com/{{wad}}\">https://**example**.com/{{wad}}</a></p>"
	},
	{
		.name    =  "Escaped link",
		.input   =  "A paragraph with an ~[[escaped link]].",
		.output  =  "<p>A paragraph with an [[escaped link]].</p>"
	},
	{
		.name    =  "Link with an escaped end",
		.input   =  "[[https://example.com|A link with an escaped ~]] end]]",
		.output  =  "<p><a href=\"https://example.com\">A link with an escaped ]] end</a></p>"
	},
	{
		.name    =  "Link with empty text",
		.input   =  "[[https://example.com|]]",
		.output  =  "<p><a href=\"https://example.com\"></a></p>"
	},
	{
		.name    =  "Link with empty address",
		.input   =  "[[|Hello]]",
		.output  =  "<p><a href=\"\">Hello</a></p>"
	},
	{
		.name    =  "Empty link",
		.input   =  "[[]]",
		.output  =  "<p><a href=\"\"></a></p>"
	},
	{
		.name    =  "Raw HTTP URL",
		.input   =  "Here is a http://example.com/examplepage link.",
		.output  =  "<p>Here is a <a href=\"http://example.com/examplepage\">"
		            "http://example.com/examplepage</a> link.</p>"
	},
	{ // This is interesting because it doesn't contain a "://".
		.name    =  "Raw mailto URL",
		.input   =  "mailto:[email protected]",
		.output  =  "<p><a href=\"mailto:[email protected]\">"
		            "mailto:[email protected]</a></p>"
	},
	{ // This test captures a non-standard (?) special case in the parser.
		.name    =  "Raw URL followed by full stop",
		.input   =  "My favorite website is https://wiki.c2.com/.",
		.output  =  "<p>My favorite website is <a href=\"https://wiki.c2.com/\">"
		            "https://wiki.c2.com/</a>.</p>"
	},
	{
		.name    =  "Escaped raw URL",
		.input   =  "Please don't register ~https://cohost.org/!",
		.output  =  "<p>Please don't register https://cohost.org/!</p>"
	},
	{
		.name    =  "Unnamed URL",
		.input   =  "[[http //example.com/examplepage]]",
		.output  =  "<p><a href=\"http //example.com/examplepage\">"
		            "http //example.com/examplepage</a></p>"
	},
	{
		.name    =  "Named URL",
		.input   =  "[[http //example.com/examplepage|Example Page]]",
		.output  =  "<p>"
		            "<a href=\"http //example.com/examplepage\">Example Page</a></p>"
	},
	{
		.name    =  "Emphasis",
		.input   =  "//Emphasis//",
		.output  =  "<p><em>Emphasis</em></p>"
	},
	{
		.name    =  "Emphasis spans multiple lines",
		.input   =  "Bold and italics should //be\nable// to cross lines.",
		.output  =  "<p>Bold and italics should <em>be\nable</em> to cross lines.</p>"
	},
	{
		.name    =  "Emphasised URL",
		.input   =  "//https://example.com//",
		.output  =  "<p><em><a href=\"https://example.com\">https://example.com</a></em></p>"
	},
	{ // I don't know that this is necessarily //correct// behavior... Let's document it anyways
		.name    =  "Emphasised URL ending in slash",
		.input   =  "//https://example.com///",
		.output  =  "<p><em><a href=\"https://example.com\">https://example.com</a></em>/</p>"
	},
	{
		.name    =  "Emphasis does not cross paragraph boundaries",
		.input   =  "This text should //not\n\nbe emphased// as it crosses a paragraph boundary.",
		.output  =  "<p>This text should //not</p>"
		            "<p>be emphased// as it crosses a paragraph boundary.</p>"
	},
	{
		.name    =  "URL/emphasis ambiguity",
		.input   =  "This is an //italic// text. This is a url  "
		            "http://www.wikicreole.org. This is what can go wrong //this "
		            "should be an italic text//.",
		.output  =  "<p>This is an <em>italic</em> text. This is a url  "
		            "<a href=\"http://www.wikicreole.org\">"
		            "http://www.wikicreole.org</a>. This is what can go wrong "
		            "<em>this should be an italic text</em>.</p>"
	},
	{
		.name    =  "Escaped emphasis",
		.input   =  "I //love double ~// slashes//!",
		.output  =  "<p>I <em>love double // slashes</em>!</p>"
	},
	{ // Not sure what the standard demands. Here's our behavior.
		.name    =  "Empty emphasis",
		.input   =  "////",
		.output  =  "<p>////</p>"
	},
	{
		.name    =  "Bold",
		.input   =  "**Strong**",
		.output  =  "<p><strong>Strong</strong></p>"
	},
	{ // Not sure what the standard demands. Here's our behavior.
		.name    =  "Empty bold",
		.input   =  "You f****g asshole!",
		.output  =  "<p>You f****g asshole!</p>"
	},
	{
		.name    =  "Escaped bold",
		.input   =  "**Strong ~** still strong**",
		.output  =  "<p><strong>Strong ** still strong</strong></p>"
	},
	{
		.name    =  "Nested bold/italic",
		.input   =  "//**Strong and emphasized**//",
		.output  =  "<p><em><strong>Strong and emphasized</strong></em></p>"
	},
	{
		.name    =  "Alternating bold/italic doesn't work",
		.input   =  "//**Strong and emphasized//**",
		.output  =  "<p><em>**Strong and emphasized</em>**</p>"
	},
	{
		.name    =  "Inline nowiki",
		.input   =  "Some examples of markup are: {{{** <i>this</i> **}}}",
		.output  =  "<p>Some examples of markup are: <tt>** &lt;i&gt;this&lt;/i&gt; **</tt></p>"
	},
	{
		.name    =  "Inline nowiki is stripped",
		.input   =  "{{{  foo  }}}",
		.output  =  "<p><tt>foo</tt></p>"
	},
	{ // Spec does not seem to clear this issue.
	  // As it becomes a <tt> in their example, I'll assume newlines aren't included verbatim in the output.
	  // However, for consistency with (e.g.) bold text, they will "work" across line boundaries.
		.name    =  "Linebreaks in inline nowiki",
		.input   =  "This should not work {{{foo\nbar}}}",
		.output  =  "<p>This should not work <tt>foo\nbar</tt></p>"
	},
	{
		.name    =  "Inline nowiki brace helll",
		.input   =  "Creole: Inline nowiki with closing braces: {{{if (a>b) { b = a; }}}}.",
		.output  =  "<p>Creole: Inline nowiki with closing braces: <tt>if (a&gt;b) { b = a; }</tt>.</p>"
	},
	{
		.name    =  "Nowiki block",
		.input   =  "Here is some stuff:\n\n{{{\nwad\n}}}",
		.output  =  "<p>Here is some stuff:</p>"
		            "<pre><code>wad</code></pre>"
	},
	{
		.name    =  "Non-closed nowiki block",
		.input   =  "Here is some stuff:\n\n{{{\nwad",
		.output  =  "<p>Here is some stuff:</p>"
		            "<p>{{{\nwad</p>"
	},
	{
		.name    =  "Empty nowiki block",
		.input   =  "{{{\n}}}",
		.output  =  "<pre><code></code></pre>"
	},
	{ // Spec: In preformatted blocks, since markers must not be preceded by leading spaces, lines with three closing braces
	  // which belong to the preformatted block must follow at least one space. In the rendered output, one leading space is removed.
		.name    =  "Whitespace before }}} stripped",
		.input   =  "{{{\nif (x != NULL) {\n  for (i = 0; i < size; i++) {\n    if (x[i] > 0) {\n      x[i]--;\n  }}}\n}}}\n",
		.output  =  "<pre><code>if (x != NULL) {\n  for (i = 0; i &lt; size; i++) {\n    if (x[i] &gt; 0) {\n      x[i]--;\n  }}}</code></pre>",
	},
	{
		.name    =  "Inline tt",
		.input   =  "Inline {{{tt}}} example {{{here}}}!",
		.output  =  "<p>Inline <tt>tt</tt> example <tt>here</tt>!</p>"
	},
	{
		.name    =  "Simple unordered list",
		.input   =  "* list item\n*list item 2",
		.output  =  "<ul><li> list item<li>list item 2</ul>"
	},
	{
		.name    =  "Simple ordered list",
		.input   =  "# list item\n#list item 2",
		.output  =  "<ol><li> list item<li>list item 2</ol>"
	},
	{
		.name    =  "Unordered item with unordered sublist",
		.input   =  "* Item\n** Subitem",
		.output  =  "<ul><li> Item<ul><li> Subitem</ul></ul>"
	},
	{
		.name    =  "Unwindling deeply nested list",
		.input   =  "* A\n** B\n*** C\n**** D\n***** E",
		.output  =  "<ul><li> A<ul><li> B<ul><li> C<ul><li> D<ul><li> E</ul></ul></ul></ul></ul>"
	},
	{
		.name    =  "Leading spaces ignored in lists",
		.input   =  "  * Item 1\n  * Item 2\n    **  Item 2.1\n     ** Item 2.2\n",
		.output  =  "<ul><li> Item 1\n  <li> Item 2\n    <ul><li>  Item 2.1\n     <li> Item 2.2</ul></ul>"
	},
	{
		.name    =  "Unordered sublist without initial tag",
		.input   =  "** Sublist item",
		.output  =  "<p>** Sublist item</p>"
	},
	{
		.name    =  "Ordered sublist without initial tag",
		.input   =  "## Sublist item",
		.output  =  "<p>## Sublist item</p>"
	},
#if 0
	{
		.name    =  "Ordered item with ordered sublist",
		.input   =  "# Item\n## Subitem",
		.output  =  "<ol><li> Item<ol>\n<li> Subitem</li></ol></li></ol>"
	},
	{
		.name    =  "Unordered item with ordered sublist",
		.input   =  "* Item\n*# Subitem",
		.output  =  "<ul><li> Item<ol>\n<li> Subitem</li></ol></li></ul>"
	},
	{
		.name    =  "Horizontal rule",
		.input   =  "Some text\n----\nSome more text",
		.output  =  "<p>Some text</p><hr /><p>Some more text</p>"
	},
	{
		.name    =  "Preformatted block",
		.input   =  "{{{\nPreformatted block\n}}}",
		.output  =  "<pre>Preformatted block\n</pre>"
	},
	{
		.name    =  "Two preformatted blocks",
		.input   =  "{{{\nPreformatted block\n}}}\n{{{Block 2}}}",
		.output  =  "<pre>Preformatted block\n</pre><pre>Block 2</pre>"
	},
	{
		.name    =  "Tables",
		.input   =  "| A | B |\n| //C// | **D** \\\\ E |",
		.output  =  "<table><tr><td> A </td><td> B </td></tr>"
		            "<tr><td> <em>C</em> </td>"
		            "<td> <strong>D</strong> <br /> E </td></tr></table>"
	},
	{
		.name    =  "Image",
		.input   =  "{{image.gif|my image}}",
		.output  =  "<p><img src=\"image.gif\" alt=\"my image\"/></p>"
	},
#endif
};

int print_escaped(FILE *fp, const char *string, size_t length) {
       static struct {
               char from;
               const char *to;
       } replacements[] = {
               { '\\', "\\\\" },
               { '\t', "\\t" },
               { '\n', "\\n" },
               { '"', "\\\"" },
       };

       if (fputc('"', fp) == EOF) {
               return -1;
       }

       for (size_t i = 0; i < length; ++i) {
               for (size_t j = 0; j < COUNT(replacements); ++j) {
                       if (string[i] == replacements[j].from) {
                               if (fprintf(fp, "%s", replacements[j].to) < 0) {
                                       return -1;
                               }
                               goto next_char;
                       }
               }
               if (fputc(string[i], fp) == EOF) {
                       return -1;
               }
next_char:
               ;
       }

       if (fputc('"', fp) == EOF) {
               return -1;
       }

       return 0;
}

int print_escaped_ze(FILE *fp, const char *string) {
	return print_escaped(fp, string, strlen(string));
}

int main(void) {
	for (size_t i = 0; i < COUNT(tests); ++i) {
		printf("Running test: \x1b[1m%s\x1b[0m... ", tests[i].name);

		static char buffer[1024];
		FILE *fp = fmemopen(buffer, sizeof(buffer), "wb");
		render_creole(fp, tests[i].input, strlen(tests[i].input));
		long buffer_length = ftell(fp);
		fclose(fp);

		if (!strneq(buffer, tests[i].output, buffer_length)) {
			printf("\x1b[31merror\x1b[0m\n");
			printf("├──── markup: ");
			print_escaped_ze(stdout, tests[i].input);
			putchar('\n');
			printf("├── expected: ");
			print_escaped_ze(stdout, tests[i].output);
			putchar('\n');
			printf("└─────── got: ");
			print_escaped(stdout, buffer, buffer_length);
			putchar('\n');
		} else {
			printf("\x1b[32mok\x1b[0m\n");
		}
	}
}