Skip to content
This repository has been archived by the owner on Aug 9, 2020. It is now read-only.

Latest commit

 

History

History
97 lines (66 loc) · 3.57 KB

README.md

File metadata and controls

97 lines (66 loc) · 3.57 KB
Raw

Gorgon Build Status Gem Version Code Climate

About

Gorgon provides a method for distributing the workload of running ruby test suites. It relies on amqp for message passing, and rsync for the synchronization of source code.

Installing Gorgon

This tutorial explains how to install gorgon in a sample app.

Installing listener as a Daemon process (Ubuntu 9.10 or later)

  1. run gorgon install_listener from the directory where gorgon.json is
  2. run gorgon ping to check if the listener is running

Gotchas

  • if you get cannot load such file -- qrack/qrack (LoadError), just add gem 'gorgon', '~> 0.8.4' , :group => :remote_test to your Gemfile, and run tests using bundle exec gorgon
  • If gorgon install_listener didn't work for you, you can try these steps

Also note that the steps in the tutorial are not meant to work on every project, they will only give you initial settings. You will probably have to modify the following files:

  • gorgon.json
  • gorgon_secret.json
  • {test, spec}/gorgon_callbacks/gorgon_callbacks.rb
  • gorgon_listener.json (located in your project root or in ~/.gorgon/)

If you modify ~/.gorgon/gorgon_listener.json, make sure you restart the listener.

Configuration

gorgon.json

This file contains project-specific settings for gorgon, such as:

  • The connection information for AMQP
  • The connection information for File Server
  • Information about how clients can rsync the working directory (optional). See more info here
  • Files that can be excluded by rsync
  • Callback file containing Ruby code to be used as callbacks
  • A glob for generating the list of test files
  • The file used for Originator's logs

See gorgon.json example for an example file.

gorgon_secret.json (optional)

This optional file contains sensitive information such as passwords that cannot be put in gorgon.json.

See gorgon_secret.json example for an example file.

gorgon_listener.json

This file contains the listener-specific settings, such as:

  • The connection information for AMQP
  • How many worker slots are provided by this listener
  • The file used for logs

See gorgon_listener.json example for more details.

Contributing

Read overview architecture

Requirements:

Prepare your environment

  • Execute ./run_dev_environment.sh
  • In a new terminal tab, execute ./run_listener.sh

NOTE: If you make changes changes to listener code, you must restart ./run_listener.sh for those changes to take effect

Running all tests

  • ./run_test.sh

Running gorgon using the spec/dummy project

  • ./run_gorgon.sh

Releasing to RubyGems

  1. Update version.rb
  2. Run rake release

Credits

Gorgon is maintained by:

  • Justin Fitzsimmons
  • Arturo Pie

Gorgon is funded by Nulogy Corp. Thank you to all the contributors.