Actions

Difference between revisions of "Testing Area/Behat Testing/Setup"

From Mahara Wiki

< Testing Area‎ | Behat Testing
m
 
(35 intermediate revisions by 9 users not shown)
Line 1: Line 1:
=How to install Mahara and Behat=
+
{{note|These instructions for the Behat setup are only for machines running Linux. They will not work for Windows machines.}}
  
'''Note''': These instructions for Mahara and Behat setup are only for machines running Linux. They will not work for Windows machines
+
1. Set up your [[Developer_Area/Developer_Environment | developer environment]] if you haven't already done so.
  
 +
2. Install Behat's dependencies:
 +
<syntaxhighlight lang="bash">
 +
$ sudo apt-get install curl openjdk-8-jre-headless
 +
</syntaxhighlight>
  
 +
3. Add the following config settings to the bottom of your Mahara config.php file inside the htdocs/ subdirectory of the Mahara codebase.
  
== For dev's instructions to install a Mahara ==
+
{{note|If /var/www/maharadata is not where you created your dataroot, you'll need to replace that with the correct path in the following commands}}
Please use [[System_Administrator%27s_Guide/Installing_Mahara]].
 
  
 +
<syntaxhighlight lang="bash">
 +
// Behat config
 +
$cfg->behat_dbprefix = 'behat_'; // must not empty
 +
$cfg->behat_dataroot = "/var/lib/maharadata/master_behat"; // The Behat copy of maharadata.
 +
$cfg->behat_wwwroot = 'http://localhost:8000'; // Must be this
 +
$cfg->behat_selenium2 = "http://127.0.0.1:4444/wd/hub"; // Must be this
  
 +
// If you want failed step screenshots appear directly on screen while the step fails (only Ubuntu)
 +
$cfg->behat_view_screenshots = true;
 +
</syntaxhighlight>
  
== Otherwise, if you do not have Mahara installed ==
+
{{note|There should be a behat_dataroot for each Mahara instance that you set up. Here the one for the master branch / this Mahara instance is created.}}
 +
{{note|If the directory for $cfg->behat_dataroot does not exist then it will need to be created.}}
  
[[Developer_Area/Developer_Environment | Follow the instructions]] for setting up Mahara.
+
4. Make your Behat data directory (check this matches what you set in config.php):
 +
<syntaxhighlight lang="bash">
 +
$ sudo mkdir /var/lib/maharadata/master_behat
 +
</syntaxhighlight>
  
{{note|If you do have Mahara already installed, skip to [[#Behat_installation]]}}
+
5. Make the directory and any subdirectories writeable by Mahara (check the directory is correct):
 +
<syntaxhighlight lang="bash">
 +
$ sudo chmod 777 -R /var/lib/maharadata/master_behat
 +
</syntaxhighlight>
 +
<span id="chown"></span>
 +
6. Change the directory and any subdirectories permissions to be owned by apache user (check the directory is correct):
 +
<syntaxhighlight lang="bash">
 +
$ sudo chown -R www-data:www-data /var/lib/maharadata/master_behat
 +
</syntaxhighlight>
  
 +
*For Ubuntu, apache runs with user www-data
 +
*For Centos, apache runs with user apache
  
===Behat installation===
+
7. Run Behat tests (change into your Mahara code directory first) as the apache user:
 +
<syntaxhighlight lang="bash">
 +
$ cd
 +
$ cd code/mahara
 +
./test/behat/mahara_behat.sh run
 +
</syntaxhighlight>
  
Install Behat's dependencies:
+
Or if you have sudo access:
sudo apt-get install curl openjdk-7-jre-headless
+
<syntaxhighlight lang="bash">
 +
$ cd
 +
$ cd code/mahara
 +
sudo -u www-data ./test/behat/mahara_behat.sh run
 +
</syntaxhighlight>
  
Add these config settings to the bottom of your Mahara config.php file, inside the htdocs/ subdirectory of the Mahara codebase.
 
  
{{note|If /var/www/maharadata is not where you created your dataroot, you'll need to replace that with the correct path in the following commands}}
+
For the first time of running Behat, you need to wait for the Behat environment initialisation. This can take a while.
 +
 
 +
To run all tests:
 +
./test/behat/mahara_behat.sh run
 +
 
 +
To run your specific tests marked with @yourtags:
 +
./test/behat/mahara_behat.sh run @yourtags
 +
 
 +
To run a particular feature file:
 +
./test/behat/mahara_behat.sh run my_file.feature
 +
 
 +
The run / runheadless / rundebug / rundebugheadless / runfresh are interchangable with run in above commands
 +
 
 +
[[Category:Behat]]
 +
 
 +
==Running Behat tests with html report and screenshots on failed steps==
 +
 
 +
To run tests with html output, add the flag 'html' to your test run command, e.g:
 +
 
 +
<syntaxhighlight lang="bash">./test/behat/mahara_behat.sh run create_page.feature html</syntaxhighlight>
 +
 
 +
This will automatically open an html report of the test run in your browser. If there were failed steps, the the html report plugin takes a screenshot of the page that failed.
 +
You can find the screenshots in your behat dataroot (usually /var/lib/maharadata/master_behat) at the following path:
 +
behat/html_results/<feature title>/<scenario title>.png
 +
 
 +
Ubuntu only (you need the image viewer '[https://packages.ubuntu.com/search?keywords=eog eog]'): If you set
 +
 
 +
$cfg->behat_view_screenshots = true;
 +
 
 +
in your config.php file then the images will be opened up in image browser.
 +
 
 +
Hopefully we will rig up the report to link to the screenshot soon.
 +
 
 +
==How to Run Mahara behat test on Chrome for versions older than 17.04==
 +
 
 +
{{note|Mahara behat is running on chrome driver by default in 17:04+}}
 +
 
 +
This is steps for older versions of Mahara
 +
 
 +
1. Download chromedriver here http://www.seleniumhq.org/download/ ( download the latest release)
 +
 
 +
2. Start selenium Server with chrome driver
  
<pre>
+
$ java -jar selenium-server-standalone-2.53.1.jar -Dwebdriver.chrome.driver=path of chromedriver
// Behat config
 
$cfg->dbprefix = ''; // Behat complains without dbprefix being set
 
$cfg->wwwroot = 'http://your.mahara.domain/';  // Add this if you do not have wwwroot set already, Behat complains with out it
 
$cfg->behat_dbprefix = 'behat_'; // must not empty
 
$cfg->behat_dataroot = "/var/lib/maharadata/behat"; // Behat's copy of mahara data
 
$cfg->behat_wwwroot = 'http://localhost:8000'; // Must be this
 
</pre>
 
  
Make your data directory (check this matches what you set in config.php):
+
3. Change the behat.yml file as follows,
sudo mkdir /var/lib/maharadata/behat
 
  
Make directory writeable by mahara (check this is correct):
+
Here is the file path var/lib/maharadata/master_behat/behat.yml
sudo chmod 777 /var/lib/maharadata/behat
 
  
Run Behat tests (change into your Mahara code directory first)
+
when you open the beaht.yml file replace the following code with the lines that contain sessions to goutte=NUll( Niranjan or Lovesh can exactly tell you where to replcae the code if it is confusing) and save it
./test/behat/mahara_behat.sh run
 
  
For the first time of running behat, you need to wait for the Behat environment initialisation. This can take a while.
+
javascript_session: selenium2
 +
        selenium2:
 +
          browser: chrome
 +
            goutte: ~
  
To run all tests
+
4. Run the behat test without rundebug
./test/behat/mahara_behat.sh run
 
  
To run your specific tests:
+
for example ./test/behat/mahara_behat.sh run example.feature
  ./test/behat/mahara_behat.sh run @yourtags
 
  
 +
==Debugging==
  
[[Category:Behat]]
+
Go here for tips: https://wiki.mahara.org/wiki/Testing/Behat_Testing/Error_%26_Solutions

Latest revision as of 14:45, 20 May 2022

Note: These instructions for the Behat setup are only for machines running Linux. They will not work for Windows machines.

1. Set up your developer environment if you haven't already done so.

2. Install Behat's dependencies:

$ sudo apt-get install curl openjdk-8-jre-headless

3. Add the following config settings to the bottom of your Mahara config.php file inside the htdocs/ subdirectory of the Mahara codebase.

Note: If /var/www/maharadata is not where you created your dataroot, you'll need to replace that with the correct path in the following commands
// Behat config
$cfg->behat_dbprefix = 'behat_'; // must not empty
$cfg->behat_dataroot = "/var/lib/maharadata/master_behat"; // The Behat copy of maharadata.
$cfg->behat_wwwroot = 'http://localhost:8000'; // Must be this
$cfg->behat_selenium2 = "http://127.0.0.1:4444/wd/hub"; // Must be this

// If you want failed step screenshots appear directly on screen while the step fails (only Ubuntu)
$cfg->behat_view_screenshots = true;
Note: There should be a behat_dataroot for each Mahara instance that you set up. Here the one for the master branch / this Mahara instance is created.
Note: If the directory for $cfg->behat_dataroot does not exist then it will need to be created.

4. Make your Behat data directory (check this matches what you set in config.php):

$ sudo mkdir /var/lib/maharadata/master_behat

5. Make the directory and any subdirectories writeable by Mahara (check the directory is correct):

$ sudo chmod 777 -R /var/lib/maharadata/master_behat

6. Change the directory and any subdirectories permissions to be owned by apache user (check the directory is correct):

$ sudo chown -R www-data:www-data /var/lib/maharadata/master_behat
  • For Ubuntu, apache runs with user www-data
  • For Centos, apache runs with user apache

7. Run Behat tests (change into your Mahara code directory first) as the apache user:

$ cd
$ cd code/mahara
./test/behat/mahara_behat.sh run

Or if you have sudo access:

$ cd
$ cd code/mahara
sudo -u www-data ./test/behat/mahara_behat.sh run


For the first time of running Behat, you need to wait for the Behat environment initialisation. This can take a while.

To run all tests:

./test/behat/mahara_behat.sh run

To run your specific tests marked with @yourtags:

./test/behat/mahara_behat.sh run @yourtags

To run a particular feature file:

./test/behat/mahara_behat.sh run my_file.feature

The run / runheadless / rundebug / rundebugheadless / runfresh are interchangable with run in above commands

Running Behat tests with html report and screenshots on failed steps

To run tests with html output, add the flag 'html' to your test run command, e.g:

./test/behat/mahara_behat.sh run create_page.feature html

This will automatically open an html report of the test run in your browser. If there were failed steps, the the html report plugin takes a screenshot of the page that failed. You can find the screenshots in your behat dataroot (usually /var/lib/maharadata/master_behat) at the following path: behat/html_results/<feature title>/<scenario title>.png

Ubuntu only (you need the image viewer 'eog'): If you set

$cfg->behat_view_screenshots = true;

in your config.php file then the images will be opened up in image browser.

Hopefully we will rig up the report to link to the screenshot soon.

How to Run Mahara behat test on Chrome for versions older than 17.04

Note: Mahara behat is running on chrome driver by default in 17:04+

This is steps for older versions of Mahara

1. Download chromedriver here http://www.seleniumhq.org/download/ ( download the latest release)

2. Start selenium Server with chrome driver

$ java -jar selenium-server-standalone-2.53.1.jar -Dwebdriver.chrome.driver=path of chromedriver

3. Change the behat.yml file as follows,

Here is the file path var/lib/maharadata/master_behat/behat.yml

when you open the beaht.yml file replace the following code with the lines that contain sessions to goutte=NUll( Niranjan or Lovesh can exactly tell you where to replcae the code if it is confusing) and save it

javascript_session: selenium2

        selenium2:
          browser: chrome
           goutte: ~

4. Run the behat test without rundebug

for example ./test/behat/mahara_behat.sh run example.feature

Debugging

Go here for tips: https://wiki.mahara.org/wiki/Testing/Behat_Testing/Error_%26_Solutions