Adds module:config:status command which checks if the module config i…

[hostep]

…n the app/etc/config.php file is correct or not.

Description (*)

This adds a new command to bin/magento: module:config:status.
This command checks if the modules in the file app/etc/config.php are correct or not.

I've created this command since I'm getting a bit tired of seeing incorrect app/etc/config.php files being added to our git repo's whenever somebody adds a new module using composer and forgets to run bin/magento setup:upgrade, or when some branch get merged which has merge conflicts in the config.php file and the conflict gets solved incorrectly.
Having this new command, would allow us to have a pre-commit githook which can check for this problem and then tell the developer to fix the config.php file before committing.

Feel free to let me know if the command name or description needs to be changed. And also if the output messages need to be changed.

Fixed Issues (if relevant)

None that I could find.

Manual testing scenarios (*)

1. Have a correct Magento installation
2. Run bin/magento module:config:status, it should say: The modules configuration is up to date.
3. Edit the file app/etc/config.php and remove or add a module. Or just switch the sort order of 2 modules.
4. Run bin/magento module:config:status, it should say: The modules configuration in the 'app/etc/config.php' file is outdated. Run 'setup:upgrade' to fix it.
5. Run bin/magento setup:upgrade
6. Run bin/magento module:config:status, it should say: The modules configuration is up to date.

Contribution checklist (*)

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/integration tests (if applicable)
• All automated tests passed successfully (all builds on Travis CI are green)

[m2-assistant]

Hi @hostep. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

• @magento-engcom-team give me test instance - deploy test instance based on PR changes
• @magento-engcom-team give me 2.3-develop instance - deploy vanilla Magento instance

For more details, please, review the Magento Contributor Assistant documentation

[hostep]

@dmytro-ch: I've force pushed the requested changes.
I changed some other output messages and the description of the command as well, so they are more consistent with each other.

[magento-engcom-team]

Hi @dmytro-ch, thank you for the review.
ENGCOM-5080 has been created to process this Pull Request

[dmytro-ch]

@hostep thank you!

[VasylShvorak]

✔️ QA passed

[hostep]

Thanks for the cleanup @nmalevanec! I'm curious which command you ran to detect these problems, so the next time I can try to fix these myself when creating a new PR.

[nmalevanec]

Hi, @hostep. You can just run dev/tests/static/testsuite/Magento/Test/Php/LiveCodeTest.php test against modified php files.

[sivaschenko]

@piotrekkaminski can you please take a look at this feature and provide your feedback

[sivaschenko]

@magento run all tests

[hostep]

@sivaschenko: is it ok if I still update my PR? There are some missing declare(strict_types=1); lines, it seems like I forgot to add these. And should I add these to new classes only, or also to other classes touched by this PR?

I'll then also do some git rebasing of this PR on top of the latest 2.3-develop, maybe that helps with these tests which seem to be not running somehow.

I also still don't understand how to execute static tests on my local, the dev/tests/static/testsuite/Magento/Test/Php/LiveCodeTest.php file just contains a class and no executable code, so I'm a bit confused about the statement above.

Thanks!

[hostep]

Rebased PR on latest 2.3-develop branch and added declare(strict_types=1); to the 2 new classes.

[sivaschenko]

@magento run all tests

[hostep]

Force pushed again, which will hopefully satisfy the static tests (I've amended @nmalevanec's commit for this, as not to loose his authorship of the other fixes).

It would still be great if somebody can tell me how to execute these static tests on my local environment, so I don't have to wait 2 days for the results and can just fix them in one go, thanks! 🙂

[m2-assistant]

Hi @hostep, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.