Ruby test reporting
Installation
gem install tesultsConfiguration
require 'tesults'Usage
Upload your test results using the upload method.
res =Tesults.upload(data)
# res[:success] - Boolean, true if results successfully uploaded, false otherwise.
# res[:message] - String, if success if alse check message for reason
# res[:warnings] - Array of Strings, if non empty there may be issues with file uploads.
# res[:errors] - Array of Strings, if success is true this is empty
The data param in upload is a Hash containing your build and test results in the form:
require 'tesults'
data = {
:target => "token",
:results => {
:cases => [
{
:name => "Test 1",
:desc => "Test 1 description",
:suite => "Suite A",
:result => "pass"
},
{
:name => "Test 2",
:desc => "Test 2 description",
:suite => "Suite B",
:result => "pass",
:params => {
:param1 => "value1",
:param2 => "value2"
},
:_CustomField => "Custom field value"
},
{
:name => "Test 3",
:desc => "Test 3 description",
:suite => "Suite A",
:start => ((Time.now.to_f * 1000).to_i) - 60000,
:end => ((Time.now.to_f * 1000).to_i,
:result => "fail",
:reason => "Assert fail in line 203 of example.rb",
:files => ["full/path/to/file/log.txt", "full/path/to/file/screencapture.png"],
:steps => [
{
:name => "Step 1",
:desc => "Step 1 description",
:result => "pass",
},
{
:name => "Step 2",
:desc => "Step 2 description",
:result => "fail",
:reason => "Assert fail in line 203 of example.rb"
}
]
}
]
}
}
res = Tesults.upload(data)
puts 'Success: ' + (res[:success] ? "true" : "false")
puts 'Message: ' + res[:message]
puts 'Warnings: ' + res[:warnings].length.to_s
puts 'Errors: ' + res[:errors].length.to_s
The target value, 'token' above should be replaced with your Tesults target token. If you have lost your token you can regenerate one from the config menu. The cases Array should contain your test cases. You would usually add these by looping through the test case objects you currently have in your build and test scripts.
Each test case added to cases must have a name and a result. The result value must be one of 'pass', 'fail' or 'unknown'. All other fields are optional: desc, suite, files, params, steps, reason and custom fields (prefixed with underscore).
The 'params' value is for use by parameterized test cases and is a Hash containing the parameter names and values.
Test case properties
This is a complete list of test case properties for reporting results. The required fields must have values otherwise upload will fail with an error message about missing fields.
| Property | Required | Description |
|---|---|---|
| name | * | Name of the test. |
| result | * | Result of the test. Must be one of: pass, fail, unknown. Set to 'pass' for a test that passed, 'fail' for a failure. |
| suite | Suite the test belongs to. This is a way to group tests. | |
| desc | Description of the test | |
| reason | Reason for the test failure. Leave this empty or do not include it if the test passed | |
| params | Parameters of the test if it is a parameterized test. | |
| files | Files that belong to the test case, such as logs, screenshots, metrics and performance data. | |
| steps | A list of test steps that constitute the actions of a test case. | |
| start | Start time of the test case in milliseconds from Unix epoch. | |
| end | End time of the test case in milliseconds from Unix epoch. | |
| duration | Duration of the test case running time in milliseconds. There is no need to provide this if start and end are provided, it will be calculated automatically by Tesults." : "Duration of the build time in milliseconds. There is no need to provide this if start and end are provided, it will be calculated automatically by Tesults. | |
| rawResult | Report a result to use with the result interpretation feature. This can give you finer control over how to report result status values beyond the three Tesults core result values of pass, fail and unknown. | |
| _custom | Report any number of custom fields. To report custom fields add a field name starting with an underscore ( _ ) followed by the field name. |
Build properties
To report build information simply add another case added to the cases array with suite set to [build]. This is a complete list of build properties for reporting results. The required fields must have values otherwise upload will fail with an error message about missing fields.
| Property | Required | Description |
|---|---|---|
| name | * | Name of the build, revision, version, or change list. |
| result | * | Result of the build. Must be one of: pass, fail, unknown. Use 'pass' for build success and 'fail' for build failure. |
| suite | * | Must be set to value '[build]', otherwise will be registered as a test case instead. |
| desc | Description of the build or changes. | |
| reason | Reason for the build failure. Leave this empty or do not include it if the build succeeded. | |
| params | Build parameters or inputs if there are any. | |
| files | Build files and artifacts such as logs. | |
| start | Start time of the build in milliseconds from Unix epoch. | |
| end | End time of the build in milliseconds from Unix epoch. | |
| duration | Duration of the build time in milliseconds. There is no need to provide this if start and end are provided, it will be calculated automatically by Tesults. | |
| _custom | Report any number of custom fields. To report custom fields add a field name starting with an underscore ( _ ) followed by the field name. |
Files generated by tests
The example above demonstrates how to upload files for each test case. In practice you would generate the array of file paths for each test case programatically.
To make this process simpler we suggest you write a helper function to extract files for each test case and this can be easily achieved by following a couple of simple conventions when testing.
1. Store all files in a temporary directory as your tests run. After Tesults upload is complete you can delete the temporary directory or overwrite it on the next test run.
2. Within this temporary directory create subdirectories for each test case so that files for each test case are easily mapped to a particular test case.
temporary folder- Test Suite A
- Test 1
- test.log
- screenshot.png
- Test 2
- test.log
- screenshot.png
- Test Suite B
- Test 3
- metrics.csv
- error.log
- Test 4
- test.log
Then all your helper function needs to do is take the test name and/or suite as parameters and return an array of files for that particular test case.
require 'tesults'
def filesForTest (suite, testCase)
temp = '/temp-files-dir';
filePaths = []
searchDir = File.join(temp, suite, testCase, "*")
files = []
begin
files = Dir[searchDir]
rescue
# dir may not exist
end
files.each {
|file|
if file != ".DS_Store" # Exclude os files
filePaths.push(file)
end
}
return filePaths;
end
#testCase[:files] = filesForTest(testCase[:suite], testCase[:name])
Caution: If uploading files the time taken to upload is entirely dependent on your network speed. Typical office upload speeds of 100 - 1000 Mbps should allow upload of even hundreds of files quite quickly, just a few seconds, but if you have slower access it may take hours. We recommend uploading a reasonable number of files for each test case. The upload method blocks at the end of a test run while uploading test results and files. When starting out test without files first to ensure everything is setup correctly.
Consolidating parallel test runs
If you execute multiple test runs in parallel or serially for the same build or release and results are submitted to Tesults within each run, separately, you will find that multiple test runs are generated on Tesults. This is because the default behavior on Tesults is to treat each results submission as a separate test run. This behavior can be changed from the configuration menu. Click 'Results Consolidation By Build' from the Configure Project menu to enable and disable consolidation by target. Enabling consolidation will mean that multiple test runs submitted with the same build name will be consolidated into a single test run.
Dynamically created test cases
If you dynamically create test cases, such as test cases with variable values, we recommend that the test suite and test case names themselves be static. Provide the variable data information in the test case description or other custom fields but try to keep the test suite and test name static. If you change your test suite or test name on every test run you will not benefit from a range of features Tesults has to offer including test case failure assignment and historical results analysis. You need not make your tests any less dynamic, variable values can still be reported within test case details.
Proxy servers
Does your corporate/office network run behind a proxy server? Contact us and we will supply you with a custom API Library for this case. Without this results will fail to upload to Tesults.