kerodon

kerodon is an interaction and testing library for ring html based apps. It is intented to look like the interaction a user would have. It is inspired by capybara.

Dependency Information

kerodon is available from clojars.

Leiningen

[kerodon "0.0.6"]

Maven (requires adding clojars repo):

<dependency>
  <groupId>kerodon</groupId>
  <artifactId>kerodon</artifactId>
  <version>0.0.6</version>
</dependency>

Usage

Example

(ns myapp.test.integration
  (:use [kerodon.core]
        [kerodon.test]
        [clojure.test])
  (:require [clojure.java.io :as io]))

(deftest user-can-login-and-upload-picture
  ;imagine ring-app is a login required picture upload
  (-> (session ring-app)
      (visit "/")
      (follow "login")
      (fill-in "User:" "username")
      (fill-in "Password:" "wrong-password")
      (press "Login")
      (follow-redirect)
      (has (missing? [:#no-such-element]) "User shouldn't see the no-such-element")
      (within [:#user_name]
        (has (text? "username")
             "Username shows up in #user_name when logged in"))
      (press "Login")
      (follow "update profile")
      (has (attr? [:form] :id "profile"))
      (has (value? "Email:" "example@example.org")
           "Email field defaults to user's email")
      (attach-file "Picture:" (io/file "/tmp/foo.png"))
      (follow-redirect)
      (within [:#picture]
        (has (text? "foo.png")
             "Picture name is near picture."))
      (within [:#content]
        (has (missing? [:#navigation])))))

Interaction

The api namespace for interaction is kerodon.core. If you are using kerodon in tests you may want to have (:use [kerodon.core]) in your ns declaration. All examples below assume so.

kerodon is based on peridot, and designed to be used with ->.

Initialization

You can create an initial state with session.

(session ring-app) ;Use your ring app

Navigation

You can use visit to send a request to your ring app.

(-> (session ring-app) ;Use your ring app
    (visit "/"))

You can pass extra arguments like you can to peridot.core/request, but this is not recommended.

kerodon will not follow redirects automatically. To follow a redirect use follow-redirect. This will throw an IllegalArgumentException when the last response was not a redirect.

(-> (session ring-app) ;Use your ring app
    (visit "/redirect")
    (follow-redirect))

You can use follow to follow a link.

(-> (session ring-app) ;Use your ring app
    (visit "/")
    (follow "login"))

The selector can be the text of the link, or a vector of css elements.

Form interaction

You can use fill-in to fill in a form field.

(-> (session ring-app) ;Use your ring app
    (visit "/")
    (follow "login")
    (fill-in "User:" "username")
    (fill-in "Password:" "password")

The selector can be the text or css of a label with a for element, or the css of the field itself.

You can use attach-file to fill in a file field.

(-> (session ring-app) ;Use your ring app
    (visit "/")
    (follow "upload")
    (attach-file "Picture:" (clojure.java.io/file "/tmp/foo")))

The selector can be the text or css of a label with a for element, or the css of the field itself.

You can use press to submit a form.

(-> (session ring-app) ;Use your ring app
    (visit "/")
    (follow "login")
    (fill-in "User:" "username")
    (fill-in "Password:" "password")
    (press "Login"))

The selector can be the text or css of a submit button.

Within

Sometimes you might have multiple html elements that can match. You can restrict the search space using within.

(-> (session ring-app) ;Use your ring app
    (visit "/")
    (within [:#signin2]
      (press "Login")))

Testing

The api namespace for testing is kerodon.test. This uses the same machinery as clojure.test. If you are using kerodon in tests you may want to have (:use [kerodon.test]) in your ns declaration. All examples below assume so.

The main function is has. It allows the verifications to compose using ->. It requires one of the verification functions, and an optional error message.

You can use status? to validate the status code of the last response. You can use text? to validate the text in the page. You can use value? to validate the value of a field. The selector can be the text or css of a label with a for element, or the css of the field itself. You can use attr? to validate an attribute's value.

(-> (session ring-app)
    (visit "/hello")
    (has (status? 200)
         "page is found")
    (has (text? "hello world")
         "page says hello world"))

(-> (session ring-app)
    (visit "/comment/new")
    (has (value? "name" "anonymous")
         "comments default to anonymous")
    (has (value? "comment" "")
         "comments default empty"))

(-> (session ring-app)
    (visit "/comment/new")
    (has (attr? [:form] :class "comments")))

These should all work with within.

Transactions and database setup

kerodon runs without an http server and, depending on your setup, transactions can be used to rollback and isolate tests. Some fixtures may be helpful:

(use-fixtures :once
              (fn [f]
                (clojure.java.jdbc/with-connection db (f))))
(use-fixtures :each
              (fn [f]
                (clojure.java.jdbc/transaction
                 (clojure.java.jdbc/set-rollback-only)
                 (f))))

Building

leiningen version 2 is used as the build tool. lein2 all test will run the test suite against clojure 1.3 and a recent 1.4-beta.

License

Distributed under the Eclipse Public License, the same as Clojure.

aredington/kerodon