Microsoft.Testing.Platform (MTP) pengaturan konfigurasi

MTP mendukung penggunaan file konfigurasi dan variabel lingkungan untuk mengonfigurasi perilaku platform pengujian. Artikel ini menjelaskan pengaturan konfigurasi yang dapat Anda gunakan untuk mengonfigurasi platform pengujian.

testconfig.json

Platform pengujian menggunakan file konfigurasi bernama [appname].testconfig.json untuk mengonfigurasi perilaku platform pengujian. File testconfig.json adalah file JSON yang berisi pengaturan konfigurasi untuk platform pengujian.

File testconfig.json memiliki struktur berikut:

{
    "platformOptions": {
        "resultDirectory": "./TestResults"
    }
}

Platform akan secara otomatis mendeteksi dan memuat file.testconfig.json [appname] yang terletak di direktori output proyek pengujian (dekat dengan yang dapat dieksekusi).

Saat menggunakan Microsoft.Testing.Platform.MSBuild, Anda cukup membuat file testconfig.json yang akan secara otomatis diganti namanya menjadi [nama aplikasi].testconfig.json dan dipindahkan ke direktori output proyek pengujian.

Dimulai dengan MTP 1.5, Anda dapat menggunakan argumen --config-file baris perintah untuk menentukan jalur ke testconfig.json. File ini lebih diutamakan daripada file.testconfig.json [appname].

Menggunakan testconfig.json terpusat

Jika Anda ingin satu testconfig.json dibagikan di beberapa proyek pengujian, Anda dapat menempatkannya di lokasi pusat dan meneruskannya melalui --config-file. Saat MSBuild tersedia (misalnya, dotnet test atau dotnet run), Anda dapat menggunakan TestingPlatformCommandLineArguments properti MSBuild untuk meneruskan argumen secara otomatis. Menambahkan ini ke Directory.Build.props di akar repositori memastikan semua proyek pengujian menggunakan konfigurasi yang sama:

<PropertyGroup>
  <TestingPlatformCommandLineArguments>
    $(TestingPlatformCommandLineArguments) --config-file $(MSBuildThisFileDirectory)testconfig.json
  </TestingPlatformCommandLineArguments>
</PropertyGroup>

Urutan prioritas konfigurasi

Ketika pengaturan yang sama dapat ditentukan dalam beberapa cara, MTP menyelesaikannya dalam urutan berikut (kemenangan pertandingan pertama):

1. Argumen baris perintah (misalnya, --results-directory)
2. Variabel lingkungan
3. testconfig.json setelan
4. Setelan bawaan

Pilihan platform

Bagian platformOptions file testconfig.json mengonfigurasi perilaku inti platform pengujian. Tabel berikut ini mencantumkan semua opsi platform yang didukung:

Contoh:

{
  "platformOptions": {
    "resultDirectory": "../../TestResults",
    "exitProcessOnUnhandledException": false
  }
}

Variabel lingkungan dalam testconfig.json

Bagian ini environmentVariables mengatur variabel lingkungan untuk proses pengujian sebelum dimulai. Gunakan nilai string untuk setiap variabel.

{
  "environmentVariables": {
    "DOTNET_ENVIRONMENT": "Development",
    "FEATURE_FLAG": "true"
  }
}

Opsi CLI di testconfig.json

Sebelum MTP 2.3.0, fitur ekstensi seperti crash dump, hang dump, coba lagi, laporan TRX, dan cakupan kode tidak dapat dikonfigurasi melalui testconfig.json. Fitur-fitur ini dikonfigurasi secara eksklusif melalui argumen baris perintah.

Dimulai dengan MTP 2.3.0, MTP dapat membaca opsi CLI dari testconfig.json melalui IConfiguration. Dukungan ini mencakup opsi ekstensi, sehingga Anda dapat menggunakan entri JSON untuk opsi yang tidak ingin Anda teruskan pada baris perintah setiap eksekusi. Argumen baris perintah masih diutamakan.

Untuk referensi lengkap opsi baris perintah, lihat Referensi opsi MTP CLI.

Menguji pengaturan khusus kerangka kerja

Kerangka kerja pengujian dapat menentukan bagian konfigurasi mereka sendiri dalam file testconfig.json . Lihat dokumentasi untuk kerangka kerja pengujian Anda:

• MSTest: Mengonfigurasi MSTest — testconfig.json
• xUnit.net v3: xUnit.net testconfig.json
• NUnit: Lihat dokumentasi NUnit untuk dukungan terbaru Microsoft.Testing.Platform.
• TUnit: Lihat dokumentasi TUnit untuk dukungan terbaru Microsoft.Testing.Platform.

Contoh testconfig.json

Contoh berikut menunjukkan file testconfig.json yang mengonfigurasi opsi platform dan pengaturan MSTest:

{
  "platformOptions": {
    "resultDirectory": "./TestResults"
  },
  "mstest": {
    "parallelism": {
      "enabled": true,
      "workers": 4,
      "scope": "method"
    },
    "timeout": {
      "test": 30000
    },
    "execution": {
      "considerFixturesAsSpecialTests": true
    }
  }
}

Migrasi dari .runsettings ke testconfig.json

Jika Anda bermigrasi dari file .runsettings , tabel berikut memetakan pengaturan umum ke testconfig.json setara atau alternatifnya:

Variabel lingkungan

Variabel lingkungan dapat digunakan untuk menyediakan beberapa informasi konfigurasi runtime.

variabel lingkungan TESTINGPLATFORM_EXIT_PROCESS_ON_UNHANDLED_EXCEPTION

Ketika diatur ke 1, proses host uji akan langsung keluar saat terjadi pengecualian yang tidak tertangani. Ketika diatur ke 0, platform memungkinkan penghentian secara elegan. Pengaturan ini lebih diutamakan daripada platformOptions:exitProcessOnUnhandledException konfigurasi.

variabel lingkungan TESTINGPLATFORM_DEFAULT_HANG_TIMEOUT

Mengganti waktu tunggu default (300 detik) yang digunakan untuk koneksi named pipe antara pengontrol host pengujian dan host pengujian. Nilai harus berupa TimeSpanstring yang kompatibel.

variabel lingkungan TESTINGPLATFORM_UI_LANGUAGE

Dimulai dengan MTP 1.5, variabel lingkungan ini mengatur bahasa platform untuk menampilkan pesan dan log menggunakan nilai lokal seperti en-us. Bahasa ini lebih diutamakan daripada bahasa Visual Studio dan .NET SDK. Nilai yang didukung sama seperti untuk Visual Studio. Untuk informasi selengkapnya, lihat bagian tentang mengubah bahasa penginstal dalam dokumentasi penginstalan Visual Studio.

variabel lingkungan TESTINGPLATFORM_DIAGNOSTIC

Jika diatur ke 1, mengaktifkan pembuatan log diagnostik.

variabel lingkungan TESTINGPLATFORM_DIAGNOSTIC_VERBOSITY

Menentukan tingkat verbositas saat diagnostik diaktifkan. Nilai yang tersedia adalah Trace, Debug, Information, Warning, Error, atau Critical.

variabel lingkungan TESTINGPLATFORM_DIAGNOSTIC_OUTPUT_DIRECTORY

Direktori keluaran untuk pencatatan log diagnostik. Jika tidak ditentukan, file dihasilkan di direktori TestResults default.

variabel lingkungan TESTINGPLATFORM_DIAGNOSTIC_FILE_PREFIX

Awalan untuk nama file log. Secara default menjadi "log_". Sesuai dengan opsi baris perintah --diagnostic-file-prefix.

variabel lingkungan TESTINGPLATFORM_DIAGNOSTIC_SYNCHRONOUS_WRITE

Memaksa pencatat file bawaan untuk menulis log secara sinkron. Berguna untuk skenario di mana Anda tidak ingin kehilangan entri log apa pun (jika proses crash). Ini memperlambat eksekusi pengujian. Sesuai dengan opsi baris perintah --diagnostic-synchronous-write.

variabel lingkungan TESTINGPLATFORM_EXITCODE_IGNORE

Daftar kode keluar yang diabaikan, dipisahkan dengan titik koma. Ketika kode keluar diabaikan, proses akan kembali 0 sebagai gantinya. Misalnya, TESTINGPLATFORM_EXITCODE_IGNORE=2;8 mengabaikan kegagalan pengujian dan skenario tanpa pengujian yang dijalankan.

variabel lingkungan TESTINGPLATFORM_NOBANNER

Saat diatur ke 1 atau true, opsi ini menyembunyikan banner saat startup, pesan hak cipta, dan banner telemetri. Setara dengan --no-banner opsi baris perintah. Variabel DOTNET_NOLOGO lingkungan memiliki efek yang sama.

variabel lingkungan NO_COLOR

Jika diatur ke nilai apa pun yang tidak kosong, semua keluaran warna ANSI akan dinonaktifkan. MTP menghormati NO_COLOR konvensi.

variabel lingkungan DOTNET_NOLOGO

Saat diatur ke 1 atau true, opsi ini menyembunyikan banner saat startup, pesan hak cipta, dan banner telemetri. Ini adalah variabel lingkungan CLI .NET standar dan dihormati oleh MTP. Lihat juga TESTINGPLATFORM_NOBANNER.

variabel lingkungan TESTINGPLATFORM_WAIT_ATTACH_DEBUGGER

Ketika diatur ke 1, proses pengujian berhenti sejenak saat startup dan menunggu debugger dilampirkan sebelum melanjutkan. Setara dengan --debug opsi baris perintah. Tidak didukung pada platform browser.

variabel lingkungan TESTINGPLATFORM_LAUNCH_ATTACH_DEBUGGER

Ketika diatur ke 1, proses pengujian memanggil Debugger.Launch() saat mulai dijalankan, yang menyebabkan sistem meluncurkan debugger just-in-time dan melampirkannya ke proses tersebut. Gunakan variabel ini untuk mendebug masalah saat startup (misalnya, handshake mode server) yang terjadi sebelum Anda dapat melakukan attach secara manual. Pada platform non-Windows, perilaku tergantung pada debugger JIT yang dikonfigurasi.

Baca juga

• Referensi opsi MTP CLI
• Fitur MTP
• Mengonfigurasi MSTest
• Pemecahan masalah MTP