Teste de unidade de que eventos são gerados em C # (em ordem)


159

Eu tenho algum código que gera PropertyChangedeventos e gostaria de poder testar a unidade de que os eventos estão sendo gerados corretamente.

O código que está gerando os eventos é como

public class MyClass : INotifyPropertyChanged
{
   public event PropertyChangedEventHandler PropertyChanged;  

   protected void NotifyPropertyChanged(String info)
   {
        if (PropertyChanged != null)
        {
            PropertyChanged(this, new PropertyChangedEventArgs(info));
        }
   }  

   public string MyProperty
   {
       set
       {
           if (_myProperty != value)
           {
               _myProperty = value;
               NotifyPropertyChanged("MyProperty");
           }
       }
   }
}

Eu recebo um bom teste verde do código a seguir em meus testes de unidade, que usa delegados:

[TestMethod]
public void Test_ThatMyEventIsRaised()
{
    string actual = null;
    MyClass myClass = new MyClass();

    myClass.PropertyChanged += delegate(object sender, PropertyChangedEventArgs e)
    {
         actual = e.PropertyName;
    };

    myClass.MyProperty = "testing";
    Assert.IsNotNull(actual);
    Assert.AreEqual("MyProperty", actual);
}

No entanto, se eu tentar encadear a configuração de propriedades da seguinte maneira:

public string MyProperty
{
    set
    {
        if (_myProperty != value)
        {
            _myProperty = value;
            NotifyPropertyChanged("MyProperty");
            MyOtherProperty = "SomeValue";
        }
    }
}

public string MyOtherProperty
{
    set
    {
        if (_myOtherProperty != value)
        {
            _myOtherProperty = value;
            NotifyPropertyChanged("MyOtherProperty");
        }
    }
}

Meu teste para o evento falha - o evento que ele captura é o evento para MyOtherProperty.

Tenho certeza de que o evento é acionado, minha interface do usuário reage da mesma forma, mas meu delegado captura apenas o último evento.

Então, eu estou pensando:
1. Meu método de testar eventos está correto?
2. Meu método de gerar eventos encadeados está correto?

Respostas:


189

Tudo o que você fez está correto, desde que você deseje que seu teste pergunte "Qual foi o último evento que foi gerado?"

Seu código está disparando esses dois eventos, nesta ordem

  • Propriedade alterada (... "Minha propriedade" ...)
  • Propriedade alterada (... "MyOtherProperty" ...)

Se isso é "correto" ou não, depende do objetivo desses eventos.

Se você deseja testar o número de eventos que são gerados e a ordem em que eles são gerados, você pode facilmente estender seu teste existente:

[TestMethod]
public void Test_ThatMyEventIsRaised()
{
    List<string> receivedEvents = new List<string>();
    MyClass myClass = new MyClass();

    myClass.PropertyChanged += delegate(object sender, PropertyChangedEventArgs e)
    {
        receivedEvents.Add(e.PropertyName);
    };

    myClass.MyProperty = "testing";
    Assert.AreEqual(2, receivedEvents.Count);
    Assert.AreEqual("MyProperty", receivedEvents[0]);
    Assert.AreEqual("MyOtherProperty", receivedEvents[1]);
}

13
Versão mais curta: myClass.PropertyChanged + = (remetente do objeto, e) => receivedEvents.Add (e.PropertyName);
ShloEmi

22

Se você estiver fazendo TDD, o teste de eventos poderá começar a gerar muitos códigos repetitivos. Eu escrevi um monitor de eventos que permite uma abordagem muito mais limpa da gravação de testes de unidade para essas situações.

var publisher = new PropertyChangedEventPublisher();

Action test = () =>
{
    publisher.X = 1;
    publisher.Y = 2;
};

var expectedSequence = new[] { "X", "Y" };

EventMonitor.Assert(test, publisher, expectedSequence);

Por favor, veja minha resposta ao seguinte para mais detalhes.

Teste de unidade de que um evento é gerado em C #, usando reflexão


3
O segundo link está inoperante.
Lennart

10

Isso é muito antigo e provavelmente nem será lido, mas com alguns novos recursos .net, criei uma classe INPC Tracer que permite:

[Test]
public void Test_Notify_Property_Changed_Fired()
{
    var p = new Project();

    var tracer = new INCPTracer();

    // One event
    tracer.With(p).CheckThat(() => p.Active = true).RaisedEvent(() => p.Active);

    // Two events in exact order
    tracer.With(p).CheckThat(() => p.Path = "test").RaisedEvent(() => p.Path).RaisedEvent(() => p.Active);
}

Veja o gist: https://gist.github.com/Seikilos/6224204


Beautiful - você deve empacotá-lo e publicá-lo em nuget.org
Simon Ejsing

1
Ótimo trabalho! Eu realmente gosto da API fluente. Eu mesmo fiz algo semelhante ( github.com/f-tischler/EventTesting ), mas acho que sua abordagem é ainda mais concisa.
Florian Tischler

6

Abaixo está um código de Andrew ligeiramente alterado que, em vez de apenas registrar a sequência de eventos gerados, conta quantas vezes um evento específico foi chamado. Embora seja baseado no código dele, acho mais útil nos meus testes.

[TestMethod]
public void Test_ThatMyEventIsRaised()
{
    Dictionary<string, int> receivedEvents = new Dictionary<string, int>();
    MyClass myClass = new MyClass();

    myClass.PropertyChanged += delegate(object sender, PropertyChangedEventArgs e)
    {
        if (receivedEvents.ContainsKey(e.PropertyName))
            receivedEvents[e.PropertyName]++;
        else
            receivedEvents.Add(e.PropertyName, 1);
    };

    myClass.MyProperty = "testing";
    Assert.IsTrue(receivedEvents.ContainsKey("MyProperty"));
    Assert.AreEqual(1, receivedEvents["MyProperty"]);
    Assert.IsTrue(receivedEvents.ContainsKey("MyOtherProperty"));
    Assert.AreEqual(1, receivedEvents["MyOtherProperty"]);
}

1

Com base neste artigo, eu criei este auxiliar de asserção simples:

private void AssertPropertyChanged<T>(T instance, Action<T> actionPropertySetter, string expectedPropertyName) where T : INotifyPropertyChanged
    {
        string actual = null;
        instance.PropertyChanged += delegate (object sender, PropertyChangedEventArgs e)
        {
            actual = e.PropertyName;
        };
        actionPropertySetter.Invoke(instance);
        Assert.IsNotNull(actual);
        Assert.AreEqual(propertyName, actual);
    }

Com esse auxiliar de método, o teste se torna realmente simples.

[TestMethod()]
public void Event_UserName_PropertyChangedWillBeFired()
{
    var user = new User();
    AssertPropertyChanged(user, (x) => x.UserName = "Bob", "UserName");
}

1

Não escreva um teste para cada membro - isso é muito trabalho

(talvez essa solução não seja perfeita para todas as situações - mas mostra uma maneira possível. Talvez seja necessário adaptá-la ao seu caso de uso)

É possível usar o reflexo em uma biblioteca para testar se todos os membros estão respondendo corretamente ao evento alterado de sua propriedade:

  • O evento PropertyChanged é gerado no acesso do setter
  • O evento é gerado corretamente (o nome da propriedade é igual ao argumento do evento gerado)

O código a seguir pode ser usado como uma biblioteca e mostra como testar a seguinte classe genérica

using System.ComponentModel;
using System.Linq;

/// <summary>
/// Check if every property respons to INotifyPropertyChanged with the correct property name
/// </summary>
public static class NotificationTester
    {
        public static object GetPropertyValue(object src, string propName)
        {
            return src.GetType().GetProperty(propName).GetValue(src, null);
        }

        public static bool Verify<T>(T inputClass) where T : INotifyPropertyChanged
        {
            var properties = inputClass.GetType().GetProperties().Where(x => x.CanWrite);
            var index = 0;

            var matchedName = 0;
            inputClass.PropertyChanged += (o, e) =>
            {
                if (properties.ElementAt(index).Name == e.PropertyName)
                {
                    matchedName++;
                }

                index++;
            };

            foreach (var item in properties)
            { 
                // use setter of property
                item.SetValue(inputClass, GetPropertyValue(inputClass, item.Name));
            }

            return matchedName == properties.Count();
        }
    }

Os testes de sua classe agora podem ser escritos como. (talvez você queira dividir o teste em "evento está aí" e "evento gerado com o nome correto" - você pode fazer isso sozinho)

[TestMethod]
public void EveryWriteablePropertyImplementsINotifyPropertyChangedCorrect()
{
    var viewModel = new TestMyClassWithINotifyPropertyChangedInterface();
    Assert.AreEqual(true, NotificationTester.Verify(viewModel));
}

Classe

using System.ComponentModel;

public class TestMyClassWithINotifyPropertyChangedInterface : INotifyPropertyChanged
{
        public event PropertyChangedEventHandler PropertyChanged;

        protected void NotifyPropertyChanged(string name)
        {
            if (PropertyChanged != null)
            {
                PropertyChanged(this, new PropertyChangedEventArgs(name));
            }
        }

        private int id;

        public int Id
        {
            get { return id; }
            set { id = value;
                NotifyPropertyChanged("Id");
            }
        }
}

Eu tentei isso, mas se meus criadores de propriedades tiverem uma declaração de guarda como "if (value == _myValue) return", que todos os meus fazem, os itens acima não funcionarão, a menos que esteja faltando alguma coisa. Eu vim recentemente de C ++ para C #.
Cod23 #

0

Eu fiz uma extensão aqui:

public static class NotifyPropertyChangedExtensions
{
    private static bool _isFired = false;
    private static string _propertyName;

    public static void NotifyPropertyChangedVerificationSettingUp(this INotifyPropertyChanged notifyPropertyChanged,
      string propertyName)
    {
        _isFired = false;
        _propertyName = propertyName;
        notifyPropertyChanged.PropertyChanged += OnPropertyChanged;
    }

    private static void OnPropertyChanged(object sender, PropertyChangedEventArgs e)
    {
        if (e.PropertyName == _propertyName)
        {
            _isFired = true;
        }
    }

    public static bool IsNotifyPropertyChangedFired(this INotifyPropertyChanged notifyPropertyChanged)
    {
        _propertyName = null;
        notifyPropertyChanged.PropertyChanged -= OnPropertyChanged;
        return _isFired;
    }
}

Existe o uso:

   [Fact]
    public void FilesRenameViewModel_Rename_Apply_Execute_Verify_NotifyPropertyChanged_If_Succeeded_Through_Extension_Test()
    {
        //  Arrange
        _filesViewModel.FolderPath = ConstFolderFakeName;
        _filesViewModel.OldNameToReplace = "Testing";
        //After the command's execution OnPropertyChanged for _filesViewModel.AllFilesFiltered should be raised
        _filesViewModel.NotifyPropertyChangedVerificationSettingUp(nameof(_filesViewModel.AllFilesFiltered));
        //Act
        _filesViewModel.ApplyRenamingCommand.Execute(null);
        // Assert
        Assert.True(_filesViewModel.IsNotifyPropertyChangedFired());

    }
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.