teardown getting current test info for email

Ask general questions here.
sstowe
Posts: 62
Joined: Thu May 31, 2018 2:26 pm

teardown getting current test info for email

Post by sstowe » Wed Sep 12, 2018 5:41 pm

How do I get things like

- Current running test configuration.
- Execution time
- pass/fail status

I know it is part of the API, but I cannot find it in the docs. Thanks

Stephanie

User avatar
Stub
Posts: 173
Joined: Fri Jul 15, 2016 1:35 pm

Re: teardown getting current test info for email

Post by Stub » Wed Sep 12, 2018 9:41 pm

This is almost certainly not what you're after, but in our automated system I email out a compressed Ranorex test log which contains the execution time and success/failures. The test configuration I'd know from the way I invoke the Ranorex tests executable since I pass that in as a command-line parameter, though we haven't advanced to the point of using that too much (we just have a test run configuration, and developer specific configurations).

I guess you're sending email from within your Ranorex Test Suite however? Not something I've done here I must admit.

sstowe
Posts: 62
Joined: Thu May 31, 2018 2:26 pm

Re: teardown getting current test info for email

Post by sstowe » Thu Sep 13, 2018 1:14 pm

I am sending an email on test fail using AutomationHelpers. I am looking for a reference to the Ranorex API for determining pass/fail and execution time. I know it exists but cannot find it. I love Ranorex. I don't love the documentation I fear.

User avatar
odklizec
Ranorex Guru
Ranorex Guru
Posts: 3930
Joined: Mon Aug 13, 2012 9:54 am
Location: Zilina, Slovakia

Re: teardown getting current test info for email

Post by odklizec » Thu Sep 13, 2018 2:50 pm

Hi

I have to agree that Ranorex API documentation is far from perfect. It's just a raw list of methods and properties, without good search and badly missing examples.

I'm using these methods in my tests...

This returns actually selected run configuration:

Code: Select all

 string getRunConfiguration = TestSuite.Current.SelectedRunConfig.ToString();
With this you can check the status of given test case:

Code: Select all

var tcStatus_1 = TestSuite.Current.GetTestContainer("nameoftestcase").Status;
And this should returr overall test suite status:

Code: Select all

 var tcStatus = Ranorex.Core.Reporting.ActivityStack.Current.Status; 
And I believe this should return the test suite elapsed time:

Code: Select all

Ranorex.Core.Reporting.ActivityStack.Current.ElapsedTime;
Pavel Kudrys
Ranorex explorer at Descartes Systems

Please add these details to your questions:
  • Ranorex Snapshot. Learn how to create one >here<
  • Ranorex xPath of problematic element(s)
  • Ranorex version
  • OS version
  • HW configuration

sstowe
Posts: 62
Joined: Thu May 31, 2018 2:26 pm

Re: teardown getting current test info for email

Post by sstowe » Thu Sep 13, 2018 3:12 pm

Thanks! You can always hire me to write the documentation. :)

User avatar
jarrettmk
Posts: 9
Joined: Wed Sep 19, 2018 6:10 pm

Re: teardown getting current test info for email

Post by jarrettmk » Thu Sep 20, 2018 9:25 pm

This is a status service I wrote as I need to update some external testing systems with each test case's status. Sounds like it may work well for your situation of needing to check if a test case failed so you can send an email. However, I would agree with Stub sending the compressed test log at the end is probably more useful.

(I edited out some non-essential information and removed a few methods that wouldn't apply outside our specific system.)
/// <summary>
/// Description of StatusService.
/// </summary>
[TestModule("########-####-####-####-############", ModuleType.UserCode, 1)]
public class StatusService : ITestModule
{
    /// <summary>
    /// Constructs a new instance.
    /// </summary>
    public StatusService()
    {
        // Do not delete - a parameterless constructor is required!
    }

    /// <summary>
    /// Performs the playback of actions in this module.
    /// </summary>
    /// <remarks>You should not call this method directly, instead pass the module
    /// instance to the <see cref="TestModuleRunner.Run(ITestModule)"/> method
    /// that will in turn invoke this method.</remarks>
    void ITestModule.Run()
    {
        Mouse.DefaultMoveTime = 300;
        Keyboard.DefaultKeyPressTime = 100;
        Delay.SpeedFactor = 1.0;

        switch (TestSuite.CurrentTestContainer.Status)
        {
            case ActivityStatus.Success:
                Report.Log(ReportLevel.Info, "Status Service", "The Test Case Passed. Preparing Update to #######.");
                SetStatusParameter("completed", "All is well.");
                break;
            case ActivityStatus.Ignored:
                Report.Log(ReportLevel.Info, "Status Service", "The Test Case was Ignored. Preparing Update to #######..");
                SetStatusParameter("completed", string.Format("Test Case \"{0}\" was ignored.", TestSuite.CurrentTestContainer.Name));
                break;
            case ActivityStatus.Failed:
            default:
                Report.Log(ReportLevel.Info, "Status Service", "The Test Case Failed. Collecting the Reason and Preparing Update to #######..");
                SetStatusParameter("error", GetFailureReason());
                break;
        }
    }

    private static void SetStatusParameter(string status, string reason)
    {
        var reqestString = string.Concat("{\"status\":\"", string.Format("{0}", status), "\", \"reason\":\"", string.Format("{0}", reason), "\"}");

        TestSuite.CurrentTestContainer.Parameters["FinalStatus"] = reqestString;

        Report.Log(ReportLevel.Info, "Status Service", "####### Status Compiled and Assigned to 'FinalStatus' Parameter.");
    }

    private static string GetFailureReason()
    {
        var rootActivity = ActivityStack.Instance.RootActivity;
        var activityList = GetAllRootActivities(rootActivity).Where(
            activity => !string.IsNullOrEmpty(activity.ErrorMessage) || !string.IsNullOrWhiteSpace(activity.ErrorMessage)).ToList();

        var currentItem = activityList[activityList.Count - 1];
        var reasonText = "''{0}'' started at ''{1}'' and has the Status: ''{2}'' because of the following error: ''{3}''";
        var reason = string.Format(reasonText, TestSuite.CurrentTestContainer.Name, currentItem.BeginTime, TestSuite.CurrentTestContainer.Status.ToString(), currentItem.ErrorMessage);
        Report.Log(ReportLevel.Info, "Status Service - Failure Reason", reason);
        return reason;
    }

    private static IEnumerable<Activity> GetAllRootActivities(IActivity rootActivity)
    {
        var activities = new List<Activity>();

        foreach (var child in rootActivity.Children)
        {
            var activity = child as Activity;
            if (activity != null)
            {
                AddActivitiesRecursive(activities, activity);
            }
        }

        return activities;
    }

    private static void AddActivitiesRecursive(ICollection<Activity> activities, IActivity parent)
    {
        foreach (var child in parent.Children)
        {
            var activity = child as Activity;

            if (activity == null)
            {
                continue;
            }

            activities.Add(activity);
            AddActivitiesRecursive(activities, activity);
        }
    }
}
Jarrett Karyshyn
Quality Assurance & Automation Engineer
USA - EST (UTC−05:00)/EDT (UTC−04:00)
Image