Bagikan melalui


Tutorial: Menguji pustaka kelas .NET menggunakan Visual Studio Code

Tutorial ini menunjukkan cara mengotomatiskan pengujian unit dengan menambahkan proyek pengujian ke solusi.

Prasyarat

Membuat proyek pengujian unit

Pengujian unit menyediakan pengujian perangkat lunak otomatis selama pengembangan dan penerbitan yang Anda lakukan. Kerangka kerja pengujian yang Anda gunakan dalam tutorial ini adalah MSTest. MSTest adalah salah satu dari tiga kerangka kerja pengujian yang dapat Anda pilih. Yang lain adalah xUnit dan nUnit.

  1. Mulai Visual Studio Code.

  2. Buka solusi ClassLibraryProjects yang Anda buat di Membuat pustaka kelas .NET menggunakan Visual Studio Code.

  3. Dari Penjelajah Solusi , pilih Proyek Baru , atau dari Palet Perintah pilih .NET: Proyek Baru .

  4. Pilih MSTest Test Project, beri nama "StringLibraryTest", pilih direktori default, dan pilih Buat Proyek.

    Templat proyek membuat file UnitTest1.cs dengan kode berikut:

    namespace StringLibraryTest;
    
    [TestClass]
    public class UnitTest1
    {
        [TestMethod]
        public void TestMethod1()
        {
        }
    }
    

    Kode sumber yang dibuat oleh templat pengujian unit melakukan hal berikut:

    Setiap metode yang ditandai dengan [TestMethod] dalam kelas pengujian yang ditandai dengan [TestClass] dijalankan secara otomatis saat pengujian unit dipanggil.

Menambahkan referensi proyek

Agar proyek pengujian berfungsi dengan kelas StringLibrary, tambahkan referensi dalam proyek StringLibraryTest ke proyek StringLibrary.

  1. Dari Penjelajah Solusi klik kanan pada Proyek 'StringLibraryTest' dan pilih Tambahkan Referensi Proyek.

  2. Pilih "StringLibrary".

Tambahkan dan jalankan metode uji unit

Saat Visual Studio memanggil pengujian unit, Visual Studio menjalankan setiap metode yang ditandai dengan atribut TestMethodAttribute di kelas yang ditandai dengan atribut TestClassAttribute. Metode pengujian berakhir ketika kegagalan pertama ditemukan atau ketika semua pengujian yang terkandung dalam metode telah berhasil.

Tes yang paling umum memanggil anggota kelas Assert. Banyak metode pernyataan mencakup setidaknya dua parameter, salah satunya adalah hasil pengujian yang diharapkan dan yang lainnya adalah hasil pengujian aktual. Beberapa metode kelas Assert yang paling sering disebut diperlihatkan dalam tabel berikut:

Metode pernyataan Fungsi
Assert.AreEqual Memverifikasi bahwa dua nilai atau objek sama. Pernyataan gagal jika nilai atau objek tidak sama.
Assert.AreSame Memverifikasi bahwa dua variabel objek merujuk ke objek yang sama. Pernyataan gagal jika variabel merujuk ke objek yang berbeda.
Assert.IsFalse Memverifikasi bahwa kondisi falseterpenuhi. Pernyataan assert gagal jika kondisinya true.
Assert.IsNotNull Memverifikasi bahwa sebuah objek tidak null. Asersi gagal jika objek adalah null.

Anda juga dapat menggunakan metode Assert.ThrowsException (atau Assert.Throws dan Assert.ThrowsExactly jika menggunakan metode MSTest 3.8 dan yang lebih baru) dalam metode pengujian untuk menunjukkan jenis pengecualian yang diharapkan untuk dilemparkan. Pengujian gagal jika pengecualian yang ditentukan tidak terjadi.

Dalam menguji metode StringLibrary.StartsWithUpper, Anda ingin menyediakan sejumlah string yang dimulai dengan karakter huruf besar. Anda mengharapkan metode untuk mengembalikan true dalam kasus ini, sehingga Anda dapat memanggil metode Assert.IsTrue. Demikian pula, Anda ingin menyediakan sejumlah string yang dimulai dengan sesuatu selain karakter huruf besar. Anda mengharapkan metode untuk mengembalikan false dalam kasus ini, sehingga Anda dapat memanggil metode Assert.IsFalse.

Karena metode pustaka Anda menangani string, Anda juga ingin memastikan bahwa metode tersebut berhasil menangani string kosong (String.Empty) dan string null. String kosong adalah string yang tidak memiliki karakter dan yang Length-nya adalah 0. String null adalah string yang belum diinisialisasi. Anda dapat memanggil StartsWithUpper secara langsung sebagai metode statis dan meneruskan satu argumen String. Atau Anda dapat memanggil StartsWithUpper sebagai metode ekstensi pada variabel string yang ditetapkan ke null.

Anda akan menentukan tiga metode, yang masing-masing memanggil metode Assert untuk setiap elemen dalam array string. Anda akan memanggil kelebihan beban metode yang memungkinkan Anda menentukan pesan kesalahan yang akan ditampilkan jika terjadi kegagalan pengujian. Pesan mengidentifikasi string yang menyebabkan kegagalan.

Untuk membuat metode pengujian:

  1. Buka StringLibraryTest/UnitTest1.cs dan ganti semua kode dengan kode berikut.

    using Microsoft.VisualStudio.TestTools.UnitTesting;
    using UtilityLibraries;
    
    namespace StringLibraryTest
    {
        [TestClass]
        public class UnitTest1
        {
            [TestMethod]
            public void TestStartsWithUpper()
            {
                // Tests that we expect to return true.
                string[] words = { "Alphabet", "Zebra", "ABC", "Αθήνα", "Москва" };
                foreach (var word in words)
                {
                    bool result = word.StartsWithUpper();
                    Assert.IsTrue(result,
                           string.Format("Expected for '{0}': true; Actual: {1}",
                                         word, result));
                }
            }
    
            [TestMethod]
            public void TestDoesNotStartWithUpper()
            {
                // Tests that we expect to return false.
                string[] words = { "alphabet", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство",
                                   "1234", ".", ";", " " };
                foreach (var word in words)
                {
                    bool result = word.StartsWithUpper();
                    Assert.IsFalse(result,
                           string.Format("Expected for '{0}': false; Actual: {1}",
                                         word, result));
                }
            }
    
            [TestMethod]
            public void DirectCallWithNullOrEmpty()
            {
                // Tests that we expect to return false.
                string?[] words = { string.Empty, null };
                foreach (var word in words)
                {
                    bool result = StringLibrary.StartsWithUpper(word);
                    Assert.IsFalse(result,
                           string.Format("Expected for '{0}': false; Actual: {1}",
                                         word == null ? "<null>" : word, result));
                }
            }
        }
    }
    

    Pengujian karakter huruf besar dalam metode TestStartsWithUpper mencakup alfa huruf kapital Yunani (U+0391) dan huruf kapital Sirilik EM (U+041C). Pengujian karakter huruf kecil dalam metode TestDoesNotStartWithUpper mencakup alfa huruf kecil Yunani (U+03B1) dan huruf kecil Sirilik Ghe (U+0433).

  2. Simpan perubahan Anda.

Membangun dan Menjalankan Pengujian Anda

  1. Di Solution Explorer, klik kanan solusi dan pilih Build atau dari Palet Perintah, pilih .NET: Build.

  2. Pilih jendela Pengujian, pilih Jalankan Pengujian atau dari Palet Perintah, pilih Pengujian: Jalankan semua Pengujian.

    Penjelajah Uji Visual Studio Code

Menangani kegagalan pengujian

Jika Anda melakukan pengembangan berbasis pengujian (TDD), Anda menulis pengujian terlebih dahulu dan mereka gagal saat pertama kali menjalankannya. Kemudian Anda menambahkan kode ke aplikasi yang membuat pengujian berhasil. Untuk tutorial ini, Anda membuat pengujian setelah menulis kode aplikasi yang divalidasinya, sehingga Anda belum melihat pengujian gagal. Untuk memvalidasi bahwa pengujian gagal ketika Anda mengharapkannya gagal, tambahkan nilai yang tidak valid ke input pengujian.

  1. Ubah array words dalam metode TestDoesNotStartWithUpper untuk menyertakan string "Kesalahan".

    string[] words = { "alphabet", "Error", "zebra", "abc", "αυτοκινητοβιομηχανία", "государство",
                       "1234", ".", ";", " " };
    
  2. Jalankan pengujian dengan mengklik kesalahan hijau di samping pengujian di editor.

    Output menunjukkan bahwa pengujian gagal, dan memberikan pesan kesalahan untuk pengujian yang gagal: "Assert.IsFalse tidak berhasil. Diharapkan untuk 'Kesalahan': false; aktual: Benar". Karena kegagalan, tidak ada string dalam array setelah "Kesalahan" diuji.

    Pengujian Gagal Visual Studio Code

  3. Hapus string "Kesalahan" yang Anda tambahkan pada langkah tersebut.

  4. Jalankan ulang ujiannya, dan ujian tersebut berhasil.

Menguji versi rilis perpustakaan

Sekarang setelah semua pengujian lulus saat menjalankan Debug build pustaka, jalankan pengujian sekali lagi terhadap Rilis build pustaka. Sejumlah faktor, termasuk pengoptimalan pengkompilasi, terkadang dapat menghasilkan perilaku yang berbeda antara build Debug dan Rilis.

  1. Jalankan pengujian dengan konfigurasi build Rilis:

    dotnet test StringLibraryTest/StringLibraryTest.csproj --configuration Release
    

    Tes lulus.

Tes penyaringan kesalahan

Jika Anda menggunakan Visual Studio Code sebagai IDE, Anda dapat menggunakan proses yang sama yang ditampilkan di Men-debug aplikasi konsol .NET menggunakan Visual Studio Code untuk men-debug kode menggunakan proyek pengujian unit Anda. Alih-alih memulai proyek aplikasi ShowCase, buka StringLibraryTest/UnitTest1.cs, dan pilih Debug Tests di file saat ini di antara baris 7 dan 8. Jika Anda tidak dapat menemukannya, tekan Ctrl+Shift+P untuk membuka palet perintah dan masukkan Muat Ulang Jendela.

Visual Studio Code memulai proyek pengujian dengan debugger terlampir. Eksekusi akan berhenti pada titik henti apa pun yang telah Anda tambahkan ke proyek pengujian atau kode pustaka yang mendasar.

Sumber daya tambahan

Langkah berikutnya

Dalam tutorial ini, Anda telah menguji unit sebuah perpustakaan kelas. Anda dapat membuat pustaka tersedia untuk orang lain dengan menerbitkannya ke NuGet sebagai paket. Untuk mempelajari caranya, ikuti tutorial NuGet:

Jika Anda menerbitkan pustaka sebagai paket NuGet, orang lain dapat menginstal dan menggunakannya. Untuk mempelajari caranya, ikuti tutorial NuGet:

Pustaka tidak harus didistribusikan sebagai paket. Ini dapat dibundel dengan aplikasi konsol yang menggunakannya. Untuk mempelajari cara menerbitkan aplikasi konsol, lihat tutorial sebelumnya dalam seri ini:

Ekstensi Visual Studio Code C# Dev Kit menyediakan lebih banyak alat untuk mengembangkan aplikasi dan pustaka C#: