Jump to content
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

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...