userdiff: php: Improved tests catching "abstract" and "final" functions

From: Javier Spagnoletti <[email protected]>

Since the original tests cases were using other detectable keywords (like "public" or "protected"), they are able to pass even if the keywords intended to be covered are not present.

---
userdiff: php: Improved test cases used to catch "abstract" and "final" functions

Since the original tests cases were using other detectable keywords (like "public" or "protected"), they are able to pass even if the keywords intended to be covered are not present. In the case of the test for "abstract" keyword, the method's body was removed in the fixture, since PHP doesn't allow an abstract method to have a body.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-915%2Fphansys%2Fpr_864-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-915/phansys/pr_864-v1
Pull-Request: https://github.com/git/git/pull/915

 t/t4018/php-abstract-method | 5 ++++-
 t/t4018/php-final-method    | 2 +-
 2 files changed, 5 insertions(+), 2 deletions(-)

index ce215df75a..14d77e6c15 100644
@@ -1,7 +1,10 @@
 abstract class Klass
 {
-    abstract public function RIGHT(): ?string
+    abstract function RIGHT(): ?string
     {
+        // PHP doesn't allow abstract methods to have a body,
+        // but this is here just for diff ckeck purposes.
+
         return 'ChangeMe';
     }
 }

index 537fb8ad9a..f7dd2dec17 100644
@@ -1,6 +1,6 @@
 class Klass
 {
-    final public function RIGHT(): string
+    final function RIGHT(): string
     {
         return 'ChangeMe';
     }

base-commit: e31aba42fb12bdeb0f850829e008e1e3f43af500

gitgitgadget

Am 14.11.20 um 22:18 schrieb Javier Spagnoletti via GitGitGadget:

Good find! I had to look at the patch text, though, before I could understand what the description wants to say. How about:

We have dedicated tests that "abstract" and "final" declarations are picked up as hunk context. However, the tests also use the keywords "public" and "protected" that by themselves denote hunk context lines. For this reason, the tests would not fail if the patterns for "abstract" and "final" were to become non-functional. Remove the distracting keywords from the two tests.

-- Hannes

"Javier Spagnoletti via GitGitGadget" <[email protected]>

I'd suggest using this instead:

Subject: [PATCH] userdiff: improve "abstract" and "final" function tests for php

I am not familiar enough with PHP to know if s/function/method/ is more appropriate for certain, but I suspect that would be the case.

I think you meant that other keywords that start functions were on the same line and that hides if "abstract" alone is recognised without these other keywords?

The patch changes "abstract public function" to "abstract function"; the assumption is that the presence of "public" alone is enough for such a line to be recognised to start a function.

But is that assumption tested elsewhere?

    ... goes and looks ...

    $ ls t/t4018/php-*
    t/t4018/php-abstract-class  t/t4018/php-function   t/t4018/php-trait
    t/t4018/php-class	    t/t4018/php-interface
    t/t4018/php-final-class     t/t4018/php-method

    $ git grep -e public -e protected t/t4018/php-*
    t/t4018/php-interface:    public function foo($ChangeMe);
    t/t4018/php-method:    public static function RIGHT()
    t/t4018/php-trait:    public function foo($ChangeMe)

You bring up "protected" but I do not see it mentioned anywhere in your patch or in existing tests, by the way.

Taking all of the above together, perhaps

A few tests try to see if lines with "abstract public function RIGHT()" and "final public function RIGHT()" on them are recognised as starting a method, but the presense of the keyword "public" is enough to get them recognised; ensure that these lines are still recognised as the beginning of a function without the "public" keyword.

Note that t4018/php-method already tests a line with 'public static function RIGHT()' on it to start a function, so we are not losing test coverage for "public" keyword with this change

would make it clearer?