Extensibility- Test Workflow Hooks

Learn how to extend the BELLATRIX test workflow using hooks.

Example

[TestClass]
[Android(Constants.AndroidNativeAppPath,
    Constants.AndroidDefaultAndroidVersion,
    Constants.AndroidDefaultDeviceName,
    Constants.AndroidNativeAppAppExamplePackage,
    ".view.Controls1",
    AppBehavior.ReuseIfStarted)]
public class TestWorkflowHooksTests : AndroidTest
{
    private static Button _button;
    private static CheckBox _checkBox;
    
    public override void TestsArrange()
    {
        _button = App.ElementCreateService.CreateByIdContaining<Button>("button");
        _checkBox = App.ElementCreateService.CreateByIdContaining<CheckBox>("check1");
    }

    public override void TestsAct()
    {
        _button.Click();
        _checkBox.Check();
    }

    public override void TestInit()
    {
        // Executes a logic before each test in the test class.
    }

    public override void TestCleanup()
    {
        // Executes a logic after each test in the test class.
    }

    [TestMethod]
    public void ButtonIsAboveOfCheckBox_GreaterThanOrEqual105px()
    {
        _button.AssertAboveOfGreaterThanOrEqual(_checkBox, 105);
    }

    [TestMethod]
    public void ButtonIsNearTopOfCheckBox_GreaterThan100px()
    {
        _button.AssertNearTopOfGreaterThan(_checkBox, 100);
    }
}

Explanations

One of the greatest features of BELLATRIX is test workflow hooks. It gives you the possibility to execute your logic in every part of the test workflow. Also, as you can read in the next chapter write plug-ins that execute code in different places of the workflow every time. This is happening no matter what test framework you use- MSTest or NUnit. As you know, MSTest is not extension friendly.

BELLATRIX Default Test Workflow.

The following methods are called once for test class:

  1. All plug-ins PreTestsArrange logic executes.
  2. Current class TestsArrange method executes. By default it is empty, but you can override it in each class and execute your logic. This is the place where you can set up data for your tests, call internal API services, SQL scripts and so on.
  3. All plug-ins PostTestsArrange logic executes.
  4. All plug-ins PreTestsAct logic executes.
  5. Current class TestsAct method executes. By default it is empty, but you can override it in each class and execute your logic. This is the place where you can execute the primary actions for your test case. This is useful if you want later include only assertions in the tests.
  6. All plug-ins PostTestsAct logic executes.

The following methods are called once for each test in the class:

  1. All plug-ins PreTestInit logic executes.
  2. Current class TestInit method executes. By default it is empty, but you can override it in each class and execute your logic. You can add some logic that is executed for each test instead of copy pasting it for each test. For example- navigating to a specific Android activity.
  3. All plug-ins PostTestInit logic executes.
  4. All plug-ins PreTestCleanup logic executes.
  5. Current class TestCleanup method executes. By default it is empty, but you can override it in each class and execute your logic. You can add some logic that is executed after each test instead of copy pasting it. For example- deleting some entity from DB.
  6. All plug-ins PostTestCleanup logic executes.

Note: TestsArrange and TestsAct are similar to MSTest TestClassInitialize and OneTimeSetup in NUnit. We decided to split them into two methods to make the code more readable and two allow customization of the workflow.

public override void TestsArrange()
{
    _button = App.ElementCreateService.CreateByIdContaining<Button>("button");
	_checkBox = App.ElementCreateService.CreateByIdContaining<CheckBox>("check1");
}

public override void TestsAct()
{
    _button.Click();
	_checkBox.Check();
}

This is one of the ways you can use TestsArrange and TestsAct. You can find create all elements in the TestsArrange and create all necessary data for the tests. Then in the TestsAct execute the actual tests logic but without asserting anything. Then in each separate test execute single assert or ensure method. Following the best testing practices- having a single assertion in a test. If you execute multiple assertions and if one of them fails, the next ones are not executed which may lead to missing some major clue about a bug in your product. Anyhow, BELLATRIX allows you to write your tests the standard way of executing the primary logic in the tests or reuse some of it through the usage of TestInit and TestCleanup methods.

public override void TestInit()
{
    // ...
}

Executes a logic before each test in the test class.

public override void TestCleanup()
{
    // ...
}

Executes a logic after each test in the test class.