Siirry pääsisältöön

Integraatiotestit Codeceptionin avulla

Opi hyödyntämään Codeception-testauskehystä ja wp-test-komentoa WordPress-sivuston toimivuuden varmistamiseen. Katso ohjeet omien hyväksyntätestien kirjoittamiseen ja selainkonsolivirheiden sallimiseen Seravolla.

Testatut päivitykset ovat olennainen osa Seravon WordPress-palvelua. Ohjelmistojen pitäminen ajan tasalla on tärkeää sekä tietoturvan että toiminnallisuuden kannalta, mutta uudet versiot voivat toisinaan aiheuttaa odottamattomia yhteensopivuusongelmia. Seravo ajaa jokaiselle sivustolle automaattiset testit ennen ja jälkeen päivitysten varmistaakseen, ettei päivitys riko sivustoa.

Voit ajaa nämä samat testit milloin tahansa itse ja kirjoittaa niiden rinnalle sivustokohtaisia mukautettuja testejä Codeception-testauskehyksen avulla.

Miten Seravon testaus toimii?

Seravon testit ovat hyväksyntä- eli integraatiotestejä (acceptance tests), jotka testaavat sivustoa kokonaisuutena todellisen kävijän näkökulmasta yksittäisten koodifunktioiden sijaan. Testaus suoritetaan aidolla selaimella (Headless Google Chrome ja ChromeDriver), jolloin testit havaitsevat samat ongelmat kuin sivuston käyttäjät.

Oletustestit tarkistavat muun muassa seuraavat asiat:

  • Sivuston etusivu latautuu ilman virheitä.

  • Kirjautumissivu (/wp-login.php) avautuu ja tilapäisellä testikäyttäjällä kirjautuminen WordPressin hallintapaneeliin onnistuu ja hallintapaneelin yläpalkki latautuu.

  • Palvelin ei palauta HTTP-virhekoodeja (kuten 500 tai 404).

  • PHP-koodi ei tuota vakavia virheitä ja sivu renderöityy selaimessa oikein.

  • Tyylitiedostot (CSS), kuvat ja muut resurssit latautuvat onnistuneesti.

  • Selainkonsoliin ei tulostu JavaScript-virheitä tai -varoituksia.

Jos jokin testeistä epäonnistuu päivityksen yhteydessä, päivitys perutaan automaattisesti. Lisäksi wp-test-ajo ottaa sivustosta kuvakaappauksia visuaalisten muutosten vertailua varten.

Huom: Kriittisten tietoturvapäivitysten kohdalla Seravo voi asentaa päivityksen testituloksista riippumatta sivuston suojaamiseksi. Huomioithan myös, että integraatiotestit ovat erillinen työkalu eivätkä osa Seravon ympärivuorokautista palvelinvalvontaa.

Testien ajaminen (wp-test)

Voit ajaa testit missä tahansa ympäristössä (tuotanto, staging-varjoympäristö ja paikallinen Docker-kehitysympäristö) komennolla:

wp-test

Esimerkki onnistuneesta testiajosta:

I: Starting wp-test...
I: Using URL 'https://www.example.com' for pre-flight checks.
I: Pre-flight test for https://www.example.com returned HTTP code 200
I: Executing ChromeDriver...
I: Ensure test user exists...
I: Updated permission and password for existing test user...
I: Running Codecept test suite 1/1..
Codeception PHP Testing Framework
Acceptance Tests (2) ----------------------------------------------------
⏺ Recording ⏺ step-by-step screenshots will be saved to /data/reports/tests/
✔ SeravoCheckWPHomeCest: Try to open home (1.86s)
✔ SeravoCheckWPLoginCest: Try to login and access wp admin (10.60s)
--------------------------------------------------------------------------
⏺ Records saved into: file:///data/reports/tests/records.html
OK (2 tests, 3 assertions)
I: Lower test user privileges as test ended...
I: Finished running wp-test

Testien kuvakaappaukset ja vaiheittaiset HTML-raportit tallentuvat palvelimella hakemistoon /data/reports/tests/.

Seravon vakiotestit ovat täysin turvallisia ajaa myös tuotantosivustolla: testaus luo tilapäisen testikäyttäjän vain testin ajaksi ja poistaa sen käyttöoikeudet välittömästi testin päätyttyä.

Vinkki: Hyödynnä wp-test-komentoa osana julkaisuprosessia ajamalla testit ensin varjoympäristössä (staging) koodimuutosten viennin jälkeen, ennen kuin julkaiset muutokset tuotantoon.

Omien testien kirjoittaminen

wp-test-komento suorittaa automaattisesti kaikki mukautetut testit, jotka sijaitsevat hakemistossa /data/wordpress/tests/codeception/. Jos hakemistoa ei vielä ole projektissasi, voit luoda sen ja lisätä testit suoraan sivuston Git-versionhallintaan.

Järjestelmä tukee kolmea tapaa kirjoittaa omia testejä:

1. Yksinkertaiset testit (*Cept.php)

Proseduraaliset *Cept.php-tiedostot sopivat nopeisiin ja yksittäisiin tarkistuksiin. Luo tiedosto polkuun /data/wordpress/tests/codeception/acceptance/ExampleCept.php:

<?php
$I = new AcceptanceTester($scenario);
$I->amOnPage('/');
$I->checkBrowserConsole();
$I->see('WordPress');

2. Luokkapohjaiset testit (*Cest.php)

Oliopohjaiset *Cest.php-luokat ovat suositeltavin tapa laajempien testikokonaisuuksien rakentamiseen. Jokainen tiedosto sisältää yhden PHP-luokan, jonka nimen tulee vastata tiedoston nimeä (esim. /data/wordpress/tests/codeception/acceptance/UserCheckWPHomeCest.php):

<?php

class UserCheckWPHomeCest
{
/**
* Testaa etusivun hakulomakkeen toiminta
*/
public function trySubmittingSearch(\AcceptanceTester $I)
{
// Siirry etusivulle
$I->amOnPage('/');

// Varmista, ettei selainkonsolissa ole virheitä
$I->checkBrowserConsole();

// Tarkista sivun sisältö ja elementit
$I->see('Tervetuloa');
$I->seeElement('h1#maintitle');
$I->seeElement('form[name=searchform]');

// Täytä ja lähetä hakulomake
$I->fillField('input[name=search]', 'hakusana');
$I->click('#submitSearchForm');

// Tarkista hakutulokset ja ota kuvakaappaus
$I->see('Hakutulokset:');
$I->makeScreenshot('searchresults');
}

/**
* Tarkista DOM-rakenteessa olevat piilotetut elementit
*/
public function tryIfNonVisibleElementExists(\AcceptanceTester $I)
{
$I->amOnPage('/esimerkkisivu');
$I->seeElementInDOM('#piilotettu-elementti');

$I->amOnPage('/toinen-sivu');
$I->dontSeeElementInDOM('h3#ei-saa-esiintya');
}
}

Voit ajaa ja debugata uutta testiä tarkemmalla tulosteella ja pysäyttää ajon ensimmäiseen virheeseen komennolla:

wp-test --debug --fail-fast

Huom: Testatut WordPress-päivitykset sisältyvät kaikkiin Seravon palvelupaketteihin. Sivustokohtaisten mukautettujen testien kirjoittaminen tai vianmääritys ei sisälly kuukausimaksuun, mutta voit tilata testien toteutuksen asiantuntijoiltamme tuntityönä.

3. Täysin mukautettu konfiguraatio (custom.yml)

Voit määritellä myös täysin oman Codeception-testikokonaisuuden tallentamalla testitiedostot hakemistoon /data/wordpress/tests/codeception/ ja luomalla sinne määritystiedoston custom.yml, jonka voi suorittaa komennolla codecept run.

Apufunktioiden luettelo

Seravon omat apufunktiot (SeravoAcceptanceHelper)

Seravon ympäristö tarjoaa valmiita apumetodeja ympäristön tunnistamiseen ja selainkonsolin tarkistamiseen:

// Palauttaa nykyisen ympäristön (production, development, staging, update)
$I->getEnvironment();

// Tarkista ajetaanko testi tuotanto- tai kehitysympäristössä (true/false)
$I->isProduction();
$I->isDevelopment();

// Palauttaa selainkonsolin lokiviestit taulukkona
$I->getConsoleLog();

Vinkki: Jos kirjoitat testejä, jotka lähettävät yhteydenottolomakkeita tai luovat testitilauksia, ohita ne tuotantoympäristössä ehdolla if ($I->isProduction()) { return; }.

Yleisimmät Codeception-komennot

// Sivulla liikkuminen
$I->amOnPage('/polku/sivulle?parametri=1');

// Linkkien ja painikkeiden klikkaaminen
$I->click('#elementin-id');
$I->click('a.painikkeen-luokka');
$I->click('input[name=ok]');

// Lomakekenttien täyttäminen
$I->fillField('kentan-nimi', 'arvo');

// Sivun sisällön ja rakenteen tarkistaminen
$I->seeInTitle('Sivun otsikko');
$I->see('Haettava teksti');
$I->seeElement('//table/tr'); // XPath-valitsin
$I->seeElement('h1'); // HTML-elementti
$I->seeElement('#id'); // ID-valitsin
$I->seeElement('.luokka'); // CSS-luokka
$I->seeElement('div#main p.intro'); // Tarkempi CSS-valitsin

// Selainkonsolin tarkistaminen
$I->checkBrowserConsole();

// Ohita varoitukset (WARNING), tarkista vain virheet (SEVERE)
$I->checkBrowserConsole(true);

// Ohita varoitukset sekä yksittäinen määritelty virheilmoitus
$I->checkBrowserConsole(true, array(
array(
"level" => "SEVERE",
"message" => ".* Uncaught DOMException: play\(\) failed because the user didn't interact with the document first.",
"regex" => true
)
));

Harmittomien selainkonsolivirheiden salliminen (whitelistaus)

Oletuksena $I->checkBrowserConsole() tulkitsee minkä tahansa Chrome-konsoliin tulostuvan virheen tai varoituksen testin epäonnistumiseksi – koski se sitten JavaScriptiä, puuttuvaa kuvaa tai sekasisältövaroitusta (Mixed Content).

Joskus konsoliviesti on kuitenkin harmiton ilmoitus, joka ei estä päivityksiä (esimerkiksi vanhemman lisäosan aiheuttama jQuery Migrate -varoitus):

WARNING: https://example.com/wp-includes/js/jquery/jquery-migrate.js?ver=1.4.1 44:11 "JQMIGRATE: jQuery.browser is deprecated"

Tapa 1: Salliminen wp-test-whitelist-komennolla (suositeltu)

Voit lisätä viestin sivustokohtaiseen sallittujen listaan suoraan komentoriviltä:

wp-test-whitelist --add ".* JQMIGRATE: .* is deprecated" --regex

Komento päivittää automaattisesti sivuston console-whitelist.json-tiedoston. Näet kaikki komennon valitsimet ajamalla wp-test-whitelist --help.

Tapa 2: console-whitelist.json-tiedoston muokkaaminen

Voit hallita sallittuja ilmoituksia myös suoraan versionhallinnassa olevassa tiedostossa /data/wordpress/tests/codeception/acceptance/console-whitelist.json:

[
{
"level": "WARNING",
"message": ".* JQMIGRATE: .* is deprecated",
"regex": true
}
]
  • message (pakollinen): Sallittava merkkijono tai säännöllinen lauseke (regex).

  • regex (valinnainen): Aseta arvoon true, jos message-kenttä käyttää säännöllistä lauseketta.

  • level (valinnainen): Virheen taso, kuten WARNING tai SEVERE.

Huom: Koska JSON käyttää kenoviivaa (\) pakomerkkinä, säännöllisten lausekkeiden kenoviivat täytyy kahdentaa. Esimerkiksi pisteen pakomerkintä jquery\.com kirjoitetaan JSON-tiedostossa muodossa jquery\\.com.

Sivustokohtaisen console-whitelist.json-tiedoston etuna on, että se koskee kaikkia $I->checkBrowserConsole()-kutsuja – mukaan lukien Seravon automaattisten päivitystestien aikaisia tarkistuksia.

Yleisimmät virhetilanteet

  • wp-test epäonnistuu selainkonsolin virheeseen (Browser console error): Tarkista virheilmoitus testitulosteesta. Jos kyseessä on ulkoisen skriptin tai kolmannen osapuolen lisäosan harmiton varoitus, jota et voi korjata omassa koodissasi, salli ilmoitus wp-test-whitelist-komennolla.

  • Testi epäonnistuu paikallisessa Docker-ympäristössä SSL- tai osoitevirheeseen: Varmista, että paikallinen Docker-ympäristö on käynnissä (seravo-docker up) ja että sivusto vastaa osoitteessa, joka on määritelty ympäristön asetuksissa.

  • Oma *Cest.php-testi ei suoriudu lainkaan: Varmista, että tiedosto sijaitsee hakemistossa /data/wordpress/tests/codeception/acceptance/, sen tiedostopääte on täsmälleen Cest.php (esim. OmaTestiCest.php) ja tiedoston sisällä määritellyn PHP-luokan nimi on täsmälleen sama kuin tiedostonimi ilman .php-päätettä.

  • Mistä näen, mitä selaimessa tapahtui testin epäonnistuessa? Avaa hakemistoon /data/reports/tests/ tallennetut kuvakaappaukset tai tarkastele vaiheittaista suoritusta tiedostosta /data/reports/tests/records.html.

  • wp-test epäonnistuu varjoympäristössä tai keskeneräisellä sivustolla kirjautumis- tai etusivuvirheeseen: Jos sivustolla on käytössä HTTP-perustodennus (Basic Auth / .htpasswd) tai erillinen Coming Soon / ylläpitotilalisäosa, Headless Chrome ei pääse sivuston etusivulle tai kirjautumislomakkeelle. Poista salasanasuojaus tai ylläpitotila tilapäisesti testauksen ajaksi.

Katso myös

Automaattiset Codeception-testit varmistavat, että sekä WordPress-päivitykset että omat koodimuutoksesi voidaan julkaista luottavaisin mielin. Mikäli tarvitset apua testien vianmäärityksessä tai mukautettujen testien toteuttamisessa, asiakaspalvelumme auttaa osoitteessa [email protected].

Vastasiko tämä kysymykseesi?