Module:UnitTests/doc - Revision history

Repakr: Added nowiki

2025-01-20T12:20:59Z

Added nowiki

← Previous revision		Revision as of 12:20, 20 January 2025
Line 6:		Line 6:

	function p:test_hello()		function p:test_hello()
	self:preprocess_equals('{{#invoke:Example \| hello}}', 'Hello World!')		self:preprocess_equals('<nowiki>{{#invoke:Example \| hello}}</nowiki>', 'Hello World!')
	end		end

BrandonXLF: Remove confusing sort key for Category:Modules for test tools

2024-09-01T22:28:20Z

Remove confusing sort key for Category:Modules for test tools

← Previous revision		Revision as of 22:28, 1 September 2024
Line 98:		Line 98:
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	<!-- Categories go here and interwikis go in Wikidata. -->		<!-- Categories go here and interwikis go in Wikidata. -->
	[[Category:Modules for test tools~~\|Test tools, {{PAGENAME}}~~]]		[[Category:Modules for test tools]]
	[[Category:Modules that check for strip markers]]		[[Category:Modules that check for strip markers]]
	}}</includeonly>		}}</includeonly>

W.andrea: /* Methods */ Fix formatting (nesting, wikitext syntax highlighting).

2024-04-24T16:39:35Z

Methods: Fix formatting (nesting, wikitext syntax highlighting).

Show changes

BrandonXLF: Module uses stripmarker instead of stripmarkers

2023-05-24T22:49:44Z

Module uses stripmarker instead of stripmarkers

← Previous revision		Revision as of 22:49, 24 May 2023
Line 95:		Line 95:
	Enabling this fixes the IDs in the [[mw:Strip marker\|strip markers]] {{tag\|templatestyles}} produces when processed to avoid incorrectly failing the tests.		Enabling this fixes the IDs in the [[mw:Strip marker\|strip markers]] {{tag\|templatestyles}} produces when processed to avoid incorrectly failing the tests.

	=== ~~stripmarkers~~ ===		=== stripmarker ===
	{{hatnote\|Only available in <code>preprocess_equals</code> and <code>preprocess_equals_preprocess</code>}}		{{hatnote\|Only available in <code>preprocess_equals</code> and <code>preprocess_equals_preprocess</code>}}
	Enabling this fixes the IDs in ''all'' strip markers produces when processed to avoid incorrectly failing the tests.		Enabling this fixes the IDs in ''all'' strip markers produces when processed to avoid incorrectly failing the tests.

Aidan9382: /* run_tests */ clarify why live_sandbox exists

2023-02-06T12:00:30Z

run_tests: clarify why live_sandbox exists

← Previous revision		Revision as of 12:00, 6 February 2023
Line 28:		Line 28:
	{{#invoke:Example/testcases\|run_tests\|highlight=1}}		{{#invoke:Example/testcases\|run_tests\|highlight=1}}
	</pre>		</pre>
	* If {{code\|1=live_sandbox}} is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected"		* If {{code\|1=live_sandbox}} is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected". This is required when using the {{code\|1=preprocess_equals_sandbox_many}} method.

	=== preprocess_equals ===		=== preprocess_equals ===

Aidan9382: /* Test options */ ce

2023-02-06T11:58:10Z

Test options: ce

← Previous revision		Revision as of 11:58, 6 February 2023
Line 82:		Line 82:

	== Test options ==		== Test options ==
	These are the valid options that can be passed into the options parameters test functions listed above.		These are the valid options that can be passed into the options parameters of the test functions listed above.

	=== nowiki ===		=== nowiki ===

Fred Gandt: /* run_tests */ added "A user script that moves failed tests to the top is also available." to highlight description

2023-01-29T10:25:53Z

run_tests: added "A user script that moves failed tests to the top is also available." to highlight description

← Previous revision		Revision as of 10:25, 29 January 2023
Line 24:		Line 24:
	{{#invoke:Example/testcases\|run_tests\|differs_at=1}}		{{#invoke:Example/testcases\|run_tests\|differs_at=1}}
	</pre>		</pre>
	* If {{code\|1=highlight}} is specified, failed tests will be highlighted to make them easier to spot.		* If {{code\|1=highlight}} is specified, failed tests will be highlighted to make them easier to spot. A [[WP:USERSCRIPT\|user script]] that [[User:Fred_Gandt/moveFailedModuleTestsToTop.js\|moves failed tests to the top]] is also available.
	<pre>		<pre>
	{{#invoke:Example/testcases\|run_tests\|highlight=1}}		{{#invoke:Example/testcases\|run_tests\|highlight=1}}

Aidan9382: Update with new and old info

2023-01-28T20:46:15Z

Update with new and old info

← Previous revision		Revision as of 20:46, 28 January 2023
Line 1:		Line 1:
	UnitTests provides a unit test facility that can be used by other scripts using '''require'''. See [[Wikipedia:Lua#Unit_testing]] for details. ~~Following~~ is a sample from [[Module:Example/testcases]]:		UnitTests provides a unit test facility that can be used by other scripts using '''require'''. See [[Wikipedia:Lua#Unit_testing]] for details. The following is a sample from [[Module:Example/testcases]]:

	{{#tag:syntaxhighlight\|		{{#tag:syntaxhighlight\|
Line 23:		Line 23:
	<pre>		<pre>
	{{#invoke:Example/testcases\|run_tests\|differs_at=1}}		{{#invoke:Example/testcases\|run_tests\|differs_at=1}}
			</pre>
			* If {{code\|1=highlight}} is specified, failed tests will be highlighted to make them easier to spot.
			<pre>
			{{#invoke:Example/testcases\|run_tests\|highlight=1}}
	</pre>		</pre>
	* If {{code\|1=live_sandbox}} is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected"		* If {{code\|1=live_sandbox}} is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected"
Line 29:		Line 33:
	* {{code\|1=preprocess_equals(text, expected, options)}}: Gives a piece of wikitext to preprocess and an expected resulting value. Scripts and templates can be invoked in the same manner they would be in a page.		* {{code\|1=preprocess_equals(text, expected, options)}}: Gives a piece of wikitext to preprocess and an expected resulting value. Scripts and templates can be invoked in the same manner they would be in a page.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	self:preprocess_equals('{{#invoke:Example \| hello}}', 'Hello, world!',{nowiki=1})		self:preprocess_equals('{{#invoke:Example \| hello}}', 'Hello, world!', {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

Line 38:		Line 42:
	{'John', 'Hello, John!'},		{'John', 'Hello, John!'},
	{'Jane', 'Hello, Jane!'},		{'Jane', 'Hello, Jane!'},
	},{nowiki=1})		}, {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

Line 44:		Line 48:
	* {{code\|1=preprocess_equals_preprocess(text, expected, options)}}: Gives two pieces of wikitext to preprocess and determines if they produce the same value. Useful for comparing scripts to existing templates.		* {{code\|1=preprocess_equals_preprocess(text, expected, options)}}: Gives two pieces of wikitext to preprocess and determines if they produce the same value. Useful for comparing scripts to existing templates.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	self:preprocess_equals_preprocess('{{#invoke:Example \| hello}}', '{{Hello}}',{nowiki=1})		self:preprocess_equals_preprocess('{{#invoke:Example \| hello}}', '{{Hello}}', {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

Line 53:		Line 57:
	{'2'}, -- equivalent to {'2','2'},		{'2'}, -- equivalent to {'2','2'},
	{'-2', '-2.0'},		{'-2', '-2.0'},
	},{nowiki=1})		}, {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

	=== preprocess_equals_sandbox_many ===		=== preprocess_equals_sandbox_many ===
	* {{code\|1=preprocess_equals_sandbox_many(module, function, cases, options)}}: Performs a series of preprocess_equals_compare() calls on a set of given pairs. The test compares the live version of the module vs the /sandbox version and vs an expected result.		* {{code\|1=preprocess_equals_sandbox_many(module, function, cases, options)}}: Performs a series of preprocess_equals_compare() calls on a set of given pairs. The test compares the live version of the module vs the /sandbox version and vs an expected result. Ensure live_sandbox is specified or there may be some errors in the output.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	self:preprocess_equals_sandbox_many('{{#invoke:Example', 'hello_to', {		self:preprocess_equals_sandbox_many('{{#invoke:Example', 'hello_to', {
	{'John', 'Hello, John!'},		{'John', 'Hello, John!'},
	{'Jane', 'Hello, Jane!'},		{'Jane', 'Hello, Jane!'},
	},{nowiki=1})		}, {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

Line 68:		Line 72:
	* {{code\|1=equals(name, actual, expected, options)}}: Gives a computed value and the expected value, and checks if they are equal according to the == operator. Useful for testing modules that are designed to be used by other modules rather than using #invoke.		* {{code\|1=equals(name, actual, expected, options)}}: Gives a computed value and the expected value, and checks if they are equal according to the == operator. Useful for testing modules that are designed to be used by other modules rather than using #invoke.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	self:equals('Simple addition', 2 + 2, 4,{nowiki=1})		self:equals('Simple addition', 2 + 2, 4, {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

Line 74:		Line 78:
	* {{code\|1=equals_deep(name, actual, expected, options)}}: Like equals, but handles tables by doing a deep comparison. Neither value should contain circular references, as they are not handled by the current implementation and may result in an infinite loop.		* {{code\|1=equals_deep(name, actual, expected, options)}}: Like equals, but handles tables by doing a deep comparison. Neither value should contain circular references, as they are not handled by the current implementation and may result in an infinite loop.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	self:equals_deep('Table comparison', createRange(1,3), {1,2,3},{nowiki=1})		self:equals_deep('Table comparison', createRange(1,3), {1,2,3}, {nowiki=1})
	</syntaxhighlight>		</syntaxhighlight>

	== ~~Options~~ ==		== Test options ==
	These are the valid options that can be passed into the ~~equals~~ functions listed above.		These are the valid options that can be passed into the options parameters test functions listed above.

	=== nowiki ===		=== nowiki ===
	Enabling this wraps the output text in {{tag\|nowiki}} tags to avoid the text being rendered (E.g. <nowiki><span>[[Example\|Page]]</span></nowiki> instead of <span>[[Example\|Page]]</span>)		Enabling this wraps the output text in {{tag\|nowiki}} tags to avoid the text being rendered (E.g. <nowiki><span>[[Example\|Page]]</span></nowiki> instead of <span>[[Example\|Page]]</span>)

			=== combined ===
			{{hatnote\|Only available in <code>preprocess_equals</code> and <code>preprocess_equals_preprocess</code>}}
			Enabling this will display the output text in both the rendered mode and the nowiki mode to allow for both a raw text and visual comparison.

	=== templatestyles ===		=== templatestyles ===
	{{hatnote\|Only available ~~for~~ {{code~~\|1=~~preprocess_equals_preprocess}}}}		{{hatnote\|Only available in <code>preprocess_equals</code> and <code>preprocess_equals_preprocess</code>}}
	Enabling this fixes the IDs in the [[mw:Strip marker\|strip markers]] {{tag\|templatestyles}} produces when processed to avoid incorrectly failing the tests.		Enabling this fixes the IDs in the [[mw:Strip marker\|strip markers]] {{tag\|templatestyles}} produces when processed to avoid incorrectly failing the tests.

	=== stripmarkers ===		=== stripmarkers ===
	{{hatnote\|Only available ~~for~~ {{code~~\|1=~~preprocess_equals_preprocess}}}}		{{hatnote\|Only available in <code>preprocess_equals</code> and <code>preprocess_equals_preprocess</code>}}
	Enabling this fixes the IDs in ''all'' strip markers produces when processed to avoid incorrectly failing the tests.		Enabling this fixes the IDs in ''all'' strip markers produces when processed to avoid incorrectly failing the tests.

	=== display ===		=== display ===
	{{hatnote\|Only available ~~for~~ {{code~~\|1=~~equals}}}}		{{hatnote\|Only available in <code>equals</code>}}
	An optional function that changes how the output from the tests are displayed. This doesn't effect the comparison process.		An optional function that changes how the output from the tests are displayed. This doesn't effect the comparison process.

Aidan9382: Section on the options that can be passed into the methods (probably should standardize them in one way or another)

2023-01-27T13:41:14Z

Section on the options that can be passed into the methods (probably should standardize them in one way or another)

@@ Line 76: / Line 76: @@
     self:equals_deep('Table comparison', createRange(1,3), {1,2,3},{nowiki=1})
 </syntaxhighlight>
 == See also ==

Aidan9382: /* run_tests */ thats also just an "if exists", woops

2023-01-27T13:21:07Z

run_tests: thats also just an "if exists", woops

← Previous revision		Revision as of 13:21, 27 January 2023
Line 24:		Line 24:
	{{#invoke:Example/testcases\|run_tests\|differs_at=1}}		{{#invoke:Example/testcases\|run_tests\|differs_at=1}}
	</pre>		</pre>
	* If {{code\|1=live_sandbox~~=yes~~}} is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected"		* If {{code\|1=live_sandbox}} is specified, the header will show the columns "Test", "Live", "Sandbox", "Expected"

	=== preprocess_equals ===		=== preprocess_equals ===