Bob the Builder

This is what CI/CD should've been.

Why Bob

🚧 This is a proof of concept and isn't fully functional yet. 🚧

See the Kanban board to see the roadmap and planned work.

Check out the Getting Started guide.

Build requirements

• Any OS supporting Java and Docker
• JDK 11+
• Boot 2.7+

Running requirements

• Any OS supporting Java and Docker
• JDK 11+
• Docker (latest preferred for optimal performance)

Configuration

Configuration uses the environ library and therefore several variables can be set by specifying them as environment variable or as java system property. Possible variables are:

You can also set configuration in a file called .bob.conf inside your home folder. This is supposed to be an edn-file and will be merged with the config passed as env-vars, system properties and the defaults.

A sample configuration looks like this:

{:server {:port 7777}
 :docker {:uri "unix:///var/run/docker.sock",
          :timeouts {:connect-timeout 1000,
                     :read-timeout 30000,
                     :write-timeout 30000,
                     :call-timeout 40000}},
 :postgres {:host "localhost",
            :port 5432,
            :user "bob",
            :database "bob"}}

The priority of your configuration is following:

1. defaults
2. Environment variables
3. Java system properties
4. Bob's configuration file

Testing, building and running locally

• Clone this repository.
• Install the Build requirements.
• Following steps need Docker:

  • Run boot kaocha to run tests.

  • Start a PostgreSQL server instance locally on port 5432, and ensure a DB bob and a user bob exists on the DB.

      docker run --name bob-db             \
        -p 5432:5432                       \
        -e POSTGRES_DB=bob                 \
        -e POSTGRES_USER=bob               \
        -e POSTGRES_HOST_AUTH_METHOD=trust \
        -d postgres

  • Optionally if Resources and Artifacts are to be used follow the instuctions in the Resources doc and Artifacts doc respectively.

  • Run boot run to start the server on port 7777.

Running integration tests:

Docker is need to be installed for this

One way to run the integration tests is to use docker. In the integration-tests dir, run:

docker-compose up --abort-on-container-exit integration-tests

Note: This will try to create new containers that might have been created by running docker-compose up in the source root. Hence you might need to clean up.

You can also run the tests using strest.

• Start Bob either via boot or docker as mentioned above.
• Install strest

  npm i -g @strest/cli
  

• Run

  strest bob-tests.strest.yaml
  

Note: We're simulating a stateful client on the tests. Which means you'll have to reset the database between each run. (Drop the db docker container and restart it)

For Cursive users:

This project is built using the Boot build tool which is unsupported on Cursive at the moment.

To get it running on Cursive using leiningen:

• Install Boot 2.7+.
• Install Leiningen 2.8+.
• Run boot -d onetom/boot-lein-generate generate to generate a project.clj.
• Open up this directory in Cursive and it should work.
• Happy development!

Extensive Usage + API docs

Join the conversation

For discussions regarding the usage and general development of Bob join the Gitter channel.

For a more Clojure specific discussion we also have a Clojurians Slack channel.

You can come with us with any questions that seem too lengthy for github issues.

Happy Building!