Um A de destino depende de um B de destino se o B for necessário para o A no momento da criação ou
da execução. A relação depende de induz um gráfico acíclico dirigido (DAG, na sigla em inglês) sobre as metas. Isso é chamado de gráfico de dependência.
As dependências diretas de um destino são os outros destinos acessíveis por um caminho de tamanho 1 no gráfico de dependências. As dependências transitivas de um destino são aqueles de que ele depende por um caminho de qualquer tamanho no gráfico.
Na verdade, no contexto dos builds, há dois gráficos de dependência: o gráfico de dependências reais e o de dependências declaradas. Na maioria das vezes, os dois gráficos são tão semelhantes que não é necessário fazer essa distinção, mas é útil para a discussão abaixo.
Dependências reais e declaradas
Um X de destino é realmente dependente do Y de destino se o Y precisar estar presente,
criado e atualizado para que X seja criado corretamente. Criado pode significar geradas, processadas, compiladas, vinculadas, arquivadas, compactadas, executadas ou qualquer um dos outros tipos de tarefas que ocorrem rotineiramente durante um build.
Um X de destino tem uma dependência declarada no destino Y se houver uma borda
de dependência de X para Y no pacote de X.
Para os builds corretos, o gráfico das dependências A reais precisa ser um subgráfico do
gráfico das dependências declaradas D. Ou seja, cada par de
nós diretamente conectados x --> y em A também precisa estar diretamente conectado em
D. Pode-se dizer que D é uma aproximação excessiva de A.
Os gravadores de arquivos BUILD precisam declarar explicitamente todas as dependências diretas
reais de cada regra ao sistema de build, e nada mais.
A não observação desse princípio causa um comportamento indefinido: o build pode falhar, mas, pior, pode depender de algumas operações anteriores ou de dependências declaradas transitivas que o destino tem. Ele verifica se há dependências ausentes e relata erros, mas não é possível que essa verificação seja concluída em todos os casos.
Você não precisa (e não deve) tentar listar tudo que foi importado indiretamente,
mesmo que seja necessário para A no momento da execução.
Durante um build de X de destino, a ferramenta de build inspeciona todo o fechamento transitivo
de dependências de X para garantir que qualquer mudança nesses destinos seja
refletida no resultado final, recriando intermediários conforme necessário.
A natureza transitiva das dependências leva a um erro comum. Às vezes,
o código em um arquivo pode usar código fornecido por uma dependência indireta, uma
borda transitiva, mas não direta, no gráfico de dependência declarada. As dependências
indiretas não aparecem no arquivo BUILD. Como a regra não
depende diretamente do provedor, não é possível rastrear as mudanças, conforme mostrado
neste exemplo de linha do tempo:
1. Dependências declaradas correspondem às dependências reais
No início, tudo funciona. O código no pacote a usa o código no pacote b.
O código no pacote b usa o código no pacote c e, portanto, a depende transitivamente
de c.
a/BUILD |
b/BUILD |
|---|---|
rule(
name = "a",
srcs = "a.in",
deps = "//b:b",
)
|
rule(
name = "b",
srcs = "b.in",
deps = "//c:c",
)
|
a / a.in |
b / b.in |
import b;
b.foo();
|
import c;
function foo() {
c.bar();
}
|
|
|
As dependências declaradas se aproximam das dependências reais. Tudo bem.
2. Como adicionar uma dependência não declarada
Um risco latente é introduzido quando alguém adiciona um código a a que cria uma
dependência real direta em c, mas esquece de declará-la no arquivo de build
a/BUILD.
a / a.in |
|
|---|---|
import b;
import c;
b.foo();
c.garply();
|
|
|
|
|
As dependências declaradas não superaproximam mais as dependências reais.
Isso pode ser criado corretamente, porque os fechamentos transitivos dos dois gráficos são iguais,
mas mascara um problema: a tem uma dependência real, mas não declarada, em c.
3. Divergência entre gráficos de dependência declarados e reais
O perigo é revelado quando alguém refatora o b para que ele não dependa mais de
c, interrompendo acidentalmente o a sem
recuperação própria.
b/BUILD |
|
|---|---|
rule(
name = "b",
srcs = "b.in",
deps = "//d:d",
)
|
|
b / b.in |
|
import d;
function foo() {
d.baz();
}
|
|
|
|
O gráfico de dependência declarada agora é uma subaproximação das dependências reais, mesmo quando fechado de forma transitiva. O build provavelmente falhará.
O problema poderia ter sido evitado garantindo que a dependência real de
a para c introduzida na etapa 2 fosse declarada corretamente no arquivo BUILD.
Tipos de dependências
A maioria das regras de build tem três atributos para especificar diferentes tipos de
dependências genéricas: srcs, deps e data. Eles são explicados abaixo. Para
mais detalhes, consulte
Atributos comuns a todas as regras.
Muitas regras também têm outros atributos para tipos de
dependências específicos da regra, por exemplo, compiler ou resources. Eles estão detalhados na
Enciclopédia de build.
srcs dependências
Arquivos consumidos diretamente pelas regras que geram arquivos de origem.
deps dependências
Regra que aponta para módulos compilados separadamente que fornecem arquivos principais, símbolos, bibliotecas, dados etc.
data dependências
Um destino de build pode precisar de alguns arquivos de dados para ser executado corretamente. Esses arquivos de dados não são código-fonte, mas não afetam como o destino é criado. Por exemplo, um teste de unidade pode comparar a saída de uma função com o conteúdo de um arquivo. Quando você cria o teste de unidade, não precisa do arquivo, mas precisa dele ao executar o teste. O mesmo se aplica a ferramentas iniciadas durante a execução.
O sistema de build executa testes em um diretório isolado em que apenas os arquivos listados como
data estão disponíveis. Portanto, se um binário/biblioteca/teste precisar de alguns arquivos para serem executados,
especifique-os (ou uma regra de build que os contenha) em data. Exemplo:
# I need a config file from a directory named env:
java_binary(
name = "setenv",
...
data = [":env/default_env.txt"],
)
# I need test data from another directory
sh_test(
name = "regtest",
srcs = ["regtest.sh"],
data = [
"//data:file1.txt",
"//data:file2.txt",
...
],
)
Esses arquivos estão disponíveis usando o caminho relativo path/to/data/file. Nos testes,
é possível consultar esses arquivos mesclando os caminhos do diretório de origem
do teste e o caminho relativo ao espaço de trabalho, por exemplo,
${TEST_SRCDIR}/workspace/path/to/data/file.
Como usar rótulos para fazer referência a diretórios
Ao analisar nossos arquivos BUILD, você verá que alguns rótulos data se referem a diretórios. Esses rótulos terminam com /. ou /, como nos exemplos a seguir, que não devem ser usados:
Não recomendado —
data = ["//data/regression:unittest/."]
Não recomendado —
data = ["testdata/."]
Não recomendado —
data = ["testdata/"]
Isso parece conveniente, especialmente para testes, porque permite que um teste use todos os arquivos de dados no diretório.
Mas tente não fazer isso. Para garantir recriações incrementais corretas (e
reexecução de testes) após uma mudança, o sistema de build precisa estar ciente do
conjunto completo de arquivos que são entradas para o build (ou teste). Quando você especifica
um diretório, o sistema de build executa uma recriação somente quando o próprio diretório
é alterado (devido à adição ou exclusão de arquivos), mas não consegue detectar
edições em arquivos individuais, já que essas alterações não afetam o diretório de inclusão.
Em vez de especificar diretórios como entradas para o sistema de build,
enumere o conjunto de arquivos contidos neles de maneira explícita ou usando a
função glob(). Use ** para forçar a
glob() a ser recursiva.
Recomendado —
data = glob(["testdata/**"])
Infelizmente, há alguns cenários em que é necessário usar rótulos de diretório.
Por exemplo, se o diretório testdata tiver arquivos com nomes que não estão em conformidade com a sintaxe do rótulo, a enumeração explícita de arquivos ou o uso da função glob() produzirá um erro de rótulos inválidos. É necessário usar os rótulos de diretório nesse caso, mas tenha cuidado com o
risco associado de recriações incorretas descritas acima.
Se você precisar usar rótulos de diretório, lembre-se de que não é possível referenciar o
pacote pai com um caminho ../ relativo. Em vez disso, use um caminho absoluto como
//data/regression:unittest/..
Qualquer regra externa, como um teste, que precise usar vários arquivos precisa
declarar explicitamente sua dependência em todos eles. É possível usar filegroup() para
agrupar arquivos no arquivo BUILD:
filegroup(
name = 'my_data',
srcs = glob(['my_unittest_data/*'])
)
Em seguida, é possível referenciar o rótulo my_data como a dependência de dados no teste.
| Arquivos BUILD | Visibilidade |