tests/e2e/README.md

   1 # Selenium + PHPUnit Test OpenEMR
   2
   3 Author: Sharon Cohen, Oleg Sverdlov
   4
   5
   6 This is a guide on how to install and run a simple selenium test (using phpunit) to the Open EMR system.
   7
   8 This is just a sample test (and simple one).
   9
  10 The example test includes:
  11
  12 * Open the browser and go to local OpenEMR installation
  13 * Login with default admin credentials
  14 * Go to New patient form
  15 * Add a new patient with random names(string) and DOB
  16 * Accept the creation of the new patient
  17 * Check the database that this patient exist in the table patient_data
  18 * Close the  browser
  19
  20 ### Things to improve:
  21
  22 To have a complete set of test they should include:
  23
  24 * Login failure
  25 * Validation test when creating a new patient
  26 * Checking the existence/inexistence of clinical reminders according to personal configuration
  27
  28 ## Installation:
  29
  30 The test works for OpenEMR installed on local computer. You'll need Chrome browser :)
  31 (Note that with a simple code change, there is also the option of using the Firefox browser)
  32
  33 ### Install Composer and packages
  34
  35 If you don't have Composer refer to https://getcomposer.org/download/
  36
  37 From OpenEMR folder install phpunit and phpunit-selenium via composer
  38
  39     composer require --dev phpunit/phpunit
  40     composer require --dev phpunit/phpunit-selenium
  41
  42 (depending on how you installed Composer you may need to run `php composer.phar` )
  43
  44 ### Install Browser driver
  45
  46 To use Chrome as a test Browser download the driver from here: https://sites.google.com/a/chromium.org/chromedriver/downloads
  47
  48 Move the downloaded file to an executable directory
  49
  50     sudo mv chromedriver /usr/local/bin/
  51
  52     sudo chmod 755 /usr/local/bin/chromedriver
  53
  54
  55 ### Install Selenium server
  56
  57 Download standalone selenium server from here: http://docs.seleniumhq.org/download/
  58
  59 Download and install JRE. You can get JRE from java.com or from your Linux distro repositories. Check you can run it:
  60
  61     java -version
  62
  63
  64 ## Running tests
  65
  66 *never run the tests on production database!
  67
  68 First, run Selenium server in separate process
  69
  70     java -jar selenium-server-standalone-<version>.jar
  71
  72 Then, run the test:
  73
  74     ./vendor/bin/phpunit Tests/selenium/CheckCreateUser.php
  75
  76 ## References:
  77
  78     https://getcomposer.org/download/
  79
  80     https://phpunit.de/manual/current/en/installation.html
  81
  82     https://sites.google.com/a/chromium.org/chromedriver/downloads
  83
  84     http://docs.seleniumhq.org/download/
  85
  86     https://www.sitepoint.com/using-selenium-with-phpunit/
  87
  88     https://phpunit.de/manual/3.7/en/selenium.html
  89
  90     https://phpunit.de/manual/current/en/database.html
  91
  92