MockedEvent Class

Typemock Isolator Developer Guide

MockedEvent is used to validate firing of events.

To use this an event must be mocked first, and then the test can fire that event to test that the correct methods are actually called.

Inheritance Hierarchy

SystemObject
TypeMockMockedEvent

Namespace: TypeMock
Assembly: TypeMock (in TypeMock.dll) Version: 9.3.6.0 (9.3.6.0)

Syntax

Copy

public class MockedEvent : IMockedEvent

Public Class MockedEvent
	Implements IMockedEvent

The MockedEvent type exposes the following members.

Properties

	Name	Description
	Instance	Retrieve the IMockedEvent when more than one instance of the event published is mocked The first instance to register to the event will be in index 0, the next instance in 1 and so on. This is used to simulate firing the event.
	InstanceCount	Return the number of instances registered to this mocked event. See Instance

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Fire	Fire a mocked event
	GetEventHandle	Retrieve the EventHandle
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

When more than one instance of the event published is mocked, use the MockedEvent.Instance[index] property The first instance to register to the event will be in index 0, the next instance in 1 and so on.

Examples

Example of one instance of Button having the Click event mocked. We will fire the event to test that our TestedClass event handler is called

Copy

// Part of tested class
public void Init()
{
   Button button = new Button();
   button.Click += new EventHandler(button_Click);
}

Public Sub Init()
   Dim button As Button = New Button
   AddHandler button.Click, AddressOf button_Click
End Sub

Here is the test

Copy

[Test]
public void Test()
{
    // we will mock the Click event and save the MockedEvent
    Mock buttonMock = MockManager.Mock(typeof(Button));
    MockedEvent buttonHandle = buttonMock.ExpectAddEvent("Click");

    // we expect button_Click to be called once (when the button is clicked)
    Mock testedMock = MockManager.Mock(typeof(TestedClass));
    testedMock.ExpectCall("button_Click");

    // call our code
    TestedClass test = new TestedClass();
    test.Init();

    // emulate click.
    buttonHandle.Fire(this, EventArgs.Empty);

    // verify that all calls where made
    MockManager.Verify();
}
// Natural Mocks
[Test]
public void Test()
{
    MockedEvent buttonHandle;
       // Start mocking 
    using (RecordExpectations recorder = RecorderManager.StartRecording())
    {
       // we will mock the Click event and save the MockedEvent
       Button buttonMock = new Button();
       buttonMock.Click += null;
       buttonHandle = RecorderManager.LastMockedEvent;

       // we expect button_Click to be called once (when the button is clicked)
       TestedClass testMock = new TestedClass();
       testMock.button_Click(null,null); // use Reflective Mocks if this is private 
    }

    // call our code
    TestedClass test = new TestedClass();
    test.Init();

    // emulate click.
    buttonHandle.Fire(this, EventArgs.Empty);

    // verify that all calls where made
    MockManager.Verify();
}

<Test()> _
Public Sub Test()
    ' we will mock the Click event and save the MockedEvent 
    Dim buttonMock As Mock = MockManager.Mock(GetType(Button))
    Dim buttonHandle As MockedEvent = buttonMock.ExpectAddEvent("Click")

    ' we expect button_Click to be called once (when the button is clicked)
    Dim testedMock As Mock = MockManager.Mock(GetType(TestedClass))
    testedMock.ExpectCall("button_Click")

    ' call our code
     Dim test As New TestedClass
     test.Init()

     ' emulate click.
     buttonHandle.Fire(Me, EventArgs.Empty)
     ' Verify that all calls were made 
     MockManager.Verify()
   End Sub

' .NET 2.0 Natural Mocks
<Test()> _
Public Sub Test()
   Dim buttonHandle As MockedEvent
   Dim test As New TestedClass
   Using recorder As New RecordExpectations
      ' mock the Click event and save the MockedEvent 
      Dim buttonMock As Button = New Button()
      AddHandler buttonMock.Click, AddressOf test.button_Click
      buttonHandle = RecorderManager.LastMockedEvent

      ' we expect button_Click to be called once (when the button is clicked)
      testMock.button_Click(Nothing, Nothing) ' use Reflective Mocks if this is private 
    End Using   

     ' call our code
     test.Init()

     ' emulate click.
     buttonHandle.Fire(Me, EventArgs.Empty)
     ' Verify that all calls were made 
     MockManager.Verify()
   End Sub

For VB .NET 1.1 see RecordExpectations

Since Version 3.6

Reference

TypeMock Namespace