TestResults.io
  • What is TestResults.io
  • System Architecture
  • Regulated Markets
    • Health Care Industry
    • Financial Services Industry
  • What's new?
    • Update Instruction
      • Update of the Designer extension in Visual Studio
      • Update the Execution Engine
      • Update the Base- and Environment Models
    • Migration to new project file
  • Designer
    • Overview
    • First Steps
    • Installation
    • TestResults.io solution
    • The development environment
      • Tool Window Overview
        • Test Environments
          • Steps to configure a SUT VM
          • How to access files on the system under test
        • Remote Viewer
          • Control Mode
          • Capture Mode
          • Screen Editor
          • Capture Single Image
        • Screen Explorer
        • Test Case Designer
        • Image Explorer
        • API Testing
        • TestResults.io options
          • Engines
          • Servers
    • Test Cases
      • Adding Test Cases
      • Test Case structure
      • Simple Test Case (Example)
      • Executing your Test Case
      • Generating Test Containers
      • Publishing Test Cases
      • Execution Variables
    • Software Models
      • Adding SW Models
      • Referencing the Model in the Test Case
      • Generating Test Containers
      • Publishing SW Models
      • Screens and Screen Elements
        • Tables
        • Visual Sense
        • Custom Screen Elements
    • Installers
      • Adding Installers
      • Generating Test Containers
      • Publishing Installers
    • Automation Framework Reference
      • Attributes
      • Enumerations
      • Filters
        • IImageFilter Interface
        • Select
        • Resize
      • GlobalEngineParameters
      • ImageDetectionParameters
      • ImageReference
      • Interfaces
        • ITester Interface
          • ITester Methods
          • ITester Properties
        • ITestee Interface
          • ITestee Methods
        • IConnections Interface
          • IConnections Methods
          • IConnections Properties
        • IDebug Interface
        • IEngineResult
        • IHelpers Interface
        • IImageHelper Interface
          • IImageHelper Methods
        • IKeyboard Interface
          • IKeyboard Methods
        • IMouse Interface
          • IMouse Methods
          • IMouse Properties
        • IReport Interface
          • IReport Methods
        • ISUTConnection Interface
      • OcrEngineParameters
        • Best practise
        • IronOcrEngineParameters
        • LEADOcrEngineParameters
        • OcrEngineRelatedCharacters
        • OcrPreprocessingParameters
      • ResultRectangle
      • SutNotReadyException
      • TestStepAbortedException
    • FAQ
      • Two-factor authentication (2FA) and One Time Passwords (OTP)
      • Receive and verify Emails
      • Using Excel as test data source
      • Verify PDF Content
  • Portal
    • Overview
    • First Steps
    • User's Guide
      • Login
      • Projects
      • Dashboard
      • Test Cases
      • Software & Environments
      • Test Sets
      • Job Queue
      • Management
      • Notifications Summary
    • Automation Engineer's Guide
      • Test Automation Workflow
      • Automating a test case
      • Enabling Software & Environments
    • REST API Reference
      • Authentication
      • Projects
      • Test Sets
      • Test Cases
      • Test Plans
      • Test Reports
      • Files
      • Software
      • Environments
      • Untitled
      • Executions
      • Favorites
      • Statistics
      • User Management
      • Customer Management
      • Notifications
      • Configurations
      • Invoicing
  • Models
    • Overview
    • Base Model
      • BaseScreen
        • BaseScreen Properties
        • BaseScreen Methods
      • OnScreenElement
        • OnScreenElement Methods
        • OnScreenElement Properties
      • Primitives
        • Button
          • Button Methods
          • Button Properties
        • Checkbox
          • Checkbox Methods
        • ContextMenu
          • ContextMenu Methods
          • ContextMenu Properties
        • Dropdown
          • Dropdown Methods
          • Dropdown Properties
        • DropdownMenu
          • DropdownMenu Methods
          • DropdownMenu Properties
        • GenericScroller
          • GenericScroller Methods
          • GenericScroller Properties
        • HorizontalScroller
        • IconButton
          • IconButton Properties
        • Label
        • LabelWithButton
          • LabelWithButton Properties
        • LabelWithCheckbox
          • LabelWithCheckbox Properties
        • LabelWithValue
          • LabelWithValue Methods
          • LabelWithValue Properties
        • PwTextBox
          • PwTextBox Methods
        • TextBox
          • TextBox Methods
          • TextBox Properties
        • Tables and lists
          • Column
            • Column Methods
            • Column Properties
          • ItemList
            • ItemList Methods
            • ItemList Properties
          • Row
            • Row Methods
            • Row Properties
          • TableBase
            • TableBase Methods
            • TableBase Properties
        • LabelWithElementBase
          • LabelWithElementBase Properties
      • Enumerations
      • Extensions
        • EngineResultExtensions Methods
        • EnumExtensions Methods
        • ReportExtensions Methods
        • StringExtensions Methods
        • TesterConnectionExtensions Methods
        • TesterDebugExtensions Methods
        • TesterHelperExtensions Methods
        • TesterMouseExtensions Methods
        • TesterOnScreenElementExtensions
        • TesterSelectExtensions Methods
      • Helper Classes
        • BaseModelHelpers
          • BaseModelHelpers Methods
          • BaseModelHelpers Properties
        • Attributes for Designer
        • ListHelpers
      • Exceptions
        • ElementNotFoundException
        • InteractionFailedException
        • ScreenNotFoundException
      • Interfaces
        • IAppBasics Interface
          • IAppBasics Methods
          • IAppBasics Properties
        • IBrowser
        • ICommandLineWindow
        • IScroller Interface
          • IScroller Methods
          • IScroller Properties
        • ISutLocale Interface
          • ISutLocale Methods
          • ISutLocale Properties
        • ISystemHelpers
        • ISystemInteractions
        • IWindow
    • Environment Model
      • Windows
        • Screens
          • CmdWindow
            • CmdWindow Methods
            • CmdWindow Properties
          • FileDialog
            • FileDialog Methods
            • FileDialog Properties
          • FileExplorer
            • FileExplorer Properties
          • RunWindow
            • RunWindow Methods
            • RunWindow Properties
          • Window
            • Window Methods
            • Window Properties
        • SutLocale
          • SutLocale Methods
          • SutLocale Properties
        • SystemHelpers
          • SystemHelpers Methods
          • SystemHelpers Properties
        • SystemInteractions
        • WebBrowser
          • Browser
            • Browser Methods
            • Browser Properties
          • BrowserScroller
            • BrowserScroller Methods
            • BrowserScroller Properties
          • AuthenticationDialog
            • AuthenticationDialog Methods
            • AuthenticationDialog Properties
          • DownloadDialog
            • DownloadDialog Methods
            • DownloadDialog Properties
        • EnvironmentModel Enumerations
        • Interfaces
          • IWebAppBasics
            • IWebAppBasics Property
Powered by GitBook
On this page
  • CleanupStepAttribute
  • PreconditionStepAttribute
  • SetupTestAttribute
  • TearDownTestAttribute
  • TestCaseAttribute
  • TestStepAttribute
  • TestStepInteractiveAttribute

Was this helpful?

  1. Designer
  2. Automation Framework Reference

Attributes

These are attributes to mark classes and methods as Test Cases and Test Case Steps that can be executed by the Test Framework.

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

Namespace: Progile.ATE.TestFramework Syntax:

[CleanupStep(
    Properties:
    [TestInput = string],
    [FlowDescription = string],
    [ExpectedResults = string],
    [ScreenShotsOnException = bool]
)]
public void MethodName(ITester t)

Parameters:

Parameter

Description

[TestInput]

Type: string

The test input which describes the stimuli that shall be done on the SUT. Will be displayed in the Test Input column in the test report in the portal.

[FlowDescription]

Type: string

Not used at the moment.

[ExpectedResults]

Type: string

The expected behaviour on the SUT based on the test input. Will be displayed in the Expected Results column in the test report in the portal.

If an expected result is provided, the test step is required to set a result (e.g. by calling t.Report.PassStep or .FailStep) otherwise an error will be raised. If no expected result is provided, the test step is passed by default (e.g. for preparatory steps).

[ScreenShotsOnException]

Type: boolean

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.

Namespace: Progile.ATE.TestFramework Syntax:

[PreconditionStep(
    Properties:
    [TestInput = string],
    [FlowDescription = string],
    [ExpectedResults = string],
    [ScreenShotsOnException = bool]
)]
public void MethodName(ITester t)

Parameters:

Parameter

Description

[TestInput]

Type: string

The test input which describes the stimuli that shall be done on the SUT. Will be displayed in the Test Input column in the test report in the portal.

[FlowDescription]

Type: string

Not used at the moment.

[ExpectedResults]

Type: string

The expected behaviour on the SUT based on the test input. Will be displayed in the Expected Results column in the test report in the portal.

If an expected result is provided, the test step is required to set a result (e.g. by calling t.Report.PassStep or .FailStep) otherwise an error will be raised. If no expected result is provided, the test step is passed by default (e.g. for preparatory steps).

[ScreenShotsOnException]

Type: boolean

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.

Namespace: Progile.ATE.TestFramework Syntax:

[SetupTest()]
public 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 return trueand the test execution will finish with a valid result. In case you were not able to dispose your data structures return false which will set the report to execution error. Be aware that you don't have to return 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.

Namespace: Progile.ATE.TestFramework Syntax:

[TearDownTest()]
public bool MethodName(ITester t)

TestCaseAttribute

Marks a .net class as TestResults.io test case

Namespace: Progile.ATE.TestFramework Syntax:

[TearDownTest(
    int PlanRevision,
    Properties:
    [FailOnEngineError = bool],
    [Model = string]
)]
class TestCaseName

Parameters:

Parameter

Description

PlanRevision

Type: int

Sets the plan revision of the test plan from the portal corresponding to the automated test case. This is typically set automatically by the designer when creating the test case project.

[FailOnEngineError]

Type: bool

Determines whether the test case should be aborted if an error happens in the execution engine, e.g. a image that shall be searched could not be found. This should always be true. Default: true.

[Model]

Type: string

Not used at the moment.

TestStepAttribute

Marks a .net method as a TestResults.io test step.

Namespace: Progile.ATE.TestFramework Syntax:

[TestStep(
    int sequence,
    Properties:
    [TestInput = string],
    [FlowDescription = string],
    [ExpectedResults = string],
    [ScreenShotsOnException = bool]
)]
public void MethodName(ITester t)

Parameters:

Parameter

Description

sequence

Type: int

The step number (required) starting from 1. This will be updated by the designer based on the order of the other test steps in the Test Case.

[TestInput]

Type: string

The test input which describes the stimuli that shall be done on the SUT. Will be displayed in the Test Input column in the test report in the portal.

[FlowDescription]

Type: string

Not used at the moment.

[ExpectedResults]

Type: string

The expected behaviour on the SUT based on the test input. Will be displayed in the Expected Results column in the test report in the portal.

If an expected result is provided, the test step is required to set a result (e.g. by calling t.Report.PassStep or .FailStep) otherwise an error will be raised. If no expected result is provided, the test step is passed by default (e.g. for preparatory steps).

[ScreenShotsOnException]

Type: boolean

TestStepInteractiveAttribute

Marks a .net method as a TestResults.io test step that can require manual interaction

Namespace: Progile.ATE.TestFramework Syntax:

[TestStep(
    int sequence,
    double timeOutInMinutes,
    Properties:
    [TestInput = string],
    [FlowDescription = string],
    [ExpectedResults = string],
    [ScreenShotsOnException = bool]
)]
public void MethodName(ITester t)

Parameters:

Parameter

Description

sequence

Type: int

The step number (required) starting from 1. This will be updated by the designer based on the order of the other test steps in the Test Case.

timeOutInMinutes

Type: double

How long the test case execution shall wait for the manual interaction. After this timeout the test case is aborted.

[TestInput]

Type: string

The test input which describes the stimuli that shall be done on the SUT. Will be displayed in the Test Input column in the test report in the portal.

[FlowDescription]

Type: string

Not used at the moment.

[ExpectedResults]

Type: string

The expected behaviour on the SUT based on the test input. Will be displayed in the Expected Results column in the test report in the portal.

If an expected result is provided, the test step is required to set a result (e.g. by calling t.Report.PassStep or .FailStep) otherwise an error will be raised. If no expected result is provided, the test step is passed by default (e.g. for preparatory steps).

[ScreenShotsOnException]

Type: boolean

PreviousAutomation Framework ReferenceNextEnumerations

Last updated 5 years ago

Was this helpful?

Whether or not a screenshot shall be taken when the test step is Aborted by an exception (e.g. ). Default true.

Whether or not a screenshot shall be taken when the test step is Aborted by an exception (e.g. ). Default true.

Whether or not a screenshot shall be taken when the test step is Aborted by an exception (e.g. ). Default true.

Whether or not a screenshot shall be taken when the test step is Aborted by an exception (e.g. ). Default true.

ElementNotFoundException
ElementNotFoundException
ElementNotFoundException
ElementNotFoundException