[open-ils-commits] [GIT] Evergreen ILS branch rel_2_5 updated. c925dc2564141656f41cd298de2ed031e0e55b6b

[Evergreen Git]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".

The branch, rel_2_5 has been updated
       via  c925dc2564141656f41cd298de2ed031e0e55b6b (commit)
      from  b0711f572cab48341af687a80bf721241e616859 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit c925dc2564141656f41cd298de2ed031e0e55b6b
Author: Dan Scott <dscott at laurentian.ca>
Date:   Thu Nov 14 18:17:58 2013 -0500

    Add basic docs for testing with pgTAP
    
    This can be expanded to describe how to create pgTAP tests later. For
    now, let's help people actually set up their environment and test.
    
    Signed-off-by: Dan Scott <dscott at laurentian.ca>

diff --git a/docs/development/pgtap.txt b/docs/development/pgtap.txt
new file mode 100644
index 0000000..2e93926
--- /dev/null
+++ b/docs/development/pgtap.txt
@@ -0,0 +1,39 @@
+Developing with pgTAP tests
+===========================
+
+Setting up pgTAP on your development server
+-------------------------------------------
+
+Currently, Evergreen pgTAP tests expect a version of pgTAP (0.93)
+that is not yet available in the packages for most Linux distributions.
+Therefore, you will have to install pgTAP from source as follows:
+
+. Download, make, and install pgTAP on your database server. pgTAP can
+  be downloaded from http://pgxn.org/dist/pgtap/ and the instructions
+  for building and installing the extension are available from
+  http://pgtap.org/documentation.html
+
+. Create the pgTAP extension in your Evergreen database. Using `psql`,
+  connect to your Evergreen database and then issue the command:
++
+[source,sql]
+------------------------------------------------------------------------------
+CREATE EXTENSION pgtap;
+------------------------------------------------------------------------------
+
+Running pgTAP tests
+-------------------
+The pgTAP tests can be found in subdirectories of `Open-ILS/src/sql/Pg/`
+as follows:
+
+* `t`: contains pgTAP unit tests that can be run on a freshly installed
+  Evergreen database
+* `live_t`: contains pgTAP unit tests meant to be run on an Evergreen
+  database that also has had the "concerto" sample data loaded on it
+
+To run the pgTAP unit and regression tests, use the `pg_prove` command.
+For example, from the Evergreen source directory, you can issue the
+command:
+`pg_prove -U evergreen Open-ILS/src/sql/Pg/t Open-ILS/src/sql/Pg/t/regress`
+
+
diff --git a/docs/root.txt b/docs/root.txt
index 2168940..2108c6d 100644
--- a/docs/root.txt
+++ b/docs/root.txt
@@ -391,6 +391,7 @@ communication protocols and standards used in Evergreen.
 // Push titles down one level.
 :leveloffset: 1
 
+include::development/pgtap.txt[]
 include::development/intro_opensrf.txt[]
 include::development/updating_translations_launchpad.txt[]
 

-----------------------------------------------------------------------

Summary of changes:
 docs/development/pgtap.txt |   39 +++++++++++++++++++++++++++++++++++++++
 docs/root.txt              |    1 +
 2 files changed, 40 insertions(+), 0 deletions(-)
 create mode 100644 docs/development/pgtap.txt


hooks/post-receive
-- 
Evergreen ILS