在 Spock 測試方法間共用程式碼

在進行測試程式開發時，經常會有執行或驗證的程序是在不同的測試案例間一直重覆，當然使用 Spock 時也不例外。根據 Spock 的官方文件提到，在 Spock 中可以使用 Helper Methods 來把要被共用的程式碼收納於其中，並且在不同的測試方法間呼叫。

以下為測試方法共用程式碼的範例：

而驗證的部份也可以使用相同的模式來實作，以下是根據官方文件所建立的程式碼：

在以上程式碼第 25 行的 Helper Method 中加入 assert 依據官方文件的說明是為了確保在測試結果輸出時，可以顯示是哪一行驗證結果不符合預期。而照實作的經驗，如果把 assert 移除，發生驗證失敗時不會顯示訊息，甚至顯示測試通過的結果。

這裡有個細節要注意的是 Helper Method 必須要明確的以 void 宣告無傳回值，否則 Spock 可能會依據 Helper Method 的內容解譯產生不符合預期的結果。另外有一個小差異是在 Android Studio 裡，如果使用 '&&' 的語法串起所有的驗證指令，沒有辦法像官方文件所示範的把 '&&' 放在程式碼的最開頭，必須要把 '&&' 放在程式碼的結尾後斷行，否則會顯示語法錯誤的訊息。

Read More

Android Studio dose not highlight task tags

A couple days ago, I upgraded Android Studio to 1.3.1 from 1.3 in OS X 10.10.4. After Android Studio was reopened by upgrade program, I found all the TODO and FIXME task tags were not highlighted. They looked just as normal comments and not listed in TODO Tool Window.

It really annoyed me when I can't identify these task tags at first sight in my code. I use task tags for my suspended work and they can remind me what I still not done. I really don't want to use 'Find' to confirm if I clear all the task tags, it's not smart.

So I opened Settings dialog and tried to find out what was going wrong. In the TODO page, I found cause. All the TODO patterns were cleared and made my custom filters turned into red.

I put these two default patterns as below back into list:

• \btodo\b.*
• \bfixme\b.*

Yes! I got the highlight back. But, after I reopened Android Studio, the pattern list was empty again! So I didn't solve this issue actually. Dose the issue come along with 1.3.1? There was another possibility. I just added custom filters before I upgraded. Since I didn't have Android Studio 1.3 to verify my guess. I decided to delete all the filters in the list. The issue dose not show up any more. I think this is a bug of Android Studio.

But I don't like this solution. I use FIXME and TODO to distinct different tasks. The tasks must be done before go live are tagged with FIXME. The rest of them are tagged with TODO. This solution means I can't switch the list between different priority tasks and focus on them.

To get better solution, I tried many combinations of patterns and filters in TODO page. There is a workaround after many times reopened of Android Studio. It is quit simple, just add a custom pattern into list and set filters what I did. I got the highlight and filter both.

Read More

如何使用 Spock 測試 Static Method

使用 Spock 來開發測試程式除了在之前的文章中提到的：可輔助 BDD 的開發流程、與 JUnit 相容及內建 Data Driven 功能等特性之外，還有另外一項優點是內建了 Mock 的功能。Spock 所提供的 Mock 功能在使用上相當的簡潔，以下是一段範例的程式碼：

由以上的程式碼可以看到只要使用 Mock() 函式就可以對指定的對象進行 Mock 的程序，同時也提供二種彈性的宣告方式，一是把要 Mock 的對象傳入 Mock() 函式(第 3, 4 行)，另一個方式是使用 Mock() 函式來建立執行個體(第 5 行)。第二種 Java-like 的語法主要是希望在編輯程式碼時 IDE 可以提供較好的支援，執行時會以宣告的型別來判定要產生的 Mock 對象之 Instance。

Spock 所提供的 Mock 功能有另一個亮點是不僅能夠針對 Interface，同時也可以使用在一般的 Class 上。如此在進行系統設計時，就可以不用遷就「是否有辦法分開測試」這個問題而要使用大量的 IoC 在設計之中，以致形成了過度設計的情況。在 Mock Class 前，專案必須要引用 cglib-nodep 和 objenesis 這二個函式庫，所以在 build.gradle 的 dependencies 應該像以下所示範的內容：

根據官方文件的說明，如果要驗證目標 Class 與其週邊 Object 互動的過程是否符合像是循序圖所表達的設計內容，可以使用範例程式中所示範之內容。使用的語法規格是：[互動的次數] * [互動的標的]，1 * mockClass.start() 就是驗證 Processor.run 是否有呼叫 ConcreteClass.start()，而且整個 Processor.run 的執行過程中只呼叫一次。

從範例程式中還可以看到，Spock 所提供的 Mock 功能，除了可以用來驗證 Class 間互動過程，同時也具有 Stub 的能力。可以依據呼叫的內容來提供對應的動作，增加了測試程式的靈活性。像範例程式中的第 8 行，當有程式呼中 mockInterface2.getInfo() 時，就會固定傳回 "二號測試字串" 的內容。而在第 15, 16 行，是代表當 Processor.run 的執行過程中，有呼叫到這二個目標函式時所會取得的內容。

雖然 Spock 提供了許多優異的特性，不過，美中不足的地方是目前的版本沒有辦法 Mock 靜態函式。在網路上看了一些討論之後，PowerMock 似乎是一個可用來搭配 Spock 解決這個問題的框架。進一步了解發現 PowerMock 所提供的套件種類繁多，包含了與幾個主流的測試框架整合的功能。而如何在 Gradle 中設定對應的套件，可以讓 Spock 與 PowerMock 協同運作會是一個門檻。

基本上要在 Spock 中使用 PowerMock 來 Mock 靜態函式，會用到 JUnit、Mockito 和 PowerMock 這幾個框架，這使得在設定 build.gradle 內容時更加的棘手。而在測試程式中要把這四個框架整合起來，以便能夠達到 Mock 靜態函式的目的，也是很費心神的一件事。

目前網路上查到的資訊都是片斷的，所以在這裡把相關的資訊統整起來，做為日後研究的起點。以下是 build.gradle 的內容：

以上的套件應該要依照所屬框架更新的狀況來調整對應的版本編號。

在測試程式中，如果有一個以下待測的 Class：

測試程式應該像以下所示範的內容來進行靜態函式的測試：

Read More

解決 Android Studio 中 TODO Highlight 效果消失的問題

前二天在昇級 Android Studio 到 1.3.1 之後，發現了一個奇怪的問題。由於更新後 Android Studio 需要重啟，但在 Android Studio 重啟後，所有 FIXME 及 TODO 的註解無法呈現 Highlight 的效果，同時在 TODO 的 Tool Window 中也搜尋不到任可的 TODO 項目。

在檢查過相關的設定之後，發現 TODO 的 Pattern 設定都被清掉了，難怪沒有辦法顯示 Highlight 的效果，也搜尋不到任何的 TODO 項目，甚至連原本設定的 Filter 都因為失效而顯示紅色。

因為原本就沒有定義額外的 Pattern，所以依照官網的說明，將以下二個預設的 Pattern 加回去後就恢復正常了。

• \btodo\b.*
• \bfixme\b.*

如果是像我一樣有自己新增 Filter 的設定，在加完 Pattern 後還是要再重新修改 Filter 的內容。

事情本來應該就這樣結束了，但其實案情並不單純，就在某個需要下重啟 Android Studio 後，TODO 的所有 Pattern 設定內容又被清除了！

由於這個功能在我進行開發工作時扮演了重要的角色，只好先放下手邊的工作研究一下。之所以重要是因為在開發的時候不一定可以完美地依照需求或設計的順序輸入程式碼，有可能會需要把繕打到一半的程式碼擱著，先去完成其他部份。或是有可能需求或設計還不確定，先以仿造的邏輯來輸入程式碼做為替代，等不確定的部份有明確的結果後再回來調整程式碼。

然而，在此時如果沒有一個有系統的方式來標注程式碼，完全依靠記憶力來找到這些待修改的程式碼，是一個非常不可靠的方式。就算是以重新檢視全部程式碼的方式，也有可能因為分神而漏看，再者程式的規模大到一定的程度，這種方式就變成了一種精神上的折磨。

故意讓程式編譯失敗是一個方法，但程式就會一直處於無法藉由執行來確認程式是否正常運作的狀態。反之，如果當初擱下的程式碼沒有編譯上的問題，就有可能因為開發的負責人忘了修改，造成程式上線一陣子了，才發現程式其實沒有完成就交付給使用者、更嚴重的可能已經造成了大量資料的錯誤。這在一般的軟體開發案子中並不罕見，因為很多的案子是沒有足夠的資源做後續的驗証與測試，以簡單的 UAT 做把關、沒有明顯的問題就放行了。

在註解中使用 FIXME 或 TODO 是解決這項問題的好方案，可以用文字來說明程式碼有問題的地方或是待完成的工作，絕大部份的 IDE 也都提供了 Highlight 的功能。比故意讓程式編譯失敗要有人性，不用費神去回想為何編譯會失敗、程式要如何改正。是可以有效地在開發階段的初期發現問題、降低系統運作問題的風險。當然，這也是要負責程式碼的人有養成良好的習慣才會有效果，所以這個習慣應做為建立團隊文化的重要規則之一。

有了好習慣，一旦沒有了 Highlight 的功能，就沒有辦法很直覺地找到還有問題的程式碼片斷，同時因為 Tool Window 也失效、列不出清單，只能以搜尋的功能來替代，對工作效率來說是有不小的影響。

印象中之前重啟 Android Studio 時並沒有出現同樣的問題，這個情況似乎是在我設定 Filter 之後才發生。我習慣把在上線前一定要修改的項目以 FIXME 標注、可以等上線後再思考解決方案的項目以 TODO 來標注。所以會需要在 TODO 的 Tool Window 中過濾 FIXME 和 TODO，以便了解在上線前還有多少部份的程式碼是沒有完成的，讓我可以專注在 FIXME 的項目上。

根據這個需求我設了二個 Filter 分別只勾取其中一個 Pattern，讓我可以在 TODO 的 Tool Window 來切換不同的清單。為了確認是不是設定 Filter 所產生的問題，我就將 Filter 全數刪除了之後重啟 Android Studio，果不其然 Pattern 這次就沒有被清除掉了，這應該是一個 Android Studio 的 Bug 吧！

但如果是為了解決重啟 Android Studio 後不清除 TODO Pattern，那不就沒有辦法使用 Filter 了嗎!?  好吧！秉持著研究的精神，就在 TODO 的設定畫面中試了幾個不同的 Pattern 及 Filter 的組合，總算發現了一個 Workaround！

原本如果只有預設的二項 Pattern，一旦設定了 Filter 就會有重啟後被清除的現象。但是在預設的二項 Pattern 外再加上一項自訂的 Pattern，依我原本的條件設定 Filter 就可以在重啟 Android Studio 之後保有重啟之前的 Pattern 設定。

目前我工作的環境是 OS X 10.10.4 及 Android Studio 1.3.1，有類似問題的朋友可以參考看看。

Read More