CRUSH

Installation

To build the crush Docker image:

  docker build -t crush .

Before using crush, you'll have to edit config.json to specify your connection to Aquarium. See config-example.json.

And to run it and log log into it

  docker run -v "$PWD:/home/crush" -it crush bash

The -v option mounts the current directory into the docker image's filesystem so you can access your local files forom within the image.

Once logged into the docker instance, you should be able to execute:

crush

Testing the Connection

Do

crush ping

to see if crush can connect to your server. Currently, crush only uses the "staging" server, so that's the one to specify correctly in config.json.

Getting Statistics

Do

crush stats
crush stats -mr
crust stats -md

to see statistics for various operation types. The mr option shows the top 10 most recently exectued operation types. The md option shows the top 10 most successfully completed operation types. This could be used to decide where to put your efforts in improving the protocol code base.

Pulling Code

To get all the Operation Type code and Library code off of an instance do

crush pull

For now this will pull from your staging server. If will create a directory structure that looks like this

staging/
  Category One/
    lib/
      Lib1/
        info.json
        source.rb
      Lib2/
        info.json
        source.rb

    op/
      OpType1/
        documentation.md
        info.json
        precondition.rb
        protocol.rb
        test.rb
    op/
      OpType2/
        documentation.md
        info.json
        precondition.rb
        protocol.rb
        test.rb
  Category Two/
    ...

You can version control this whole thing with git, for example, doing

cd staging
git init
git add .
git commit -m "Initial commit"

You can also pull a certain operation type by doing

crush pull "[operation type]"

Pushing Code

After editing code, you can push it back to an Aquarium instance. On the command line, change to a directory containing either library code or operation type code. Then do

crush push

In a library code directory, this command will push the source.rb file to the instance. In an operation type directory, this command will push protocol.rb, precondition.rb, test.rb, and documentation.md back to the instance.

Testing Code

To test code, change into an operation type directory and do

crush test