Merge pull request #2 from SmartBear/task/TM4J-3469-add-robot-framework-example

Robot framework example

Author: otaviomedeirossb

.gitignore

@@ -0,0 +1,3 @@
+app/__pycache__
+report.html
+log.html

README.md

@@ -1 +1,76 @@
-# zephyr-scale-robot-framework-example
+# Example of how to use Robot Framework to generate JUnit result file
+
+Small project to show how to make Robot Framework to generate the JUnit result file that you can [`POST /automations/executions/junit`](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#operation/createJUnitExecutions)
+
+### Configuration
+
+You just have to execute Robot Framework with `-x` parameter followed by the xml result file name to instruct it to generate the JUnit result file. Here is an example:
+
+```
+robot -x junitresult.xml mytest.robot
+```
+
+This will execute `mytest.robot` test file and generate the JUnit result file `junitresult.xml` that you'll [`POST /automations/executions/junit`](https://support.smartbear.com/zephyr-scale-cloud/api-docs/#operation/createJUnitExecutions).
+
+
+### Naming conventions
+
+There are 2 ways to match Robot Framework test cases with Zephyr Scale test cases:
+- **By Zephyr Scale test case key**: in case your Robot framework test case contains the Zephyr Scale test case key
+- **By Zephyr Scale test case name**: if your Robot Framework test case doesn't contain some Zephyr Scale test case key, then it will try to match Zephyr Scale test case by name following the pattern `<robot filename with no extension>.<robot test case name>` 
+
+Here is an example. Consider a file named `calculator.robot`:
+```robotframework
+*** Test Cases ***
+# will match Zephyr Scale test case named Calculator.User can clear the display
+User can clear the display
+    Input number    10
+    Press operator    +
+    Input number    1
+    Press clear 
+    Display should be empty
+
+*** Test Cases ***
+# will match Zephyr Scale test case with key NET-T1743
+NET-T1744 User can calculate with wrong result 
+    Input number    1
+    Press operator    +
+    Input number    1
+    Press enter 
+    Result should be     3
+
+*** Test Cases ***
+# will match Zephyr Scale test case with key NET-T1744
+User can calculate two numbers - NET-T1744
+    [Template]    Calculate two numbers should pass
+    10    +    5    15
+    10    -    5    5
+    10    /    5    2
+    10    *    5    50
+```
+As we can see, the first Robot Framework test cases will match Zephyr Scale test cases by name and the last 2 will match by key.
+
+### Requirements to run this example project
+
+In order to execute this example on your local machine you’ll have to checkout this repository and install python 3. Here is how you can do it on mac:
+
+```
+brew upgrade pyenv
+pyenv install 3.6.0
+pyenv global 3.6.0
+echo 'eval "$(pyenv init -)"' >> ~/.zshrc
+source ~/.zshrc
+```
+
+Now you have to install robot framework and docutils library:
+
+```
+pip install robotframework
+pip install docutils
+```
+
+You can now make Robot Framework to generate the JUnit result file by executing the following command:
+
+```
+robot -x junitresult.xml calculator.robot
+```

app/Calculator.py

@@ -0,0 +1,33 @@
+class Calculator(object):
+
+    def __init__(self):
+        self.clear()
+
+    def clear(self):
+        self._number1 = 0
+        self._number2 = 0
+        self._result = None
+        self._display = 0
+        self._operator = None
+
+    def input_number(self, number):
+        if self._operator is None:
+            self._number1 = number
+        else:
+            self._number2 = number
+
+    def press_operator(self, operator):
+        self._operator = operator
+
+    def calculate(self):
+        self._result = eval(self._number1 + self._operator + self._number2) 
+
+    def display_should_be_empty(self):
+        self._display == 0
+
+    def result_should_be(self, expected_result):
+        if int(expected_result) != self._result:
+            raise AssertionError("Expected result to be '%s' but was '%s'."
+                                 % (expected_result, self._result))
+
+    

calculator.robot

@@ -0,0 +1,56 @@
+
+*** Test Cases ***
+# will match Zephyr Scale test case named Calculator.User can clear the display
+User can clear the display
+    Input number    10
+    Press operator    +
+    Input number    1
+    Press clear 
+    Display should be empty
+
+*** Test Cases ***
+# will match Zephyr Scale test case with key NET-T1743
+NET-T1744 User can calculate with wrong result 
+    Input number    1
+    Press operator    +
+    Input number    1
+    Press enter 
+    Result should be     3
+
+*** Test Cases ***
+# will match Zephyr Scale test case with key NET-T1744
+User can calculate two numbers - NET-T1744
+    [Template]    Calculate two numbers should pass
+    10    +    5    15
+    10    -    5    5
+    10    /    5    2
+    10    *    5    50
+
+
+*** Keywords ***
+Calculate two numbers should pass
+    [Arguments]    ${number1}    ${operator}    ${number2}    ${result}
+    Input number    ${number1}
+    Press operator    ${operator}
+    Input number    ${number2}
+    Press enter
+    Result should be    ${result}
+
+Press enter
+    Calculate
+
+Press clear
+    Clear 
+
+Clear Calculator
+    Clear
+
+
+*** Settings ***
+Library           app/Calculator.py
+
+
+*** Settings ***
+Suite Setup       Clear Calculator
+Test Teardown     Clear Calculator
+

junitresult.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite name="Calculator" tests="3" errors="0" failures="1" skipped="0" time="0.042">
+   <testcase classname="Calculator" name="User can clear the display" time="0.003" />
+   <testcase classname="Calculator" name="NET-T1744 User can calculate with wrong result" time="0.003">
+      <failure message="Expected result to be '3' but was '2'." type="AssertionError" />
+   </testcase>
+   <testcase classname="Calculator" name="User can calculate two numbers - NET-T1744" time="0.009" />
+</testsuite>