From 15c742b418e4f398c3bb13dc2a512893e8380efc Mon Sep 17 00:00:00 2001 From: Matt Rogers Date: Mon, 24 Oct 2011 12:34:11 -0500 Subject: [PATCH] Update the README for developers. We're using bundler now so update the piece about installing the dependencies. Also do some reformatting at the 80 column boundary in order to avoid having really long lines that don't look quite so nice in a smaller editor window. Add information about running the Test::Unit tests. Remove the reference to the forum since it's not accepting new registrations anymore and users are advised to use the mailing list elsewhere. --- doc/README_DEVELOPERS | 42 ++++++++++++++++++++++++------------------ 1 file changed, 24 insertions(+), 18 deletions(-) diff --git a/doc/README_DEVELOPERS b/doc/README_DEVELOPERS index b0a98d3e..e63c7e44 100644 --- a/doc/README_DEVELOPERS +++ b/doc/README_DEVELOPERS @@ -3,8 +3,7 @@ Tracks is using * github to host the git repository. * Assembla to manage bugs and enhancement request. -* the mailing list to discuss features and development -* the forum to discuss with users +* the mailing list to discuss features and development and interact with users See README for links to the respective sites @@ -12,35 +11,39 @@ Also see the Development pages on the wiki for details on installing, upgrading, 2. Dependencies -The dependencies are maintained by Tracks. For development we try not to vendor them - -Install them using - - rake gems:install RAILS_ENV=development - rake gems:install RAILS_ENV=test - rake gems:install RAILS_ENV=selenium +The dependencies for Tracks are maintained using bundler. Before starting your +tracks instance, you'll need to run 'bundle install' to fetch all the +dependencies 3. Wiki -There are some pointers for setting up your Tracks copy for testing at https://github.com/TracksApp/tracks/wiki/Testing/ +There are some pointers for setting up your Tracks copy for testing at +https://github.com/TracksApp/tracks/wiki/Testing/ 4. SQLITE3 FOR TESTING -By default, tests are configured to run using sqlite3 in memory mode to increase speed. You will need the sqlite3-ruby gem for this. +By default, tests are configured to run using sqlite3 in memory mode to +increase speed. You will need the sqlite3-ruby gem for this. -To avoid showing the migrations as tests are run, add the following to your database.yml below 'database: ":memory:"': +To avoid showing the migrations as tests are run, add the following to your +database.yml below 'database: ":memory:"': verbosity: quiet -If you want to run tests using another database, that's fine, too. Just change your database.yml accordingly. +If you want to run tests using another database, that's fine, too. Just change +your database.yml accordingly. -5. SELENIUM TESTS (Selenium on Rails) +5. Test::Unit tests -This testing style is deprecated and tests are being moved over to Selenium via Cucumber. +To run the Test::Unit tests run -See the wiki for more information to run the tests that are not yet migrated: https://github.com/TracksApp/tracks/wiki/Testing + rake test -6. RSPEC tests +Running the above command will run through the unit, functional, and +integration tests for Tracks. Use 'rake -T' to see a list of all rake tasks to +determine how to run each section of tests separately. + +6. RSpec tests To run the RSpec tests run @@ -56,4 +59,7 @@ and for those using javascript/ajax use rake cucumber:selenium -See the wiki for more information on testing: https://github.com/TracksApp/tracks/wiki/Testing \ No newline at end of file +In order to run the selenium tests, you'll need to have Firefox 3.x installed. +Newer versions won't work. + +See the wiki for more information on testing: https://github.com/TracksApp/tracks/wiki/Testing