PHPUnit - Revision history

Devdocsbot: Protected "PHPUnit": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2022-06-29T05:33:46Z

Protected "PHPUnit": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 05:33, 29 June 2022
(No difference)

Devdocsbot: Update migration status and path

2022-06-29T05:31:30Z

Update migration status and path

← Older revision		Revision as of 05:31, 29 June 2022
Line 1:		Line 1:
			{{Template:Migrated\|newDocId=/general/development/tools/phpunit}}
	{{Moodle 2.3}}		{{Moodle 2.3}}
	=What is PHPUnit=		=What is PHPUnit=

Mudrd8mz: /* PHPUnit versions */

2022-05-09T20:35:16Z

PHPUnit versions

← Older revision		Revision as of 20:35, 9 May 2022
Line 43:		Line 43:
	!Links		!Links
	\|-		\|-
	\| Moodle 3.11		\| Moodle 3.11 - 4.0
	\| PHPUnit 9.5		\| PHPUnit 9.5
	\|[https://phpunit.readthedocs.io/en/9.5/ Documentation]		\|[https://phpunit.readthedocs.io/en/9.5/ Documentation]
Line 67:		Line 67:
	\|[https://phpunit.de/manual/4.8/en/ Documention 4.8]		\|[https://phpunit.de/manual/4.8/en/ Documention 4.8]
	\|}		\|}

	=Initialisation of test environment=		=Initialisation of test environment=
	Our PHPUnit integration requires a dedicated database and dataroot. First, add a new dataroot directory and prefix into your config.php, you can find examples in config-dist.php (scroll down to 'Section 9').		Our PHPUnit integration requires a dedicated database and dataroot. First, add a new dataroot directory and prefix into your config.php, you can find examples in config-dist.php (scroll down to 'Section 9').

Mits: ja link

2022-04-16T15:08:02Z

ja link

← Older revision		Revision as of 15:08, 16 April 2022
Line 228:		Line 228:
	* Display each test name before running it (useful e.g. if it crashes before the end and you want to know which test it was running at that point) vendor/bin/phpunit --debug (you will probably want to redirect this to a file as it gets very long).		* Display each test name before running it (useful e.g. if it crashes before the end and you want to know which test it was running at that point) vendor/bin/phpunit --debug (you will probably want to redirect this to a file as it gets very long).
	[[Category:Unit testing]]		[[Category:Unit testing]]

			[[ja:PHPUnit]]

Bencellis: /* PHPUnit versions */ Add Links to documentation

2021-11-30T15:43:55Z

PHPUnit versions: Add Links to documentation

Show changes

Stronk7: MDL-71049 - Towards namespaced _test test cases #n

2021-11-29T10:54:26Z

MDL-71049 - Towards namespaced _test test cases #n

← Older revision		Revision as of 10:54, 29 November 2021
Line 222:		Line 222:

	<syntaxhighlight lang="php">		<syntaxhighlight lang="php">
			namespace qtype_stack;
	/**		/**
	* Unit tests for {@link stack_cas_keyval}.		* Unit tests for {@link stack_cas_keyval} @ qtype/stack/tests/cas_keyval_test.php.
	* @group qtype_stack		* @group qtype_stack
	*/		*/
	class ~~qtype_stack_cas_keyval_exception_testcase~~ extends basic_testcase {		class cas_keyval_test extends \basic_testcase {
	</syntaxhighlight>		</syntaxhighlight>

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T19:17:47Z
Text replacement - "<code bash>" to "<syntaxhighlight lang="bash">"

				
				
				
				
				
				← Older revision
				Revision as of 19:17, 14 July 2021
				
Line 169:
Line 169:
The fastest way to run a single test in PHPUnit 9.5 and higher (Moodle 3.11 and higher) is to use the filter argument: The fastest way to run a single test in PHPUnit 9.5 and higher (Moodle 3.11 and higher) is to use the filter argument:



<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase
</syntaxhighlight> </syntaxhighlight>
Line 175:
Line 175:
To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example: To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example:



<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite
</syntaxhighlight> </syntaxhighlight>
Line 181:
Line 181:
Alternatively if you have config files built for each component: Alternatively if you have config files built for each component:



<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit -c mod/workshop/form/accumulative/ vendor/bin/phpunit -c mod/workshop/form/accumulative/
</syntaxhighlight> </syntaxhighlight>
Line 190:
Line 190:
The fastest way to run a single test in PHPUnit 8.5 and lower (Moodle 3.10 and lower): The fastest way to run a single test in PHPUnit 8.5 and lower (Moodle 3.10 and lower):



  <code bash>   <syntaxhighlight lang="bash">
vendor/bin/phpunit my/tests/filename.php vendor/bin/phpunit my/tests/filename.php
</syntaxhighlight> </syntaxhighlight>
so, run this command in the CLI to see a real test in action: so, run this command in the CLI to see a real test in action:
<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit cohort/tests/cohortlib_test.php vendor/bin/phpunit cohort/tests/cohortlib_test.php
</syntaxhighlight> </syntaxhighlight>



You can also run a single test method inside a class: You can also run a single test method inside a class:
<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit --filter test_function_name path/to/file.php vendor/bin/phpunit --filter test_function_name path/to/file.php
</syntaxhighlight> </syntaxhighlight>
Line 206:
Line 206:



Filters can also be applied to capture a group of similar tests across all testsuites: Filters can also be applied to capture a group of similar tests across all testsuites:
<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit --filter test_flag_user vendor/bin/phpunit --filter test_flag_user
</syntaxhighlight> </syntaxhighlight>



It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option: It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option:
<code bash> <syntaxhighlight lang="bash">
vendor/bin/phpunit --testsuite mod_forum_testsuite vendor/bin/phpunit --testsuite mod_forum_testsuite
vendor/bin/phpunit --testsuite core_privacy_testsuite vendor/bin/phpunit --testsuite core_privacy_testsuite



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:31:57Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:31, 14 July 2021
				
Line 221:
Line 221:
If you add annotations like If you add annotations like



<code php> <syntaxhighlight lang="php">
/** /**
  * Unit tests for {@link stack_cas_keyval}.   * Unit tests for {@link stack_cas_keyval}.
Line 264:
Line 264:



# clone https://github.com/moodlehq/moodle-exttests to web directory # clone https://github.com/moodlehq/moodle-exttests to web directory
# add to your config.php or modify phpunit.xml file <code php>define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</syntaxhighlight> # add to your config.php or modify phpunit.xml file <syntaxhighlight lang="php">define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</syntaxhighlight>



=Writing new tests= =Writing new tests=



Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:05:56Z
Text replacement - "</code>" to "</syntaxhighlight>"

				
				
				
				
				
				← Older revision
				Revision as of 13:05, 14 July 2021
				
Line 149:
Line 149:
=Test execution= =Test execution=



To execute all test suites from main configuration file execute the <syntaxhighlight lang="php">vendor/bin/phpunit</code> script from your <syntaxhighlight lang="php">$CFG->dirroot</code> directory. To execute all test suites from main configuration file execute the <syntaxhighlight lang="php">vendor/bin/phpunit</syntaxhighlight> script from your <syntaxhighlight lang="php">$CFG->dirroot</syntaxhighlight> directory.



  cd /home/example/moodle   cd /home/example/moodle
  vendor/bin/phpunit   vendor/bin/phpunit



The rest of examples uses <syntaxhighlight lang="php">phpunit</code>, please substitute it with <syntaxhighlight lang="php">vendor/bin/phpunit</code> or create a shortcut in your dirroot. The rest of examples uses <syntaxhighlight lang="php">phpunit</syntaxhighlight>, please substitute it with <syntaxhighlight lang="php">vendor/bin/phpunit</syntaxhighlight> or create a shortcut in your dirroot.



In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <syntaxhighlight lang="php">phpunit.xml</code> from your <syntaxhighlight lang="php">$CFG->dirroot</code>. In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <syntaxhighlight lang="php">phpunit.xml</syntaxhighlight> from your <syntaxhighlight lang="php">$CFG->dirroot</syntaxhighlight>.






There is an alternative script for running of tests via web interface: <syntaxhighlight lang="php">admin/tool/phpunit/webrunner.php</code>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported. There is an alternative script for running of tests via web interface: <syntaxhighlight lang="php">admin/tool/phpunit/webrunner.php</syntaxhighlight>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.






Line 171:
Line 171:
<code bash> <code bash>
vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase
</code> </syntaxhighlight>



To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example: To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example:
Line 177:
Line 177:
<code bash> <code bash>
vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite
</code> </syntaxhighlight>



Alternatively if you have config files built for each component: Alternatively if you have config files built for each component:
Line 183:
Line 183:
<code bash> <code bash>
vendor/bin/phpunit -c mod/workshop/form/accumulative/ vendor/bin/phpunit -c mod/workshop/form/accumulative/
</code> </syntaxhighlight>



==== Running a single test quickly (PHPUnit 8) ==== ==== Running a single test quickly (PHPUnit 8) ====
Line 192:
Line 192:
  <code bash>   <code bash>
vendor/bin/phpunit my/tests/filename.php vendor/bin/phpunit my/tests/filename.php
</code> </syntaxhighlight>
so, run this command in the CLI to see a real test in action: so, run this command in the CLI to see a real test in action:
<code bash> <code bash>
vendor/bin/phpunit cohort/tests/cohortlib_test.php vendor/bin/phpunit cohort/tests/cohortlib_test.php
</code> </syntaxhighlight>



You can also run a single test method inside a class: You can also run a single test method inside a class:
<code bash> <code bash>
vendor/bin/phpunit --filter test_function_name path/to/file.php vendor/bin/phpunit --filter test_function_name path/to/file.php
</code> </syntaxhighlight>



Note: You should be careful because it may be possible to run tests this way which are not included in the normal run if, for example, the file is not placed in the correct location. If you use this method, do at least one full test run (or --group run, as below) to ensure the test can be found. Note: You should be careful because it may be possible to run tests this way which are not included in the normal run if, for example, the file is not placed in the correct location. If you use this method, do at least one full test run (or --group run, as below) to ensure the test can be found.
Line 208:
Line 208:
<code bash> <code bash>
vendor/bin/phpunit --filter test_flag_user vendor/bin/phpunit --filter test_flag_user
</code> </syntaxhighlight>



It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option: It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option:
Line 215:
Line 215:
vendor/bin/phpunit --testsuite core_privacy_testsuite vendor/bin/phpunit --testsuite core_privacy_testsuite
vendor/bin/phpunit --testsuite core_privacy_testsuite --filter test_component_is_compliant vendor/bin/phpunit --testsuite core_privacy_testsuite --filter test_component_is_compliant
</code> </syntaxhighlight>



==== Using the @group annotation ==== ==== Using the @group annotation ====
Line 227:
Line 227:
  */   */
class qtype_stack_cas_keyval_exception_testcase extends basic_testcase { class qtype_stack_cas_keyval_exception_testcase extends basic_testcase {
</code> </syntaxhighlight>



to all the classes in your plugin, then you can run just the tests for your plugin by doing to all the classes in your plugin, then you can run just the tests for your plugin by doing
Line 264:
Line 264:



# clone https://github.com/moodlehq/moodle-exttests to web directory # clone https://github.com/moodlehq/moodle-exttests to web directory
# add to your config.php or modify phpunit.xml file <code php>define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</code> # add to your config.php or modify phpunit.xml file <code php>define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</syntaxhighlight>



=Writing new tests= =Writing new tests=



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:02:22Z
Text replacement - "<code>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:02, 14 July 2021
				
Line 149:
Line 149:
=Test execution= =Test execution=



To execute all test suites from main configuration file execute the <code>vendor/bin/phpunit</code> script from your <code>$CFG->dirroot</code> directory. To execute all test suites from main configuration file execute the <syntaxhighlight lang="php">vendor/bin/phpunit</code> script from your <syntaxhighlight lang="php">$CFG->dirroot</code> directory.



  cd /home/example/moodle   cd /home/example/moodle
  vendor/bin/phpunit   vendor/bin/phpunit



The rest of examples uses <code>phpunit</code>, please substitute it with <code>vendor/bin/phpunit</code> or create a shortcut in your dirroot. The rest of examples uses <syntaxhighlight lang="php">phpunit</code>, please substitute it with <syntaxhighlight lang="php">vendor/bin/phpunit</code> or create a shortcut in your dirroot.



In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <code>phpunit.xml</code> from your <code>$CFG->dirroot</code>. In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <syntaxhighlight lang="php">phpunit.xml</code> from your <syntaxhighlight lang="php">$CFG->dirroot</code>.






There is an alternative script for running of tests via web interface: <code>admin/tool/phpunit/webrunner.php</code>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported. There is an alternative script for running of tests via web interface: <syntaxhighlight lang="php">admin/tool/phpunit/webrunner.php</code>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.

← Older revision		Revision as of 19:17, 14 July 2021
Line 169:		Line 169:
	The fastest way to run a single test in PHPUnit 9.5 and higher (Moodle 3.11 and higher) is to use the filter argument:		The fastest way to run a single test in PHPUnit 9.5 and higher (Moodle 3.11 and higher) is to use the filter argument:

	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase		vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase
	</syntaxhighlight>		</syntaxhighlight>
Line 175:		Line 175:
	To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example:		To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example:

	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite		vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite
	</syntaxhighlight>		</syntaxhighlight>
Line 181:		Line 181:
	Alternatively if you have config files built for each component:		Alternatively if you have config files built for each component:

	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit -c mod/workshop/form/accumulative/		vendor/bin/phpunit -c mod/workshop/form/accumulative/
	</syntaxhighlight>		</syntaxhighlight>
Line 190:		Line 190:
	The fastest way to run a single test in PHPUnit 8.5 and lower (Moodle 3.10 and lower):		The fastest way to run a single test in PHPUnit 8.5 and lower (Moodle 3.10 and lower):

	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit my/tests/filename.php		vendor/bin/phpunit my/tests/filename.php
	</syntaxhighlight>		</syntaxhighlight>
	so, run this command in the CLI to see a real test in action:		so, run this command in the CLI to see a real test in action:
	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit cohort/tests/cohortlib_test.php		vendor/bin/phpunit cohort/tests/cohortlib_test.php
	</syntaxhighlight>		</syntaxhighlight>

	You can also run a single test method inside a class:		You can also run a single test method inside a class:
	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit --filter test_function_name path/to/file.php		vendor/bin/phpunit --filter test_function_name path/to/file.php
	</syntaxhighlight>		</syntaxhighlight>
Line 206:		Line 206:

	Filters can also be applied to capture a group of similar tests across all testsuites:		Filters can also be applied to capture a group of similar tests across all testsuites:
	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit --filter test_flag_user		vendor/bin/phpunit --filter test_flag_user
	</syntaxhighlight>		</syntaxhighlight>

	It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option:		It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option:
	<~~code~~ bash>		<syntaxhighlight lang="bash">
	vendor/bin/phpunit --testsuite mod_forum_testsuite		vendor/bin/phpunit --testsuite mod_forum_testsuite
	vendor/bin/phpunit --testsuite core_privacy_testsuite		vendor/bin/phpunit --testsuite core_privacy_testsuite

← Older revision		Revision as of 13:31, 14 July 2021
Line 221:		Line 221:
	If you add annotations like		If you add annotations like

	<~~code~~ php>		<syntaxhighlight lang="php">
	/**		/**
	* Unit tests for {@link stack_cas_keyval}.		* Unit tests for {@link stack_cas_keyval}.
Line 264:		Line 264:

	# clone https://github.com/moodlehq/moodle-exttests to web directory		# clone https://github.com/moodlehq/moodle-exttests to web directory
	# add to your config.php or modify phpunit.xml file <~~code~~ php>define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</syntaxhighlight>		# add to your config.php or modify phpunit.xml file <syntaxhighlight lang="php">define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</syntaxhighlight>

	=Writing new tests=		=Writing new tests=

← Older revision		Revision as of 13:05, 14 July 2021
Line 149:		Line 149:
	=Test execution=		=Test execution=

	To execute all test suites from main configuration file execute the <syntaxhighlight lang="php">vendor/bin/phpunit</~~code~~> script from your <syntaxhighlight lang="php">$CFG->dirroot</~~code~~> directory.		To execute all test suites from main configuration file execute the <syntaxhighlight lang="php">vendor/bin/phpunit</syntaxhighlight> script from your <syntaxhighlight lang="php">$CFG->dirroot</syntaxhighlight> directory.

	cd /home/example/moodle		cd /home/example/moodle
	vendor/bin/phpunit		vendor/bin/phpunit

	The rest of examples uses <syntaxhighlight lang="php">phpunit</~~code~~>, please substitute it with <syntaxhighlight lang="php">vendor/bin/phpunit</~~code~~> or create a shortcut in your dirroot.		The rest of examples uses <syntaxhighlight lang="php">phpunit</syntaxhighlight>, please substitute it with <syntaxhighlight lang="php">vendor/bin/phpunit</syntaxhighlight> or create a shortcut in your dirroot.

	In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <syntaxhighlight lang="php">phpunit.xml</~~code~~> from your <syntaxhighlight lang="php">$CFG->dirroot</~~code~~>.		In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <syntaxhighlight lang="php">phpunit.xml</syntaxhighlight> from your <syntaxhighlight lang="php">$CFG->dirroot</syntaxhighlight>.


	There is an alternative script for running of tests via web interface: <syntaxhighlight lang="php">admin/tool/phpunit/webrunner.php</~~code~~>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.		There is an alternative script for running of tests via web interface: <syntaxhighlight lang="php">admin/tool/phpunit/webrunner.php</syntaxhighlight>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.


Line 171:		Line 171:
	<code bash>		<code bash>
	vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase		vendor/bin/phpunit --filter tool_dataprivacy_metadata_registry_testcase
	</~~code~~>		</syntaxhighlight>

	To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example:		To run all tests provided by the single component, use suite and the name it has in the phpunit.xml file. Example:
Line 177:		Line 177:
	<code bash>		<code bash>
	vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite		vendor/bin/phpunit --testsuite workshopform_accumulative_testsuite
	</~~code~~>		</syntaxhighlight>

	Alternatively if you have config files built for each component:		Alternatively if you have config files built for each component:
Line 183:		Line 183:
	<code bash>		<code bash>
	vendor/bin/phpunit -c mod/workshop/form/accumulative/		vendor/bin/phpunit -c mod/workshop/form/accumulative/
	</~~code~~>		</syntaxhighlight>

	==== Running a single test quickly (PHPUnit 8) ====		==== Running a single test quickly (PHPUnit 8) ====
Line 192:		Line 192:
	<code bash>		<code bash>
	vendor/bin/phpunit my/tests/filename.php		vendor/bin/phpunit my/tests/filename.php
	</~~code~~>		</syntaxhighlight>
	so, run this command in the CLI to see a real test in action:		so, run this command in the CLI to see a real test in action:
	<code bash>		<code bash>
	vendor/bin/phpunit cohort/tests/cohortlib_test.php		vendor/bin/phpunit cohort/tests/cohortlib_test.php
	</~~code~~>		</syntaxhighlight>

	You can also run a single test method inside a class:		You can also run a single test method inside a class:
	<code bash>		<code bash>
	vendor/bin/phpunit --filter test_function_name path/to/file.php		vendor/bin/phpunit --filter test_function_name path/to/file.php
	</~~code~~>		</syntaxhighlight>

	Note: You should be careful because it may be possible to run tests this way which are not included in the normal run if, for example, the file is not placed in the correct location. If you use this method, do at least one full test run (or --group run, as below) to ensure the test can be found.		Note: You should be careful because it may be possible to run tests this way which are not included in the normal run if, for example, the file is not placed in the correct location. If you use this method, do at least one full test run (or --group run, as below) to ensure the test can be found.
Line 208:		Line 208:
	<code bash>		<code bash>
	vendor/bin/phpunit --filter test_flag_user		vendor/bin/phpunit --filter test_flag_user
	</~~code~~>		</syntaxhighlight>

	It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option:		It is also possible to run all tests in a component (subsystem or plugin) by using the testsuite option:
Line 215:		Line 215:
	vendor/bin/phpunit --testsuite core_privacy_testsuite		vendor/bin/phpunit --testsuite core_privacy_testsuite
	vendor/bin/phpunit --testsuite core_privacy_testsuite --filter test_component_is_compliant		vendor/bin/phpunit --testsuite core_privacy_testsuite --filter test_component_is_compliant
	</~~code~~>		</syntaxhighlight>

	==== Using the @group annotation ====		==== Using the @group annotation ====
Line 227:		Line 227:
	*/		*/
	class qtype_stack_cas_keyval_exception_testcase extends basic_testcase {		class qtype_stack_cas_keyval_exception_testcase extends basic_testcase {
	</~~code~~>		</syntaxhighlight>

	to all the classes in your plugin, then you can run just the tests for your plugin by doing		to all the classes in your plugin, then you can run just the tests for your plugin by doing
Line 264:		Line 264:

	# clone https://github.com/moodlehq/moodle-exttests to web directory		# clone https://github.com/moodlehq/moodle-exttests to web directory
	# add to your config.php or modify phpunit.xml file <code php>define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</~~code~~>		# add to your config.php or modify phpunit.xml file <code php>define('TEST_EXTERNAL_FILES_HTTP_URL', 'http://localhost/moodle-exttests');</syntaxhighlight>

	=Writing new tests=		=Writing new tests=

← Older revision		Revision as of 13:02, 14 July 2021
Line 149:		Line 149:
	=Test execution=		=Test execution=

	To execute all test suites from main configuration file execute the <~~code~~>vendor/bin/phpunit</code> script from your <~~code~~>$CFG->dirroot</code> directory.		To execute all test suites from main configuration file execute the <syntaxhighlight lang="php">vendor/bin/phpunit</code> script from your <syntaxhighlight lang="php">$CFG->dirroot</code> directory.

	cd /home/example/moodle		cd /home/example/moodle
	vendor/bin/phpunit		vendor/bin/phpunit

	The rest of examples uses <~~code~~>phpunit</code>, please substitute it with <~~code~~>vendor/bin/phpunit</code> or create a shortcut in your dirroot.		The rest of examples uses <syntaxhighlight lang="php">phpunit</code>, please substitute it with <syntaxhighlight lang="php">vendor/bin/phpunit</code> or create a shortcut in your dirroot.

	In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <~~code~~>phpunit.xml</code> from your <~~code~~>$CFG->dirroot</code>.		In IDEs, you may need to specify the path to the PHPUnit configuration file. Use the absolute path to <syntaxhighlight lang="php">phpunit.xml</code> from your <syntaxhighlight lang="php">$CFG->dirroot</code>.


	There is an alternative script for running of tests via web interface: <~~code~~>admin/tool/phpunit/webrunner.php</code>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.		There is an alternative script for running of tests via web interface: <syntaxhighlight lang="php">admin/tool/phpunit/webrunner.php</code>. Use this as the last resort only when you cannot use the command-line interface on your test server. It will most probably break due to permissions problems if you try to execute it both from command-line and from webrunner. This feature is not officially supported.