arm ttk

Azure Resource Manager 템플릿 도구 키트(arm-ttk)

이 리포지토리의 코드는 Azure Resource Manager 템플릿을 분석하고 테스트하는 데 사용할 수 있습니다. 테스트에서는 코딩 모범 사례에 대한 템플릿 또는 템플릿 세트를 확인합니다. 간단한 구문 오류에 대한 몇 가지 검사가 있지만 플랫폼(예: /validate API)에서 제공하는 테스트나 검사를 다시 구현하려는 의도는 없습니다.

참고: 0.10 릴리스부터 Bicep에는 이제 TTK에 포함된 모든 developmentTemplate 테스트 사례가 포함됩니다. 우리는 새로운 테스트에 대한 투자를 Bicep linter로 옮기기 시작할 것입니다. TTK는 사용 가능한 JSON 및 createUiDefinition 시나리오를 지원하는 데 계속 사용할 수 있습니다.

TTK 사용

arm-ttk 사용 방법에 대한 자세한 지침은 이 추가 정보를 참조하세요. 자세한 내용은 설명서에서 확인할 수 있습니다.

arm-ttk에 대한 안내 튜토리얼을 보려면 이 MS LEARN 모듈을 확인하세요.

철학

테스트에 대한 정보... 이는 Azure QuickStart Repo 및 Azure Marketplace용 템플릿의 유효성을 검사하는 데 사용되는 테스트입니다. 목적은 템플릿 언어(읽기, 쓰기, 디버그하기 쉬움)를 사용하여 전문 지식을 더 쉽게 개발할 수 있도록 표준 또는 일관된 코딩 방법 세트를 보장하는 것입니다.

테스트의 유형, 수 및 성격에 관해서는 테스트에서 다음 범주의 내용을 확인해야 합니다(생각나는대로 더 추가하세요 :))

• 작성자의 의도 확인(사용되지 않은 매개변수 또는 변수)
• 언어에 대한 보안 관행(비밀 정보를 일반 텍스트로 출력)
• 현재 작업에 적합한 언어 구성 사용(하드 코딩 값 대신 환경 함수 사용)

모든 테스트가 보편적인 테스트 세트에 적합한 것은 아니며 모든 테스트가 모든 시나리오에 적용되는 것은 아닙니다. 따라서 프레임워크에서는 테스트를 쉽게 확장하고 개별적으로 선택할 수 있습니다.

PR을 요청하기 전에 로컬에서 단위 테스트 실행

테스트는 PowerShell에서 직접 실행하거나 래퍼 스크립트를 사용하여 명령줄에서 실행할 수 있습니다.

. arm-ttk.tests.ps1 을 사용하여 모든 단위 테스트를 실행할 수 있습니다.

그러면 테스트 json 파일에 대해 전체 단위 테스트 모음이 실행됩니다.

사용:

 # 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

기여

이 프로젝트는 기여와 제안을 환영합니다. 대부분의 기여는 귀하가 귀하의 기여를 사용할 권리가 있고 실제로 그렇게 할 권리가 있음을 선언하는 기여자 라이센스 계약(CLA)에 동의해야 합니다. 자세한 내용을 보려면 https://cla.opensource.microsoft.com을 방문하세요.

끌어오기 요청을 제출하면 CLA 봇이 자동으로 CLA 제공이 필요한지 여부를 결정하고 PR을 적절하게 장식합니다(예: 상태 확인, 댓글). 봇이 제공하는 지침을 따르기만 하면 됩니다. CLA를 사용하여 모든 리포지토리에서 이 작업을 한 번만 수행하면 됩니다.

이 프로젝트는 Microsoft 오픈 소스 행동 강령을 채택했습니다.

자세한 내용은 행동 강령 FAQ를 참조하거나 추가 질문이나 의견이 있는 경우 [email protected]으로 문의하세요.