moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-08 02:16:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-71036 phpunit: Mock->setMethods() silently deprecated

Browse source 
The current ->setMethods() has been silently (won't emit any
warning) in PHPUnit 9. And will stop working (current plans)
in PHPUnit 10.

Basically the now deprecated method has been split into:

- onlyMethods(): To point to existing methods in the mocked artifact.
- addMethods(): To point to non existing (yet) methods in the mocked
  artifact.

In practice that means that all our current setMethods() calls can be
converted to onlyMethods() (existing) and done. The addMethods() is
mostly useful on development phases, not final testing.

Finally note that <null> isn't accepted anymore as parameter to
double all the methods. Instead empty array [] must be used.

Link: https://github.com/sebastianbergmann/phpunit/issues/3770
This commit is contained in:
Eloy Lafuente (stronk7) 2021-03-11 19:31:28 +01:00
parent 8a14a7bd22
commit 81407f18ec
42 changed files with 181 additions and 181 deletions
Download patch file Download diff file Expand all files Collapse all files

20
lib/antivirus/clamav/tests/scanner_test.php
View file

@ -44,7 +44,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
public function test_scan_file_not_exists() {
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods(array('scan_file_execute_commandline', 'message_admins'))
->onlyMethods(array('scan_file_execute_commandline', 'message_admins'))
->getMock();
// Test specifying file that does not exist.
@ -63,7 +63,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_config',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Initiate mock scanning with configuration setting to use commandline.
$configmap = array(array('runningmethod', 'commandline'));
@ -104,7 +104,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_config',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Initiate mock scanning with configuration setting to use commandline.
$configmap = array(array('runningmethod', 'commandline'));
@ -146,7 +146,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_scanning_notice',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Configure scan_file_execute_commandline and scan_file_execute_socket
@ -193,7 +193,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_scanning_notice',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Configure scan_file_execute_commandline and scan_file_execute_socket
@ -242,7 +242,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_config',
'get_scanning_notice',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')->setMethods($methods)->getMock();
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')->onlyMethods($methods)->getMock();
// Configure scan_file_execute_commandline and scan_file_execute_unixsocket
// method stubs to behave as if there is a scanning error (SCAN_RESULT_ERROR).
@ -273,7 +273,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_config',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Initiate mock scanning with configuration setting to use unixsocket.
$configmap = array(array('runningmethod', 'unixsocket'));
@ -307,7 +307,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_config',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Initiate mock scanning with configuration setting to use unixsocket.
$configmap = array(array('runningmethod', 'unixsocket'));
@ -342,7 +342,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_scanning_notice',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Initiate mock scanning with configuration setting to do nothing on
// scanning error and using unixsocket.
@ -380,7 +380,7 @@ class antivirus_clamav_scanner_testcase extends advanced_testcase {
'get_scanning_notice',
);
$antivirus = $this->getMockBuilder('\antivirus_clamav\scanner')
->setMethods($methods)
->onlyMethods($methods)
->getMock();
// Initiate mock scanning with configuration setting to act like virus on

16
lib/filestorage/tests/file_system_filedir_test.php
View file

@ -99,14 +99,14 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
* If no methods are specified, only abstract functions are mocked.
* @return stored_file
*/
protected function get_stored_file($filecontent, $filename = null, $mockedmethods = null) {
protected function get_stored_file($filecontent, $filename = null, $mockedmethods = []) {
$contenthash = file_storage::hash_from_string($filecontent);
if (empty($filename)) {
$filename = $contenthash;
}
$file = $this->getMockBuilder(stored_file::class)
->setMethods($mockedmethods)
->onlyMethods($mockedmethods)
->setConstructorArgs([
get_file_storage(),
(object) [
@ -129,7 +129,7 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
*/
protected function get_testable_mock($mockedmethods = []) {
$fs = $this->getMockBuilder(file_system_filedir::class)
->setMethods($mockedmethods)
->onlyMethods($mockedmethods)
->getMock();
return $fs;
@ -321,7 +321,7 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
$file = $this->getMockBuilder('stored_file')
->disableOriginalConstructor()
->setMethods([
->onlyMethods([
'sync_external_file',
'get_contenthash',
])
@ -441,7 +441,7 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
$fs = $this->getMockBuilder(file_system_filedir::class)
->disableOriginalConstructor()
->setMethods([
->onlyMethods([
'get_local_path_from_storedfile',
])
->getMock();
@ -997,7 +997,7 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
global $DB;
$DB = $this->getMockBuilder(\moodle_database::class)
->setMethods(['record_exists'])
->onlyMethods(['record_exists'])
->getMockForAbstractClass();
$DB->expects($this->never())
@ -1031,7 +1031,7 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
$vfileroot = $this->setup_vfile_root($filedircontent);
$DB = $this->getMockBuilder(\moodle_database::class)
->setMethods(['record_exists'])
->onlyMethods(['record_exists'])
->getMockForAbstractClass();
$DB->method('record_exists')->willReturn(true);
@ -1064,7 +1064,7 @@ class core_files_file_system_filedir_testcase extends advanced_testcase {
$vfileroot = $this->setup_vfile_root($filedircontent);
$DB = $this->getMockBuilder(\moodle_database::class)
->setMethods(['record_exists'])
->onlyMethods(['record_exists'])
->getMockForAbstractClass();
$DB->method('record_exists')->willReturn(false);

20
lib/filestorage/tests/file_system_test.php
View file

@ -70,14 +70,14 @@ class core_files_file_system_testcase extends advanced_testcase {
* If no methods are specified, only abstract functions are mocked.
* @return stored_file
*/
protected function get_stored_file($filecontent, $filename = null, $mockedmethods = null) {
protected function get_stored_file($filecontent, $filename = null, $mockedmethods = []) {
$contenthash = file_storage::hash_from_string($filecontent);
if (empty($filename)) {
$filename = $contenthash;
}
$file = $this->getMockBuilder(stored_file::class)
->setMethods($mockedmethods)
->onlyMethods($mockedmethods)
->setConstructorArgs([
get_file_storage(),
(object) [
@ -100,7 +100,7 @@ class core_files_file_system_testcase extends advanced_testcase {
*/
protected function get_testable_mock($mockedmethods = []) {
$fs = $this->getMockBuilder(file_system::class)
->setMethods($mockedmethods)
->onlyMethods($mockedmethods)
->getMockForAbstractClass();
return $fs;
@ -514,7 +514,7 @@ class core_files_file_system_testcase extends advanced_testcase {
$contenthash = file_storage::hash_from_string($filecontent);
$DB = $this->getMockBuilder(\moodle_database::class)
->setMethods(['record_exists'])
->onlyMethods(['record_exists'])
->getMockForAbstractClass();
$DB->method('record_exists')->willReturn(true);
@ -538,7 +538,7 @@ class core_files_file_system_testcase extends advanced_testcase {
$contenthash = file_storage::hash_from_string($filecontent);
$DB = $this->getMockBuilder(\moodle_database::class)
->setMethods(['record_exists'])
->onlyMethods(['record_exists'])
->getMockForAbstractClass();
$DB->method('record_exists')->willReturn(false);
@ -615,7 +615,7 @@ class core_files_file_system_testcase extends advanced_testcase {
->willReturn(__FILE__);
$packer = $this->getMockBuilder(file_packer::class)
->setMethods(['list_files'])
->onlyMethods(['list_files'])
->getMockForAbstractClass();
$packer->expects($this->once())
@ -648,7 +648,7 @@ class core_files_file_system_testcase extends advanced_testcase {
->willReturn(__FILE__);
$packer = $this->getMockBuilder(file_packer::class)
->setMethods(['extract_to_pathname'])
->onlyMethods(['extract_to_pathname'])
->getMockForAbstractClass();
$packer->expects($this->once())
@ -681,7 +681,7 @@ class core_files_file_system_testcase extends advanced_testcase {
->willReturn(__FILE__);
$packer = $this->getMockBuilder(file_packer::class)
->setMethods(['extract_to_storage'])
->onlyMethods(['extract_to_storage'])
->getMockForAbstractClass();
$packer->expects($this->once())
@ -720,7 +720,7 @@ class core_files_file_system_testcase extends advanced_testcase {
->willReturn(__FILE__);
$archive = $this->getMockBuilder(file_archive::class)
->setMethods([
->onlyMethods([
'add_directory',
'add_file_from_pathname',
])
@ -757,7 +757,7 @@ class core_files_file_system_testcase extends advanced_testcase {
->willReturn($filepath);
$archive = $this->getMockBuilder(file_archive::class)
->setMethods([
->onlyMethods([
'add_directory',
'add_file_from_pathname',
])

8
lib/table/tests/local/filter/filterset_test.php
View file

@ -135,7 +135,7 @@ class filterset_test extends advanced_testcase {
public function test_add_filter_validated_type(): void {
$namefilter = $this->getMockBuilder(filter::class)
->setConstructorArgs(['name'])
->setMethods(null)
->onlyMethods([])
->getMock();
$namefilter->add_filter_value('rosie');
@ -188,7 +188,7 @@ class filterset_test extends advanced_testcase {
// Add a filter to the list.
// This is the 'name' filter.
$namefilter = $this->getMockBuilder(filter::class)
->setMethods(null)
->onlyMethods([])
->setConstructorArgs([$filtername])
->getMock();
@ -207,7 +207,7 @@ class filterset_test extends advanced_testcase {
public function test_add_filter_from_params(): void {
$filtername = "name";
$otherfilter = $this->getMockBuilder(filter::class)
->setMethods(null)
->onlyMethods([])
->setConstructorArgs([$filtername])
->getMock();
@ -254,7 +254,7 @@ class filterset_test extends advanced_testcase {
public function test_add_filter_from_params_invalid(): void {
$filtername = "name";
$otherfilter = $this->getMockBuilder(filter::class)
->setMethods(null)
->onlyMethods([])
->setConstructorArgs([$filtername])
->getMock();

8
lib/tests/accesslib_test.php
View file

@ -4233,7 +4233,7 @@ class core_accesslib_testcase extends advanced_testcase {
public function test_is_parent_of(string $contextpath, string $testpath, bool $testself, bool $expected): void {
$context = $this->getMockBuilder(\context::class)
->disableOriginalConstructor()
->setMethods([
->onlyMethods([
'get_url',
'get_capabilities',
])
@ -4245,7 +4245,7 @@ class core_accesslib_testcase extends advanced_testcase {
$comparisoncontext = $this->getMockBuilder(\context::class)
->disableOriginalConstructor()
->setMethods([
->onlyMethods([
'get_url',
'get_capabilities',
])
@ -4335,7 +4335,7 @@ class core_accesslib_testcase extends advanced_testcase {
public function test_is_child_of(string $contextpath, string $testpath, bool $testself, bool $expected): void {
$context = $this->getMockBuilder(\context::class)
->disableOriginalConstructor()
->setMethods([
->onlyMethods([
'get_url',
'get_capabilities',
])
@ -4347,7 +4347,7 @@ class core_accesslib_testcase extends advanced_testcase {
$comparisoncontext = $this->getMockBuilder(\context::class)
->disableOriginalConstructor()
->setMethods([
->onlyMethods([
'get_url',
'get_capabilities',
])

12
lib/tests/completionlib_test.php
View file

@ -129,7 +129,7 @@ class core_completionlib_testcase extends advanced_testcase {
$this->mock_setup();
$mockbuilder = $this->getMockBuilder('completion_info');
$mockbuilder->setMethods(array('is_enabled', 'get_data', 'internal_get_state', 'internal_set_data',
$mockbuilder->onlyMethods(array('is_enabled', 'get_data', 'internal_get_state', 'internal_set_data',
'user_can_override_completion'));
$mockbuilder->setConstructorArgs(array((object)array('id' => 42)));
$cm = (object)array('id'=>13, 'course'=>42);
@ -453,7 +453,7 @@ class core_completionlib_testcase extends advanced_testcase {
$this->mock_setup();
$mockbuilder = $this->getMockBuilder('completion_info');
$mockbuilder->setMethods(array('is_enabled', 'get_data', 'internal_set_data', 'update_state'));
$mockbuilder->onlyMethods(array('is_enabled', 'get_data', 'internal_set_data', 'update_state'));
$mockbuilder->setConstructorArgs(array((object)array('id' => 42)));
$cm = (object)array('id'=>13, 'course'=>42);
@ -542,7 +542,7 @@ class core_completionlib_testcase extends advanced_testcase {
$this->mock_setup();
$mockbuilder = $this->getMockBuilder('completion_info');
$mockbuilder->setMethods(array('delete_all_state', 'get_tracked_users', 'update_state'));
$mockbuilder->onlyMethods(array('delete_all_state', 'get_tracked_users', 'update_state'));
$mockbuilder->setConstructorArgs(array((object)array('id' => 42)));
$c = $mockbuilder->getMock();
@ -756,7 +756,7 @@ class core_completionlib_testcase extends advanced_testcase {
$this->mock_setup();
$mockbuilder = $this->getMockBuilder('completion_info');
$mockbuilder->setMethods(array('get_tracked_users'));
$mockbuilder->onlyMethods(array('get_tracked_users'));
$mockbuilder->setConstructorArgs(array((object)array('id' => 42)));
$c = $mockbuilder->getMock();
@ -790,7 +790,7 @@ class core_completionlib_testcase extends advanced_testcase {
$this->mock_setup();
$mockbuilder = $this->getMockBuilder('completion_info');
$mockbuilder->setMethods(array('get_tracked_users'));
$mockbuilder->onlyMethods(array('get_tracked_users'));
$mockbuilder->setConstructorArgs(array((object)array('id' => 42)));
$c = $mockbuilder->getMock();
@ -844,7 +844,7 @@ class core_completionlib_testcase extends advanced_testcase {
$this->mock_setup();
$mockbuilder = $this->getMockBuilder('completion_info');
$mockbuilder->setMethods(array('is_enabled', 'update_state'));
$mockbuilder->onlyMethods(array('is_enabled', 'update_state'));
$mockbuilder->setConstructorArgs(array((object)array('id' => 42)));
$cm = (object)array('course'=>42, 'id'=>13, 'completion'=>0, 'completiongradeitemnumber'=>null);

2
lib/tests/content/export/exportable_items/exportable_filearea_test.php
View file

@ -224,7 +224,7 @@ class exportable_filearea_test extends advanced_testcase {
): exported_item {
$archive = $this->getMockBuilder(zipwriter::class)
->setConstructorArgs([$this->getMockBuilder(\ZipStream\ZipStream::class)->getmock()])
->setMethods([
->onlyMethods([
'add_file_from_stored_file',
'is_file_in_archive',
])

2
lib/tests/content/export/exportable_items/exportable_stored_file_test.php
View file

@ -209,7 +209,7 @@ class exportable_stored_file_test extends advanced_testcase {
): void {
$archive = $this->getMockBuilder(zipwriter::class)
->setConstructorArgs([$this->getMockBuilder(\ZipStream\ZipStream::class)->getmock()])
->setMethods([
->onlyMethods([
'add_file_from_stored_file',
])
->getMock();

4
lib/tests/content/export/exportable_items/exportable_textarea_test.php
View file

@ -309,7 +309,7 @@ EOF;
): void {
$archive = $this->getMockBuilder(zipwriter::class)
->setConstructorArgs([$this->getMockBuilder(\ZipStream\ZipStream::class)->getmock()])
->setMethods([
->onlyMethods([
'is_file_in_archive',
'add_file_from_string',
'add_file_from_stored_file',
@ -357,7 +357,7 @@ EOF;
): void {
$archive = $this->getMockBuilder(zipwriter::class)
->setConstructorArgs([$this->getMockBuilder(\ZipStream\ZipStream::class)->getmock()])
->setMethods([
->onlyMethods([
'add_file_from_stored_file',
'add_file_from_string',
'add_file_from_template',

2
lib/tests/content/export/exporters/course_exporter_test.php
View file

@ -149,7 +149,7 @@ class course_exporter_test extends advanced_testcase {
protected function get_mocked_zipwriter(?array $methods = []): zipwriter {
return $this->getMockBuilder(zipwriter::class)
->setConstructorArgs([$this->getMockBuilder(\ZipStream\ZipStream::class)->getmock()])
->setMethods($methods)
->onlyMethods($methods)
->getMock();
}
}

2
lib/tests/curl_security_helper_test.php
View file

@ -48,7 +48,7 @@ class core_curl_security_helper_testcase extends advanced_testcase {
public function test_curl_security_helper_url_is_blocked($dns, $url, $blockedhosts, $allowedports, $expected) {
$this->resetAfterTest(true);
$helper = $this->getMockBuilder('\core\files\curl_security_helper')
->setMethods(['get_host_list_by_name'])
->onlyMethods(['get_host_list_by_name'])
->getMock();
// Override the get host list method to return hard coded values based on a mapping provided by $dns.

2
lib/tests/h5p_get_content_types_task_test.php
View file

@ -73,7 +73,7 @@ class h5p_get_content_types_task_testcase extends advanced_testcase {
// Mock implementation of \core\task\h5p_get_content_types_task::get_core to avoid external systems.
$mocktask = $this->getMockBuilder(\core\task\h5p_get_content_types_task::class)
->setMethods(['get_core'])
->onlyMethods(['get_core'])
->getMock();
$mocktask->expects($this->any())

6
lib/tests/task_database_logger_test.php
View file

@ -104,7 +104,7 @@ class task_database_logger_testcase extends advanced_testcase {
file_put_contents($logpath, 'Example content');
$task = $this->getMockBuilder(\core\task\adhoc_task::class)
->setMethods(['get_component', 'execute'])
->onlyMethods(['get_component', 'execute'])
->getMock();
$task->method('get_component')->willReturn('core_test');
@ -165,7 +165,7 @@ class task_database_logger_testcase extends advanced_testcase {
file_put_contents($logpath, 'Example content');
$task = $this->getMockBuilder(\core\task\adhoc_task::class)
->setMethods(['get_component', 'execute'])
->onlyMethods(['get_component', 'execute'])
->getMock();
$task->method('get_component')->willReturn('core_test');
@ -197,7 +197,7 @@ class task_database_logger_testcase extends advanced_testcase {
file_put_contents($logpath, 'Example content');
$task = $this->getMockBuilder(\core\task\adhoc_task::class)
->setMethods(['get_component', 'execute', 'get_userid'])
->onlyMethods(['get_component', 'execute', 'get_userid'])
->getMock();
$task->method('get_component')->willReturn('core_test');