docs: Add a note about how to run tests

[patchwork] / docs / INSTALL

diff --git a/docs/INSTALL b/docs/INSTALL
index 4c178efe1c8dc9f7ef3c489d51c8edd08f1b0602..d40ddd2e7d072528728dbee47c4204a45b36e2ac 100644 (file)
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -3,16 +3,17 @@ Deploying Patchwork
 Patchwork uses the django framework - there is some background on deploying
 django applications here:
 
 Patchwork uses the django framework - there is some background on deploying
 django applications here:
 

- http://www.djangobook.com/en/1.0/chapter20/
+ http://www.djangobook.com/en/2.0/chapter12/

 
 You'll need the following (applications used for patchwork development are
 in brackets):
 
   * A python interpreter
 
 You'll need the following (applications used for patchwork development are
 in brackets):
 
   * A python interpreter

-  * django
+  * django >= 1.5

   * A webserver (apache)
   * mod_python or flup
   * A webserver (apache)
   * mod_python or flup

-  * A database server (postgresql)
+  * A database server (postgresql, mysql)
+  * relevant python modules for the database server (e.g: python-mysqldb)

 
 1. Database setup
 
 
 1. Database setup
 


@@ -51,19 +52,43 @@ in brackets):
         settings, using local_settings.py (see below) to override the defaults
         in settings.py:
 
         settings, using local_settings.py (see below) to override the defaults
         in settings.py:
 

-        DATABASE_ENGINE = 'postgresql_psycopg2'
-        DATABASE_NAME = 'patchwork'
-        DATABASE_USER = 'patchwork'
-        DATABASE_PASSWORD = 'my_secret_password
-        DATABASE_HOST = 'localhost'
-        DATABASE_PORT = ''
+        DATABASES = {
+            'default': {
+                'ENGINE': 'django.db.backends.postgresql_psycopg2',
+                'HOST': 'localhost',
+                'PORT': '',
+                'USER': 'patchwork',
+                'PASSWORD': 'my_secret_password',
+                'NAME': 'patchwork',
+            },
+        }

 
     For MySQL:
         $ mysql
 
     For MySQL:
         $ mysql

-        > CREATE DATABASE 'patchwork';
+        > CREATE DATABASE 'patchwork' CHARACTER SET utf8;

         > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
         > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
 
         > CREATE USER 'www-data'@'localhost' IDENTIFIED BY '<password>';
         > CREATE USER 'nobody'@'localhost' IDENTIFIED BY '<password>';
 

+       Once that is done, you need to tell Django about the new Database
+       settings, using local_settings.py (see below) to override the defaults
+       in settings.py:
+
+        DATABASES = {
+            'default': {
+                'ENGINE': 'django.db.backends.mysql',
+                'HOST': 'localhost',
+                'PORT': '',
+                'USER': 'patchwork',
+                'PASSWORD': 'my_secret_password',
+                'NAME': 'patchwork',
+                'TEST_CHARSET': 'utf8',
+            },
+        }
+
+        TEST_CHARSET is used when creating tables for the test suite. Without
+        it, tests checking for the correct handling of non-ASCII characters
+        fail.
+

 2. Django setup
 
         Set up some initial directories in the patchwork base directory:
 2. Django setup
 
         Set up some initial directories in the patchwork base directory:


@@ -73,37 +98,14 @@ in brackets):
         lib/packages is for stuff we'll download, lib/python is to add
         to our python path. We'll symlink python modules into lib/python.
 
         lib/packages is for stuff we'll download, lib/python is to add
         to our python path. We'll symlink python modules into lib/python.
 

-        At the time of release, patchwork depends on django version 1.0 or
+        At the time of release, patchwork depends on django version 1.5 or

         later. Your distro probably provides this. If not, do a:
 
          cd lib/packages
         later. Your distro probably provides this. If not, do a:
 
          cd lib/packages

-         svn checkout http://code.djangoproject.com/svn/django/tags/releases/1.2
+         git clone https://github.com/django/django.git -b stable/1.5.x

          cd ../python
          ln -s ../packages/django/django ./django
 
          cd ../python
          ln -s ../packages/django/django ./django
 

-        We also use the django-registration infrastructure from
-        http://bitbucket.org/ubernostrum/django-registration/. Your distro
-        may provide the django-registration python module (in Ubuntu/Debian it's
-        called 'python-django-registration'). If not, download the module
-        and symlink it to lib/python/ :
-
-         cd lib/packages/
-         hg clone http://bitbucket.org/ubernostrum/django-registration/
-         cd ../python
-         ln -s ../packages/django-registration/registration ./registration
-
-        We also use some Javascript libraries:
-
-         cd lib/packages
-         mkdir jquery
-         cd jquery
-         wget http://jqueryjs.googlecode.com/files/jquery-1.3.min.js
-         wget http://www.isocra.com/articles/jquery.tablednd_0_5.js.zip
-         unzip jquery.tablednd_0_5.js.zip jquery.tablednd_0_5.js
-         cd ../../../htdocs/js/
-         ln -s ../../lib/packages/jquery/jquery-1.3.min.js ./
-         ln -s ../../lib/packages/jquery/jquery.tablednd_0_5.js ./
-

         The settings.py file contains default settings for patchwork, you'll
         need to configure settings for your own setup.
 
         The settings.py file contains default settings for patchwork, you'll
         need to configure settings for your own setup.
 


@@ -115,6 +117,8 @@ in brackets):
           ADMINS
           TIME_ZONE
           LANGUAGE_CODE
           ADMINS
           TIME_ZONE
           LANGUAGE_CODE

+          DEFAULT_FROM_EMAIL
+          NOTIFICATION_FROM_EMAIL

 
         You can generate the SECRET_KEY with the following python code:
 
 
         You can generate the SECRET_KEY with the following python code:
 


@@ -122,12 +126,6 @@ in brackets):
           chars = string.letters + string.digits + string.punctuation
           print repr("".join([random.choice(chars) for i in range(0,50)]))
 
           chars = string.letters + string.digits + string.punctuation
           print repr("".join([random.choice(chars) for i in range(0,50)]))
 

-        If you have patchwork installed in somewhere other than /srv/patchwork,
-        you'll also need to define:
-
-          MEDIA_ROOT
-          TEMPLATE_DIRS
-

         If you wish to enable the XML-RPC interface, add the following to
         your local_settings.py file:
 
         If you wish to enable the XML-RPC interface, add the following to
         your local_settings.py file:
 


@@ -225,6 +223,39 @@ fastcgi:
 
      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 
 
      sudo -u nobody /srv/patchwork/apps/patchwork/bin/parsemail.sh < mail
 

+7. Set up the patchwork cron script
+
+    Patchwork uses a cron script to clean up expired registrations, and
+    send notifications of patch changes (for projects with this enabled).
+
+    Something like this in your crontab should work:
+
+      # m h  dom mon dow   command
+      PYTHONPATH=apps:.
+      DJANGO_SETTINGS_MODULE=settings
+      */10 * * * * cd patchwork; python apps/patchwork/bin/patchwork-cron.py
+
+
+    - the frequency should be the same as the NOTIFICATION_DELAY_MINUTES
+    setting, which defaults to 10 minutes.
+
+8. Optional: Configure your VCS to automatically update patches
+
+    The tools directory of the patchwork distribution contains a file
+    named post-receive.hook which is an example git hook that can be
+    used to automatically update patches to the Accepted state when
+    corresponding comits are pushed via git.
+
+    To install this hook, simply copy it to the .git/hooks directory on
+    your server, name it post-receive, and make it executable.
+
+    This sample hook has support to update patches to different states
+    depending on which branch is being pushed to. See the STATE_MAP
+    setting in that file.
+
+    If you are using a system other than git, you can likely write a
+    similar hook using pwclient to update patch state. If you do write
+    one, please contribute it.

 
 Some errors:
 
 
 Some errors: