arm ttk

Perangkat Templat Azure Resource Manager (arm-ttk)

Kode dalam repositori ini dapat digunakan untuk menganalisis dan menguji Templat Azure Resource Manager. Tes ini akan memeriksa template atau kumpulan template untuk praktik terbaik pengkodean. Ada beberapa pemeriksaan untuk kesalahan sintaksis sederhana tetapi tujuannya bukan untuk menerapkan kembali pengujian atau pemeriksaan yang disediakan oleh platform (misalnya api /validasi).

Catatan: Dimulai dengan rilis 0.10, Bicep sekarang berisi semua kasus pengujian deploymentTemplate yang disertakan dalam TTK. Kami akan mulai memindahkan investasi dalam pengujian baru ke linter Bicep. TTK akan tetap tersedia untuk mendukung skenario JSON dan createUiDefinition yang tersedia.

Menggunakan TTK

Untuk instruksi rinci tentang cara menggunakan arm-ttk, lihat readme ini. Informasi lebih lanjut dapat ditemukan di dokumentasi.

Untuk tutorial terpandu tentang arm-ttk, lihat modul MS LEARN ini.

Filsafat

Sedikit tentang pengujian... Ini adalah pengujian yang digunakan untuk memvalidasi templat untuk Azure QuickStart Repo dan Azure Marketplace. Tujuannya adalah untuk memastikan seperangkat praktik pengkodean yang standar atau konsisten untuk memudahkan pengembangan keahlian menggunakan bahasa template (mudah dibaca, ditulis, di-debug).

Mengenai jenis, jumlah, dan sifat tes, suatu tes harus memeriksa sesuatu dalam kategori berikut (tambahkan lagi sesuai keinginan Anda :))

• Memvalidasi maksud penulis (parameter atau variabel yang tidak digunakan)
• Praktik keamanan untuk bahasa tersebut (mengeluarkan rahasia dalam teks biasa)
• Menggunakan konstruksi bahasa yang sesuai untuk tugas yang ada (menggunakan fungsi lingkungan alih-alih nilai hard-coding)

Tidak semuanya cocok untuk serangkaian pengujian universal dan tidak semua pengujian dapat diterapkan pada setiap skenario, sehingga kerangka kerja ini memungkinkan perluasan yang mudah dan pemilihan pengujian individual.

Menjalankan Tes Unit secara lokal sebelum meminta PR

Pengujian dapat dijalankan langsung di PowerShell, atau dijalankan dari baris perintah menggunakan skrip wrapper.

Anda dapat menjalankan semua pengujian unit dengan menggunakan .arm-ttk.tests.ps1 .

Ini akan menjalankan rangkaian lengkap pengujian unit terhadap file json pengujian.

menggunakan:

 # 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

Berkontribusi

Proyek ini menyambut baik kontribusi dan saran. Sebagian besar kontribusi mengharuskan Anda menyetujui Perjanjian Lisensi Kontributor (CLA) yang menyatakan bahwa Anda berhak, dan memang benar, memberi kami hak untuk menggunakan kontribusi Anda. Untuk detailnya, kunjungi https://cla.opensource.microsoft.com.

Saat Anda mengirimkan permintaan tarik, bot CLA akan secara otomatis menentukan apakah Anda perlu memberikan CLA dan menghiasi PR dengan tepat (misalnya, pemeriksaan status, komentar). Cukup ikuti instruksi yang diberikan oleh bot. Anda hanya perlu melakukan ini sekali di seluruh repositori menggunakan CLA kami.

Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft.

Untuk informasi lebih lanjut lihat FAQ Pedoman Perilaku atau hubungi [email protected] jika ada pertanyaan atau komentar tambahan.