テストと仲良くするためのCodeceptionのはじめかた #phpkansai

ςετͱ஥ྑ͘͢ΔͨΊͷ
Codeceptionͷ͸͡Ί͔ͨ
PHP Conference Kansai 2017 
2017-07-15

View Slide

ࣗݾ঺հ
• ֯ాɹҰฏʢ͢Έͩɹ͍ͬ΃͍ʣ
• ϑϦʔϥϯεΤϯδχΞ 
ˠ͓࢓ࣄઈࢍืूதʂ
• CoderDojoຕํɹ୅ද

View Slide

ࠓ೔ͷ໨ඪ
• Codeceptionʹ͍ͭͯ஌ͬͯ΋Β͏
• CodeceptionͷςετͷྲྀΕΛ஌ͬͯ΋Β͏
• ʰCodeceptionͱҰॹʹ 
ɹςετͱ஥ྑ͘ͳΖ͏ʱͱࢥͬͯ΋Β͏

View Slide

ΞδΣϯμ
• Codeceptionͱ͸
• CodeceptionͰͷςετ࣮૷
• Codeception Tips

View Slide

ςετॻ͍ͯ·͔͢ʁ

View Slide

–ݪాɹ߁ੜ
“ςετ͸઒ͷਫ࣭ௐࠪͩͱࢥͬͨΒ͍͍
Ͱ͢Α”

View Slide

ւˡ

View Slide

View Slide

୯ମςετ
ػೳςετ
γεςϜɾडೖςετ

View Slide

γεςϜςετ
ػೳςετ
୯ମςετ

View Slide

దࡐదॴͳςετΛ༻ҙ

View Slide

దࡐదॴͷςετ͸…
• ෆ۩߹ൃݟ͕༰қʹ
• ૝ఆ֎ͷӨڹΛૣظൃݟ
• ֎෦ύοέʔδΛ҆৺ͯ͠ߋ৽

View Slide

Codeceptionͱ͸

View Slide

1.Codeceptionͱ͸
ςεςΟϯάϑϨʔϜϫʔΫ 
(PHP੡)

View Slide

PHPer Readableͳ 
ςεςΟϯάϑϨʔϜϫʔΫ
1.Codeceptionͱ͸

View Slide

public function registerTest(AcceptanceTester $I)
{
$I->wantToTest('ొ࿥ςετ');
$I->canSee('͓໰͍߹Θͤ', '#title');
$I->fillField('#inquiry_name', '͢Έͩɹ͍ͬ΃͍');
$I->fillField('#inquiry_email', '[email protected]');
$I->fillField('#inquiry_question', '͓໰͍߹Θͤ಺༰');
$I->click('ૹ৴');
$I->canSee('͓໰͍߹Θͤ׬ྃ͠·ͨ͠ɻ', '#title');
$I->canSeeInDatabase('inquiry', [
'name' => '͢Έͩɹ͍ͬ΃͍',
'email' => '[email protected]',
'question' => '͓໰͍߹Θͤ಺༰',
]);
}
1.Codeceptionͱ͸

View Slide

ςετͷ؅ཧָ͕
1.Codeceptionͱ͸

View Slide

1.Codeceptionͱ͸
6OJU
w ֤Ϋϥεɺϝιου
w 1)16OJUΠϯετʔϧ 
ෆཁ
1)16OJUΛར༻ͨ͠ 
୯ମςετ
'VODUJPOBM
w ػೳ୯Ґ
w ϦΫΤετʹର͢Δ 
݁ՌΛ֬ೝ
w ֤'8ରԠ
8FCαʔόΛհ͞ͳ
͍'8ςετ
"DDFQUBODF
w ػೳ୯Ґ
w ը໘্ͷಈ࡞֬ೝ
w ϒϥ΢βґଘ
ϒϥ΢βΛར༻ͨ͠
डೖςετ

View Slide

Codeception͚ͩͰ 
֤छςετΛҰׅ؅ཧɺ࣮ߦ
1.Codeceptionͱ͸

View Slide

֤छϑϨʔϜϫʔΫαϙʔτ
1.Codeceptionͱ͸

View Slide

1.Codeceptionͱ͸
And more…

View Slide

ͦͷ΄͔
• REST APIςετՄ
• ϨεϙϯγϒαΠτͷςετՄ
• ֤छCIͱ࿈ܞՄ
• Ωϟϓνϟऔಘ
• ίʔυΧόϨοδऔಘ

View Slide

ଟػೳɾ؆୯
1.Codeceptionͱ͸
ςετͱ஥ྑ͘Ͱ͖ͦ͏ʂ

View Slide

Conclusion
• Codeception͸ςεςΟϯάϑϨʔϜϫʔΫ
• PHPer͕ಡΈ΍͍͢ςετίʔυ
• ֤छςετΛҰׅ؅ཧɺ࣮ߦՄೳ
• ֤छϑϨʔϜϫʔΫରԠ
• ͦͷଞॾʑ༻ҙ͞ΕͯΔͷͰ஥ྑ͘ͳΕͦ͏

View Slide

CodeceptionͰͷςετ࣮૷

View Slide

2.CodeceptionͰͷςετ࣮૷
6OJU
w ֤Ϋϥεɺϝιου
w 1)16OJUΠϯετʔϧ 
ෆཁ
1)16OJUΛར༻ͨ͠ 
୯ମςετ
'VODUJPOBM
w ػೳ୯Ґ
w ϦΫΤετʹର͢Δ 
݁ՌΛ֬ೝ
w ֤'8ରԠ
8FCαʔόΛհ͞ͳ
͍'8ςετ
"DDFQUBODF
w ػೳ୯Ґ
w ը໘্ͷಈ࡞֬ೝ
w ϒϥ΢βґଘ
ϒϥ΢βΛར༻ͨ͠
डೖςετ

View Slide

Unit
ϝιου࣮ߦ
ϝιουΛ࣮ߦͯ͠ 
࣮ߦ݁Ռʹରͯ͠ςετɻ 

View Slide

Functional
ϦΫΤετ
FWʢϓϩάϥϜʣʹϦΫΤετΛ౉ͯ͠ɺ 
࣮ߦ݁Ռʹରͯ͠ςετɻ 
= WebαʔόΛհ͞ͳ͍

View Slide

Acceptance
ϒϥ΢βΛ੍ޚͯ͠ɺ 
ϒϥ΢βදࣔ݁Ռʹରͯ͠ςετɻ 
㲈ਓͷखʹΑΔϒϥ΢βςετ
ϦΫΤετ

View Slide

࣮ߦ଎౓͸ 
Unit > Functional > Acceptance

View Slide

શͯΛAcceptanceͰ
ߦΘͳ͍

View Slide

Acceptance = Ϧϋʔαϧ

View Slide

Πϯετʔϧ 
؀ڥ४උ
࣮ߦ

View Slide

$ composer require —dev codeception/codeception
Πϯετʔϧ

View Slide

bootstrap - ؀ڥ࡞੒
build - ઃఆ൓ө
$ vendor/bin/codecept bootstrap
$ vendor/bin/codecept build

View Slide

$ vendor/bin/codecept run
ςετ࣮ߦʢҰׅʣ

View Slide

$ vendor/bin/codecept run acceptance HogeCest:hogeTest
ςετ࣮ߦʢҰ෦ʣ
TVJUF ςετϑΝΠϧɺϝιου

View Slide

Acceptance (phpbrowser) Tests (2)
---------------------------------------------------------------------
---------------------------------------------------------------------
---------------------
Testing acceptance (phpbrowser)
✔ InquiryCest: Test ొ࿥ςετ (1.30s)
✔ InquiryCest: Test ॏෳొ࿥ςετ (1.04s)
---------------------------------------------------------------------
---------------------------------------------------------------------
-------------------------------------------------------
Time: 2.59 seconds, Memory: 17.00MB
OK (2 tests, 5 assertions)
࣮ߦ݁ՌʢOKʣ

View Slide

Acceptance (phpbrowser) Tests (2)
---------------------------------------------------------------------
---------------------------------------------------------------------
---------------------
Testing acceptance (phpbrowser)
✖ InquiryCest: Test ొ࿥ςετ
✔ InquiryCest: Test ొ࿥ςετ[F] (2.10s)
✔ InquiryCest: Test ॏෳొ࿥ςετ (1.30s)
---------------------------------------------------------------------
---------------------------------------------------------------------
-------------------------------------------------------
Time: 3.7 seconds, Memory: 17.25MB
There was 1 failure:
࣮ߦ݁ՌʢNGʣ

View Slide

---------
1) InquiryCest: Test ొ࿥ςετ
Test tests/acceptance/InquiryCest.php:registerTest
Failed asserting that any element by '#title' on page /inquiry/
+ ͓໰͍߹Θͤ
contains text 'a͓໰͍߹Θͤ'
࣮ߦ݁ՌʢNGʣ
ͲͷςετͰΤϥʔʹͳ͔ͬͨग़ྗ

View Slide

࣮ߦ݁ՌʢNGʣ
Τϥʔ࣌ʹͲͷΑ͏ͳ݁Ռ͕ग़ྗ͞Ε͔ͨอଘ

View Slide

֤ઃఆ

View Slide

Unit Test

View Slide

unit.suite.yml
# Codeception Test Suite Configuration
#
# Suite for unit or integration tests.
actor: UnitTester
modules:
enabled:
- Asserts
- \Helper\Unit

View Slide

generate:test - testϑΝΠϧ࡞੒
$ vendor/bin/codecept generate:test unit HogeTest

View Slide

Functional Test

View Slide

functional.suite.yml
actor: FunctionalTester
modules:
enabled:
# add a framework module here
- \Helper\Functional
- Symfony:
app_path: 'app'
var_path: 'var'
- Db:
dsn: 'sqlite:var/data.sqlite'
user: ''
password: ''
populate: true
dump: 'tests/_data/dump.sql'

View Slide

modules:
enabled:
- Symfony:
app_path: 'app'
var_path: 'var'
- Db:
user: ''
password: ''
populate: true
ϑϨʔϜϫʔΫͷઃఆ

View Slide

modules:
enabled:
- Symfony:
app_path: 'app'
var_path: 'var'
- Db:
user: ''
password: ''
populate: true
%#ͷઃఆ

View Slide

generate:cept - ceptϑΝΠϧ࡞੒
generate:cest - cestϑΝΠϧ࡞੒
$ vendor/bin/codecept generate:cept functional HogeCept
$ vendor/bin/codecept generate:cest functional HogeCest

View Slide

Acceptance Test

View Slide

acceptance.suite.yml
actor: AcceptanceTester
modules:
enabled:
- WebDriver:
url: http://localhost:8000
browser: phantomjs
- \Helper\Acceptance
- Db:
user: ''
password: ''
populate: true
env:
firefox:
modules:
config:
WebDriver:
browser: firefox

View Slide

modules:
enabled:
- WebDriver:
browser: phantomjs
- Db:
user: ''
password: ''
populate: true
env:
firefox:
modules:
config:
WebDriver:
browser: firefox
acceptance.suite.yml
ϒϥ΢βͷઃఆ

View Slide

1)1#SPXTFS 1IBOUPN+4
pSFGPY
DISPNF
+BWB4DSJQU º ˚ ̋
#BTJDೝূ ̋ ˚ ̋
࣮ߦ଎౓ ̋ ˚ º

View Slide

1)1 
#SPXTFS
1IBOUPN+4 'JSFGPY $ISPNF
4FMFOJVN4UBOEBMPOF
4FSWFS
̋ ̋ ̋
1IBOUPN+4 ̋
DISPNFESJWFS ̋
Required

View Slide

ϒϥ΢βࢦఆ
PHPBrowser
PhantomJS
ﬁrefox/chrome
modules:
enabled:
- PhpBrowser:
modules:
enabled:
- WebDriver:
browser: phantomjs
modules:
enabled:
- WebDriver:
browser: firefox

View Slide

generate:cept - ceptϑΝΠϧ࡞੒
generate:cest - cestϑΝΠϧ࡞੒
$ vendor/bin/codecept generate:cept acceptance HogeCept
$ vendor/bin/codecept generate:cest acceptance HogeCest

View Slide

ςετ࣮૷

View Slide

CeptͱCest

View Slide

$FQU
w ্͔Βॱʹ࣮ߦ
w ϑΝΠϧγφϦΦ
w ؆୯ͳγφϦΦ޲͖
γφϦΦϑΝΠϧ
$FTU
w 1)16OJUͷ༷ʹهड़
w ϝιουγφϦΦ
w ෳࡶͳγφϦΦ0,
γφϦΦΫϥε

View Slide

Cept
$I = new FunctionalTester($scenario);
$I->wantTo('͓໰͍߹Θͤొ࿥ςετ');
$I->amOnPage('/inquiry');

View Slide

Cest
class InquiryFunctionalCest
{
// tests
public function registrationTest(FunctionalTester $I)
{
$I->amOnPage('/inquiry');
}
}

View Slide

class InquiryFunctionalCest
{
public function _before(FunctionalTester $I)
{
}
public function _after(FunctionalTester $I)
{
}
// tests
}
Cest
લॲཧʢ@CFGPSF

ޙॲཧʢ@BGUFS

View Slide

$FQU
w ্͔Βॱʹ࣮ߦ
w ϑΝΠϧγφϦΦ
w ؆୯ͳγφϦΦ޲͖
γφϦΦϑΝΠϧ
$FTU
w 1)16OJUͷ༷ʹهड़
w ϝιουγφϦΦ
w ෳࡶͳγφϦΦ0,
γφϦΦΫϥε
ɹ
Φ
ε
ε
ϝ
ʂ
ɹ

View Slide

ϝιου උߟ
ࢦఆͷϖʔδʹҠಈ *BN0O1BHF l63-z

BDDFQUBODFTVJUFZNM
ʹࢦఆͨ͠63-ʹ௥Ճ͞
ΕͯΞΫηεɻ
ϖʔδʹࢦఆͷจࣈ͕͋
Δ͔
*TFF lจࣈྻz

*TFF lจࣈྻz lཁ
ૉz

*DBO4FF lจࣈྻz

DBOΛ͚ͭΔͱݟ͔ͭΒ
ͳͯ͘΋ςετ͕ࢭ·Β
ͳ͍
ϖʔδʹࢦఆͷจࣈ͕ͳ
͍͔
*EPOU4FF lจࣈྻz

*EPOU4FF lจࣈྻz
lཁૉz

*DBOU4FF lจࣈྻz

ͳ͍
ΫϦοΫ
*DMJDL lϩάΠϯz

*DMJDL lMPHJOz

จࣈྻ 9QBUI $44
4FMFDUPSͰࢦఆ
Α͘࢖͏ϝιου

View Slide

ϝιου උߟ
ςΩετϘοΫεʹॻ͘
*pMM'JFME lOBNFz
lWBMVFz

*pMM'JFME lOBNFz
lWBMVFz

ϑΟʔϧυ
໊ 9QBUI $444FMFDUPS
Ͱࢦఆ
ϥδΦϘλϯબ୒
*
DIFDL0QUJPO lOBNFz
lWBMVFz

*
ϑΟʔϧυ
Ͱࢦఆ
ηϨΫτϘοΫεɺ
νΣοΫϘοΫεબ୒
*
TFMFDU0QUJPO lOBNFz
lWBMVFz

*
ϑΟʔϧυ
Ͱࢦఆ
·ͱΊͯϑΥʔϜૹ৴
*
TVCNJU'PSN bGPSN`

ϑΟʔϧυ
Ͱࢦఆ
Α͘࢖͏ϝιουʢFormʣ

View Slide

ϝιου උߟ
%#ʹࢦఆͷσʔλ͕͋
Δ͔֬ೝ
*TFF*O%BUBCBTF bςʔϒϧ
໊`

ͳ͍
%#ʹࢦఆͷσʔλ͕ͳ
͍͔֬ೝ
*EPOU4FF*O%BUBCBTF bςʔ
ϒϧ໊`

DBOΛ͚ͭΔͱݟ͔ͭͬ
ͯ΋ςετ͕ࢭ·Βͳ͍
σʔλΛొ࿥͢Δ *IBWF*O%BUBCBTF bςʔϒϧ
໊`

ςετσʔλ࡞੒࣌ʹ
σʔλΛऔಘ͢Δ
*HSBC'SPN%BUBCBTF
bςʔϒϧ໊` bऔಘϑΟʔϧυ໊`

Α͘࢖͏ϝιουʢDBʣ

View Slide

/**
* ొ࿥ςετ
*
* @param AcceptanceTester $I
*/
{
'name' => '͢Έͩɹ͍ͬ΃͍',
]);
}

View Slide

/**
* ొ࿥ςετ
*
*/
{
'name' => '͢Έͩɹ͍ͬ΃͍',
]);
}
JElUJUMFzʹʰ͓໰͍߹Θͤʱ
ͱग़ྗ͞Ε͍ͯΔ͔ʁ

View Slide

/**
* ొ࿥ςετ
*
*/
{
'name' => '͢Έͩɹ͍ͬ΃͍',
]);
}
[email protected]ʹʰ͢Έͩɹ͍ͬ΃͍ʱ
Λೖྗ͢Δ

View Slide

/**
* ొ࿥ςετ
*
*/
{
'name' => '͢Έͩɹ͍ͬ΃͍',
]);
}
l*ORVJSZzςʔϒϧʹ
ࢦఆͷ಺༰Ͱొ࿥͞Εͨ 
σʔλ͕͋Δ͔֬ೝ

View Slide

id, classΛద੾ʹηοτ
CodeceptionͰͷςετָ͕ʹʂ

View Slide

Conclusion
• ઃఆϑΝΠϧͰɺFWɾϒϥ΢βͳͲΛઃఆ
• Functional, Acceptance͸ςετͷॻ͖ํతʹ͸΄΅ಉ͡
• Functional͸WebαʔόΛհ͞ͳ͍
• ϒϥ΢βʹΑΓͰ͖ͳ͍͜ͱ΋͋Δ
• CeptΑΓ΋Cest͕Φεεϝ
• class, idΛద੾ʹηοτ͢Δͱςετ͠΍͍͢

View Slide

Codeception Tips
΋ͬͱ஥ྑ͘͢ΔͨΊͷ

View Slide

env
3.Codeception Tips

View Slide

envͰ࣮ߦ؀ڥΛ੾Γସ͑

View Slide

modules:
enabled:
- WebDriver:
browser: phantomjs
- Db:
user: ''
password: ''
populate: true
env:
firefox:
modules:
config:
WebDriver:
browser: firefox
ࢦఆͨ͠಺༰Ͱ্ॻ͖
͜͜Ͱ͸CSPXTFSΛpSFGPYʹ্ॻ͖
3.Codeception Tips

View Slide

$ vendor/bin/codecept run acceptance —env=firefox
؀ڥ੾Γସ͑
3.Codeception Tips

View Slide

/**
* @env firefox
* @env chrome
*/
public function tryToTest(AcceptanceTester $I)
{
// env=firefox or chrome͚ͩςετ
}
ΞϊςʔγϣϯͰ؀ڥΛࢦఆ
3.Codeception Tips

View Slide

modules:
enabled:
- WebDriver:
browser: phantomjs
- Db:
user: ''
password: ''
populate: true
env:
firefox:
modules:
config:
WebDriver:
browser: firefox
window_size: 1024x768
3.Codeception Tips
΢Οϯυ΢αΠζมߋ

View Slide

disabled
3.Codeception Tips

View Slide

modules:
enabled:
- WebDriver:
browser: phantomjs
env:
firefox:
modules:
config:
WebDriver:
browser: firefox
phpbrowser:
modules:
enabled:
- PhpBrowser:
͜Εͩͱ--env=phpbrowserͰΤϥʔʂ
3.Codeception Tips

View Slide

modules:
enabled:
- WebDriver:
browser: phantomjs
env:
firefox:
modules:
config:
WebDriver:
browser: firefox
phpbrowser:
modules:
enabled:
- PhpBrowser:
͜Εͩͱ--env=phpbrowserͰΤϥʔʂ
ͲͪΒͷϒϥ΢βͰςετ͢Ε͹ 
Α͍͔Θ͔Βͳ͘ͳ͍ͬͯΔɻ
3.Codeception Tips

View Slide

modules:
enabled:
- WebDriver:
browser: phantomjs
env:
firefox:
modules:
config:
WebDriver:
browser: firefox
phpbrowser:
modules:
disabled:
- WebDriver
enabled:
- PhpBrowser:
EJTBCMFEͰແޮԽ
3.Codeception Tips

View Slide

CSSηϨΫλͷௐ΂ํ
3.Codeception Tips

View Slide

3.Codeception Tips

View Slide

3.Codeception Tips
͜͜ͷCSSηϨΫλ͕Θ͔Βͳ͍

View Slide

3.Codeception Tips
CSSηϨΫλͷίϐʔ͕Մೳ

View Slide

3.Codeception Tips
$$(‘[ηϨΫλ]’); Ͱݕূ

View Slide

લɾޙॲཧϝιου
3.Codeception Tips

View Slide

/**
* ॏෳొ࿥ςετ
* @before createData
* @after afterMethod
*/
public function duplicateTest(AcceptanceTester $I)
{
$I->wantToTest('ॏෳొ࿥ςετ');
$I->canSee('͜ͷϝʔϧΞυϨε͸͢Ͱʹ࢖༻͞Ε͍ͯ·͢');
}
3.Codeception Tips

View Slide

/**
* ॏෳςετ༻ͷσʔλΛ࡞੒͢Δ
*
*/
protected function createData(AcceptanceTester $I)
{
$I->haveInDatabase('inquiry', [
'name' => '͢Έͩɹ͍ͬ΃͍',
'created_at' => \Carbon\Carbon::now()
]);
}
3.Codeception Tips
લɾޙॲཧ༻ϝιου͸”protected”

View Slide

@CFGPSF

!CFGPSFͭΊ
!BGUFSͭΊ
3.Codeception Tips
@BGUFS

!CFGPSFͭΊ
!BGUFSͭΊ
ςετϝιου

View Slide

Conclusion
• envΛࢦఆ͢Δ͜ͱͰɺϒϥ΢βͳͲ؀ڥΛ੾
Γସ͑
• @before, @afterΛઃఆͯ͠ɺಠࣗͷલɾޙॲ
ཧΛૠೖ
• CSSηϨΫλͰࠔͬͨΒChrome։ൃπʔϧʂ

View Slide

CodeceptionͱҰॹʹ 
ςετͱ஥ྑ͘͠Α͏ʂ

View Slide

͝੩ௌ 
͋Γ͕ͱ͏͍͟͝·ͨ͠

View Slide

テストと仲良くするためのCodeceptionのはじめかた #phpkansai

テストと仲良くするためのCodeceptionのはじめかた #phpkansai

Ippei Sumida

More Decks by Ippei Sumida

Other Decks in Programming

Featured

Transcript