Test an Action

• May 05, 2022
• 4 minutes to read

This topic provides step-by step instructions on how to test an XAF application. A custom Controller that provides the Postpone Action is implemented in this example. Then, this Action’s functionality will be tested via the EasyTest functional testing.

Implement a Custom Action

Create a new custom Controller that will perform an Action over Task business objects. The sample Task business class exposes two properties - Description and DueDate.

C#

using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl;
using DevExpress.Xpo;
using System;

namespace MySolution.Module.BusinessObjects {
    [DefaultClassOptions]
    public class Task : BaseObject {
        public Task(Session session) : base(session) { }

        private string description;
        public string Description {
            get => description;
            set => SetPropertyValue(nameof(Description), ref description, value);
        }

        private DateTime dueDate;
        public DateTime DueDate {
            get => dueDate;
            set => SetPropertyValue(nameof(DueDate), ref dueDate, value);
        }
    }
}

VB.NET

Imports DevExpress.Persistent.Base
Imports DevExpress.Persistent.BaseImpl
Imports DevExpress.Xpo

Namespace MySolution.Module.BusinessObjects
    <DefaultClassOptions>
    Public Class Task
        Inherits BaseObject

        Public Sub New(ByVal session As Session)
            MyBase.New(session)
        End Sub

        Private descriptionField As String

        Public Property Description As String
            Get
                Return descriptionField
            End Get
            Set(ByVal value As String)
                SetPropertyValue(NameOf(Task.Description), descriptionField, value)
            End Set
        End Property

        Private dueDateField As Date

        Public Property DueDate As Date
            Get
                Return dueDateField
            End Get
            Set(ByVal value As Date)
                SetPropertyValue(NameOf(Task.DueDate), dueDateField, value)
            End Set
        End Property
    End Class
End Namespace

The custom Controller is targeted for List Views and contains the Postpone Action. This Action processes the selected objects in a Task List View. The Action adds one day to the objects’ DueDate property values.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.Persistent.Base;
using MySolution.Module.BusinessObjects;
using System;

namespace MySolution.Module.Controllers {
    public class PostponeController : ViewController {
        public PostponeController() {
            TargetObjectType = typeof(Task);
            var postpone = new SimpleAction(this, "Postpone", PredefinedCategory.Edit);
            postpone.SelectionDependencyType = SelectionDependencyType.RequireMultipleObjects;
            postpone.Execute += (s, e) => {
                foreach (object selectedObject in View.SelectedObjects) {
                    Task selectedTask = (Task)selectedObject;
                    selectedTask.DueDate = selectedTask.DueDate == DateTime.MinValue ? DateTime.Today : selectedTask.DueDate.AddDays(1);                    
                }
            };
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Actions
Imports DevExpress.Persistent.Base
Imports MySolution.Module.BusinessObjects

Namespace MySolution.Module.Controllers
    Public Class PostponeController
        Inherits ViewController

        Public Sub New()
            TargetObjectType = GetType(Task)
            Dim postpone = New SimpleAction(Me, "Postpone", PredefinedCategory.Edit)
            postpone.SelectionDependencyType = SelectionDependencyType.RequireMultipleObjects
            postpone.Execute += Sub(s, e)
                                    For Each selectedObject As Object In View.SelectedObjects
                                        Dim selectedTask As Task = CType(selectedObject, Task)
                                        selectedTask.DueDate = If(selectedTask.DueDate = Date.MinValue, Date.Today, selectedTask.DueDate.AddDays(1))
                                    Next
                                End Sub
        End Sub
    End Class
End Namespace

Functional Tests

This section describes a way of creating an EasyTest script that ensures that the implemented Postpone Action works as expected. The test will work for Windows Forms, ASP.NET Core Blazor, and ASP.NET Web Forms applications.

1. In Solution Explorer, navigate to the module project. Right-click the FunctionalTests folder and select Add | New Item.

   

   In the Add New Item dialog, select Text File, set its name to “PostponeControllerTest.ets”. Open the newly created file and enter the following code.

   ETS

   #DropDB MySolutionEasyTest
   
   #Application MySolutionWin
   #Application MySolutionWeb
   #Application MySolutionBlazor
   
   *Action Navigation(Task)
   
   *Action New
   
   *FillForm
   Description = Test Task One
   Due Date = 06/06/2011
   
   *Action Save
   
   *Action New
   
   *FillForm
   Description = Test Task Two
   Due Date = 07/07/2011
   
   *Action Save
   
   *Action Navigation(Task)
   
   *SelectRecords
   Columns = Description
   Row = Test Task One
   Row = Test Task Two
   
   *Action Postpone
   
   *CheckTable
   Columns = 'Due Date'
   Row = 6/7/2011
   Row = 7/8/2011
   

   This script creates two Task objects, selects them in the List View and executes the Postpone Action. After that, the script ensures that the test objects’ DueDate property values change as expected. For detailed information on the EasyTest command syntax, refer to the EasyTest Script Reference topic.

   Note

   By default, the FunctionalTests folder contains the Sample.ets script. You can use it as a starting point when creating tests. If you do not need this file, you can delete it. Another file, initially located in the FunctionalTests folder, is Config.xml. This file specifies the EasyTest configuration settings and should not be deleted.

2. Save the test script.

   • For WinForms and ASP.NET Web Forms applications: right-click this file in Solution Explorer and select Run:

     

     The test will first be executed in Windows Forms, and then in the ASP.NET Web Forms application (this is specified by the second and third commands of the test script). You will then see the following output, indicating that all tests passed successfully.

     

   • For ASP.NET Core Blazor applications: Run Tests in Console.