Testing with Craft

Who dis? Tech lead @ Global Network Group Discord & Github: @gtettelaar

Testing What’s it all about?

Everyone tests their code already 4

Let’s improve our application 5

“ You can’t sleep well if you are not confident that your last commit didn’t take down the whole application. 6

“The best developers are lazy energy efficient”

Well.. How? Let’s get some practical tests going.

Two main types of testing Unit Computer oriented Done through PHPUnit Test small part of your code You write a lot of these. Pretty fast For Modules, Plugins and/or any seperate - Test results of PHP functions/classes Primarily for your services. Functional From perspective of user Tests more generally functionality Simulates a web request Write less of these Slower For Modules, Plugins, Sites and/or any controller or twig template. Your twig templates. Only for testing Controllers. 9 All testing is done with Codeception ❤

Anatomy of a test class Let’s have a look at what a test *usually* looks like

Running your tests 11 Tests run through Console. Output printed to console in real time. You will get an overview of any tests that failed and why. https://codeception.com/docs/reference/Commands

(Unit) Demo time

Just some possible assertions PHP Unit assertSame() assertNotSame() assertArrayHasKey() assertContains() assertGreaterThan() assertInstanceOf() assertStringEndsWith() https://phpunit.readthedocs.io/en/8.3/as sertions.html Craft assertion methods assertElementsExist() expectEvent() assertTestFailed() assertPushedToQueue() https://docs.craftcms.com/v3/testing/framewor k/assertion-helpers.htm

(Functional) Demo time

Just some possible methods Codeception amOnPage() grabCookie() grabPageSource() see() seeCurrentUrlEquals() submitForm() https://codeception.com/docs/modules/ Symfony Thanks Symfony❤ Craft specific amLoggedInAs() amOnRoute() https://codeception.com/docs/modules/ Yii2 Thanks Yii2 ❤

What to test? 16 Unit ● Go high up the call-stack ● If it can be functional, make it functional (i.e. validators). ● Restructure for testing. ● Don’t test non-essential methods When testing validate() should you also test the return result of the rules() of your model. Functional ● Test functionality ● Don’t test UI specific. Test the features. ● Controller functionality. When building a website should you check that a button is given a class or that clicking on it performs an action you want to perform? You know your app. Where could it break?

“ Test your application’s business logic - not it’s implementation. 17

Top tip: 18

Craft’s tests Craft CMS actually has tests of it’s own since 3.2.

Demo time. let’s look at Craft’s tests

How do i start? Craft actually has a testing Framework!

It’s really easy 22 Manual ● Really good getting started guide on Github/Craft docs which covers all steps to get started. ● Craft’s testing suite ● https://docs.craftcms.co m/v3/testing/testing-cra ft/getting-started.html Automatic A test suite will be added in a directory of your choosing. Also coming to a pluginfactory.io near you

CI/CD 23 Continuous Integration: ● Runs your tests automatically (i.e when a PR is opened or some code is committed). ● Get notified ● Mostly free to implement. ● See the Craft testing docs or Craft’s own tests. Continuous Delivery/Deployment ● Everything from CI ● Cancel builds if tests fail. ● Either automatic deploys or by pushing a button. ● Reduces risk of site breaking builds. Still, don’t deploy on a friday

What can it do? 24 Project config support Setup a fresh Database before tests Extends the Yii2 codeception module Module and plugin support Mocking support including testing Craft in full isolation Console command testing Run (site) Migrations before tests Ability to configure Craft in exactly the way you want for tests Email testing without sending emails Fixtures Event testing

That’s it Well… Yes but no….

Where to go from here 26 ● Craft documentation ● #testing-craft (Discord) ● Codeception documentation ● Yii2 codeception documentation ● Craftquest.io ● Craft CMS Github ● Campaign Plugin (Ben Croker) ● Craft Commerce ● To be released plugins.

Thanks! 27 Shoutouts (never really angry) Brad Pixel and Tonic team. Ben Croker Andrew Welch Aaron Bushnell Takalani Radali All of you! ← Doge, for getting me through talk prep.