tpr

Using Nette Tester with ProcessWire

Recommended Posts

Update 2018-07-09: ProcessNetteTester module is available in the Modules Directory and on GitHub.

processnettetester.thumb.png.ca7e5a36e142095fb2db7cf08a8c9a86.png

This is a short tutorial on how to use Nette Tester with ProcessWire.

As you will see it's very easy to setup and use and it's perfect for testing your code's functionality. With bootstrapping ProcessWire it's also possible to check the rendered markup of pages using the API, checking page properties, etc. It's also a great tool for module developers for writing better code. 

While there will be nothing extraordinary here that you couldn't find in Tester's docs this can serve as a good starting point.

Prerequisites: PHP 5.6+

01 Download Tester

Go to https://github.com/nette/tester/releases and download the latest release (currently 2.0.2). Download from the link reading "Source code (zip)". You can use composer also if you wish.

02 Extract Tester files

Create a new directory in your site root called "tester". Extract the zip downloaded here, so it should look like this:

/site
/tester/src
/tester/tools
/tester/appveyor.yml
/tester/composer.json
/tester/contributing.md
/tester/license.md
/tester/readme.md
/wire
...

03 Create directory for test files

Add a new directory in "/tester" called "tests". Tester recognizes "*.Test.php" and "*.phpt" files in the tests directory, recursively. 

04 Create your first test

In the "tests" directory create a new "MyTest.php" file.

The first test is a very simple one that bootstraps ProcessWire and checks if the Home page name is "Home". This is not the smartest test but will show you the basics.

Add this to "/tester/tests/MyTest.php":

<?php namespace ProcessWire;

use \Tester\Assert;
use \Tester\DomQuery;
use \Tester\TestCase;
use \Tester\Environment;

require __DIR__ . '/../src/bootstrap.php'; // load Tester
require __DIR__ . '/../../index.php'; // bootstrap ProcessWire

Environment::setup();

class MyTest extends TestCase
{
    // first test (step 04)
    public function testHomeTitle()
    {
        $expected = 'Home'; // we expect the page title to be "Home"
        $actual = wire('pages')->get(1)->title; // check what's the actual title
        Assert::equal($expected, $actual); // check whether they are equal
    }

    // second test will go here (step 06)
    // third test will go here (step 07)
}

// run testing methods
(new MyTest())->run();

I've added comment placeholders for the second and third tests that we will insert later.

05 Run Tester

Tester can be run either from the command line or from the browser. The command line output is more verbose and colored while in the browser it's plain text only (see later).

Running from the command line

Navigate to the "/tester" directory in your console and execute this:

php src/tester.php -C tests

This will start "/tester/src/tester.php" and runs test files from the "/tester/tests" directory. The "-C" switch tells Tester to use the system-wide php ini file, that is required here because when bootstrapping ProcessWire you may run into errors (no php.ini file is used by default). You may load another ini file with the "-c <path>" (check the docs).

If the title of your Home page is "Home" you should see this:

tester-ok.png.7af030edf8d090a2d50c38ce87fa5d5a.png

If it's for example "Cats and Dogs", you should see this:

tester-failure.png.0e1a44f116602b4373221ddfacd4850d.png

Running from the browser

First we need to create a new PHP file in ProcessWire's root, let's call it "testrunner.php". This is because ProcessWire doesn't allow to run PHP files from its "site" directory.

The following code runs two test classes and produces a legible output. IRL you should probably iterate through directories to get test files (eg. with glob()), and of course it's better not allow tests go out to production.

<?php
ini_set('html_errors', false);
header('Content-type: text/plain');

echo 'Starting tests.' . PHP_EOL;
echo '--------------------------' . PHP_EOL;

$file = __DIR__ . '/PATH_TO/FirstTest.php';
echo basename($file) . ' ';
require $file;
echo '[OK]' . PHP_EOL;

$file = __DIR__ . '/PATH_TO/SecondTest.php';
echo basename($file) . ' ';
require $file;
echo '[OK]' . PHP_EOL;

echo '--------------------------' . PHP_EOL;
echo 'Tests finished.';

exit;

Navigate to "DOMAIN/testrunner.php" in your browser to execute the file. If every test succeeds you should get this:

tester-ok-browser.png.bd4dc2b5d69f1be26ea2b00eabdd286f.png

If there are failed tests the execution stops and you can read the error message. If there were more tests (eg. ThirdTest), those won't be displayed under the failed test.

tester-failure-browser.png.1a89ccae06b187ab56fa9482b61e9240.png

06 DOM test

This test will check if a page with "basic-page" template has a "h1" element. We will create the page on the fly with ProcessWire's API. To keep things simple we will add the new test as a new method to our MyTest class.

Add this block to the MyTest class:

public function testBasicPageHeadline()
{
    $p = new Page();
    $p->template = 'basic-page';
    $html = $p->render();
    $dom = DomQuery::fromHtml($html);

    Assert::true($dom->has('h1'));
}

This will most likely be true but of course you can check for something more specific, for example "div#main". Note that we have used the DomQuery helper here (check the "use" statement on the top of the file).

07 Custom function test

You will probably want to make sure your custom functions/methods will work as they should so let's write a test that demonstrates this.

I don't want to complicate things so I'll check if the built-in "pageName" sanitizer works as expected. Add this to the myTest class:

public function testPageNameSanitizer()
{
    $expected = 'hello-world';
    $actual = wire('sanitizer')->pageName('Hello world!', true);

    Assert::equal($expected, $actual);
}

This should also be true. Try to change the expected value if you are eager to see a failure message.
 
08 Next steps

You can add more methods to the MyTest class or create new files in the "tests" directory. Check out the range of available Assertions and other features in the docs and see how they could help you writing more fail-safe code.

Once you make a habit of writing tests you'll see how it can assist making your code more bulletproof and stable. Remember: test early, test often 🙂

If you find out something useful or cool with Tester make sure to share.

  • Like 18
  • Thanks 2

Share this post


Link to post
Share on other sites

It seems like nette is a bit less crufty than phpunit, which is nice. However I'm wondering how you're handling state in the database. E.g. how do you make sure if one tests creates a new page it's not affecting the next test?

Share this post


Link to post
Share on other sites

Honestly I haven't went that far yet but the closest I found are the setUp and tearDown methods (see the docs). Of course this creates holes in the autoincrement ids but I don't think that matters much. 

Method calls order
------------------
setUp()
testOne()
tearDown()

setUp()
testTwo()
tearDown()
  • Like 1

Share this post


Link to post
Share on other sites

When using setUp and tearDown methods it's good to keep in mind that Tester runs tests in parallel threads. That is, if you except that a Page you create in the setUp method will be deleted in tearDown before the next test method begins, you may be wrong.

For example I've created and saved a new Page with the same title in setUp and deleted it in tearDown. I randomly got a ProcessWire error saying it could not generate a unique name for the page, and that was because the other tests have been started before the page could be deleted in the tearDown method.

The actual thread number can be retrieved, so appending it to the title solved the issue (or by adding a random suffix):

$p->title = 'Test ' . getenv(\Tester\Environment::THREAD);

Alternatively you can reduce the number of threads to 1 with the "-j 1" switch (runtime will increase a lot).

  • Like 2

Share this post


Link to post
Share on other sites

I've updated the first post with info on how to run tests from the browser, so there's no need to have command line access to the server.

  • Like 5

Share this post


Link to post
Share on other sites

I'm working on a module that makes easier to run tests, from within the admin. It's a process module and you can add pages anywhere in the admin and set each page a tests directory. So you can add new tester pages, or specify a path to an existing tests directory, see my TemplateLatteReplace module's tests in action on the screencap. Furthermore you can narrow the list of tests within a directory with URL parameters, to include only a few tests or exclude some. This may come handy if you don't want to run all the tests within a directory.

Another handy feature is that you can re-run tests via ajax, that makes it easy to check whether your fixes are working (whether in "real" code or in test code).

processnettetester.thumb.gif.f6e93f5b9eec35e88d3958f291fef11b.gif

  • Like 9

Share this post


Link to post
Share on other sites

I'm close to release the initial version of the module, only a few issues are left behind.

I rewrite the UI so it uses ajax all the time. It was an overkill to start all test on page load, plus it was done in one PHP thread which involved a few issues (timeout, included files were inherited by next tests, etc). With ajax it's not only user-friendlier but more reliable too, and it's possible to catch PHP errors too (beforehands the syntax error was outputted on the whole page).

I also managed to format the Assert error message so now it's much easier to grasp the message.

I really like how it looks and works now. Even so it seems simple the JS part was tricky sometimes 🙂

processnettetester-20180705.thumb.gif.682e100030265b137bca591426405d6a.gif

  • Like 5

Share this post


Link to post
Share on other sites

This is really nice @tpr! I am currently reading up on these test suites like Codeception and Tester or plain testing like phpunit. This comes in very handy.

  • Like 2

Share this post


Link to post
Share on other sites

Hello there, it is good to hear that someone cares about code testing in PW community. Some time ago I've created a tool which helps you to run your tests against multiple version of PW quite easily. You can check it out there: https://github.com/uiii/tense. It is compatible with any testing framework. I would be really glad if I'm not the only one using it 🙂

  • Like 1

Share this post


Link to post
Share on other sites

 

5 hours ago, Richard Jedlička said:

... I've created a tool which helps you to run your tests against multiple version of PW quite easily. You can check it out there: https://github.com/uiii/tense. ...

But the truth is my tool is more suitable for module or site profile development rather than for site testing, where you would test the specific PW instance.

  • Like 1

Share this post


Link to post
Share on other sites
6 hours ago, Richard Jedlička said:

Hello there, it is good to hear that someone cares about code testing in PW community.

Well I'm a starter only but it's fun, and knowing you can any time run tests to ensure everything is OK is invaluable.

  • Like 6

Share this post


Link to post
Share on other sites

Just added the beforementioned ProcessNetteTester module download links to the first post. Read the readme on GitHub on how to set it up.

  • Like 4

Share this post


Link to post
Share on other sites

Hello,

I am discovering PHP tests and this great module (thanks !).

Just to mention in case it helps others. The first example kept failing on my website until I understood it was due to the multilanguage setup. Eventually, test 01 became :

	    public function testHomeTitle()
    {
      $expected = 'Home'; // we expect the page title to be "Home"
      $actual = wire('pages')->get(1)->title->getLanguageValue("default"); // check what's the actual title
      Assert::equal($expected, $actual); // check whether they are equal
    }

and passed 🙂 

This may seem perfectly obvious to most of you, but it might help a few ?

By the way, I wish I could use my usual debugging tools to debug my tests (sounds quite funny to say 🙂 ) and write something like 

	bd($actual);
	

Here I had to fiddle until I found out about my multiLanguage thing... Would you have any tips on that ?

 

Share this post


Link to post
Share on other sites
3 minutes ago, celfred said:

By the way, I wish I could use my usual debugging tools to debug my tests (sounds quite funny to say 🙂 ) and write something like 


	bd($actual);
	

Here I had to fiddle until I found out about my multiLanguage thing... Would you have any tips on that ?

It might be a module load order issue. Please try grabbing the latest dev version of PW and the latest Tracy and see if that helps. Tracy is now the first module loaded so that should hopefully solve things for you.

  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites
On 9/23/2018 at 5:41 PM, adrian said:

It might be a module load order issue. Please try grabbing the latest dev version of PW and the latest Tracy and see if that helps. Tracy is now the first module loaded so that should hopefully solve things for you.

Thanks a lot for your quick help. But I'm not that good and I am running PW 3.0.62 both on local and production. I won't update right now because I'm not able to easily manage different version on local and remote... So I'll manage little by little and do the update later 🙂 But thanks !

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Anssi
      A simple module to enable easy navigation between the public and the admin side of the site. After installation a green bar will appear to the upper side of the screen, containing a few navigation elements and displaying the PW version number.
      Heavily inspired by @apeisa's great AdminBar (Thanks!). I needed a bit simpler tool for my projects and as a result, this was made. Available on GitHub .

    • By Sebi
      I've created a small module which lets you define a timestamp after which a page should be accessible. In addition you can define a timestamp when the release should end and the page should not be accessable any more.
      Github: https://github.com/Sebiworld/PageAccessReleasetime
      Usage
      PageAccessReleasetime can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules
      After that, you will find checkboxes for activating the releasetime-fields at the settings-tab of each page. You don't need to add the fields to your templates manually.
      Check e.g. the checkbox "Activate Releasetime from?" and fill in a date in the future. The page will not be accessable for your users until the given date is reached.
      If you have $config->pagefileSecure = true, the module will protect files of unreleased pages as well.
      How it works
      This module hooks into Page::viewable to prevent users to access unreleased pages:
      public function hookPageViewable($event) { $page = $event->object; $viewable = $event->return; if($viewable){ // If the page would be viewable, additionally check Releasetime and User-Permission $viewable = $this->canUserSee($page); } $event->return = $viewable; } To prevent access to the files of unreleased pages, we hook into Page::isPublic and ProcessPageView::sendFile.
      public function hookPageIsPublic($e) { $page = $e->object; if($e->return && $this->isReleaseTimeSet($page)) { $e->return = false; } } The site/assets/files/ directory of pages, which isPublic() returns false, will get a '-' as prefix. This indicates ProcessWire (with activated $config->pagefileSecure) to check the file's permissions via PHP before delivering it to the client.
      The check wether a not-public file should be accessable happens in ProcessPageView::sendFile. We throw an 404 Exception if the current user must not see the file.
      public function hookProcessPageViewSendFile($e) { $page = $e->arguments[0]; if(!$this->canUserSee($page)) { throw new Wire404Exception('File not found'); } } Additionally we hook into ProcessPageEdit::buildForm to add the PageAccessReleasetime fields to each page and move them to the settings tab.
      Limitations
      In the current version, releasetime-protected pages will appear in wire('pages')->find() queries. If you want to display a list of pages, where pages could be releasetime-protected, you should double-check with $page->viewable() wether the page can be accessed. $page->viewable() returns false, if the page is not released yet.
      If you have an idea how unreleased pages can be filtered out of ProcessWire selector queries, feel free to write an issue, comment or make a pull request!
    • By David Karich
      Thanks to the great Pro module "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use this module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      With this proof of concept I have created a module which adds the feature to copy a repeater item to the clipboard so that you can paste this item to another page with the same repeater field. The module has been developed very rudimentarily so far. It is currently not possible to copy nested items. There is also no check of Min/Max. You can also only copy items that have the same field on different pages. And surely you can solve all this more elegantly with AJAX. But personally I lack the deeper understanding of the repeaters. Also missing on the Javascript side are event triggers for the repeaters, which would make it easier. Like e.g. RepeaterItemInitReady or similar.
      it would be great if @ryan would implement this functionality in the core of RepeaterMatrix. I think he has better ways to implement this. Or what do you think, Ryan?
      Everybody is welcome to work on this module and improve it, if it should not be integrated into the matrix core. Therefore I put it for testing and as download on GitHub: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDublicate
      You can best see the functionality in the screencast: 
       
    • By anderson
      Hi,
      Please take a look at this:
      https://templatemag.com/demo/Good/
      The upper nav bar, including dropdowns like "pages" and "portfolios", what do you call this whole thing? At first I guess it's called "dropdown nav bar", but seems not.
      AND of course, what's the simplest way/module to achieve this in PW?
      Thanks in advance.
    • By Sebi2020
      Hey, I'm new and I created a simple module for tagging pages because I didn't found a module for it (sadly this is not a core feature). This module is licensed under the GPL3 and cames with absolutly no warranty at all. You should test the module before using it in production environments. Currently it's an alpha release. if you like the module or have ideas for improvements feel free to post a comment. Currently this fieldtype is only compatible with the Inputfield I've created to because I haven't found  an Inputfield yet, that returns arrays from a single html input.
      Greetings Sebi2020
      FieldtypeTags.zip.asc
      InputfieldTagify.zip
      InputfieldTagify.zip.asc
      FieldtypeTags.zip