Pengantar Pengujian dengan Spock dan Groovy

1. Perkenalan

Pada artikel ini, kita akan melihat Spock, framework pengujian Groovy. Terutama, Spock bertujuan untuk menjadi alternatif yang lebih kuat untuk tumpukan JUnit tradisional, dengan memanfaatkan fitur Groovy.

Groovy adalah bahasa berbasis JVM yang terintegrasi mulus dengan Java. Selain interoperabilitas, ia menawarkan konsep bahasa tambahan seperti dinamis, memiliki tipe opsional dan meta-pemrograman.

Dengan menggunakan Groovy, Spock memperkenalkan cara baru dan ekspresif untuk menguji aplikasi Java kami, yang tidak mungkin dilakukan dalam kode Java biasa. Kami akan menjelajahi beberapa konsep tingkat tinggi Spock selama artikel ini, dengan beberapa contoh praktis langkah demi langkah.

2. Ketergantungan Maven

Sebelum kita mulai, mari tambahkan dependensi Maven kita:

 org.spockframework spock-core 1.0-groovy-2.4 test   org.codehaus.groovy groovy-all 2.4.7 test 

Kami telah menambahkan Spock dan Groovy seperti yang kami lakukan pada perpustakaan standar lainnya. Namun, karena Groovy adalah bahasa JVM baru, kami perlu menyertakan plugin gmavenplus agar dapat mengkompilasi dan menjalankannya:

 org.codehaus.gmavenplus gmavenplus-plugin 1.5    compile testCompile    

Sekarang kami siap untuk menulis tes Spock pertama kami, yang akan ditulis dalam kode Groovy. Perhatikan bahwa kami menggunakan Groovy dan Spock hanya untuk tujuan pengujian dan inilah mengapa dependensi tersebut memiliki cakupan pengujian.

3. Struktur Tes Spock

3.1. Spesifikasi dan Fitur

Saat kita menulis pengujian kita di Groovy, kita perlu menambahkannya ke direktori src / test / groovy , bukan ke src / test / java. Mari buat tes pertama kita di direktori ini, beri nama Specification.groovy:

class FirstSpecification extends Specification { }

Perhatikan bahwa kami memperluas antarmuka Spesifikasi . Setiap kelas Spock harus memperluas ini untuk membuat kerangka kerja tersedia untuk itu. Hal itu memungkinkan kami menerapkan fitur pertama kami :

def "one plus one should equal two"() { expect: 1 + 1 == 2 }

Sebelum menjelaskan kodenya, perlu juga dicatat bahwa di Spock, apa yang kami sebut sebagai fitur agak identik dengan apa yang kami lihat sebagai pengujian di JUnit. Jadi, setiap kali kami merujuk ke fitur, kami sebenarnya mengacu pada tes.

Sekarang, mari kita analisis fitur kita . Dalam melakukannya, kita akan segera dapat melihat beberapa perbedaan antara Java dan Java.

Perbedaan pertama adalah nama metode fitur dituliskan sebagai string biasa. Di JUnit, kami akan memiliki nama metode yang menggunakan camelcase atau garis bawah untuk memisahkan kata-kata, yang tidak akan terlalu ekspresif atau dapat dibaca manusia.

Yang berikutnya adalah bahwa hidup kode uji kami di harapkan blok. Kami akan membahas blok secara lebih rinci sebentar lagi, tetapi pada dasarnya mereka adalah cara logis untuk membagi langkah-langkah pengujian kami yang berbeda.

Akhirnya, kami menyadari bahwa tidak ada pernyataan. Itu karena pernyataannya implisit, diteruskan ketika pernyataan kita sama dengan benar dan gagal ketika itu sama dengan salah . Sekali lagi, kami akan membahas pernyataan secara lebih rinci segera.

3.2. Blok

Terkadang saat menulis tes JUnit, kita mungkin memperhatikan bahwa tidak ada cara ekspresif untuk memecahnya menjadi beberapa bagian. Misalnya, jika kita mengikuti pengembangan yang didorong perilaku, kita mungkin akan menunjukkan bagian yang diberikan ketika kemudian menggunakan komentar:

@Test public void givenTwoAndTwo_whenAdding_thenResultIsFour() { // Given int first = 2; int second = 4; // When int result = 2 + 2; // Then assertTrue(result == 4) }

Spock mengatasi masalah ini dengan blok. Pemblokiran adalah cara asli Spock untuk memecah fase pengujian kami menggunakan label. Mereka memberi kita label untuk diberikan saat itu dan lebih banyak lagi:

  1. Setup (Aliased by Diberikan) - Di sini kita melakukan pengaturan yang diperlukan sebelum tes dijalankan. Ini adalah blok implisit, dengan kode yang sama sekali tidak ada di blok mana pun menjadi bagian darinya
  2. Kapan - Di sinilah kami memberikan rangsangan untuk apa yang sedang diuji. Dengan kata lain, di mana kami menjalankan metode kami yang sedang diuji
  3. Kemudian - Di sinilah asersinya berada. Di Spock, ini dievaluasi sebagai pernyataan boolean biasa, yang akan dibahas nanti
  4. Harapkan - Ini adalah cara melakukan stimulus dan pernyataan kita dalam blok yang sama. Bergantung pada apa yang menurut kami lebih ekspresif, kami mungkin atau mungkin tidak memilih untuk menggunakan blok ini
  5. Pembersihan - Di sini kami merobohkan sumber daya ketergantungan pengujian yang akan tertinggal. Misalnya, kami mungkin ingin menghapus file apa pun dari sistem file atau menghapus data pengujian yang ditulis ke database

Mari coba terapkan pengujian kami lagi, kali ini manfaatkan blok sepenuhnya:

def "two plus two should equal four"() { given: int left = 2 int right = 2 when: int result = left + right then: result == 4 }

Seperti yang bisa kita lihat, blok membantu pengujian kita menjadi lebih mudah dibaca.

3.3. Memanfaatkan Fitur Groovy untuk Pernyataan

Dalam blok kemudian dan harapkan , pernyataan tersirat .

Kebanyakan, setiap pernyataan dievaluasi dan kemudian gagal jika tidak benar . Saat menggabungkan ini dengan berbagai fitur Groovy, ini berfungsi dengan baik untuk menghilangkan kebutuhan akan pustaka pernyataan. Mari kita coba pernyataan daftar untuk mendemonstrasikan ini:

def "Should be able to remove from list"() { given: def list = [1, 2, 3, 4] when: list.remove(0) then: list == [2, 3, 4] }

Meskipun kami hanya menyentuh secara singkat tentang Groovy di artikel ini, ada baiknya menjelaskan apa yang terjadi di sini.

Pertama, Groovy memberi kita cara yang lebih sederhana untuk membuat daftar. Kami hanya dapat mendeklarasikan elemen kami dengan tanda kurung siku, dan secara internal daftar akan dibuat.

Kedua, karena Groovy bersifat dinamis, kita dapat menggunakan def yang artinya kita tidak mendeklarasikan tipe untuk variabel kita.

Terakhir, dalam konteks menyederhanakan pengujian kami, fitur paling berguna yang ditunjukkan adalah kelebihan beban operator. Ini berarti bahwa secara internal, daripada membuat perbandingan referensi seperti di Java, metode equals () akan dipanggil untuk membandingkan dua daftar.

Penting juga untuk mendemonstrasikan apa yang terjadi jika pengujian kami gagal. Mari kita hancurkan dan kemudian lihat apa yang dihasilkan ke konsol:

Condition not satisfied: list == [1, 3, 4] | | | false [2, 3, 4]  at FirstSpecification.Should be able to remove from list(FirstSpecification.groovy:30)

Sementara semua yang terjadi adalah memanggil equals () pada dua daftar, Spock cukup cerdas untuk melakukan perincian dari pernyataan yang gagal, memberi kami informasi yang berguna untuk debugging.

3.4. Menegaskan Pengecualian

Spock also provides us with an expressive way of checking for exceptions. In JUnit, some our options might be using a try-catch block, declare expected at the top of our test, or making use of a third party library. Spock's native assertions come with a way of dealing with exceptions out of the box:

def "Should get an index out of bounds when removing a non-existent item"() { given: def list = [1, 2, 3, 4] when: list.remove(20) then: thrown(IndexOutOfBoundsException) list.size() == 4 }

Here, we've not had to introduce an additional library. Another advantage is that the thrown() method will assert the type of the exception, but not halt execution of the test.

4. Data Driven Testing

4.1. What Is a Data Driven Testing?

Essentially, data driven testing is when we test the same behavior multiple times with different parameters and assertions. A classic example of this would be testing a mathematical operation such as squaring a number. Depending on the various permutations of operands, the result will be different. In Java, the term we may be more familiar with is parameterized testing.

4.2. Implementing a Parameterized Test in Java

For some context, it's worth implementing a parameterized test using JUnit:

@RunWith(Parameterized.class) public class FibonacciTest { @Parameters public static Collection data() { return Arrays.asList(new Object[][] { { 1, 1 }, { 2, 4 }, { 3, 9 } }); } private int input; private int expected; public FibonacciTest (int input, int expected) { this.input = input; this.expected = expected; } @Test public void test() { assertEquals(fExpected, Math.pow(3, 2)); } }

As we can see there's quite a lot of verbosity, and the code isn't very readable. We've had to create a two-dimensional object array that lives outside of the test, and even a wrapper object for injecting the various test values.

4.3. Using Datatables in Spock

One easy win for Spock when compared to JUnit is how it cleanly it implements parameterized tests. Again, in Spock, this is known as Data Driven Testing. Now, let's implement the same test again, only this time we'll use Spock with Data Tables, which provides a far more convenient way of performing a parameterized test:

def "numbers to the power of two"(int a, int b, int c)  4 3 

As we can see, we just have a straightforward and expressive Data table containing all our parameters.

Also, it belongs where it should do, alongside the test, and there is no boilerplate. The test is expressive, with a human-readable name, and pure expect and where block to break up the logical sections.

4.4. When a Datatable Fails

It's also worth seeing what happens when our test fails:

Condition not satisfied: Math.pow(a, b) == c | | | | | 4.0 2 2 | 1 false Expected :1 Actual :4.0

Again, Spock gives us a very informative error message. We can see exactly what row of our Datatable caused a failure and why.

5. Mocking

5.1. What Is Mocking?

Mocking is a way of changing the behavior of a class which our service under test collaborates with. It's a helpful way of being able to test business logic in isolation of its dependencies.

A classic example of this would be replacing a class which makes a network call with something which simply pretends to. For a more in-depth explanation, it's worth reading this article.

5.2. Mocking Using Spock

Spock has it's own mocking framework, making use of interesting concepts brought to the JVM by Groovy. First, let's instantiate a Mock:

PaymentGateway paymentGateway = Mock()

In this case, the type of our mock is inferred by the variable type. As Groovy is a dynamic language, we can also provide a type argument, allow us to not have to assign our mock to any particular type:

def paymentGateway = Mock(PaymentGateway)

Now, whenever we call a method on our PaymentGateway mock, a default response will be given, without a real instance being invoked:

when: def result = paymentGateway.makePayment(12.99) then: result == false

The term for this is lenient mocking. This means that mock methods which have not been defined will return sensible defaults, as opposed to throwing an exception. This is by design in Spock, in order to make mocks and thus tests less brittle.

5.3. Stubbing Method Calls on Mocks

We can also configure methods called on our mock to respond in a certain way to different arguments. Let's try getting our PaymentGateway mock to return true when we make a payment of 20:

given: paymentGateway.makePayment(20) >> true when: def result = paymentGateway.makePayment(20) then: result == true

What's interesting here, is how Spock makes use of Groovy's operator overloading in order to stub method calls. With Java, we have to call real methods, which arguably means that the resulting code is more verbose and potentially less expressive.

Now, let's try a few more types of stubbing.

If we stopped caring about our method argument and always wanted to return true, we could just use an underscore:

paymentGateway.makePayment(_) >> true

If we wanted to alternate between different responses, we could provide a list, for which each element will be returned in sequence:

paymentGateway.makePayment(_) >>> [true, true, false, true]

There are more possibilities, and these may be covered in a more advanced future article on mocking.

5.4. Verification

Another thing we might want to do with mocks is assert that various methods were called on them with expected parameters. In other words, we ought to verify interactions with our mocks.

A typical use case for verification would be if a method on our mock had a void return type. In this case, by there being no result for us to operate on, there's no inferred behavior for us to test via the method under test. Generally, if something was returned, then the method under test could operate on it, and it's the result of that operation would be what we assert.

Let's try verifying that a method with a void return type is called:

def "Should verify notify was called"() { given: def notifier = Mock(Notifier) when: notifier.notify('foo') then: 1 * notifier.notify('foo') } 

Spock is leveraging Groovy operator overloading again. By multiplying our mocks method call by one, we are saying how many times we expect it to have been called.

If our method had not been called at all or alternatively had not been called as many times as we specified, then our test would have failed to give us an informative Spock error message. Let's prove this by expecting it to have been called twice:

2 * notifier.notify('foo')

Following this, let's see what the error message looks like. We'll that as usual; it's quite informative:

Too few invocations for: 2 * notifier.notify('foo') (1 invocation)

Just like stubbing, we can also perform looser verification matching. If we didn't care what our method parameter was, we could use an underscore:

2 * notifier.notify(_)

Or if we wanted to make sure it wasn't called with a particular argument, we could use the not operator:

2 * notifier.notify(!'foo')

Sekali lagi, ada lebih banyak kemungkinan, yang mungkin akan dibahas di artikel lanjutan selanjutnya.

6. Kesimpulan

Dalam artikel ini, kami telah memberikan gambaran singkat melalui pengujian dengan Spock.

Kami telah mendemonstrasikan bagaimana, dengan memanfaatkan Groovy, kami dapat membuat pengujian kami lebih ekspresif daripada tumpukan JUnit biasa. Kami telah menjelaskan struktur spesifikasi dan fitur .

Dan kami telah menunjukkan betapa mudahnya melakukan pengujian berbasis data, dan juga betapa mudahnya membuat ejekan dan pernyataan melalui fungsionalitas Spock asli.

Penerapan contoh-contoh ini dapat ditemukan di GitHub. Ini adalah proyek berbasis Maven, jadi harus mudah dijalankan apa adanya.