Below is a collection of frequently asked questions about how the technical use. If you have a question that is not listed below, please feel free to let us know at firstname.lastname@example.org.
Frequently Asked Questions
How do you locate the RFML ID for an existing test in Rainforest?
To locate the RFML ID for an existing test Rainforest, the simplest way would be to download the Rainforest test using the Rainforest CLI. The .rfml will contain the original RFML ID for this test, but you can change it a natural language ID - "Login" or "Checkout" for example - to make it easier to locate in the future.
How should we store screenshots / files in our repo?
At Rainforest, we keep the screenshots in our own S3 repository so that the screenshots can be properly versioned within the tests. Similarly, if you may also upload your screenshots and files to a hosting service like Amazon S3 include the links manually in the code. If hosting services are not viable, Git Large Storage File is a workable alternative.
Do you support external link as screenshot (e.g. an image file on AWS or Azure) in the test? If so, what syntax shall we use to embed the external link?
If files are hosted on a service like S3, it is possible to directly insert the link to the image directly in the test .rfml file. After the link is inserted, the step can be written to have the tester navigate to the file and perform some operation (download, save as, copy, etc...) on.
How can you view results programmatically? Do you have to go through the UI?
While the results from all your runs can be found in the Rainforest dashboard, results can also be viewed programmatically through taking advantage of the Rainforest CLI and API as well as the various Rainforest Integrations.
To start, we recommend integrating with your main communication channel (Slack, Hipchat or Email all work great) with Rainforest to receive notifications for important run events such as run completion or test failure. In the latter case, we also recommend setting up a JIRA or Pivotal Tracker integration to automatically create issues in your bug tracking tool. Once an event occurs and a notification is sent, one can leverage the Rainforest API to view the results as well.
Tip from the Rainforest Eng. Team:
rainforest --fail-fast --<token> run all
This does the same as the above, but will fail with an exit code as soon as there is a failure on rainforest (--fail-fast).
Note: Our normal best practice is to NOT run all tests, but to run via a tag or smart folder. This pushes run decisions out of the CI tool user into rainforest and/or the .rfml.
Why am I encountering a “Account not found” error when I'm using the Rainforest CLI even though I've fully set up my Rainforest user account?
This error should be resolved after you've rotated your API token in Rainforest. You can do so by going to your Integrations settings in the Rainforest Dashboard and from there click the "Rotate API Token" button. A pop up will appear with your new API token and from then until your rotate your token again your token will partially hidden next to the button/
How do I programmatically upload files like screenshots and text files to my tests?
We've laid out the process to upload inline screenshots and files to a Rainforest test through the Rainforest API here.
Is there a way to link the test to a specific JIRA ticket and to get the result within that ticket? If not, can we get the results within a Github PR?
The manual export to JIRA integration will allow you to select failures to send to a specific project in JIRA; this will create a new ticket per test in Rainforest. Although our team is working on our Github integration, linking a Rainforest test to an existing JIRA ticket or Github PR is not currently available.
The general, automatic JIRA integration will send all Rainforest failures to the project you identify JIRA but will not post duplicate failures for the same test.