CodeIgniter Testing Guide: Beginners' Guide to Automated Testing in PHP

185 Pages·2016·2.14 MB·English

by  Kenji Suzuki

Kenjia nMSdau tz uWkhii tney
CodeIgniter Testing Guide
Beginners’ Guide to Automated Testing in PHP.
Kenji Suzuki and Mat Whitney
© 2015 - 2016 Kenji Suzuki and Mat Whitney
Tweet This Book!
PleasehelpKenjiSuzukiandMatWhitneybyspreadingthewordaboutthisbookonTwitter!
Thesuggestedhashtagforthisbookis#CITestGuide.
Findoutwhatotherpeoplearesayingaboutthebookbyclickingonthislinktosearchforthis
hashtagonTwitter:
https://twitter.com/search?q=#CITestGuide
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
TheBookataGlance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
WhatYouNeedforThisBook. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
WhoshouldreadThisBook? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iii
WhyPHPUnit? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv
IsThisaCodeIgniterBook? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv
IsTestingPHPApplicationsDifficult? . . . . . . . . . . . . . . . . . . . . . . . . . . . . iv
IsTestingCodeIgniterApplicationsDifficult? . . . . . . . . . . . . . . . . . . . . v
TestingisFunandEasy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
ConventionsUsedinThisBook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v
Errata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii
1. WhatisAutomatedTesting?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1 PrimitiveExample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
ManualTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
AutomatedTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Whyshouldyouwritetestcode? . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 FindingtheMiddleWay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.4 Whatshouldyoutest? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5 TDDorNotTDD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2. SettingUptheTestingEnvironment . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1 InstallingCodeIgniter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2 Installingci-phpunit-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
EnablingMonkeyPatching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.3 (Optional)InstallingVisualPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . 9
InstallingComposer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
InstallingVisualPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
InstallingPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
ConfiguringVisualPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
ConfiguringPHPUnitXMLConfigurationFile . . . . . . . . . . . . . . . . . . . 11
2.4 InstallingPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5 (Optional)InstallingPsySH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.6 InstallingviaComposer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
CONTENTS
InstallingComposer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
InstallingCodeIgniterviaComposer . . . . . . . . . . . . . . . . . . . . . . . . . 14
Installingci-phpunit-testviaComposer . . . . . . . . . . . . . . . . . . . . . . . 14
InstallingPHPUnitviaComposer . . . . . . . . . . . . . . . . . . . . . . . . . . 15
(Optional)InstallingPsySHviaComposer. . . . . . . . . . . . . . . . . . . . . . 16
3. TestJargon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.1 Testinglevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
UnitTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
IntegrationTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
SystemTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2 TestingTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
FunctionalTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
DatabaseTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
BrowserTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
AcceptanceTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3 CodeCoverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.4 Fixtures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.5 TestDoubles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
MocksandStubs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4. PHPUnitBasics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.1 RunningPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
RunningAllTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
RunningaSpecificTestCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.2 RunningPHPUnitviaWebBrowser . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RunningWebServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
RunningAllTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
RunningaSpecificTestCase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.3 ConfiguringPHPUnit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
XMLConfigurationFile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
CommandLineArgumentsandOptions . . . . . . . . . . . . . . . . . . . . . . 30
4.4 UnderstandingtheBasicsbyTestingLibraries . . . . . . . . . . . . . . . . . . . . . 33
BasicConventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
DataProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Fixtures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Assertions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
5. TestingaSimpleMVCApplication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
5.1 FunctionalTestingforController . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
ControllertoHandleStaticPages . . . . . . . . . . . . . . . . . . . . . . . . . . 46
ManualTestingwithaWebBrowser . . . . . . . . . . . . . . . . . . . . . . . . 49
TestCaseforPageController . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
CONTENTS
CheckingCodeCoverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
5.2 DatabaseTestingforModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
PreparingtheDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
NewsSection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
ManualTestingwithaWebBrowser . . . . . . . . . . . . . . . . . . . . . . . . 64
DatabaseFixtures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
TestCasefortheNewsModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
CheckingCodeCoverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
6. UnitTestingforModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.1 WhyShouldYouTestModelsFirst? . . . . . . . . . . . . . . . . . . . . . . . . . . 75
6.2 PHPUnitMockObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
PlayingwithMocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
PartialMocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
VerifyingExpectations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
6.3 TestingModelswithoutDatabase . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Testingtheget_news()MethodwithMocks . . . . . . . . . . . . . . . . . . . . . 81
Testingtheset_news()MethodwithMocks . . . . . . . . . . . . . . . . . . . . . 90
6.4 WiththeDatabaseorWithouttheDatabase? . . . . . . . . . . . . . . . . . . . . . 94
TestingwithLittleValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
WhenYouWriteTestswithouttheDatabase . . . . . . . . . . . . . . . . . . . . 96
7. TestingControllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.1 WhyisTestingControllersDifficult? . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.2 TestCasefortheNewsController . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
7.3 MockingModels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
7.4 AuthenticationandRedirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
InstallingIonAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
ManualTestingwithaWebBrowser . . . . . . . . . . . . . . . . . . . . . . . . 109
TestingRedirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
MockingAuthObjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
7.5 WhatifMyControllerNeedsSomethingElse?. . . . . . . . . . . . . . . . . . . . . 113
8. UnitTestingCLIControllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
8.1 DbfixtureController . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
8.2 Fakingis_cli() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
8.3 Testingexit() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
8.4 TestingExceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
8.5 TestingOutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
8.6 MonkeyPatching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
PatchingFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
PatchingClassMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
8.7 CheckingCodeCoverage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
CONTENTS
9. TestingRESTControllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
9.1 InstallingCodeIgniterRestServer . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
FixingtheCodeIgniterRestServerCode . . . . . . . . . . . . . . . . . . . . . . 127
9.2 TestingGETRequests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
GettingAlloftheData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
GettingOneUser’sData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
9.3 AddingRequestHeaders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
9.4 TestingPOSTRequests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
9.5 TestingJSONRequests. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
9.6 TestingDELETERequests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
10. BrowserTestingwithCodeception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
10.1 InstallingandConfiguringCodeception . . . . . . . . . . . . . . . . . . . . . . . . 139
WhatisCodeception? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
InstallingCodeception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
WhatisSeleniumServer? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
InstallingSeleniumServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
InitializingCodeception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
ConfiguringAcceptanceTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
10.2 WritingTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
ConventionsforCodeceptionAcceptanceTests . . . . . . . . . . . . . . . . . . . 142
WritingOurFirstTest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
10.3 RunningTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
RunningSeleniumServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
RunningtheWebServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
RunningCodeception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
10.4 BrowserTesting:ProsandCons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
10.5 DatabaseFixtures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
10.6 TestCasefortheNewsController . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
DatabaseFixtures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
TestingPageContents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
TestingForms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
NewsCept . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
10.7 TestingwithGoogleChrome . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
InstallingtheChromeDriver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
ConfiguringAcceptanceTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
RunningSeleniumServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
RunningTests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
11. Congratulations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
AppendixA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
HowtoSpeedUpTesting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
CONTENTS
SpeedUpwithoutCodeModifications . . . . . . . . . . . . . . . . . . . . . . . 157
AppendixB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
HowtoReadci-phpunit-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Structureofci-phpunit-test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Bootstrap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Autoloader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
ReplacedClassesandFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
NewFunctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
TestCaseclasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Requestrelatedclasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Helperclasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
MonkeyPatchlibrary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
AppendixC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
LicenseAgreementforCodeIgniteranditsUserGuide . . . . . . . . . . . . . . . . . . . 168
LicenseAgreementforCodeIgniterRestServer . . . . . . . . . . . . . . . . . . . . . . . 169
LicenseAgreementforIonAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Preface
When I learned PHP for the first time, I did not know about writing test code at all. Nobody
around me was writing test code. There was no PHPUnit (a testing framework for PHP), yet. In
2004,PHPUnit1.0.0wasreleasedforPHP4.Inthesameyear,PHPUnit2.0.0wasreleasedforPHP5.
However,IhaveneverusedPHPUnit1or2.
When I found CodeIgniter (a PHP web application framework) for the first time, in 2007, it had a
Unittestingclass,buttherewasnotestcodefortheframeworkitself.
Now,in2015,morethan10yearshavepassedsincePHPUnit1.0.0.CodeIgniter3.0hasitsowntest
code with PHPUnit, and the code coverage for those tests is around 60%. We are progressing a bit
daybyday.
Have you ever written test code for your web application? If you haven’t, you may imagine that
writingtestcodewillbeverydifficultorbothersome.Maybeyouwanttowritetestcode,butdon’t
knowhowtodoso.
Itiscommontoover-estimatethecostoflearningsomethingnew,andtestingisnoexception.After
reading a tutorial for PHPUnit, I thought, “So how do I test my application?” I had trouble seeing
the similarities between the tests in the tutorial and the tests I would need to write for my own
application.
This book is a beginners’ guide for automated testing of PHP web applications. Of course, you will
be ableto writetestcode forany PHP applicationsafter readingthisbook, butthefocus willbeon
webapplications.
I eschew complexity, favoring simple solutions. I use simple and easy to understand solutions first
inthebook,soyouwon’tgetlost.Let’skeepgoing!
The Book at a Glance
If you want to know about this book, this is a great place to start. What follows is a very quick
overview of what each chapter covers. This should give you an idea of what’s ahead, or serve as a
startingpointifyouwanttofindaparticularportionofthecontenttoreviewlater.
Chapter 1: What is Automated Testing?
Let’sbeginlearningaboutautomatedtesting.Firstwewillexplorethebasicconceptsofautomated
testing. We will find out why and what you should test. At the same time, I will explain the ideas
andtestingpoliciesusedbythisbook.
i
Preface ii
Chapter 2: Setting Up the Testing Environment
To run tests in your PHP environment, you will need to install some additional software. For this
book,thisincludesCodeIgniter,PHPUnitandatoolwhichactsasabridgebetweenthem,ci-phpunit-
test.Ifyoudon’tlikecommandline,youcanuseVisualPHPUnit toruntestsviayourwebbrowser.
Chapter 3: Test Jargon
We define test jargon here. One of the annoying and confusing things in testing is the new
vocabulary required to understand it. By the end of this chapter we’ll help you understand
the difference between Unit, Integration, and System testing; Functional and Acceptance testing;
FixturesandMocks;andmore.
Chapter 4: PHPUnit Basics
Inthischapter,wewilllearnthebasicsofPHPUnit.WewillrunPHPUnitandlearnhowtoconfigure
it. After that, we will study PHPUnit conventions and write our first test. We also cover PHPUnit
functionality,dataproviders,fixtures,andassertions.
Chapter 5: Testing a Simple MVC Application
You’vealreadylearnedhowtowritetestcode,soherewewillwritetestsforaCodeIgniterTutorial
application.Wewillwritetestsforacontrollerandamodel.Inthischapter,wewillusethedatabase
formodeltesting.
Chapter 6: Unit Testing for Models
Wewilllearnmoreabouttestingmodels.Wewillwritetestsformodelswithoutusingthedatabase.
Todothis,wewilllearnaboutPHPUnitmockobjects.
Chapter 7: Testing Controllers
We will learn more about testing controllers in this and the next two chapters. In this chapter, we
will write tests for a controller for reviewing, and write tests with mocking models. We also will
writetestcasesforauthenticationandredirects.
Chapter 8: Unit Testing CLI Controllers
We will continue learning to write tests for controllers. In this chapter, we will write unit tests for
controllers,andlearnaboutmonkeypatching.
Chapter 9: Testing REST Controllers
In this chapter, we will learn about testing REST controllers. You will learn how to send (emulate)
requestswithmethodsotherthanGETandPOST.