Automation Framework Reference

Progile.ATE.TestFramework Namespace

Classes
Class
Description
​CleanupStepAttribute​
Marks a method as clean-up step. Only one clean-up step can be present per test case. The clean-up step is a normal step, that gets reported as the last step of the test run. The clean-up step is always executed also in case any of the previous steps were aborted
​PreconditionStepAttribute​
Marks a method as precondition step. Only one precondition step can be present per test case. The precondition step is a normal step, that gets reported as the very first step (0) of the test run.
​SetupTestAttribute​
Use this attribute to mark a method with the following signature that should be used as a setup method. The setup method is executed before the first actual test step is executed. This allows you to setup internal data structures etc. You cannot add to the test report from a method flagged with this attribute. If your setup was successful you have to return true
and the test execution will start. In case you were not able to setup your data structures return false
which will abort the test execution. 
bool MethodName(ITester t)
​TearDownTestAttribute​
Use this attribute to mark a method with the following signature that should be used as a tear down method. The tear down method is executed after the last actual test step (including clean-up) was executed. This allows you to dispose internal data structures etc. You cannot add to the test report from a method flagged with this attribute. If your tear down was successful you have to true
and the test execution will finish with a valid result. In case you were not able to dispose your data structures true
which will set the report to execution error. Be aware that you don't have to false
in case something went wrong because the engine will shutdown afterwards anyway. The runtime will make sure all memory is free'ed again. Use this with caution. 
bool MethodName(ITester t)
​TestCaseAttribute​
Marks a .net class as TestResults.io test case
​TestStepAttribute​
Marks a .net method as a TestResults.io test step
​TestStepInteractiveAttribute​
Marks a .net method as a TestResults.io test step that can require manual interaction
Interfaces
All of the interfaces methods and properties can be accessed via ITester interface e.g.
[TestStep(1,
            TestInput = "Click on the Contact Us link in the top of the screen",
            ExpectedResults = "The Contact Us page is displayed")]
        public void Step1(ITester t)
        {
            t.Connections.Add(....);
            t.Testee.FindImage(....)
            t.Testee.Keyboard(....);
            t.Helpers.Image.ImageDifference(....);
            t.Report.PassStep(....);
        }   
Interface
Description
​IConnections​
Provides access to all SUT connections
​IHelpers​
Provides access to additional functionality for domain specific algorithms
​IImageHelper​
Provides access to additional functionality for image preparation and modification tasks
​IKeyboard​
Provides access to the SUT's keyboard
​IMouse​
Provides access to the SUT's mouse
​IReport​
Provides access to reporting tasks
​ITestee​
Provides access to the image and text operations
​ITester​
Provides access to all of the interfaces described within this table
Enumerations
Enumeration
Description
​MouseButton​
Defines supported mouse buttons. Can be combined with OR.
​ScrollDirection​
Defines possible directions for the scroll wheel

Publishing Installers

Enumerations

Last updated 7 months ago

Class	Description
CleanupStepAttribute	Marks a method as clean-up step. Only one clean-up step can be present per test case. The clean-up step is a normal step, that gets reported as the last step of the test run. The clean-up step is always executed also in case any of the previous steps were aborted
PreconditionStepAttribute	Marks a method as precondition step. Only one precondition step can be present per test case. The precondition step is a normal step, that gets reported as the very first step (0) of the test run.
SetupTestAttribute	Use this attribute to mark a method with the following signature that should be used as a setup method. The setup method is executed before the first actual test step is executed. This allows you to setup internal data structures etc. You cannot add to the test report from a method flagged with this attribute. If your setup was successful you have to return `true` and the test execution will start. In case you were not able to setup your data structures return `false` which will abort the test execution. `bool MethodName(ITester t)`
TearDownTestAttribute	Use this attribute to mark a method with the following signature that should be used as a tear down method. The tear down method is executed after the last actual test step (including clean-up) was executed. This allows you to dispose internal data structures etc. You cannot add to the test report from a method flagged with this attribute. If your tear down was successful you have to `true` and the test execution will finish with a valid result. In case you were not able to dispose your data structures `true` which will set the report to execution error. Be aware that you don't have to `false` in case something went wrong because the engine will shutdown afterwards anyway. The runtime will make sure all memory is free'ed again. Use this with caution. `bool MethodName(ITester t)`
TestCaseAttribute	Marks a .net class as TestResults.io test case
TestStepAttribute	Marks a .net method as a TestResults.io test step
TestStepInteractiveAttribute	Marks a .net method as a TestResults.io test step that can require manual interaction

Interface	Description
IConnections	Provides access to all SUT connections
IHelpers	Provides access to additional functionality for domain specific algorithms
IImageHelper	Provides access to additional functionality for image preparation and modification tasks
IKeyboard	Provides access to the SUT's keyboard
IMouse	Provides access to the SUT's mouse
IReport	Provides access to reporting tasks
ITestee	Provides access to the image and text operations
ITester	Provides access to all of the interfaces described within this table

Enumeration	Description
MouseButton	Defines supported mouse buttons. Can be combined with OR.
ScrollDirection	Defines possible directions for the scroll wheel