Testing - Revision history

Jureslak at 13:35, 17 January 2019

2019-01-17T13:35:14Z

← Older revision		Revision as of 13:35, 17 January 2019
Line 1:		Line 1:
	{{~~note~~\|~~Foo\|reminder~~}}		{{Info\|This page is meant for Medusa developers.}}

	<figure id="fig:tests">		<figure id="fig:tests">
	[[File:tests.png\|500px\|thumb\|upright=2\|alt=Output of successfull ./run_tests.py script run.\|<caption>Output of successfull <code>./run_tests.py</code> script run.</caption>]]		[[File:tests.png\|500px\|thumb\|upright=2\|alt=Output of a successfull ./run_tests.py script run.\|<caption>Output of successfull <code>./run_tests.py</code> script run.</caption>]]
	</figure>		</figure>

Line 11:		Line 11:
	* examples		* examples

	The <code>./run_tests.sh</code> script controlls all tests		The <code>./run_tests.py</code> script controlls all tests
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	usage: run_tests.py [-h] [-c] [-b] [-t] [--build-examples] [-e] [-s] [-d]		usage: run_tests.py [-h] [-c] [-b] [-t] [--build-examples] [-e] [-s] [-d]

Jureslak at 13:29, 17 January 2019

2019-01-17T13:29:22Z

← Older revision		Revision as of 13:29, 17 January 2019
Line 1:		Line 1:
	{{~~Note~~\|~~This page is meant for Medusa developers.~~}}		{{note\|Foo\|reminder}}

	<figure id="fig:tests">		<figure id="fig:tests">

Jureslak at 13:28, 17 January 2019

2019-01-17T13:28:09Z

← Older revision		Revision as of 13:28, 17 January 2019
Line 1:		Line 1:
	{{~~Info~~\|This page is meant for Medusa developers.}}		{{Note\|This page is meant for Medusa developers.}}

	<figure id="fig:tests">		<figure id="fig:tests">

Jureslak at 13:27, 17 January 2019

2019-01-17T13:27:34Z

← Older revision		Revision as of 13:27, 17 January 2019
Line 1:		Line 1:
	{{~~Note~~\|This page is meant for Medusa developers.}}		{{Info\|This page is meant for Medusa developers.}}

	<figure id="fig:tests">		<figure id="fig:tests">

Jureslak at 13:27, 17 January 2019

2019-01-17T13:27:22Z

← Older revision		Revision as of 13:27, 17 January 2019
Line 1:		Line 1:
	{{~~Warning~~\|This ~~section~~ is ~~out of date. If will hopefully be fixed soon. See [https://gitlab.com/e62Lab/medusa Gitlab repository]~~ for ~~more details~~.}}		{{Note\|This page is meant for Medusa developers.}}

	<figure id="fig:tests">		<figure id="fig:tests">

Jureslak at 13:26, 17 January 2019

2019-01-17T13:26:31Z

← Older revision		Revision as of 13:26, 17 January 2019
Line 2:		Line 2:

	<figure id="fig:tests">		<figure id="fig:tests">
	[[File:tests.png\|500px\|thumb\|upright=2\|alt=Output of successfull ./run_tests.sh script run.\|<caption>Output of successfull <code>./run_tests.sh</code> script run.</caption>]]		[[File:tests.png\|500px\|thumb\|upright=2\|alt=Output of successfull ./run_tests.py script run.\|<caption>Output of successfull <code>./run_tests.py</code> script run.</caption>]]
	</figure>		</figure>

Line 8:		Line 8:
	* unit tests		* unit tests
	* style checks		* style checks
	* ~~docs check~~		* documentation checks
	* ~~system configuration check~~		* examples

	The <code>./run_tests.sh</code> script controlls all tests		The <code>./run_tests.sh</code> script controlls all tests
Line 28:		Line 28:
	</syntaxhighlight>		</syntaxhighlight>

	Before pushing run <syntaxhighlight lang="bash" inline>./run_tests.sh</syntaxhighlight>.		Before pushing, always run <syntaxhighlight lang="bash" inline>./run_tests.py</syntaxhighlight>.
	This script ~~makes~~ and executes all ~~<syntaxhighlight lang="bash" inline> <util_name>_test.cpp </syntaxhighlight> test files~~, checks coding style and		This script compiles and executes all tests, checks coding style, documentation and examples.
	~~documentation.~~ If anything is wrong you will get pretty little red error, but if you see green, like in <xr id="fig:tests"/>, you're good to go.		If anything is wrong you will get pretty little red error, but if you see green, like in <xr id="fig:tests"/>, you're good to go.

	=Unit tests=		=Unit tests=
Line 60:		Line 60:

	<b>When writing unit tests, always write them thoroughly and slowly, take your time.		<b>When writing unit tests, always write them thoroughly and slowly, take your time.
	Never copy your own code's ~~ouput~~ to the test; rather produce it by hand or with another trusted tool.		Never copy your own code's output to the test; rather produce it by hand or with another trusted tool.
	Even if it seems obvious the code is correct, remember that you are writing tests also for the future.		Even if it seems obvious the code is correct, remember that you are writing tests also for the future.
	If tests have a bug, it is much harder to debug!</b>		If tests have a bug, it is much harder to debug!</b>

	See our examples in [http://~~www-~~e6.ijs.si/~~ParallelAndDistributedSystems~~/~~MeshlessMachine/technical_docs~~/html/examples.html ~~techincal~~ documentation].		See our examples in [http://e6.ijs.si/medusa/docs/html/examples.html technical documentation].

	==Running unit tests==		==Running unit tests==

	Tests can be run all at once via <syntaxhighlight lang="bash" inline>make ~~run_all_tests~~</syntaxhighlight> or individually via eg. <syntaxhighlight lang="bash" inline>make operators_run_tests </syntaxhighlight>.		Tests can be run all at once via <syntaxhighlight lang="bash" inline>make medusa_run_tests</syntaxhighlight> or individually via eg. <syntaxhighlight lang="bash" inline>make operators_run_tests </syntaxhighlight>.

	Compiled binary supports running only specified test. Use <syntaxhighlight lang="bash" inline> ./~~all_tests~~ --gtest_filter=Domain*</syntaxhighlight> for filtering and <syntaxhighlight lang="bash" inline> ./~~all_tests~~ --help </syntaxhighlight> for more options.		Compiled binary supports running only specified test. Use <syntaxhighlight lang="bash" inline>./bin/medusa_tests --gtest_filter=Domain*</syntaxhighlight> or
			simply <code>GF="Domain" make domain_run_tests</code> for filtering and <syntaxhighlight lang="bash" inline>./bin/medusa_tests --help </syntaxhighlight> for more options.

	==Fixing bugs==		==Fixing bugs==
Line 76:		Line 77:

	= Style check =		= Style check =
	Before ~~commiting~~, a linter <code>cpplint.py</code> is ran on all the source and test files to make sure that the code follows the [[coding style\|style guide]].		Before committing, a linter <code>cpplint.py</code> is ran on all the source and test files to make sure that the code follows the [[coding style\|style guide]].
	The linter is not perfect, so if any errors are unjust, feel free to comment appropriate lines in the linter out and commit the change.		The linter is not perfect, so if any errors are unjust, feel free to comment appropriate lines in the linter out and commit the change.

	= Docs check =		= Docs check =
	Every function, class or method should also have documentation as ~~einforced~~ by doxygen in the header where they are defined.		Every function, class or method should also have documentation as enforced by doxygen in the header where they are defined.
	In the comment block, all parameters, and return value should be ~~meaningully~~ described. It can also ~~containg~~ a short example.		In the comment block, all parameters, and return value should be meaningfully described. It can also containing a short example.

	Example:		Example:
Line 96:		Line 97:

	Any longer discussions about the method used or long examples belong to this wiki, but can be linked from the docs.		Any longer discussions about the method used or long examples belong to this wiki, but can be linked from the docs.

	~~= Configuration testing =~~

	~~The script [https://gitlab.com/e62Lab/e62numcodes/blob/master/scripts/configure.sh scripts/configure.sh] checks~~
	~~the computer has appropriate packages and that very basic code examples (hdf5, sfml) compile.~~
	~~It currently support arch like and ubuntu like distros.~~

	~~If you find yourself making modification to [https://gitlab.com/e62Lab/e62numcodes/blob/master/.gitlab-ci.yml .gitlab-ci.yml] then maybe you should~~
	~~update this check as well, as well as some documentation in the [[how to build]] page but this should not happen very often.~~

	= Continuous build =		= Continuous build =
Line 111:		Line 103:
	[https://docs.gitlab.com/runner/#features Runner features]		[https://docs.gitlab.com/runner/#features Runner features]

	To configure runner that perform MM test on each commit edit <~~strong~~>gitlab-ci.yml</~~strong~~> ~~on main (e62numcodes) repo~~.		To configure runner that perform MM test on each commit edit <code>.gitlab-ci.yml</code> in repository.

Jureslak at 12:29, 17 January 2019

2019-01-17T12:29:12Z

← Older revision		Revision as of 12:29, 17 January 2019
Line 13:		Line 13:
	The <code>./run_tests.sh</code> script controlls all tests		The <code>./run_tests.sh</code> script controlls all tests
	<syntaxhighlight lang="bash">		<syntaxhighlight lang="bash">
	~~Usage~~: .~~/run_tests~~.sh		usage: run_tests.py [-h] [-c] [-b] [-t] [--build-examples] [-e] [-s] [-d]
	~~Options~~:
	-c ~~run only configuration test~~		Script to check you medusa library.
	-t run ~~only unit~~ tests
	-s run ~~only stylechecks~~		optional arguments:
	-~~d run only docs check~~		-h, --help show this help message and exit
	-~~h print this help~~		-c, --configure check your system configuration
	~~Example:~~		-b, --build build the library
	~~./run_tests.sh~~ -sd		-t, --tests run all tests
			--build-examples build all examples
			-e, --run-examples run selected examples
			-s, --style style checks all sources and reports any errors
			-d, --docs generate and check for documentation errors
	</syntaxhighlight>		</syntaxhighlight>

Gkosec: /* Running unit tests */

2018-12-07T19:11:25Z

Running unit tests

← Older revision		Revision as of 19:11, 7 December 2018
Line 64:		Line 64:
	==Running unit tests==		==Running unit tests==

	Tests can be run all at once via <syntaxhighlight lang="bash" inline>make run_all_tests</syntaxhighlight> or individually via eg. <syntaxhighlight lang="bash" inline>make ~~basisfunc_run_tests~~ </syntaxhighlight>.		Tests can be run all at once via <syntaxhighlight lang="bash" inline>make run_all_tests</syntaxhighlight> or individually via eg. <syntaxhighlight lang="bash" inline>make operators_run_tests </syntaxhighlight>.

	Compiled binary supports running only specified test. Use <syntaxhighlight lang="bash" inline> ./all_tests --gtest_filter=Domain*</syntaxhighlight> for filtering and <syntaxhighlight lang="bash" inline> ./all_tests --help </syntaxhighlight> for more options.		Compiled binary supports running only specified test. Use <syntaxhighlight lang="bash" inline> ./all_tests --gtest_filter=Domain*</syntaxhighlight> for filtering and <syntaxhighlight lang="bash" inline> ./all_tests --help </syntaxhighlight> for more options.

Jureslak at 23:20, 31 May 2018

2018-05-31T23:20:37Z

← Older revision		Revision as of 23:20, 31 May 2018
Line 1:		Line 1:
			{{Warning\|This section is out of date. If will hopefully be fixed soon. See [https://gitlab.com/e62Lab/medusa Gitlab repository] for more details.}}

	<figure id="fig:tests">		<figure id="fig:tests">
	[[File:tests.png\|500px\|thumb\|upright=2\|alt=Output of successfull ./run_tests.sh script run.\|<caption>Output of successfull <code>./run_tests.sh</code> script run.</caption>]]		[[File:tests.png\|500px\|thumb\|upright=2\|alt=Output of successfull ./run_tests.sh script run.\|<caption>Output of successfull <code>./run_tests.sh</code> script run.</caption>]]

Anja at 13:43, 24 November 2016

2016-11-24T13:43:54Z

← Older revision		Revision as of 13:43, 24 November 2016
Line 10:		Line 10:

	The <code>./run_tests.sh</code> script controlls all tests		The <code>./run_tests.sh</code> script controlls all tests
	<syntaxhighlight>		<syntaxhighlight lang="bash">
	Usage: ./run_tests.sh		Usage: ./run_tests.sh
	Options:		Options: