Orangebeard.io Ranorex Report Logger

A Report Logger to report Ranorex tests in Orangebeard.

Orangebeard | Build | Install

Build

(Preferred option is NuGet install!)

• Clone this repository
• Open in a .Net IDE
• Reference Ranorex.Core.dll and Ranorex.Libs.Util.dll from your Ranorex Installation(s) - Ranorex 9.x uses net462, Ranorex 10.x uses net48. - Change the target framework(s) to what you need. Currently, the solution targets net462 and net48, so it needs Ranorex 9.x dll's, or separate references for v9 and v10.'
• Reference the Orangebeard.Client DLL
• Build the Ranorex Logger DLL

Install

• Install from NuGet
• If you built it yourself: Add your dll as a reference in your Ranorex Solution
• Reference it in Program.cs using RanorexOrangebeardListener;
• Attach the logger to your Ranorex report. This can be done in Program.cs, or in a code module to be used as the first setup step. The Loggerwill then automatically create the root siuite.
• Environment vars can of course be set up elsewhere, or use orangebeard.json. See below:

    Environment.SetEnvironmentVariable("orangebeard.endpoint", "https://your-instance.orangebeard.app");
    Environment.SetEnvironmentVariable("orangebeard.accessToken", "api-token-for-orangebeard");
    Environment.SetEnvironmentVariable("orangebeard.project", "projectname");
    Environment.SetEnvironmentVariable("orangebeard.testrun", "Test Run name");
    Environment.SetEnvironmentVariable("orangebeard.description", @"test run description"); //OPTIONAL
    Environment.SetEnvironmentVariable("orangebeard.attributes", @"key:value;single tag"); //OPTIONAL
    Environment.SetEnvironmentVariable("orangebeard.ref.url", @"https://my-ci-server.net/PRJ/1234"); //OPTIONAL
    Environment.SetEnvironmentVariable("orangebeard.fileupload.patterns", @".*\.txt;.*\.bat"); //OPTIONAL
    
    Environment.SetEnvironmentVariable("orangebeard.ranorex.systemattributes", "memory; number of displays"); //OPTIONAL
    
    OrangebeardLogger orangebeard = new OrangebeardLogger();
    Report.AttachLogger(orangebeard);

orangebeard.json: (in project work directory, or above in the path)

{
  "endpoint": "https://app.orangebeard.io/{ORGANIZATION}",
  "accessToken": "{LISTENER_TOKEN}",
  "project": "{PROJECT}",
  "testset": "{TESTSET}",
  "description": "A description",
  "attributes": [
    {
      "key": "Tool",
      "value": "Ranorex"
    }
  ],
  "ref.url": "https://docs.orangebeard.io/"
}

If the orangebeard.ranorex.systemattributes environment variable is not present, no Ranorex system information will be sent to Orangebeard. If set, the content should be a semicolon-separated list of attributes to include. Attribute keys are matched case-insensitive.

Valid attributes are:

• Ranorex version
• OS version
• OS default locale
• .NET Runtime version
• Number of logical CPUs
• Number of displays
• Screen dimension
• Memory

Now run your test as you normally do and see the results fly in to Orangebeard!