Mapeamento de testes

Esta é uma breve introdução ao mapeamento de testes e uma explicação de como começar a configurar testes no Android Open Source Project (AOSP).

Sobre o mapeamento de testes

O mapeamento de testes é uma abordagem baseada no Gerrit que permite aos desenvolvedores criar regras de teste de pré-envio e pós-envio diretamente na árvore de origem do Android e deixar as decisões de ramificações e dispositivos a serem testados para a infraestrutura de teste. As definições de mapeamento de teste são arquivos JSON chamados TEST_MAPPING que podem ser colocados em qualquer diretório de origem.

O Atest pode usar os arquivos TEST_MAPPING para executar testes de pré-envio nos diretórios associados. Com o mapeamento de testes, é possível adicionar o mesmo conjunto de testes às verificações de pré-envio com uma mudança mínima na árvore de origem do Android.

Confira estes exemplos:

O mapeamento de testes depende do Trade Federation (TF) test harness para execução de testes e geração de relatórios de resultados.

Definir grupos de teste

Teste grupos de mapeamento com um grupo de teste. O nome de um grupo de teste pode ser qualquer string. Por exemplo, presubmit pode ser o nome de um grupo de testes a ser executado ao validar mudanças. Já o postsubmit pode ser os testes usados para validar os builds depois que as mudanças são mescladas.

Regras de script de build de pacote

Para que o Trade Federation test harness execute módulos de teste para um determinado build, esses módulos precisam ter um test_suites definido para Soong ou um LOCAL_COMPATIBILITY_SUITE definido para Make em uma destas duas suítes:

  • O general-tests é para testes que não dependem de recursos específicos do dispositivo, como hardware específico do fornecedor que a maioria dos dispositivos não tem. A maioria dos testes precisa estar no conjunto general-tests, mesmo que sejam específicos para uma ABI, uma arquitetura de bits ou recursos de hardware como o HWASan (há um destino test_suites separado para cada ABI), e mesmo que tenham que ser executados em um dispositivo.
  • device-tests é para testes que dependem de recursos específicos do dispositivo. Normalmente, esses testes são encontrados em vendor/. Específico do dispositivo se refere apenas a recursos exclusivos de um dispositivo. Portanto, isso se aplica a testes do JUnit e do GTest (que geralmente devem ser marcados como general-tests, mesmo que sejam específicos da ABI).

Exemplos:

Android.bp: test_suites: ["general-tests"],
Android.mk: LOCAL_COMPATIBILITY_SUITE := general-tests

Configurar testes para serem executados em um conjunto de testes

Para que um teste seja executado em um pacote de testes, ele precisa:

  • Não pode ter um provedor de build.
  • É necessário limpar depois que ele terminar, por exemplo, excluindo arquivos temporários gerados durante o teste.
  • É necessário mudar as configurações do sistema para o valor padrão ou original.

  • Não suponha que um dispositivo esteja em um determinado estado, por exemplo, pronto para root. A maioria dos testes não exige privilégio de root para ser executada. Se um teste precisar de raiz, ele deve especificar isso com RootTargetPreparer no AndroidTest.xml, como no exemplo a seguir:

    <target_preparer class="com.android.tradefed.targetprep.RootTargetPreparer"/>

Criar arquivos de mapeamento de teste

Para o diretório que exige cobertura de teste, adicione um arquivo JSON TEST_MAPPING semelhante ao exemplo. Essas regras garantem que os testes sejam executados em verificações antes do envio quando qualquer arquivo é tocado nesse diretório ou em qualquer um dos subdiretórios.

Seguir um exemplo

Confira um exemplo de arquivo TEST_MAPPING (em formato JSON, mas com suporte a comentários):

{
  "presubmit": [
    // JUnit test with options and file patterns.
    {
      "name": "CtsWindowManagerDeviceTestCases",
      "options": [
        {
          "include-annotation": "android.platform.test.annotations.RequiresDevice"
        }
      ],
      "file_patterns": ["(/|^)Window[^/]*\\.java", "(/|^)Activity[^/]*\\.java"]
    },
    // Device-side GTest with options.
    {
      "name" : "hello_world_test",
      "options": [
        {
          "native-test-flag": "\"servicename1 servicename2\""
        },
        {
          "native-test-timeout": "6000"
        }
      ]
    }
    // Host-side GTest.
    {
      "name" : "net_test_avrcp",
      "host" : true
    }
  ],
  "postsubmit": [
    {
      "name": "CtsDeqpTestCases",
      "options": [
        {
          // Use regex in include-filter which is supported in AndroidJUnitTest
          "include-filter": "dEQP-EGL.functional.color_clears.*"
        }
      ]
    }
  ],
  "imports": [
    {
      "path": "frameworks/base/services/core/java/com/android/server/am"
    }
  ]
}

Definir atributos

No exemplo, presubmit e postsubmit são os nomes de cada grupo de teste. Consulte Definir grupos de teste para mais informações.

Você pode definir o nome do módulo de teste ou o nome do teste de integração do Trade Federation (caminho do recurso para o arquivo XML de teste, por exemplo, uiautomator/uiautomator-demo) no valor do atributo name. O campo name não pode usar a classe name nem o método de teste name. Para restringir os testes a serem executados, use opções como include-filter. Confira exemplos de uso de include-filter.

A configuração host de um teste indica se ele é executado sem dispositivo no host ou não. O valor padrão é false, o que significa que o teste requer um dispositivo para ser executado. Os tipos de teste aceitos são HostGTest para binários GTest e HostTest para testes JUnit.

O atributo file_patterns permite definir uma lista de strings de expressão regular para corresponder ao caminho relativo de qualquer arquivo de código-fonte (relativo ao diretório que contém o arquivo TEST_MAPPING). No exemplo, o teste CtsWindowManagerDeviceTestCases é executado na pré-submissão apenas quando um arquivo Java começa com Window ou Activity, que existe no mesmo diretório do arquivo TEST_MAPPING ou em qualquer um dos subdiretórios. As barras invertidas (\) precisam ser escapadas porque estão em um arquivo JSON.

O atributo imports permite incluir testes em outros arquivos TEST_MAPPING sem copiar o conteúdo. Os arquivos TEST_MAPPING nos diretórios principais do caminho importado também são incluídos. O mapeamento de testes permite importações aninhadas. Isso significa que dois arquivos TEST_MAPPING podem importar um ao outro, e o mapeamento de testes pode mesclar os testes incluídos.

O atributo options contém outras opções de linha de comando do Tradefed.

Para conferir uma lista completa de opções disponíveis para um determinado teste, execute:

tradefed.sh run commandAndExit [test_module] --help

Consulte Processamento de opções no Tradefed para mais detalhes sobre como as opções funcionam.

Executar testes com o Atest

Para executar as regras de teste de pré-envio localmente:

  1. Acesse o diretório que contém o arquivo TEST_MAPPING.

  2. Execute o comando:

    atest

Todos os testes de pré-envio configurados nos arquivos TEST_MAPPING do diretório atual e dos diretórios principais são executados. O atest localiza e executa dois testes para pré-envio (A e B).

Essa é a maneira mais direta de executar testes de pré-envio em arquivos TEST_MAPPING no diretório de trabalho atual (CWD) e nos diretórios principais. O Atest localiza e usa o arquivo TEST_MAPPING no CWD e em todos os diretórios principais.

Estruturar o código-fonte

Este exemplo mostra como configurar arquivos TEST_MAPPING na árvore de origem:

src
├── project_1
│   └── TEST_MAPPING
├── project_2
│   └── TEST_MAPPING
└── TEST_MAPPING

Conteúdo de src/TEST_MAPPING:

{
  "presubmit": [
    {
      "name": "A"
    }
  ]
}

Conteúdo de src/project_1/TEST_MAPPING:

{
  "presubmit": [
    {
      "name": "B"
    }
  ],
  "postsubmit": [
    {
      "name": "C"
    }
  ],
  "other_group": [
    {
      "name": "X"
    }
  ]}

Conteúdo de src/project_2/TEST_MAPPING:

{
  "presubmit": [
    {
      "name": "D"
    }
  ],
  "import": [
    {
      "path": "src/project_1"
    }
  ]}

Especificar diretórios de destino

É possível especificar um diretório de destino para executar testes em arquivos TEST_MAPPING nesse diretório. O comando a seguir executa dois testes (A e B):

atest --test-mapping src/project_1

Executar regras de teste de pós-envio

Também é possível usar esse comando para executar as regras de teste postsubmit definidas em TEST_MAPPING em src_path (padrão para CWD) e nos diretórios principais:

atest [--test-mapping] [src_path]:postsubmit

Executar apenas testes que não exigem um dispositivo

Você pode usar a opção --host para o Atest executar apenas os testes configurados no host que não exige um dispositivo. Sem essa opção, o Atest executa os dois testes, aqueles que exigem um dispositivo e aqueles executados em um host que não exige dispositivo. Os testes são executados em dois conjuntos separados:

atest [--test-mapping] --host

Identificar grupos de teste

É possível especificar grupos de teste no comando Atest. O comando a seguir executa todos os testes postsubmit relacionados aos arquivos no diretório src/project_1, que contém apenas um teste (C).

Ou use :all para executar todos os testes, independente do grupo. O comando a seguir executa quatro testes (A, B, C, X):

atest --test-mapping src/project_1:all

Incluir subdiretórios

Por padrão, a execução de testes em TEST_MAPPING com o Atest executa apenas testes de pré-envio configurados no arquivo TEST_MAPPING no CWD (ou diretório especificado) e nos diretórios pai. Se você quiser executar testes em todos os arquivos TEST_MAPPING nos subdiretórios, use a opção --include-subdir para forçar o Atest a incluir esses testes também.

atest --include-subdir

Sem a opção --include-subdir, o Atest executa apenas o teste A. Com a opção --include-subdir, o Atest executa dois testes (A e B).

Comentário no nível da linha aceito

Você pode adicionar um comentário de formato // no nível da linha para complementar o arquivo TEST_MAPPING com uma descrição da configuração a seguir. O ATest e a Trade Federation pré-processam TEST_MAPPING para um formato JSON válido sem comentários. Para manter o arquivo JSON limpo, apenas o comentário de formato // no nível da linha é aceito.

Exemplo:

{
  // For presubmit test group.
  "presubmit": [
    {
      // Run test on module A.
      "name": "A"
    }
  ]
}