Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

REST'ful web framework in Agda

branch: master
README.md

Lemmachine

Status

A proof of concept of compositonal web app testing (described below) can be shown satisfactorily using this branch. Current work is towards a complete static validator for HTTP 0.9 + 1.0 (a requirement of HTTP 1.1, which will be the subsequent work effort).

Description

Lemmachine is a REST'ful web framework that makes it easy to get HTTP right by exposing users to overridable hooks with sane defaults. The main architecture is a copy of Erlang-based Webmachine, which is currently the best documentation reference (for hooks & general design).

Lemmachine stands out from the dynamically typed Webmachine by being written in dependently typed Agda. The goal of the project is to show the advantages gained from compositional testing by taking advantage of proofs being inherently compositional. See proofs for examples of universally quantified proofs (tests over all possible input values) written against the default resource, which does not override any hooks.

When a user implements their own resource, they can write simple lemmas ("unit tests") against the resource's hooks, but then literally reuse those lemmas to write more complex proofs ("integration tests"). For examples see some reuse of lemmas in proofs.

The big goal is to show that in service oriented architectures, proofs of individual middlewares can themselves be reused to write cross-service proofs (even higher level "integration tests") for a consumer application that mounts those middlewares. See this post for what is meant by middleware.

Another goal is for Lemmachine to come with proofs against the default resource (as it already does). Any hooks the user does not override can be given to the user for free by the framework! Anything that is overridden can generate proofs parameterized only by the extra information the user would need to provide. This would be a major boost in productivity compared to traditional languages whose libraries cannot come with tests for the user that have language-level semantics for real proposition reuse!

Lemmachine currently uses the Haskell Hack abstraction so it can run on several Haskell webservers. Because Agda compiles to Haskell and has an FFI, existing Haskell code can be integrated quite easily.

Setup

Grab Haskell if you don't already have it installed.

cabal update
cabal install hack hack-handler-happstack Agda-executable

Add Cabal binaries to your PATH in ~/.profile: export PATH=~/.cabal/bin:$PATH

Make sure you have Agda version 2.2.6: agda --version

Development

Get Emacs to work with Agda.

Examples of how to use agda-mode.

We use a vendored modified Agda stdlib, so in Emacs: M-x customize-group agda2

Then add this to Agda2 Include Dirs: ./vendor/stdlib/src

Running

Run the following to see this in action for Lemmachine.Default: agda -c --compile-dir=. --ghc-flag=-isrc -i src -i vendor/stdlib/src src/Lemmachine/Default.agda ./Default

In a separate terminal, see a 200 response: curl -X GET -H "Accept: text/html" -i http://localhost:3000 && echo

... compared to a 406 due to requesting an unsupported text/xml media type: curl -X GET -H "Accept: text/xml" -i http://localhost:3000 && echo

... compared to a 405 due to requesting an unsupported POST method: curl -X POST -H "Accept: text/html" -i http://localhost:3000 && echo

All of this is just default behavior and can be overridden by defining appropriate hook methods.

Even though we are working in a language with a lot of verification power, the amount of code required for a complete runnable application remains competitive with more mainstream languages: module ItsSoEasy where open import Lemmachine main = runResolve (toApp [])

Something went wrong with that request. Please try again.