Merge lp:~michael.nelson/rnr-server/improve_readme into lp:rnr-server

[Michael Nelson]

Improve README for setting up developer environment.

Overview
========

Just an update to the README to improve the experience of setting up a development environment.

I've tested all the steps on an fresh Oneiric machine to verify that it works, given that that's what most devs will be using. I currently use a lucid vm, and the setup is mostly the same.

Long-term, I'm keen for a much less error-prone process, like setting up an lc-container and installing packages (rather than virtualenv) to match whatever the current staging/production servers are running.

[Aaron Peachey (aaronp)]

This is much better for new contributors to use and hopefully get up to speed quickly and easily. Thanks Michael

review: Approve

=== modified file 'README'
--- README	2011-09-13 10:13:45 +0000
+++ README	2011-11-10 11:14:23 +0000
@@ -2,21 +2,28 @@
 Setting up the development environment
 ======================================
 
-You can simply use:
-
-  $ fab bootstrap test
-
-to setup and test your development environment. If you haven't used
-pip before or setup its download cache, you may want to do the
-following first so that you don't need to download eggs for each
-branch or project that you work on:
+This branch sets up its own development environment using fabric and
+virtualenv. You can ensure all the required packages are installed on
+your development machine with:
+
+  $ sudo apt-get install fabric python-virtualenv postgresql-server-dev-9.1 python-dev unzip
+
+(python-dev and postgresql-server-dev-9.1 are required for building
+the psycopg driver on Oneiric).
+
+To bootstrap your development environment:
+  $ fab bootstrap
+
+And to verify that all tests are passing in your development environment:
+  $ fab test
+
+If you haven't used pip before or setup its download cache, you may want to do
+the following first so that you don't need to download eggs for each branch or
+project that you work on:
 
   $ mkdir -p ~/.pip/cache
   $ echo -e "[global]\ndownload_cache = ~/.pip/cache" > ~/.pip/pip.conf
 
-If you will also be testing against postgres, you'll also need
-the postgres debversion package (for your version of postgres).
-
 ==================
 Running the server
 ==================
@@ -77,6 +84,48 @@
     >>> response = api.submit_review(review=request)
 
 
+====================================
+Testing and developing with Postgres
+====================================
+
+Currently our production servers run postgresql-8.4 on lucid,
+but until we provide a virtual machine or bootstrap an lx-container
+matching our production OS, we need to satisfy dependencies for
+a dev environment in Oneiric, which means using postgresql-9.1
+(as the debversion plugin is only available for 9.1 in oneiric).
+
+  $ sudo apt-get install postgresql-9.1 postgresql-9.1-debversion
+
+then edit the postgres authentication file to allow trusted access
+to the postgres user (note: obvious security risk for any net-facing
+machine - if you're using a publicly accessible machine, then you should
+know a more secure way of enabling access :P):
+
+  $ sudo vim /etc/postgresql/9.1/main/pg_hba.conf
+
+find the line that looks like:
+
+{{{
+# Database administrative login by Unix domain socket
+local   all             postgres                                peer
+}}}
+
+and change peer to trust, save, then restart postgres with:
+
+  $ sudo service postgresql restart
+
+Finally, for postgres, we need to ensure that the rnr database
+first exists:
+
+  $ psql -U postgres
+  postgres=# create database rnr;
+  CREATE DATABASE
+  postgres=# \q
+
+You can now verify your setup with:
+  $ fab test:pg=true
+
+
 ========================
 Updating a remote server
 ========================