Teste

Informar um problemaopen_in_new Acessar a origemopen_in_new

Há várias abordagens diferentes para testar o código Starlark no Bazel. Nesta página, reunimos as práticas recomendadas e frameworks atuais por caso de uso.

Como testar regras

O Skylib tem um framework de teste chamado unittest.bzl para verificar o comportamento no tempo de análise das regras, como ações e provedores. Esses testes são chamados de "testes de análise" e são atualmente a melhor opção para testar o funcionamento interno das regras.

Algumas ressalvas:

• As declarações de teste ocorrem no build, não em um processo separado do executor de testes. Os destinos criados pelo teste precisam ser nomeados de modo a não colidirem com os destinos de outros testes ou do build. Um erro que ocorre durante o teste é visto pelo Bazel como uma falha de build, e não como uma falha de teste.

• É necessário usar uma quantidade considerável de código boilerplate para configurar as regras em teste e as que contêm declarações de teste. Esse boilerplate pode parecer assustador no começo. É importante ter em mente que as macros são avaliadas e os destinos gerados durante a fase de carregamento, enquanto as funções de implementação de regras não são executadas até mais tarde, durante a fase de análise.

• Os testes de análise foram criados para serem bem pequenos e leves. Alguns recursos do framework de teste de análise estão restritos à verificação de destinos com um número máximo de dependências transitivas (atualmente 500). Isso se deve às implicações de performance do uso desses recursos com testes maiores.

O princípio básico é definir uma regra de teste que dependa da regra em teste. Isso dá à regra de teste acesso aos provedores da regra em teste.

A função de implementação da regra de teste realiza declarações. Se houver alguma falha, ela não será gerada imediatamente chamando fail(), o que acionaria um erro de build no tempo de análise, mas sim armazenando os erros em um script gerado que falha no tempo de execução do teste.

Veja abaixo um exemplo de brinquedo mínimo, seguido por um exemplo que verifica ações.

exemplo mínimo

//mypkg/myrules.bzl:

MyInfo = provider(fields = {
    "val": "string value",
    "out": "output File",
})

def _myrule_impl(ctx):
    """Rule that just generates a file and returns a provider."""
    out = ctx.actions.declare_file(ctx.label.name + ".out")
    ctx.actions.write(out, "abc")
    return [MyInfo(val="some value", out=out)]

myrule = rule(
    implementation = _myrule_impl,
)

//mypkg/myrules_test.bzl:

load("@bazel_skylib//lib:unittest.bzl", "asserts", "analysistest")
load(":myrules.bzl", "myrule", "MyInfo")

# ==== Check the provider contents ====

def _provider_contents_test_impl(ctx):
    env = analysistest.begin(ctx)

    target_under_test = analysistest.target_under_test(env)
    # If preferred, could pass these values as "expected" and "actual" keyword
    # arguments.
    asserts.equals(env, "some value", target_under_test[MyInfo].val)

    # If you forget to return end(), you will get an error about an analysis
    # test needing to return an instance of AnalysisTestResultInfo.
    return analysistest.end(env)

# Create the testing rule to wrap the test logic. This must be bound to a global
# variable, not called in a macro's body, since macros get evaluated at loading
# time but the rule gets evaluated later, at analysis time. Since this is a test
# rule, its name must end with "_test".
provider_contents_test = analysistest.make(_provider_contents_test_impl)

# Macro to setup the test.
def _test_provider_contents():
    # Rule under test. Be sure to tag 'manual', as this target should not be
    # built using `:all` except as a dependency of the test.
    myrule(name = "provider_contents_subject", tags = ["manual"])
    # Testing rule.
    provider_contents_test(name = "provider_contents_test",
                           target_under_test = ":provider_contents_subject")
    # Note the target_under_test attribute is how the test rule depends on
    # the real rule target.

# Entry point from the BUILD file; macro for running each test case's macro and
# declaring a test suite that wraps them together.
def myrules_test_suite(name):
    # Call all test functions and wrap their targets in a suite.
    _test_provider_contents()
    # ...

    native.test_suite(
        name = name,
        tests = [
            ":provider_contents_test",
            # ...
        ],
    )

//mypkg/BUILD:

load(":myrules.bzl", "myrule")
load(":myrules_test.bzl", "myrules_test_suite")

# Production use of the rule.
myrule(
    name = "mytarget",
)

# Call a macro that defines targets that perform the tests at analysis time,
# and that can be executed with "bazel test" to return the result.
myrules_test_suite(name = "myrules_test")

O teste pode ser executado com bazel test //mypkg:myrules_test.

Além das instruções load() iniciais, há duas partes principais no arquivo:

• Os próprios testes, cada um composto por 1) uma função de implementação do tempo de análise para a regra de teste, 2) uma declaração da regra de teste via analysistest.make() e 3) uma função de tempo de carregamento (macro) para declarar a regra em teste (e as dependências dela) e a regra de teste. Se as declarações não mudarem entre os casos de teste, 1) e 2) poderão ser compartilhados por vários casos de teste.

• A função do pacote de testes, que chama as funções de tempo de carregamento para cada teste e declara um destino test_suite que agrupa todos os testes.

Para manter a consistência, siga a convenção de nomenclatura recomendada: deixe foo representar a parte do nome do teste que descreve o que o teste está verificando (provider_contents no exemplo acima). Por exemplo, um método de teste JUnit seria chamado de testFoo.

Então:

• a macro que gera o teste e o destino em teste precisa ter o nome _test_foo (_test_provider_contents).

• O tipo de regra de teste precisa ser chamado de foo_test (provider_contents_test).

• o rótulo do destino desse tipo de regra precisa ser foo_test (provider_contents_test).

• a função de implementação para a regra de teste precisa ser nomeada _foo_test_impl (_provider_contents_test_impl).

• os rótulos dos destinos das regras em teste e as dependências deles precisam ser prefixados com foo_ (provider_contents_)

Observe que os rótulos de todos os destinos podem entrar em conflito com outros rótulos no mesmo pacote BUILD. Por isso, é útil usar um nome exclusivo para o teste.

Teste de falha

Pode ser útil verificar se uma regra falha com determinadas entradas ou em um determinado estado. Isso pode ser feito usando a estrutura de teste de análise:

A regra de teste criada com analysistest.make precisa especificar expect_failure:

failure_testing_test = analysistest.make(
    _failure_testing_test_impl,
    expect_failure = True,
)

A implementação da regra de teste precisa fazer declarações sobre a natureza da falha que ocorreu (especificamente, a mensagem de falha):

def _failure_testing_test_impl(ctx):
    env = analysistest.begin(ctx)
    asserts.expect_failure(env, "This rule should never work")
    return analysistest.end(env)

Além disso, confira se o destino em teste está marcado especificamente como "manual". Sem isso, a criação de todos os destinos no pacote usando :all vai resultar em um build do destino com falha intencional e uma falha de build. Com "manual", o destino em teste vai ser criado apenas se especificado explicitamente ou como uma dependência de um destino não manual (como sua regra de teste):

def _test_failure():
    myrule(name = "this_should_fail", tags = ["manual"])

    failure_testing_test(name = "failure_testing_test",
                         target_under_test = ":this_should_fail")

# Then call _test_failure() in the macro which generates the test suite and add
# ":failure_testing_test" to the suite's test targets.

Como verificar ações registradas

É recomendável criar testes que façam declarações sobre as ações registradas pela regra, por exemplo, usando ctx.actions.run(). Isso pode ser feito na função de implementação da regra de teste de análise. Por exemplo:

def _inspect_actions_test_impl(ctx):
    env = analysistest.begin(ctx)

    target_under_test = analysistest.target_under_test(env)
    actions = analysistest.target_actions(env)
    asserts.equals(env, 1, len(actions))
    action_output = actions[0].outputs.to_list()[0]
    asserts.equals(
        env, target_under_test.label.name + ".out", action_output.basename)
    return analysistest.end(env)

Observe que analysistest.target_actions(env) retorna uma lista de objetos Action que representam ações registradas pelo destino em teste.

Como verificar o comportamento da regra sob sinalizações diferentes

É possível verificar se sua regra real se comporta de uma determinada maneira, considerando determinadas flags de build. Por exemplo, sua regra poderá se comportar de maneira diferente se um usuário especificar:

bazel build //mypkg:real_target -c opt

versus

bazel build //mypkg:real_target -c dbg

À primeira vista, isso pode ser feito testando o destino em teste usando as flags de build desejadas:

bazel test //mypkg:myrules_test -c opt

No entanto, se torna impossível para o conjunto de testes conter simultaneamente um teste que verifica o comportamento da regra em -c opt e outro teste que verifica o comportamento da regra em -c dbg. Os dois testes não poderão ser executados no mesmo build.

Isso pode ser resolvido especificando as sinalizações de compilação desejadas ao definir a regra de teste:

myrule_c_opt_test = analysistest.make(
    _myrule_c_opt_test_impl,
    config_settings = {
        "//command_line_option:compilation_mode": "opt",
    },
)

Normalmente, um destino em teste é analisado de acordo com os sinalizadores de build atuais. Especificar config_settings substitui os valores das opções da linha de comando especificadas. As opções não especificadas manterão os valores da linha de comando real.

No dicionário config_settings especificado, as sinalizações de linha de comando precisam ser prefixadas com um valor de marcador especial //command_line_option:, conforme mostrado acima.

Como validar artefatos

Estas são as principais maneiras de verificar se os arquivos gerados estão corretos:

• É possível escrever um script de teste no shell, em Python ou em outra linguagem e criar um destino do tipo de regra *_test apropriado.

• É possível usar uma regra especializada para o tipo de teste que você quer realizar.

Como usar um destino de teste

A maneira mais direta de validar um artefato é escrever um script e adicionar um destino *_test ao arquivo BUILD. Os artefatos específicos que você quer verificar precisam ser dependências de dados desse destino. Se sua lógica de validação puder ser reutilizável para vários testes, ela precisa ser um script que use argumentos de linha de comando controlados pelo atributo args do destino do teste. Confira um exemplo que valida que a saída de myrule acima é "abc".

//mypkg/myrule_validator.sh:

if [ "$(cat $1)" = "abc" ]; then
  echo "Passed"
  exit 0
else
  echo "Failed"
  exit 1
fi

//mypkg/BUILD:

...

myrule(
    name = "mytarget",
)

...

# Needed for each target whose artifacts are to be checked.
sh_test(
    name = "validate_mytarget",
    srcs = [":myrule_validator.sh"],
    args = ["$(location :mytarget.out)"],
    data = [":mytarget.out"],
)

Como usar uma regra personalizada

Uma alternativa mais complicada é escrever o script de shell como um modelo instanciado por uma nova regra. Isso envolve mais indireção e lógica do Starlark, mas leva a arquivos BUILD mais limpos. Como benefício colateral, qualquer pré-processamento de argumentos pode ser feito no Starlark em vez do script. Além disso, o script é um pouco mais autodocumentado, já que usa marcadores de posição simbólicos (para substituições) em vez de numéricos (para argumentos).

//mypkg/myrule_validator.sh.template:

if [ "$(cat %TARGET%)" = "abc" ]; then
  echo "Passed"
  exit 0
else
  echo "Failed"
  exit 1
fi

//mypkg/myrule_validation.bzl:

def _myrule_validation_test_impl(ctx):
  """Rule for instantiating myrule_validator.sh.template for a given target."""
  exe = ctx.outputs.executable
  target = ctx.file.target
  ctx.actions.expand_template(output = exe,
                              template = ctx.file._script,
                              is_executable = True,
                              substitutions = {
                                "%TARGET%": target.short_path,
                              })
  # This is needed to make sure the output file of myrule is visible to the
  # resulting instantiated script.
  return [DefaultInfo(runfiles=ctx.runfiles(files=[target]))]

myrule_validation_test = rule(
    implementation = _myrule_validation_test_impl,
    attrs = {"target": attr.label(allow_single_file=True),
             # You need an implicit dependency in order to access the template.
             # A target could potentially override this attribute to modify
             # the test logic.
             "_script": attr.label(allow_single_file=True,
                                   default=Label("//mypkg:myrule_validator"))},
    test = True,
)

//mypkg/BUILD:

...

myrule(
    name = "mytarget",
)

...

# Needed just once, to expose the template. Could have also used export_files(),
# and made the _script attribute set allow_files=True.
filegroup(
    name = "myrule_validator",
    srcs = [":myrule_validator.sh.template"],
)

# Needed for each target whose artifacts are to be checked. Notice that you no
# longer have to specify the output file name in a data attribute, or its
# $(location) expansion in an args attribute, or the label for the script
# (unless you want to override it).
myrule_validation_test(
    name = "validate_mytarget",
    target = ":mytarget",
)

Como alternativa, em vez de usar uma ação de expansão de modelo, você poderia ter incorporado o modelo no arquivo .bzl como uma string e expandido durante a fase de análise usando o método str.format ou a formatação %.

Como testar os utilitários do Starlark

O framework unittest.bzl do Skylib pode ser usado para testar funções utilitárias, ou seja, funções que não são macros nem implementações de regras. Em vez de usar a biblioteca analysistest do unittest.bzl, unittest pode ser usado. Nesses conjuntos de testes, a função de conveniência unittest.suite() pode ser usada para reduzir o código boilerplate.

//mypkg/myhelpers.bzl:

def myhelper():
    return "abc"

//mypkg/myhelpers_test.bzl:

load("@bazel_skylib//lib:unittest.bzl", "asserts", "unittest")
load(":myhelpers.bzl", "myhelper")

def _myhelper_test_impl(ctx):
  env = unittest.begin(ctx)
  asserts.equals(env, "abc", myhelper())
  return unittest.end(env)

myhelper_test = unittest.make(_myhelper_test_impl)

# No need for a test_myhelper() setup function.

def myhelpers_test_suite(name):
  # unittest.suite() takes care of instantiating the testing rules and creating
  # a test_suite.
  unittest.suite(
    name,
    myhelper_test,
    # ...
  )

//mypkg/BUILD:

load(":myhelpers_test.bzl", "myhelpers_test_suite")

myhelpers_test_suite(name = "myhelpers_tests")

Para ver mais exemplos, consulte os testes do Skylib.