MyModuleFunctionalTest.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2017 Laurent Destailleur  <eldy@users.sourceforge.net>
 * Copyright (C) ---Put here your own copyright and developer email---
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace test\functional;

use PHPUnit_Extensions_Selenium2TestCase_WebDriverException;

class MyModuleFunctionalTest extends \PHPUnit_Extensions_Selenium2TestCase
{
  // TODO: move to a global configuration file?
  protected static $base_url = 'http://dev.zenfusion.fr';
  protected static $dol_admin_user = 'admin';
  protected static $dol_admin_pass = 'admin';
  private static $module_id = 500000; // TODO: autodetect?

  public static $browsers = array(
    array(
      'browser' => 'Google Chrome on Linux',
      'browserName' => 'chrome',
      'sessionStrategy' => 'shared',
      'desiredCapabilities' => array()
    ),
    // Geckodriver does not keep the session at the moment?!
    // XPath selectors also don't seem to work
    //array(
    //    'browser' => 'Mozilla Firefox on Linux',
    //    'browserName' => 'firefox',
    //    'sessionStrategy' => 'shared',
    //    'desiredCapabilities' => array(
    //        'marionette' => true,
    //    ),
    //)
  );

  protected function byHref($value)
  {
    $anchor = null;
    $anchors = $this->elements($this->using('tag name')->value('a'));
    foreach ($anchors as $anchor) {
      if (strstr($anchor->attribute('href'), $value)) {
        break;
      }
    }
    return $anchor;
  }

  public static function setUpBeforeClass()
  {
  }

  public function setUp()
  {
    $this->setSeleniumServerRequestsTimeout(3600);
    $this->setBrowserUrl(self::$base_url);
  }

  protected function assertPreConditions()
  {
  }

  private function authenticate()
  {
    try {
      if ($this->byId('login')) {
        $login = $this->byId('username');
        $login->clear();
        $login->value('admin');
        $password = $this->byId('password');
        $password->clear();
        $password->value('admin');
        $this->byId('login')->submit();
      }
    } catch (PHPUnit_Extensions_Selenium2TestCase_WebDriverException $e) {
      // Login does not exist. Assume we are already authenticated
    }
  }

  public function testEnableDeveloperMode()
  {
    $this->url('/admin/const.php');
    $this->authenticate();
    $main_features_level_path = '//input[@value="MAIN_FEATURES_LEVEL"]/following::input[@type="text"]';
    $main_features_level = $this->byXPath($main_features_level_path);
    $main_features_level->clear();
    $main_features_level->value('2');
    $this->byName('update')->click();
    // Page reloaded, we need a new XPath
    $main_features_level = $this->byXPath($main_features_level_path);
    return $this->assertEquals('2', $main_features_level->value(), "MAIN_FEATURES_LEVEL value is 2");
  }

  public function testModuleEnabled()
  {
    $this->url('/admin/modules.php');
    $this->authenticate();
    $module_status_image_path = '//a[contains(@href, "'.self::$module_id.'")]/img';
    $module_status_image = $this->byXPath($module_status_image_path);
    if (strstr($module_status_image->attribute('src'), 'switch_off.png')) {
      // Enable the module
      $this->byHref('modMyModule')->click();
    } else {
      // Disable the module
      $this->byHref('modMyModule')->click();
      // Reenable the module
      $this->byHref('modMyModule')->click();
    }
    // Page reloaded, we need a new Xpath
    $module_status_image = $this->byXPath($module_status_image_path);
    return $this->assertContains('switch_on.png', $module_status_image->attribute('src'), "Module enabled");
  }

  public function testConfigurationPage()
  {
    $this->url('/custom/mymodule/admin/setup.php');
    $this->authenticate();
    return $this->assertContains('mymodule/admin/setup.php', $this->url(), 'Configuration page');
  }

  public function testAboutPage()
  {
    $this->url('/custom/mymodule/admin/about.php');
    $this->authenticate();
    return $this->assertContains('mymodule/admin/about.php', $this->url(), 'About page');
  }

  public function testAboutPageRendersMarkdownReadme()
  {
    $this->url('/custom/mymodule/admin/about.php');
    $this->authenticate();
    return $this->assertEquals(
      'Dolibarr Module Template (aka My Module)',
      $this->byTag('h1')->text(),
      "Readme title"
    );
  }

  public function testBoxDeclared()
  {
    $this->url('/admin/boxes.php');
    $this->authenticate();
    return $this->assertContains('mymodulewidget1', $this->source(), "Box enabled");
  }

  public function testTriggerDeclared()
  {
    $this->url('/admin/triggers.php');
    $this->authenticate();
    return $this->assertContains(
      'interface_99_modMyModule_MyModuleTriggers.class.php',
      $this->byTag('body')->text(),
      "Trigger declared"
    );
  }

  public function testTriggerEnabled()
  {
    $this->url('/admin/triggers.php');
    $this->authenticate();
    return $this->assertContains(
      'tick.png',
      $this->byXPath('//td[text()="interface_99_modMyModule_MyTrigger.class.php"]/following::img')->attribute('src'),
      "Trigger enabled"
    );
  }

  protected function assertPostConditions()
  {
  }

  public function tearDown()
  {
  }

  public static function tearDownAfterClass()
  {
  }
}