Visão Geral

Crie o arquivo "main.cpp" em seu projeto com o seguinte conteúdo:

#include <xutest/xutest.h>

TEST_CASE( primeiroTeste, Testes ) {
    int a = 1;
    int b = 1;
    int c = 2;
    ASSERT_EQUALS( a, b, )
    ASSERT_TRUE( a == b, )
    ASSERT_FALSE( a == c, )
}

int main() {
    RUN_ALL_TEST_CASES();
    return 0;
}

Agora compile o projeto acima com o seguinte comando:

Se estiver no windows faça:

g++ -o main.exe main.cpp -lxutest 

Se estiver no linux faça:

g++ -o main main.cpp -lxutest -ldl -rdynamic

Se estiver no linux, não esqueça das opções -ldl e -rdynamic.

Agora execute o executável criado que tem o nome "main", se estiver no linux e "main.exe", se estiver no windows. Exemplos:

Se estiver no windows faça:

.\main.exe

Se estiver no linux faça:

./main

Agora você deve visualizar a seguinte saída:

Se precisar dividir os testes em vários arquivos. Por exemplo, um arquivo por classe de casos de teste, pode fazer conforme a seguir:

Suponha que agora você tem o arquivo "main.cpp" e o arquivo "tests.h", veja abaixo o conteúdo de "test.h":

#include <xutest/xutest.h>

TEST_CASE( test1, MyTests ) {
    ASSERT_EQUALS( 1, 1, )
}

TEST_CASE( test2, MyTests ) {
    ASSERT_TRUE( true, )
}

TEST_CASE( test3, MyTests ) {
    ASSERT_NULL( nullptr, )
}

Agora vamos para o conteúdo do arquivo "main.cpp":

#include "tests.h"

#include <xutest/xutest.h>

int main() {
    RUN_ALL_TEST_CASES()
    return 0;
}

Perceba que o arquivo "tests.h" está sendo incluído em "main.cpp", mesmo sem ter uma de suas funções, métodos, classes, ou outro recurso diretamente chamados no arquivo "main.cpp". Isso é obrigatório. Isto é, para que as definições de casos de testes sejam encontradas, é necessária a inclusão do arquivo "tests.h".

A macro RUN_TEST_CASES_MENU, pode ser utilizada como alternativa a RUN_ALL_TEST_CASES. A diferença é que RUN_TEST_CASES_MENU mostra um menu para o usuário escolher se deseja mostrar todos os testes ou os testes de uma determinada classe. Já RUN_ALL_TEST_CASES, mostra diretamente todos os testes. Exemplo:

#include <xutest/xutest.h>

TEST_CASE( teste, Testes ) {
    int a = 1;
    int b = 1;
    int c = 2;
    ASSERT_EQUALS( a, b, )
    ASSERT_TRUE( a == b, )
    ASSERT_FALSE( a == c, )
}

int main() {
    RUN_TEST_CASES_MENU();
    return 0;
}

Para integrar com o foxmake, basta criar o foxmakeFile na raiz do projeto e executar os testes com o foxmake e as seguintes tarefas: test, testbuild ou testbuildall

Para tanto, é necessário definir as propriedades "src.dir", "test.dir" e "test.libs" no foxmakeFile.

Se estiver no linux, é necessário também definir a propriedade "test.linker.params"

Caso não tenha instalado o xutest e quiser incluí-lo manualmente no projeto, precisa definir também as propriedades "test.include.dirs", "test.lib.dirs".

Se o xutest já estiver instalado no sistema operacional, não precisa definir as propriedades "test.include.dirs", "test.lib.dirs" e "test.libs".

Atenção: A propriedade "src.dir" deve ser definida e ter valor diferente do diretório raiz do projeto ou parente dele.

Após configurado o foxmakeFile com os caminhos dos includes, lib do xutest e parâmetros para o comando que linka os arquivos de teste, é só criar os testes na pasta da propriedade "test.dir".

Veja abaixo o exemplo de configuração básica do script foxmakeFile:

src.dir=src
test.dir=test
test.libs=xutest

IF os != "windows"
# interpretado somente se estiver no linux
test.linker.params=-ldl -rdynamic
ENDIF

O exemplo acima assume que a pasta de testes é a pasta "test".

Caso não tenha instalado o foxmake e quiser inclur manualmente, faça conforme o seguinte exemplo:

src.dir=src
test.dir=test

test.include.dirs=include
test.lib.dirs=.
test.libs=xutest

IF os != "windows"
# interpretado somente se estiver no linux
test.linker.params=-ldl -rdynamic
ENDIF

O exemplo acima assume que o diretório onde deve procurar o arquivo "libxutest.a" é o diretório corrente. Para outro diretório, é só alterar "test.lib.dirs". Claro, o exemplo acima assume que o nome da static library do xutest tem o nome "libxutest.*", onde o "*" geralmente corresponde a "a" ou "lib". Esse exemplo assume também que a os arquivos de cabeçalho do xutest estão na pasta "include".

Agora, seguindo o exemplo anterior, siga os seguintes passos:

1. crie uma pasta "src" e uma pasta "test".
2. Copie o arquivo "main.cpp" para a pasta "test".
3. Agora execute o seguinte comando:
   

   foxmake testbuildall

   Você deve ver agora a seguinte saída:

   

Para incluír o xutest no projeto sem instalar, baixe o xutest da página downloads, e então, extraia o arquivo baixado e coloque o arquivo "libxutest.a" e a pasta "include" na raiz do seu projeto. Seu projeto helloworld deve ter agora a seguinte estrutura:

helloworld
├── include
│   └── xutest
│       ├── xutest.cpp
│       ├── xutest.h
│       ├── fexec
│       │   ├── fexec.cpp
│       │   └── fexec.h
│       ├── output
│       │   └── output.h
│       ├── sourcecode
│       │   ├── SourceCodeManager.cpp
│       │   └── SourceCodeManager.h
│       └── util
│           ├── io.cpp
│           ├── io.h
│           ├── strutil.cpp
│           └── strutil.h
├── libxutest.a
└── main.cpp  

Agora execute o seguinte comando para compilar e linkar:

Se estiver no linux faça:

g++ -o main main.cpp -lxutest -L. -Iinclude -ldl -rdynamic

Se estiver no windows faça:

g++ -o main.exe main.cpp -lxutest -L. -Iinclude

Foram acrescentadas as opções "-L." e "-Iinclude", onde, "-L." especifica onde procurar pela static library. Nesse caso, a lib de nome: "libxutest.a" que está na raiz do projeto. Por isso o ".". E o "-Iinclude" especifica onde encontrar os arquivos header que, nesse caso, está na pasta "include". A opção "-lxutest" deve corresponder ao nome da lib, sem o prefixo "lib" e sem a extenção ".a". Isto é, "xutest".

Agora você pode rodar o arquivo linkado: O "main.exe" se estiver no windows ou "main", se estiver no linux e, então, visualizar o resultado.

Na macro TEST_CASE, fica a escrita do caso de teste em si. Isto é, as chamadas as macros de ASSERT.

O primeiro argumento passado a TEST_CASE, é o nome do caso de teste e o segundo argumento (opcional) é o nome da classe do caso de teste. Se não quiser informar, o caso de teste é vinculado a classe de nome "default" e, a virgula após o nome do caso de teste é obrigatória, mesmo que, após a virgula, não seja definido o nome da classe do caso de testes. Veja o exemplo abaixo:

TEST_CASE( primeiroTeste, MeusTestes ) {
    ASSERT_EQUALS( 1, 1, )
}

As macros de assert suportam uma mensagem personalizada a ser mostrada no caso do assert falhar e não precisam ser finalizadas com ponto e vírgula.

No caso da macro ser chamada, por exemplo, dentro de um if/else sem blóco de código, é obrigatório não colocar o ponto e virgula no final da macro. Exemplo:

bool condicao = true;
    if ( condicao )
        ASSERT_EQUALS( 1, 1, );
    else ASSERT_EQUALS( 1, 2, )

O exemplo acima está errado porque há um ponto e virgula após a macro de assert, e antes do else do if. O correto é retirar o ponto e virgula como a seguir:

bool condicao = true;
    if ( condicao )
        ASSERT_EQUALS( 1, 1, )
    else ASSERT_EQUALS( 1, 2, )

ASSERT_EQUALS( 1, 1, )

int a = 1;
int b = 1;
string c = "teste";
string d = "teste";

ASSERT_EQUALS( a, b, )
ASSERT_EQUALS( c, d, As strings não são iguais! )

string str1 = "teste";
string str2 = "teste2";

ASSERT_NOT_EQUALS( str1, str2, )

int arr1[] = { 1, 2, 3 };
int arr2[] = { 1, 2, 3 };

ASSERT_EQUALS_ARRAYS( arr1, arr2, 3, )

int arr1[] = { 1, 2, 3 };
int arr2[] = { 3, 2, 1 };

ASSERT_EQUALS_ARRAYS( arr1, arr2, 3, )

vector vect1 = { 1, 2, 3 };
vector vect2 = { 1, 2, 3 };

ASSERT_EQUALS_VECTORS( vect1, vect2, )

vector vect1 = { 1, 2, 3 };
vector vect2 = { 3, 2, 1 };

ASSERT_NOT_EQUALS_VECTORS( vect1, vect2, )

xutest::set_print_vectors( true ); // Para habilitar
xutest::set_imp_vectors( false );  // para desabilitar

xutest::set_print_vectors( true ); // Para habilitar

vector vect1 = { 1, 2, 3 };
vector vect2 = { 3, 2, 1 };

ASSERT_EQUALS_VECTORS( vect1, vect2, )

xutest::set_print_vectors( false ); // Para desabilitar

vector vect1 = { 1, 2, 3 };
vector vect2 = { 3, 2, 1 };

ASSERT_EQUALS_VECTORS( vect1, vect2, ) 

int a = 1;

ASSERT_TRUE( a > 0, )

int a = 1;

ASSERT_FALSE( a == 0, )

string* strptr = nullptr;

ASSERT_NULL( strptr, )

string* strptr = new string( "abc" );

ASSERT_NOT_NULL( strptr, )

ASSERT_THROWS( runtime_error, {
    // Código qualquer
    throw runtime_error( "XXX" );    // lança uma runtime_error
}, );

ASSERT_NOT_THROWS( runtime_error, {
    // Código qualquer
}, );

As macros BEFORE_ALL e AFTER_ALL, podem ser usadas para definir um bloco de código que deve ser executado antes de todos os testes da classe, ou, após todos os testes da classe, respectivemante.

BEFORE_ALL( MeusTestes ) {
    cout << "Iniciando os testes da classe de testes MeusTestes" << endl;
}

TEST_CASE( teste1, MeusTestes ) {
    ASSERT_EQUALS( 1, 1, )
}

TEST_CASE( teste2, MeusTestes ) {
    ASSERT_TRUE( true, )
}

AFTER_ALL( MeusTestes ) {
    cout << "Finalizando os testes da classe de testes MeusTestes" << endl;
}

As macros BEFORE_EACH e AFTER_EACH, podem ser usadas para definir um bloco de código que deve ser executado antes de cada caso de teste da classe, ou, após cada caso de teste da classe, respectivemante.

BEFORE_EACH( MeusTestes ) {
    cout << "Iniciando execução do caso de teste" << endl;
}

AFTER_EACH( MeusTestes ) {
    cout << "Finalizando a execução do caso de teste" << endl;
}