If you’re using (and have configured) SQL statement and lock timeout, it would be good to verify how the service behaves when those timeouts happen.
Integration tests can help us verify the behavior. However, the problem with integration tests is that they make most sense in the context of your project. Without the supporting code they are devoid of information that makes them tick. Let’s try it out anyway. Here are the assumptions for the tests below:
- A service executing the tests is a Ring based service.
- An integration test will execute (integrate) all the code below the top-level
ring handler (usually called
app). This is the function given to
call-app(below) will simply run the
appwith the given mock request.
db(below) is an SQL data source using a test DB.
- It’s hard to provoke statement and lock timeouts in normal handlers. So we’ll cheat and replace the real handler with our own code that provokes them in a clear manner.
This is relatively straight forward.
(deftest db-statement-timeout (let [f (fn [_] (jdbc/with-transaction [tx db] (jdbc/execute! tx ["SET LOCAL statement_timeout = '10ms'"]) (jdbc/execute! tx ["SELECT pg_sleep(0.1)"])))] (with-redefs [user-handlers/create f] (let [response (call-app (mock/request :post "/api/v1/users"))] ;; assert response has the appropriate error message ))))
Lock timeouts usually happen when two concurrent requests try to modify the same DB resource at the same time. That’s what we want to simulate. This means coordinating threads in a deterministic manner.
(deftest db-lock-timeout (jdbc/execute! db ["INSERT INTO user (email) VALUES (?)" "email@example.com"]) (let [f (fn [_] (let [row-locked (CyclicBarrier. 2) test-done (CountDownLatch. 1)] (future ;; Simulating another HTTP thread locked the same row (jdbc/with-transaction [tx db] (jdbc/execute! tx ["UPDATE user SET email = ?" "firstname.lastname@example.org"]) (.await row-locked) (.await test-done))) (.await row-locked) (try (jdbc/with-transaction [tx db] (jdbc/execute! tx ["SET LOCAL lock_timeout = '10ms'"]) ;; Fails because another transaction locked this row (jdbc/execute! tx ["UPDATE user SET email = ?" "email@example.com"])) (finally (.countDown test-done)))))] (with-redefs [user-handlers/create f] (let [response (call-app (mock/request :post "/api/v1/users"))] ;; assert response has the appropriate error message ))) ;; cleanup after the test, perhaps in try/finally. e.g. deleting the user )