Actions

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

From Mahara Wiki

< Testing Area‎ | Behat Testing
Line 8: Line 8:
 
   
 
   
  
  '''@javascript @core @core_portfolio_page''' <- (Grouping the tests to run them. Tag them appropriately)
+
  '''@javascript @core @core_portfolio_page'''           # Grouping the tests to run them. Tag them appropriately
   '''Feature:''' Creating a Portfolio page <- (The point of the test)
+
   '''Feature:''' Creating a Portfolio page               # The point of the test
   '''In order to''' have a portfolio page in Mahara <- (What you are wanting to do)
+
   '''In order to''' have a portfolio page in Mahara     # What you are wanting to do)
   '''As an admin''' <- (Who you are logging in as eg student, admin, institution admin)
+
   '''As an admin'''                                     # Who you are logging in as eg student, admin, institution admin)
   '''So I can''' save my work on my Portfolio page <- (How you benefit from it)
+
   '''So I can''' save my work on my Portfolio page       # How you benefit from it)
  
 
The Scenario states what you are doing to test that feature. If you are testing a specific bug add the bug number here from Launchpad.
 
The Scenario states what you are doing to test that feature. If you are testing a specific bug add the bug number here from Launchpad.
  
   '''Scenario''': Creating a Portfolio Page (Bug 1234) <- (Describe what you are about to do to test it works)
+
   '''Scenario''': Creating a Portfolio Page (Bug 1234)   #Describe what you are about to do to test it works
 
   '''Given''' (Setting the scene, these are you pre conditions)
 
   '''Given''' (Setting the scene, these are you pre conditions)
 
   '''#''' Comment (Comments are milestone markers to make it human readable)  
 
   '''#''' Comment (Comments are milestone markers to make it human readable)  
Line 30: Line 30:
  
 
Behat test example:
 
Behat test example:
 
+
<pre>
 
   Feature: Creating a Portfolio page  
 
   Feature: Creating a Portfolio page  
 
   In order to have a Portfolio Page in Mahara
 
   In order to have a Portfolio Page in Mahara
Line 51: Line 51:
 
   # Verifying that the page saved   
 
   # Verifying that the page saved   
 
   Then I should see "This is where you put the page title"
 
   Then I should see "This is where you put the page title"
 
+
</pre>
 
'''Save the test as a .feature file in the right directory. For example, portfolio_page.feature'''
 
'''Save the test as a .feature file in the right directory. For example, portfolio_page.feature'''

Revision as of 11:05, 16 December 2014

How to write a Behat test

Confident coding? Skip to here:[1]

Behat tests are written in Gerkin language, which is English readable. You write the test in a text editor like Vim, Gedit or Eclipse. For beginners, Gedit is reccomended. Open your editor. To write the test start with the feature. The purpose of the Feature is to say what you are testing and what you gain from testing that feature.


@javascript @core @core_portfolio_page            # Grouping the tests to run them. Tag them appropriately
 Feature: Creating a Portfolio page               # The point of the test
 In order to have a portfolio page in Mahara      # What you are wanting to do)
 As an admin                                      # Who you are logging in as eg student, admin, institution admin)
 So I can save my work on my Portfolio page       # How you benefit from it)

The Scenario states what you are doing to test that feature. If you are testing a specific bug add the bug number here from Launchpad.

 Scenario: Creating a Portfolio Page (Bug 1234)   #Describe what you are about to do to test it works
 Given (Setting the scene, these are you pre conditions)
 # Comment (Comments are milestone markers to make it human readable) 
 And  (Use as many And's as you need to set the pre conditions)
 When (This is an action you do like clicking or pressing a button)
 And  (Use as many And's as you need to describe the action you are doing like pushing 10 buttons to get to the place you want)
 # Comment (Adding a comment here to make it readable, describing what I am doing)  
 Then (This is the achieveable outcome. Often it's what you see when the link you clicked worked)
 And  (Use as many And's as you need) 

Write down every link you click and every button you pushed to create the page using the specific Behat syntax from this page [2]. These are your Given, And, When and Then steps.

Behat test example:

  Feature: Creating a Portfolio page 
  In order to have a Portfolio Page in Mahara
  As an admin
  So I can save my work on my Portfolio page

 Scenario: Creating a Portfolio page (Bug 1234)
  Given I am logged in as the user "admin" with password "Password1"
  And I follow "Porfolio"
  # Creating a page 
  And I follow "Pages"
  When I press "Create page"
  # Filling in the information on the page
  And I fill in the following:
  | Page title | This is where you put the title of the page |
  | Page description | This is where you type the description of the page |
  # Saving the page
  And I press "Save"
  And I press "Done"
  # Verifying that the page saved  
  Then I should see "This is where you put the page title"

Save the test as a .feature file in the right directory. For example, portfolio_page.feature