Tidy up and fix phpunit_example [#3072441]

Problem/motivation:

Warnings of deprecation code and coding standards

Line   phpunit_example/tests/src/Unit/AddClassTest.php                    
 ------ ------------------------------------------------------------------- 
  114    Call to deprecated method setExpectedException() of class          
         Drupal\Tests\UnitTestCase:                                         
         in drupal:8.8.0 and is removed from drupal:9.0.0.                  
         Backward compatibility for PHPUnit 4 will no longer be supported.  

 Line   phpunit_example/tests/src/Unit/ProtectedPrivatesTest.php           
 ------ ------------------------------------------------------------------- 
  113    Call to deprecated method setExpectedException() of class          
         Drupal\Tests\UnitTestCase:                                         
         in drupal:8.8.0 and is removed from drupal:9.0.0.                  
         Backward compatibility for PHPUnit 4 will no longer be supported.  
  143    Call to deprecated method setExpectedException() of class          
         Drupal\Tests\UnitTestCase:                                         
         in drupal:8.8.0 and is removed from drupal:9.0.0.                  
         Backward compatibility for PHPUnit 4 will no longer be supported.

  1x: Drupal\Tests\BrowserTestBase::$defaultTheme is required in drupal:9.0.0 when using an install profile that does not set a default theme. See https://www.drupal.org/node/3083055, which includes recommendations on which theme to use.
    1x in PHPUnitExampleMenuTest::testLinksAndPages from Drupal\Tests\phpunit_example\Functional


FILE: examples/phpunit_example/src/ProtectedPrivates.php
--------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------
 52 | WARNING | Unused private method privateAdd()
--------------------------------------------------------------------------------------------------------


FILE: examples/phpunit_example/src/DisplayManager.php
-----------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
-----------------------------------------------------------------------------------------------------
 20 | ERROR | Missing member variable doc comment
--------------------------------------------------------------------------------

Comment	File	Size	Author
#8	phpunit-example-3072441-8.patch	3.99 KB	jungle
#8	8.x-1.x: PHP 7.2 & MySQL 5.5, D8.8 124 pass, 59 fail
#3	replace_deprecated_class-3072441-1.patch	2.55 KB	Malevi4
#3	8.x-1.x: PHP 7.2 & MySQL 5.5, D8.7 202 pass PHP 7.2 & MySQL 5.5, D8.8 192 pass, 6 fail

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

3 August 2019 at 13:21

Malevi4 created an issue. See original summary.

Comment #2

Malevi4 CreditAttribution: Malevi4 at Drupal Ukraine Community commented 3 August 2019 at 13:24

Issue summary:

View changes

Comment #3

Malevi4 CreditAttribution: Malevi4 at Drupal Ukraine Community commented 3 August 2019 at 13:49

File	Size
replace_deprecated_class-3072441-1.patch	2.55 KB
8.x-1.x: PHP 7.2 & MySQL 5.5, D8.7 202 pass PHP 7.2 & MySQL 5.5, D8.8 192 pass, 6 fail

Add patch replace_deprecated_class-3072441-1.patch

Comment #4

osab CreditAttribution: osab as a volunteer and at AnyforSoft, Drupal Ukraine Community, Happy Coding for Drupal Ukraine Community commented 3 August 2019 at 13:57

Status:

Active

» Needs review

Comment #5

andypost

he/him

Russian

CreditAttribution: andypost as a volunteer and at Skilld commented 3 August 2019 at 17:22

Title:	Replace deprecated class setExpectedException()	» [8.8 core] Replace deprecated class setExpectedException()
Issue tags:		+PHPUnit

Comment #6

Kristen Pol

she/her

English

Santa Cruz, CA, USA

CreditAttribution: Kristen Pol at Hook 42 commented 28 November 2019 at 07:19

Issue tags:

+Drupal 9 compatibility

Per a Slack discussion with Gábor Hojtsy regarding usage of D9 tags (Drupal 9, Drupal 9 compatibility, Drupal 9 readiness, etc.), "Drupal 9 compatibility" should be used for contributed projects that need updating and "Drupal 9" was the old tag for D8 issues before the D9 branch was ready. Doing tag cleanup here based on that discussion.

Comment #7

jungle

He/Him

Chongqing, China

CreditAttribution: jungle as a volunteer commented 28 December 2019 at 20:54

Title:	[8.8 core] Replace deprecated class setExpectedException()	» Tidy up phpunit_example
Assigned:	Unassigned	» jungle
Issue summary:	View changes
Status:	Needs review	» Needs work

1 file was hidden/shown/deleted

File	Size
replace_deprecated_class-3072441-1.patch	2.55 KB
8.x-1.x: PHP 7.2 & MySQL 5.5, D8.7 202 pass PHP 7.2 & MySQL 5.5, D8.8 192 pass, 6 fail

There are two more tiny issues in the phpunit_example module, for which I do not want to create new issues. So I'd submit a little big patch in one go to get the whole module looks good again here.

$defaultTheme is required
coding standards

Comment #8

jungle

He/Him

Chongqing, China

CreditAttribution: jungle as a volunteer commented 28 December 2019 at 20:59

Assigned:	jungle	» Unassigned
Status:	Needs work	» Needs review

File	Size
phpunit-example-3072441-8.patch	3.99 KB
8.x-1.x: PHP 7.2 & MySQL 5.5, D8.8 124 pass, 59 fail

BTW, the attached patch passed on my local.

................................. 33 / 33 (100%)

OK (33 tests, 43 assertions)

Comment #9

jungle

He/Him

Chongqing, China

CreditAttribution: jungle as a volunteer commented 28 December 2019 at 22:03

Comment #10

jungle

He/Him

Chongqing, China

CreditAttribution: jungle as a volunteer commented 28 December 2019 at 22:30

Title:	Tidy up phpunit_example	» Tidy up and fix phpunit_example
Issue summary:	View changes

Comment #11

29 February 2020 at 01:35

marvil07 committed 8517d03 on 8.x-1.x authored by Malevi4

Issue #3072441 by Malevi4, jungle: Tidy up and fix phpunit_example

Comment #12

marvil07 CreditAttribution: marvil07 as a volunteer commented 29 February 2020 at 01:37

Status:

Needs review

» Fixed

Thanks for all contributions here!

I ran tests for the phpunit_example module locally, before and after the latest patch; and indeed fixes the problem, as mainly mentioned on the related change record.

diff --git a/phpunit_example/src/ProtectedPrivates.php b/phpunit_example/src/ProtectedPrivates.php
index 56c75c4..24278ba 100644
--- a/phpunit_example/src/ProtectedPrivates.php
+++ b/phpunit_example/src/ProtectedPrivates.php
@@ -35,6 +35,7 @@ class ProtectedPrivates {
     return $adder->add($a, $b);
   }
   
+  // phpcs:disable
   /**
    * A simple addition method with validity checking.
    *
@@ -53,5 +54,6 @@ class ProtectedPrivates {
     $adder = new AddClass();
     return $adder->add($a, $b);
   }
+  // phpcs:enable
 
 }

I am not fully convinced of this change, but since it is mainly used from tests itself, I am OK with for now.
We can revert this hunk if needed in the future.