Testes Integrados

Introdução

Testes de integração compreendem a segunda fase do ciclo de testes de uma aplicação.

Após testar cada unidade o próximo passo é testar um grupo de funcionalidades, como um todo, fazendo a integração de todos os módulos da aplicação.

Para este tipo de teste o TNF traz algumas classes e definições na hora da criação do seu teste integrado.

As estruturas de asserts dos testes descritos abaixo foram criados usando o Xunit e o Shouldly.

Testes na camada de aplicação

Para criar testes dessa camada temos que analisar o que sua aplicação utiliza como infraestrutura.

Testando a camada de aplicação com Entity Framework Core em memória.

Considere para os cenários a seguir a seguinte tabela criada no Entity Framework Core e seu DTO

Country.cs

[AutoMap(typeof(CountryDto))]
[Table("Countries")]
public class Country : Entity
{
	public const int MaxNameLength = 256;
    [Required]
    [MaxLength(MaxNameLength)]
    public string Name { get; set; }
    public Country()
    {
    }
    public Country(int id, string name)
    {
    	Id = id;
        Name = name;
    }
}
 
public class CountryDto
{
	public string Name { get; set; }
}

Para realizar teste em cenários com o uso de Entity Framework Core em memórioa o TNF prove alguns facilitadores.

Vamos começar com a criação do modulo que fará o carregamento da estrutura de testes:

AppTestModule

[DependsOn(
	typeof(AppModule),
    typeof(TnfTestBaseModule))]
public class AppTestModule : TnfModule
{
	public override void PreInitialize()
    {
    	Configuration.Modules
        	.TnfEfCoreInMemory(IocManager.IocContainer)
            .RegisterDbContextInMemory<ArchitectureDbContext>();
	}
    
    public override void Initialize()
	{
    	IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
    }
}

O modulo "AppTestModule" foi criado no projeto de testes sendo responsável por carregar toda a estrutura de sua aplicação para o teste integrado.

Note que o atributo do modulo "DependsOn" tem como referencia outro modulo chamado "AppModule". Este modulo é um modulo da camada de aplicação de nossa aplicação concreta a ser testada. Esse modulo também contém dependências de outras camadas como domínio e infraestrutura onde as entidades estão sendo persistidas com o Entity Framework Core.

O código exemplificado acima, carrega o modulo da camada a ser testada, configurando no método "PreInitialize" o uso do Entity Framework em memoria para o DbContext "ArchitectureDbContext". Essa configuração irá habilitar o uso da estrutura em memoria podendo assim criar um setup em cada teste criado onde será possível incluir a estrutura em memoria no ORM (setup) executando assim o teste em cima da camada de serviço.

Para criação do Setup de cada teste o TNF disponibiliza uma classe abstrata chamada "TnfEfCoreIntegratedTestBase<Module>" que recebe um TnfModule ("AppTestModule" vide exemplo anterior):

AppTestBase.cs

public class AppTestBase : TnfEfCoreIntegratedTestBase<AppTestModule>
{
	protected override void InitializeIntegratedTest()
    {
    	UsingDbContext<ArchitectureDbContext>(
        	context =>
            {
            	context.Countries.Add(new Country(1, "Brasil"));
                context.Countries.Add(new Country(2, "EUA"));
                context.Countries.Add(new Country(3, "Uruguai"));
                context.Countries.Add(new Country(4, "Paraguai"));
                context.Countries.Add(new Country(5, "Venezuela"));
            });
	}
}

A classe TnfEfCoreIntegratedTestBase está contida no pacote Tnf.App.EntityFrameworkCore.TestBase em nosso feed: "https://www.myget.org/F/tnf/api/v3/index.json"

Essa classe força a implementação do método "InitializeIntegratedTest" onde será definido o setup de nosso contexto do Entity Framework Core em memoria. A mesma classe expõe alguns métodos para inclusão de dados na memoria do contexto como o do exemplo acima "UsingDbContext<DbContext>".

Definida a classe que fará o setup de cada teste criado, podemos começar a escrita de nossos testes sobre os serviços de aplicação:

ICountryAppService.cs

public interface ICountryAppService : IAsyncCrudAppService<CountryDto>
{
}

CountryAppService.cs

public class CountryAppService : AsyncCrudAppService<Country, CountryDto>, ICountryAppService
{
	public CountryAppService(IRepository<Country> repository)
    	: base(repository)
	{
    }
}

O serviço de aplicação do exemplo acima utiliza o AsyncCrudAppService do TNF que cria a estrutura de CRUD automaticamente.

Após criar nosso serviço de aplicação, podemos começar o desenvolvimento dos testes:

CountryAppServiceTests.cs

public class CountryAppServiceTests : AppTestBase
{
	private readonly ICountryAppService _countryAppService;
    public CountryAppServiceTests()
    {
    	_countryAppService = LocalIocManager.Resolve<ICountryAppService>();
	}


	[Fact]
    public void Service_Should_Not_Be_Null()
    {
    	_countryAppService.ShouldNotBeNull();
    }
 
	[Fact]
	public async Task Create_Item_With_Sucess()
    {
    	var result = await _countryAppService.Create(new CountryDto()
        {
        	Id = 6,
            Name = "Mexico"
		});
		result.Name.ShouldBe("Mexico");
	}
 
	[Fact]
    public async Task Get_Return_Item_With_Sucess()
    {
 		var result = await _countryAppService.Get(new EntityDto<int>(1));
        result.Id.ShouldBe(1);
        result.Name.ShouldBe("Brasil");
	}
}

Note que no exemplo acima realizamos a herança da nossa classe que realiza o setup dos dados em nosso contexto em memoria. Agora podemos executar nossos testes em nosso serviço de aplicação normalmente em cima da estrutura em memoria do Entity Framework Core.

Cada teste executado no cenário acima será de forma reproduzido de forma isolada.

Testando a camada de aplicação com NSubstitute

Quando estamos trabalhando com repositórios sem o uso de um ORM por exemplo, precisamos fazer o mock da interface do repositório simulando um cenário afim de explorar todo o funcionamento do sistema.

Para isso o TNF possui uma extensão onde é possível realizar a substituição de uma injeção e usar o NSubstitute para criar objeto de mock para substitui-lo no injetor de dependência.

Para o seguinte cenário de testes que iremos construir considere a seguinte entidade e Dto:

President.cs

[AutoMap(typeof(PresidentDto))]
public class President : Entity<string>
{
	public const int MaxNameLength = 256;
    public string Name { get; internal set; }
    public ZipCode ZipCode { get; internal set; }
    public enum Error
    {
    	Unexpected = 0,
        InvalidId = 1,
        PresidentNameMustHaveValue = 2,
        PresidentZipCodeMustHaveValue = 3,
	}
}
 
public class PresidentDto
{
	public PresidentDto()
    {
    }

    public PresidentDto(string id, string name, string zipCode)
    {
    	Id = id;
        Name = name;
        ZipCode = new ZipCode(zipCode);
	}

    public string Id { get; set; }
    public string Name { get; set; }
    public ZipCode ZipCode { get; set; }
}

Para realizar teste em cenários com o uso mocks o TNF prove alguns facilitadores.

Vamos começar com a criação do modulo que fará o carregamento da estrutura de testes:

AppTestModule.cs

[DependsOn(
	typeof(AppModule),
    typeof(TnfTestBaseModule))]
public class AppTestModule : TnfModule
{
	public override void PreInitialize()
	{
		// Mock repositories
        Configuration.ReplaceService<IWhiteHouseRepository>(() =>
        {
        	var instance = Substitute.For<IWhiteHouseRepository>();
            
            var presidentsToInsert = new List<PresidentDto>()
            {
	            new PresidentDto("1", "New President", "55833479")
            };
    
            instance.InsertPresidentsAsync(presidentsToInsert)
				.Returns(Task.FromResult(presidentsToInsert));
 
			IocManager.IocContainer.Register(
            	Component
                	.For<IWhiteHouseRepository>()
                    .Instance(instance)
                    .LifestyleTransient()
			);
		});
	}

    public override void Initialize()
	{
		IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
	}
}

O modulo "AppTestModule" foi criado no projeto de testes sendo responsável por carregar toda a estrutura de sua aplicação para o teste integrado.

Note que o atributo do modulo "DependsOn" tem como referencia outro modulo chamado "AppModule". Este modulo é um modulo da camada de aplicação de nossa aplicação concreta a ser testada. Esse modulo também contém dependências de outras camadas como domínio e infraestrutura onde estão definidos nossos repositórios de dados.

O código exemplificado acima, carrega o modulo da camada a ser testada, configurando no método "PreInitialize" os objetos de mock. No nosso exemplo estamos mocando

Através da função ReplaceService do TNF podemos usar o framework NSubstitute para então criar um objeto de mock para esse repositório e registrá-lo no container de injeção de dependência.

Para criação do Setup de cada teste o TNF disponibiliza uma classe abstrata chamada "TnfIntegratedTestBase<Module>" que recebe um TnfModule ("AppTestModule" vide exemplo anterior):

AppTestBase.cs

public class AppTestBase : TnfIntegratedTestBase<AppTestModule>
{
}

A classe TnfIntegratedTestBase está contida no pacote Tnf.TestBase em nosso feed: "https://www.myget.org/F/tnf/api/v3/index.json"

Definida a classe que fará o setup de cada teste criado, podemos começar a escrita de nossos testes sobre os serviços de aplicação:

IWhiteHouseService.cs

public interface IWhiteHouseAppService : IApplicationService
{
	Task<DtoResponseBase<PresidentDto>> InsertPresidentAsync(PresidentDto dto);
}

WhiteHouseAppService.cs

public class WhiteHouseAppService : ApplicationService, IWhiteHouseAppService
{
	private readonly IWhiteHouseService _whiteHouserService;
 
	public WhiteHouseAppService(IWhiteHouseService whiteHouserService)
    {
    	_whiteHouserService = whiteHouserService;
	}
 
	public async Task<DtoResponseBase<PresidentDto>> InsertPresidentAsync(PresidentDto dto)
	{
    	var response = await _whiteHouserService.InsertPresidentAsync(dto);
        return response;
	}
}

Os serviços de aplicação consomem via injeção de dependência os serviços de domínio executando as validações presentes no builder da entidade:

WhiteHouseService.cs

public interface IWhiteHouseService : IDomainService
{
	Task<DtoResponseBase<PresidentDto>> InsertPresidentAsync(PresidentDto president);
}

WhiteHouseService

public class WhiteHouseService : DomainService<IWhiteHouseRepository>, IWhiteHouseService
{
    public WhiteHouseService(IWhiteHouseRepository repository)
            : base(repository)
    {
	}
	public async Task<DtoResponseBase<PresidentDto>> InsertPresidentAsync(PresidentDto president)
	{
		var response = new DtoResponseBase<PresidentDto>();
		var builder = new PresidentBuilder()
        	.WithId(item.Id)
            .WithName(item.Name)
            .WithZipCode(item.ZipCode);

		var build = builder.Build();
		if (!build.Success)
        	response.AddNotifications(build.Notifications);


		if (response.Success)
        {
        	president = await Repository.InsertPresidentsAsync(president);
            response.Data = president;
		}

		return response;
	}
}

Caso as regras de negocio sejam satisfeitas, o repositório é consumido.

Em nossos casos de teste, fazemos o mock no ultimo nível de infra estrutura, usando o NSubstitute para realizar o mock da interface IWhiteHouseRepository.