arm ttk

Kit de ferramentas de modelo do Azure Resource Manager (arm-ttk)

O código neste repositório pode ser usado para analisar e testar modelos do Azure Resource Manager. Os testes verificarão um modelo ou conjunto de modelos para melhores práticas de codificação. Existem algumas verificações para erros sintáticos simples, mas a intenção não é reimplementar testes ou verificações fornecidas pela plataforma (por exemplo, a API /validate).

Observação: a partir da versão 0.10, o Bicep agora contém todos os casos de teste de implantaçãoTemplate incluídos no TTK. Começaremos a transferir o investimento em novos testes para o linter Bicep. O TTK permanecerá disponível para oferecer suporte aos cenários JSON e createUiDefinition disponíveis.

Usando o TTK

Para obter instruções detalhadas sobre como usar o arm-ttk, consulte este leia-me. Mais informações podem ser encontradas na documentação.

Para um tutorial guiado sobre o arm-ttk, confira este módulo MS LEARN.

Filosofia

Um pouco sobre os testes... Estes são os testes usados ​​para validar modelos para o Azure QuickStart Repo e o Azure Marketplace. O objetivo é garantir um conjunto padrão ou consistente de práticas de codificação para facilitar o desenvolvimento de conhecimentos usando a linguagem de modelo (fácil de ler, escrever, depurar).

Quanto ao tipo, número e natureza dos testes, um teste deve verificar algo nas seguintes categorias (adicione mais conforme você pensar neles :))

• Validando a intenção do autor (parâmetros ou variáveis ​​não utilizados)
• Práticas de segurança para a linguagem (exibição de segredos em texto simples)
• Usando a construção de linguagem apropriada para a tarefa em questão (usando funções ambientais em vez de valores codificados)

Nem tudo é apropriado para um conjunto universal de testes e nem todos os testes serão aplicados a todos os cenários, portanto a estrutura permite fácil expansão e seleção individual de testes.

Executando testes de unidade localmente antes de solicitar um PR

Os testes podem ser executados diretamente no PowerShell ou na linha de comando usando um script wrapper.

Você pode executar todos os testes de unidade usando .arm-ttk.tests.ps1 .

Isso executará o conjunto completo de testes de unidade nos arquivos json de testes.

usar:

 # set your location in the project directory:
Set-Location -Path "$(YourGithubProjectFolder)arm-ttkunit-tests"

# import the module from the current branch, use -Force to make sure you have imported any code changes
Import-Module ..arm-ttkarm-ttk.psd1 -Force

# These are the same tests that run in the pipeline when doing a commit or a pull request (PR). 
.arm-ttk.tests.ps1

Contribuindo

Este projeto aceita contribuições e sugestões. A maioria das contribuições exige que você concorde com um Contrato de Licença de Colaborador (CLA), declarando que você tem o direito de nos conceder, e realmente nos concede, os direitos de uso de sua contribuição. Para obter detalhes, visite https://cla.opensource.microsoft.com.

Quando você envia uma solicitação pull, um bot CLA determinará automaticamente se você precisa fornecer um CLA e decorará o PR adequadamente (por exemplo, verificação de status, comentário). Basta seguir as instruções fornecidas pelo bot. Você só precisará fazer isso uma vez em todos os repositórios que usam nosso CLA.

Este projeto adotou o Código de Conduta de Código Aberto da Microsoft.

Para obter mais informações, consulte as Perguntas frequentes sobre o Código de Conduta ou entre em contato com [email protected] com perguntas ou comentários adicionais.