Clojureアプリケーションで外界との境界をどう書くか

一般的なアプリケーションを作っている場合、外部のシステムというのは必ず存在しています。それはミドルウェアの形をしていたり、連携しないといけないAPIの形をしていたり様々な形で私たちの目の前に現れます。

このときに役立つのがboundariesという考え方です。文字通り境界ということです。

ちなみにこの考え方を取り込もうとした話は、一度書いたのですがそのときはプログラムを半自動生成したところに主眼を置いたのであまり説明していませんでした。

See also:

まあそんなことは分かっている方のほうが多いとは思うので、具体的な実装の話をしていきましょう。

外界との境界を実装する

code:clojure

これはただの関数です。ただし、この関数はデータベースに依存します。そのためこの関数を実行するためには、必ずデータベースへの接続情報を渡さないといけないですし、実際に接続可能なデータベースを必要とします。

例えば、実データベースをテスト時に利用する場合、テスト用のデータベースが必要になりますし、テストケース毎にまっさらな状態を作り直って、さらにテストデータを登録する必要があるため、このあたりの処理が煩雑になりやすいです。

------------------------

ちなみに実データベースで高速にテストを実行する話は昔書きました。

See also:

------------------------

code:clojure

code:clojure

(defprotocol UserDatabase

実装の詳細は次のように書けます。

code:clojure

(extend-protocol UserDatabase

SQLBoundary

こうしておけばこのように利用することができるようになります。

code:clojure

(let [db (map->SQLBoundary {:db-spec {:dbtype "postgresql"

:dbname "mydatabase"

:user "postgres"}})]

(get-user db "ayato-p"))

;; => {:username "ayato-p"}

これだと何がどう嬉しくなったのか見た目で分かり難いですが、テストを書いてみれば分かります。

外界との境界をモックしてテストする

code:clojure

(def simple-user-database-mock

(assoc m username user))

{}

[{:username "ayato-p"}

{:username "athos"}])]

(reify sut/UserDatabase

(get database username)))))

code:clojure

(t/deftest simple-mocking-test

(t/is (= (sut/get-user simple-user-database-mock "athos")

{:username "athos"}))

(t/is (= (sut/get-user simple-user-database-mock "ayato-p")

{:username "ayato-p"})))

また、このようなことをしたくなることは多いので、それ専用のライブラリがあります。

code:clojure

(t/deftest shrubbery-stub-test

(let [user-database-stub (shrubbery/stub

sut/UserDatabase

{:get-user {:username "ayato-p"}})]

(t/is (= (sut/get-user user-database-stub "ayato-p")

{:username "ayato-p"}))))

(t/deftest shrubbery-mock-test

(let [user-database-mock (shrubbery/mock

sut/UserDatabase

{:get-user {:username "ayato-p"}})]

(t/is (not (shrubbery/received? user-database-mock sut/get-user)))

(t/is (= (sut/get-user user-database-mock "ayato-p")

{:username "ayato-p"}))

(t/is (= (shrubbery/call-count user-database-mock sut/get-user) 1))

(t/is (shrubbery/received? user-database-mock sut/get-user))

See also: