phpbb / epv Goto Github PK

Hi

Currently I try to install EPV localy in a WAMP environment. Generally it works but the following error messsages appears:

`Warning: preg_match(): Compilation failed: PCRE does not support \L, \l, \N{name
}, \U, or \u at offset 19 in G:\programme\wamp\www\epv\src\Tests\Tests\epv_test_
validate_languages.php on line 61

Warning: preg_match(): Compilation failed: PCRE does not support \L, \l, \N{name
}, \U, or \u at offset 19 in G:\programme\wamp\www\epv\src\Tests\Tests\epv_test_
validate_languages.php on line 61

Warning: preg_match(): Compilation failed: PCRE does not support \L, \l, \N{name
}, \U, or \u at offset 19 in G:\programme\wamp\www\epv\src\Tests\Tests\epv_test_
validate_languages.php on line 61` .... and a lot more of these error .

Windows 7 Pro /64
WAMP Server 3.1.7 /64
Tested PHPs:
5.6.40: ok, but PCRE error
7.0.33: ok, but PCRE error
7.1.26: ok, but PCRE error
7.2.14: ok, but PCRE error
7.3.1: doesn't work: [31m Directory name must not be empty. [39m

Last year I tested EPV on a XAMPP server (7.2.9 /32), but the same problem with PCRE.

If there's an asset or a dependency in the extension that has a file license.txt, EPV treats it as the extension's license and runs its checks on it.

Example: vendor/ext/styles/all/theme/assets/tinymce/license.txt

EPV should only check the license.txt in the extension's root folder.

Hello

It seems since this PR, calls like this:
$this->foo->{$bar}($id);
return an error:

PHP Catchable fatal error: Object of class PHPParser_Node_Expr_PropertyFetch could not be converted to string in /home/travis/build/phpBB3/phpBB/vendor/phpbb/epv/src/Tests/Tests/epv_test_validate_php_functions.php on line 421{quote}

Full trace: https://travis-ci.org/ErnadoO/ext-phpbb-directory/jobs/155055513

Coding guidelines say, "all lower-case names with words separated by a single underscore character in PHP, and camel caps in JavaScript"

EPV expects an array literal to be used in the array_merge() call in language files:

$lang = array_merge($lang, [
    // some lang vars here
]);

When passing an array variable instead, a fatal error is thrown:

$strings = array(
    // some lang vars here
);

$lang = array_merge($lang, $strings);

https://travis-ci.org/rxu/posts_merging/jobs/32674324#L746
PHP Notice: Undefined index: name in /home/travis/build/phpBB3/phpBB/ext/rxu/PostsMerging/vendor/phpbb/epv/src/Tests/Tests/epv_test_validate_event_names.php on line 54

Same on line 58.

Currently EPV seems to only check services.yml even though that file might include other yml files using "imports:".

Vendor names should be checked including the first dot, underscore or slash/backslash to see if it actually is phpbb. Otherwise vendornames such as phpbbnl or phpbbde will result in errors.

Error: The phpbb vendorname should only be used for official extensions in route names in ...ext\phpbbde\pastebin\config\routing.yml. Current service name: phpbbde_pastebin_main_controller
Error: The phpbb vendorname should only be used for official extensions in service names in ...ext\phpbbde\pastebin\config\services.yml. Current service name: phpbbde.pastebin.functions.pastebin
Error: The phpbb vendorname should only be used for official extensions in service names in ...ext\phpbbde\pastebin\config\services.yml. Current service name: phpbbde.pastebin.controller.main

The progress bars should be removed from the EPV. The output of the EPV will be much cleaner and easier for users to understand without them.

The namespace should start with a vendor (Phpbb/).

<MichaelC|Mobile> paul999: namespace for epv should be Phpbb/epv
<paul999> MichaelC|Mobile: why? ;)
<MichaelC|Mobile> because you should always use <vendor>/<package>/<sub-namespace>/<classname>
<MichaelC|Mobile> psr-0...
<MichaelC|Mobile> psr-0 aside, it's still good practice and prevents conflicts
<MichaelC|Mobile> and epv/stuff/stuff/class looks ugly
<paul999> and so does phpbb/epv/stuff/stuff/class ;)
<paul999> but add a ticket and I will see

Warning: Can't detect the file type for credits.webp, handling it as a binary file.

Hi

EPV is a helpful tool, I like it.

There is one thing I would to suggest: to support (or ignore) the file .editorconfig. This is another standard and directly supported by GitHub, so it should be accepted by EPV too.

Informations about this standard:

https://editorconfig.org/

There you can see also, that .editorconfig is supported directly by several IDE's and editor's. For some who have no native support for it, there exists plugins.

There's a PHP notice when EPV parses this code:

$func = 'is_int';
$arg = 1;
$result = $func($arg);

Both $result = is_int($arg); and $func($arg); work fine. The combination of a variable function and assignment is causing the notice. Full stracktrace:

PHP Notice:  Undefined property: PhpParser\Node\Expr\Variable::$parts in /epv/src/Tests/Tests/epv_test_validate_php_functions.php on line 366
PHP Stack trace:
PHP   1. {main}() /epv/src/EPV.php:0
PHP   2. Phpbb\Epv\Cli->run() /epv/src/EPV.php:30
PHP   3. Phpbb\Epv\Cli->doRun() /epv/vendor/symfony/console/Application.php:125
PHP   4. Phpbb\Epv\Cli->doRunCommand() /epv/vendor/symfony/console/Application.php:224
PHP   5. Phpbb\Epv\Command\ValidateCommand->run() /epv/vendor/symfony/console/Application.php:888
PHP   6. Phpbb\Epv\Command\ValidateCommand->execute() /epv/vendor/symfony/console/Command/Command.php:262
PHP   7. Phpbb\Epv\Tests\TestStartup->__construct() /epv/src/Command/ValidateCommand.php:72
PHP   8. Phpbb\Epv\Tests\TestStartup->runTests() /epv/src/Tests/TestStartup.php:62
PHP   9. Phpbb\Epv\Tests\TestRunner->runTests() /epv/src/Tests/TestStartup.php:125
PHP  10. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->validateFile() /epv/src/Tests/TestRunner.php:94
PHP  11. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->validate() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:129
PHP  12. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->parseNodes() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:156
PHP  13. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->parseNode() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:252
PHP  14. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->parseNode() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:304
PHP  15. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->parseNode() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:304
PHP  16. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->parseNode() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:308
PHP  17. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->parseNode() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:304
PHP  18. Phpbb\Epv\Tests\Tests\epv_test_validate_php_functions->validateFunctionNames() /epv/src/Tests/Tests/epv_test_validate_php_functions.php:292

Currently the php_exporter class checks for exactly array() for the event $vars variable.

So using the short array syntax ([], PHP >= 5.4) throws an error.

Fatal error: Can not find '$vars = array();'-line for event '{EVENT}' in file '{FILE}:{LINE}'. Are you using UNIX style linefeeds?

This works:

/**
 * Sample event.
 *
 * @event vendor.extension.event_name
 * @var int	var1
 * @var array	var2
 * @since 1.0.0
 */
$vars = array(
	'var1',
	'var2',
);
extract($this->dispatcher->trigger_event('vendor.extension.event_name', compact($vars)));

This gives the fatal error:

/**
 * Sample event.
 *
 * @event vendor.extension.event_name
 * @var int	var1
 * @var array	var2
 * @since 1.0.0
 */
$vars = [
	'var1',
	'var2',
];
extract($this->dispatcher->trigger_event('vendor.extension.event_name', compact($vars)));

Both examples are using a valid PHP code and considering that phpBB 3.2.x requires at least PHP 5.4, it should support the short syntax.

Remove the dependency on phpbb/phpbb by copying the php_exporter from phpBB to EPV itself. Having a dep on phpbb/phpbb causes issues on the website/other places.

When given an error, the full path to the offending file is outputted:

Error: The phpbb vendorname should only be used for official extensions in service names in /home/anthe/www/dev/customisation-db/files/contrib_temp/board_announcments_1_0_0/phpbb/googleanalytics/config/services.yml

It should strip the base path and simply output phpbb/googleanalytics/config/services.yml.

epv/src/epv/Tests/TestStartup.php on line 117

$this->output->getMesageCount(Output::WARNING) should be
$this->output->getMessageCount(Output::WARNING) it's missing an 's'

This is website side but hey ho.

A limit of 1 epv run every 30s - should probably use a db table for this (record time and github shortname in a table).

https://travis-ci.org/rmcgirr83/contactadmin/jobs/253928763

latest epv fails running locally and in Travis CI - see execution below. I listed files in the cloned /tmp file and composer.json is there.

[myersware@web617 epv]$ php src/EPV.php run --git="https://github.com/myersjj/phpbbMapUsers"
Checkout https://github.com/myersjj/phpbbMapUsers from git on branch master.
Running Extension Pre Validator .

[Phpbb\Epv\Tests\Exception\TestException]
Can't find the composer.json file in /tmp/5a639c883e381.

run [--dir [DIR]] [--git [GIT]] [--github [GITHUB]] [--branch [BRANCH]] [--debug]

[myersware@web617 epv]$ ls /tmp/5a639c883e381
_ composer.phar docs LICENSE phpunit.phar tests
acp config event license.txt phpunit.xml travis
adm console ext.php mcp README.md ucp
composer.json controller geocoder migrations service.php vendor
composer.lock cron language notification styles
[myersware@web617 epv]$

Currently, template events aren't tested.

Hi Paul

It would be nice if EPV would output decent version information at the --version switch. "Console Tool" is not very meaningful. ^^

Example:
epv --version
Extension Pre Validator v0.0.11 by Paul Sohier (https://github.com/phpbb/epv)

Or something like that would be much more informative. Then I could also display the version information for EPV directly with --version, as with the other tools I am using for Ext Check. At the moment I have to use the static text by paul999 (https://github.com/phpbb/epv) for EPV and that is actually not in the spirit of the inventor.

Affected lines:

• https://github.com/phpbb/epv/blob/master/src/Files/FileLoader.php#L124
• https://github.com/phpbb/epv/blob/master/src/Files/FileLoader.php#L128

$dir is an array that usually looks like this: ['vendor', 'extname', 'language']. end($dir) returns language which makes the tryLoadFile() method successfully return a LangFile instance. However, a language file located in vendor/extname/language/sub/lang.php has a $dir of ['vendor', 'extname', 'language', 'sub']. end($dir) returns sub, resulting in a generic PHPFile instance to be returned. Similar problem for migration files.

At the moment I'm not sure how to fix this in a way that works locally as well as in production. Locally, the vendor/extname is missing, so $dir is just ['language'] and ['language', 'sub'], respectively. Any ideas?

When using <?php declare(strict_types=1); in a ext it causes a Warning: IN_PHPBB is not defined in which should not happen.

GPL-2.0 license is deprecated in Composer.

Composer now expects either: GPL-2.0-only or GPL-2.0-or-later

We should check and pass if any of the three forms is found in composer.json

https://spdx.org/licenses/

This will also be used by Titania so this should be within EPV itself instead of separately on the website repo.

This is no big thing, but I want to report it also.

If I understand this switch correctly, then it should supress the ANSI color codes. But with active --no-ansi switch, the output is still like this:

`←[37;41m ←[39;49m
←[37;41m Validation: FAILED ←[39;49m
←[37;41m Fatal: 15, Error: 0, Warning: 2, Notice: 0 ←[39;49m
←[37;41m ←[39;49m

←[32mTest results for extension:←[39m
←[33;1mWarning:←[39;22m←[33m Can't detect the file type for .editorconfig, handl
ing it as a binary file.←[39m
←[37;41;1mFatal error:←[39;49;22m←[37;41m Detected windows style newlines instea
d of UNIX newlines in \lukewcs\whowashere\acp\acp_whowashere_info.php←[39;49m
←[37;41;1mFatal error:←[39;49;22m←[37;41m Detected windows style newlines instea
d of UNIX newlines in \lukewcs\whowashere\acp\acp_whowashere_module.php←[39;49m
←[33;1mWarning:←[39;22m←[33m "GPL-2.0" is a deprecated SPDX license identifier,
use "GPL-2.0-only" instead. in \lukewcs\whowashere\composer.json←[39m` ....

I assume ←[32m as example is a ANSI color code?

The full EPV command line in this case is:

php src\EPV.php run --no-ansi --dir "g:\virtual\Users\Test\Documents\GitHub\lf-who-was-here\"

Tests using EPV in phpBB master branch fail because phpBB 3.3 uses Symfony 3.x... EPV is on Symfony 2.x.

https://travis-ci.org/VSEphpbb/abbc3/jobs/156994287#L801

Problem 1
    - Installation request for phpbb/epv dev-master -> satisfiable by phpbb/epv[dev-master].
    - phpbb/epv dev-master requires symfony/yaml ~2.3 -> satisfiable by symfony/yaml[2.3.x-dev, 2.4.x-dev, 2.5.x-dev, 2.6.x-dev, 2.7.x-dev, 2.8.x-dev, v2.3.0, v2.3.1, v2.3.10, v2.3.11, v2.3.12, v2.3.13, v2.3.14, v2.3.15, v2.3.16, v2.3.17, v2.3.18, v2.3.19, v2.3.2, v2.3.20, v2.3.21, v2.3.22, v2.3.23, v2.3.24, v2.3.25, v2.3.26, v2.3.27, v2.3.28, v2.3.29, v2.3.3, v2.3.30, v2.3.31, v2.3.32, v2.3.33, v2.3.34, v2.3.35, v2.3.36, v2.3.37, v2.3.38, v2.3.39, v2.3.4, v2.3.40, v2.3.41, v2.3.42, v2.3.5, v2.3.6, v2.3.7, v2.3.8, v2.3.9, v2.4.0, v2.4.0-BETA1, v2.4.0-BETA2, v2.4.0-RC1, v2.4.1, v2.4.10, v2.4.2, v2.4.3, v2.4.4, v2.4.5, v2.4.6, v2.4.7, v2.4.8, v2.4.9, v2.5.0, v2.5.0-BETA1, v2.5.0-BETA2, v2.5.0-RC1, v2.5.1, v2.5.10, v2.5.11, v2.5.12, v2.5.2, v2.5.3, v2.5.4, v2.5.5, v2.5.6, v2.5.7, v2.5.8, v2.5.9, v2.6.0, v2.6.0-BETA1, v2.6.0-BETA2, v2.6.1, v2.6.10, v2.6.11, v2.6.12, v2.6.13, v2.6.2, v2.6.3, v2.6.4, v2.6.5, v2.6.6, v2.6.7, v2.6.8, v2.6.9, v2.7.0, v2.7.0-BETA1, v2.7.0-BETA2, v2.7.1, v2.7.10, v2.7.11, v2.7.12, v2.7.13, v2.7.14, v2.7.15, v2.7.16, v2.7.17, v2.7.2, v2.7.3, v2.7.4, v2.7.5, v2.7.6, v2.7.7, v2.7.8, v2.7.9, v2.8.0, v2.8.0-BETA1, v2.8.1, v2.8.2, v2.8.3, v2.8.4, v2.8.5, v2.8.6, v2.8.7, v2.8.8, v2.8.9] 
but these conflict with your requirements or minimum-stability.

So that we only ever merge stable changes and can control .com's updates individually.

It's become common these days to see a .map file accompany minified javascript, e.g.:
script.js
script.min.js
script.min.map

It might be worth recognizing the .map files so they don't trigger any warnings about being treated as a binary file.

@kasimi

Error we got;
PHP Fatal error: Call to undefined function Phpbb\Epv\Tests\Tests\bcdiv() in /community/vendor/phpbb/epv/src/Tests/Tests/epv_test_validate_directory_structure.php on line 58, referer: https://www.phpbb.com/customise/db/extension/phpbb_saml2/revision

Event names should be in the form of vendor.name.eventname and vendor should not be core or phpbb.

I have an issue with Travis config. all builds "fail" because it doesn't seem to find prepare-epv.sh although it's there (https://github.com/Sajaki/pbwowext/blob/develop32/travis/prepare-epv.sh).

This is the log.

 ../paybas/pbwowext/travis/prepare-epv.sh $EPV $NOTESTS

/home/travis/.travis/job_stages: line 57: ../paybas/pbwowext/travis/prepare-epv.sh: No such file or directory

The command "../paybas/pbwowext/travis/prepare-epv.sh $EPV $NOTESTS" failed and exited with 127 during .

Your build has been stopped.

do you have an idea?

I tried to test on the "main" branch because GitHub is set up this way not for new projects instead of "master". You can try it yourself: https://github.com/MarkDHamill/scsscompiler. I suspect the code needs to be flexible to check for both.

EPV should check that depends_on() array's contain strings that always start with a slash.

So this is valid:

static public function depends_on()
{
    return array('\foo\bar', '\bar\foo');
}

And we should error for any missing leading slashes:

static public function depends_on()
{
    return array('foo\bar', '\bar\foo');
}

Symfony will update their YAML parser ( symfony/symfony#16285 ).
EPV should warn for incorrect usage.

EPV output formatting on phpbb.com needs some fixes. Error messages display in darkred, which is unreadable on the black background. Maybe the "Error:" can be salmon (light red) colored, and the error message be red instead of darkred.

It does not allow leading spaces on doc blocks, like phpBB does and uses

When using Titania, EPV checks that the composer.json is located under {vendor}/{extension}:
$ns . 'composer.json' => Output::FATAL,
https://github.com/phpbb/epv/blob/master/src/Tests/Tests/epv_test_validate_directory_structure.php#L38

The comparison of the file names does not take this into account (using basename()) causing it to fail.
https://github.com/phpbb/epv/blob/master/src/Tests/Tests/epv_test_validate_directory_structure.php#L62

https://api.github.com/repos/phpbb/phpbb
http://stackoverflow.com/questions/8646517/see-the-size-of-a-github-repo-before-cloning-it

This test can fail with the message:

PHP Catchable fatal error: Object of class PhpParser\Node\Expr\BinaryOp\Concat could not be converted to string in /home/travis/build/phpBB3/phpBB/vendor/phpbb/epv/src/Tests/Tests/epv_test_validate_php_functions.php on line 390

The failure will happen when an extension has, for example, a string or a string concatenated method name variable in the method call, like:

$result = $this->{'validate_' . $name}();

The obvious solution on the ext dev's end is not to do string concatenation in the method call, like:

$method = 'validate_' . $name;
$result = $this->{$method}();

However, since this is not an illegal style of coding, EPV should not fail on the string concatenated version in the first example. It should be able to successfully test both conditions.

Reference: https://travis-ci.org/phpbb-extensions/ad-management/jobs/270466947#L594

I think that you shoud throw an error for each trigger_error found in a controller and a warning for each trigger_error found anywhere else and if an extension call trigger_error in a "Symfony Event" (i.e. KernelEvents::*) it should be denied

Hello, guys!

Today I've found that the EPV started to push errors Packaging structure doesn't meet the extension DB policies. even when all is OK.

I've explored the latest updates of the EPV and found out that this edit now causes wrong errors.

That's because $this->opendir may be not the same as the actual directory.
On my local tests opendir is a relative path, but $dir and $sp are absolute paths.
So str_replace() cannot delete the relative path from the absolute path properly.

The new code also works wrongly on Travis and on phpbb.com checker even for official extensions.

I suggest reverting back the edits linked above to the previous code:

                    $sp    = str_replace('\\', '/', $dir);
                    $split = explode('/', $sp);
                    $ns    = '';
                    if (sizeof($split) - 3 >= 0)
                    {
                        $ns .= $split[sizeof($split) - 3] . '/' . $split[sizeof($split) - 2];
                    }

                    if ($this->namespace != $ns)
                    {
                        $this->output->addMessage(Output::ERROR, 'Packaging structure doesn\'t meet the extension DB policies.');
                    }

list() should be added to this part:
https://github.com/phpbb/epv/blob/master/src/Tests/Tests
/epv_test_validate_php_functions.php#L535-L552
as a warning, because the variable order changed between php5 and php7

It currently is causing issues on www.phpbb.com if we have no auth

As part of phpbb/phpbb#3140

This is the warning shown for Trait files :

Warning: IN_PHPBB is not defined in /path/traitName.php

If I add "IN_PHPBB" check after NameSpace,
This is the Err0r shown in Code Sniff :

FILE: /path/traitName.php
----------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------
 1 | WARNING | A file should declare new symbols (classes, functions,
   |         | constants, etc.) and cause no other side effects, or
   |         | it should execute logic with side effects, but should
   |         | not do both. The first symbol is defined on line 27
   |         | and the first side effect is on line 19.
   |         | (PSR1.Files.SideEffects.FoundWithSymbols)
----------------------------------------------------------------------

Which is du to "IN_PHPBB" check.

I think we can use PhpParser\Node\Stmt\Trait_ class for the check.

Best regards 👍

Running EPV tests on extensions with phpBB master branch or maybe it's a PHP 8 thing, I don't know but:

Your requirements could not be resolved to an installable set of packages.

Problem 1
- Root composer.json requires phpbb/epv dev-master -> satisfiable by phpbb/epv[dev-master].
- phpbb/epv dev-master requires nikic/php-parser ~3.0 -> found nikic/php-parser[v3.0.0, ..., v3.1.5] but the package is fixed to v4.17.1 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command.

Use the option --with-all-dependencies (-W) to allow upgrades, downgrades and removals for packages currently locked to specific versions.
Error: Your requirements could not be resolved to an installable set of packages.

Problem 1
- Root composer.json requires phpbb/epv dev-master -> satisfiable by phpbb/epv[dev-master].
- phpbb/epv dev-master requires nikic/php-parser ~3.0 -> found nikic/php-parser[v3.0.0, ..., v3.1.5] but the package is fixed to v4.17.1 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command.

Use the option --with-all-dependencies (-W) to allow upgrades, downgrades and removals for packages currently locked to specific versions.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.
Error: Process completed with exit code 2.

https://travis-ci.org/rxu/posts_merging/jobs/32649295#L824
Fatal error: Can not find event name in line 'extract($phpbb_dispatcher->trigger_event('rxu.PostsMerging.posts_merging_end', compact($vars)));' in file '/home/travis/build/phpBB3/phpBB/ext/rxu/posts_merging/event/listener.php:408'

Probably, validator does not 'understand' events with multiple dots in their names, as the rest of things in extension looks ok.