Mapeamento de teste

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

O que é mapeamento de teste?

O mapeamento de teste é uma abordagem baseada em Gerrit que permite aos desenvolvedores criar regras de teste pré 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 própria infraestrutura de teste. As definições de mapeamento de teste são arquivos JSON denominados TEST_MAPPING que podem ser colocados em qualquer diretório de origem.

Atest pode usar os arquivos TEST_MAPPING para executar testes de pré-envio nos diretórios associados. Com o Test Mapping, você pode adicionar o mesmo conjunto de testes para pré-enviar verificações com uma simples alteração na árvore de origem do Android.

Veja estes exemplos:

Adicionar testes de pré-envio a TEST_MAPPING para services.core

Adicionar testes de pré-envio a TEST_MAPPING para ferramentas/dexter usando importações

O Mapeamento de Testes depende do Conjunto de Testes da Federação de Comércio (TF) para execução de testes e relatórios de resultados.

Definindo grupos de teste

Test Mapping agrupa testes por meio de um grupo de teste . O nome de um grupo de teste pode ser qualquer string. Por exemplo, pré-envio pode ser para um grupo de testes a serem executados ao validar alterações. E os testes pós-envio podem ser usados ​​para validar as compilações após a fusão das alterações.

Regras de script de compilação de empacotamento

Para que o Trade Federation Test Harness execute os módulos de teste do Test Mapping para uma determinada compilação, esses módulos devem ter test_suite definido para Soong ou LOCAL_COMPATIBILITY_SUITE definido para Make para um destes dois conjuntos:

  • testes gerais - testes que não dependem da funcionalidade específica do dispositivo (como hardware específico do fornecedor que a maioria dos dispositivos não possui). A maioria dos testes deve estar no conjunto de testes gerais, mesmo que sejam específicos para uma ABI ou bitness ou recursos de hardware como HWASan (há um destino test_suites separado para cada ABI) e mesmo que precisem ser executados em um dispositivo.
  • testes de dispositivo - testes que dependem da funcionalidade específica do dispositivo. Normalmente, esses testes serão encontrados em vendor/ . Como "específico do dispositivo" não se refere à funcionalidade ABI ou SoC que outros dispositivos podem ou não ter, mas apenas à funcionalidade exclusiva de um dispositivo, isso se aplica tanto aos testes JUnit quanto aos testes nativos GTest (que geralmente devem ser general-tests , mesmo que sejam específicos da ABI).

Exemplos:

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

Configurando testes para serem executados em um conjunto de testes

Para que um teste seja executado dentro de um conjunto de testes, o teste:

  • não deve ter nenhum provedor de compilação.
  • deve ser limpo depois de concluído, por exemplo, excluindo todos os arquivos temporários gerados durante o teste.
  • altere as configurações do sistema para o valor padrão ou original.
  • não deve assumir um dispositivo em um determinado estado, por exemplo, pronto para root. A maioria dos testes não requer privilégio de root para ser executada. Se um teste precisar de raiz, ele deverá especificar isso com um RootTargetPreparer em seu AndroidTest.xml , como no exemplo a seguir:
<target_preparer class="com.android.tradefed.targetprep.RootTargetPreparer"/>

Criando arquivos de mapeamento de teste

Para o diretório que requer cobertura de teste, basta adicionar um arquivo TEST_MAPPING JSON semelhante ao exemplo abaixo. Essas regras garantirão que os testes sejam executados em verificações de pré-envio quando quaisquer arquivos forem tocados nesse diretório ou em qualquer um de seus subdiretórios.

Seguindo um exemplo

Aqui está um exemplo de arquivo TEST_MAPPING (está no formato JSON, mas com comentários suportados):

{
  "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": "CtsWindowManagerDeviceTestCases"
    }
  ],
  "imports": [
    {
      "path": "frameworks/base/services/core/java/com/android/server/am"
    }
  ]
}

Definir atributos

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

O nome do módulo de teste ou nome do teste de integração da Federação Comercial (caminho do recurso para o arquivo XML de teste, por exemplo, uiautomator/uiautomator-demo ) pode ser definido no valor do atributo name . Observe que o campo de nome não pode usar name da classe ou name do método de teste. Para restringir os testes a serem executados, você pode usar opções como include-filter aqui. Consulte ( uso de exemplo de filtro de inclusão ).

A configuração do host de um teste indica se o teste é um teste sem dispositivo em execução 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 suportados são HostGTest para binários GTest e HostTest para testes JUnit.

O atributo file_patterns permite definir uma lista de strings regex 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 acima, o teste CtsWindowManagerDeviceTestCases será executado em pré-envio somente quando qualquer arquivo java iniciado com Window ou Activity, que existe no mesmo diretório do arquivo TEST_MAPPING ou em qualquer um de seus subdiretórios, for alterado. Barras invertidas \ precisam ter escape, pois estão em um arquivo JSON.

O atributo imports permite incluir testes em outros arquivos TEST_MAPPING sem copiar o conteúdo. Observe que os arquivos TEST_MAPPING nos diretórios pai do caminho importado também serão incluídos. O mapeamento de teste permite importações aninhadas; isso significa que dois arquivos TEST_MAPPING podem importar um ao outro e o Mapeamento de Teste pode mesclar adequadamente os testes incluídos.

O atributo de opções contém opções de linha de comando TradeFed adicionais.

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

tradefed.sh run commandAndExit [test_module] --help

Consulte Tratamento de opções TradeFed para obter mais detalhes sobre como as opções funcionam.

Executando testes com o Atest

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

  1. Vá para 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 seus diretórios pai são executados. Atest localizará e executará dois testes para pré-envio (A e B).

Essa é a maneira mais simples de executar testes de pré-envio em arquivos TEST_MAPPING no diretório de trabalho atual (CWD) e nos diretórios pai. Um teste localizará e usará o arquivo TEST_MAPPING no CWD e todos os seus diretórios pai.

Estruturando o código-fonte

O exemplo a seguir mostra como os arquivos TEST_MAPPING podem ser configurados 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"
    }
  ]}

Especificando diretórios de destino

Você pode especificar um diretório de destino para executar testes em arquivos TEST_MAPPING nesse diretório. O comando a seguir executará dois testes (A, B).

atest --test-mapping src/project_1

Executando regras de teste pós-envio

Você também pode usar este comando para executar as regras de teste postsubmit definidas em TEST_MAPPING em src_path (padrão para CWD) e seus diretórios pai:

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

Executando apenas testes que não requerem nenhum dispositivo

Você pode usar a opção --host para Atest para executar apenas testes configurados no host que não requerem nenhum dispositivo. Sem esta opção, o Atest executará ambos os testes, os que requerem dispositivo e os que são executados no host e não requerem dispositivo. Os testes serão executados em duas suítes separadas.

atest [--test-mapping] --host

Identificando grupos de teste

Você pode especificar grupos de teste no comando Atest. O comando a seguir executará todos os testes pós-submissão relacionados aos arquivos no diretório src/project_1, que contém apenas um teste (C).

Ou você pode usar :all para executar todos os testes independentemente do grupo. O seguinte comando executa quatro testes (A, B, C, X):

atest --test-mapping src/project_1:all

Incluindo subdiretórios

Por padrão, a execução de testes em TEST_MAPPING com Atest executará apenas testes de pré-envio configurados no arquivo TEST_MAPPING no CWD (ou diretório fornecido) e seus diretórios pai. Se você deseja 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 executará apenas o teste A. Com a opção --include-subdir , o Atest executará dois testes (A, B).

Comentário em nível de linha é suportado

Você pode adicionar um // -comentário de formato de nível de linha para detalhar o arquivo TEST_MAPPING com uma descrição da configuração a seguir. ATest e Trade Federation irão pré-processar o TEST_MAPPING para um formato JSON válido sem comentários. Para manter o arquivo JSON limpo e fácil de ler, apenas o comentário de // -formato de nível de linha é suportado.

Exemplo:

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