Code Quality with Magento 2
Download as PPTX, PDF0 likes66 views
The document outlines a presentation by Andreas von Studnitz on code quality in Magento 2, covering essential topics such as code readability, updatability, and automated testing. It highlights best practices for developers and tools for enhancing code quality, including configuration management and static analysis tools. The importance of maintaining fewer bugs, security, and long-term cost effectiveness for customers is also emphasized.
Code Quality with Magento 2
- 1. Code Quality with Magento 2 April 30th 2020 – Virtual Meet Magento Meetup #2 Andreas von Studnitz – integer_net – @avstudnitz
- 2. Co-Founder and Managing Director @ integer_net Magento Developer, Trainer, Consultant since 2008 Twitter: @avstudnitz Andreas von Studnitz
- 3. Andreas von Studnitz – integer_net – @avstudnitz 2014 Image Quality
- 4. Andreas von Studnitz – integer_net – @avstudnitz 2020 Code Quality
- 5. Andreas von Studnitz – integer_net – @avstudnitz Agenda Magento-Specific Code Quality Questions and Answers General Code Quality Tools for better Code Quality Motivation
- 6. Andreas von Studnitz – integer_net – @avstudnitz For developers ◦ Code is easy to read ◦ Easy to understand ◦ Easy to adapt ◦ Easy to extend What is code quality good for? For customers • Fewer Bugs • Reliability • Security • Updatability • Less expensive long-term
- 7. General Code Quality (independent of M2)
- 8. Andreas von Studnitz – integer_net – @avstudnitz Soft Factors • Code Reviews • Working Hours • Pair Programming • Code Reviews
- 9. Andreas von Studnitz – integer_net – @avstudnitz Keep it simple • Minimal amount of LoC for demand – „only no code is good code“ • Use existing functions: Generate price rules instead of overwriting price logic • Not going to break on an update • Not going to show wrong VAT with tax included • Not going to break on a credit memo • Avoid unnecessary abstraction
- 10. “ Andreas von Studnitz – integer_net – @avstudnitz “Debugging is twice as hard as writing the code in the first place. Therefore, if you write the code as cleverly as possible, you are, by definition, not smart enough to debug it.” - Brian Kernighan
- 11. Andreas von Studnitz – integer_net – @avstudnitz Literature
- 13. Andreas von Studnitz – integer_net – @avstudnitz Updatability • No core hacks, no hacks of external modules • No changes of PHP classes Instead: Observer, Plugin or Preference • No changes of template files Instead: Make a theme specific copy, or better use Layout XML • No changes of language files Instead: Custom translation files, possibly in own language pack
- 14. Andreas von Studnitz – integer_net – @avstudnitz From MVC to MVVM • Model – View – ViewModel • ViewModels provide data for the View • PHP Classes which don’t need to inherit or implement anything • Read more: https://www.integer-net.com/view-models- in-magento-1-and-2/ (by Fabian Schmengler)
- 15. Andreas von Studnitz – integer_net – @avstudnitz An Example of View Models module-catalog/view/frontend/layout/catalog_product_view.xml module-catalog/view/frontend/templates/product/breadcrumbs.phtml
- 16. Andreas von Studnitz – integer_net – @avstudnitz Configuration as Code • Store configuration in the config.php and/or env.php • bin/magento config:set --lock-config • bin/magento config:set --lock-env • Since Magento 2.2.4 • Can create websites and stores • Can set store specific values
- 17. Andreas von Studnitz – integer_net – @avstudnitz Example
- 18. Andreas von Studnitz – integer_net – @avstudnitz Configuration: Suggestions • config.php is for sharing • Should contain everything you want to have control over • Don’t add everything – some things are better kept in config.xml • env.php is local only • Add your base URLs • Adjust security settings • Disable services like Google Analytics • Adjust payment methods and other sensitive data by environment
- 19. Andreas von Studnitz – integer_net – @avstudnitz Setup Patches • More “Configuration as Code” – don’t use the Magento Admin for crucial changes • Successor of Setup Scripts (since Magento 2.3) • Attributes • Content (CMS, categories, products, …) • Accompanied by Declarative Schema for adjusting the database schema
- 20. Andreas von Studnitz – integer_net – @avstudnitz A Setup Patch
- 21. Tools for better Code Quality with Magento 2
- 22. Andreas von Studnitz – integer_net – @avstudnitz Automated Testing • Huge improvement of M2 over M1 • In M1 automated testing not cost-effective in most mid-size cases • In M2 automated testing is now cost effective in most mid-size cases • Different types of testing: • Unit Tests • Integration Tests • Frontend Tests (MFTF)
- 23. Andreas von Studnitz – integer_net – @avstudnitz Integration Tests class NewProductsCategoryTest extends MagentoTestFrameworkTestCaseAbstractControlle { public static function loadFixture() { include __DIR__ . '/../_files/categories.php'; include __DIR__ . '/../_files/products.php'; } public function testCategoryDisplaysCorrectProducts() { $this->dispatch('catalog/category/view/id/3'); $this->assertContains('Simple Product 1', $this->getResponse()->getBody()); $this->assertNotContains('Simple Product 2', $this->getResponse()->getBody()); } } • Hint: use https://github.com/tddwizard/magento2-fixtures
- 24. Andreas von Studnitz – integer_net – @avstudnitz Static Tests • Check the code with tools like PHP Codesniffer and PHP Mess Detector • Automate with GrumPhp: Code will be checked on commit • Only a few steps to setup • Example:
- 25. Andreas von Studnitz – integer_net – @avstudnitz Static Tests • Check the code with tools like PHP Codesniffer and PHP Mess Detector • Automate with GrumPhp: Code will be checked on commit • Only a few steps to setup • Example:
- 26. Andreas von Studnitz – integer_net – @avstudnitz Static Tests • Check the code with tools like PHP Codesniffer and PHP Mess Detector • Automate with GrumPhp: Code will be checked on commit • Only a few steps to setup • Example:
- 27. #MM18DE Installation of GrumPhp (1)
- 28. #MM18DE Installation of GrumPhp (2) grumphp.yml in project root directory
- 29. Andreas von Studnitz – integer_net – @avstudnitz „The Obvious“ • Git for source code management and versioning • Composer for managing dependencies • PhpStorm • See warnings and errors directly • Easily integrate tools like Code Sniffer and Mess Detector • Built-in commands for code formatting and small refactorings
- 30. Thank you! Any Questions? [email protected] @avstudnitz @integer_net Presentation Template by SlidesCarnival