Difference between revisions of "GOCDB/Regional Module Technical Documentation"

From EGIWiki
Jump to: navigation, search
m
m (Download)
 
(225 intermediate revisions by 6 users not shown)
Line 1: Line 1:
This page is the main technical documentation for GOCDB-4 regional module
+
{{Template:Op menubar}} {{Template:GOCDB_menubar}} {{TOC_top}} This page is the main install documentation for GOCDB Version 5
  
'''SUPPORTED VERSION: GOCDB-4.0.d7 - build GOCDB-4.0-4.d7.noarch'''
+
== Download  ==
  
== Deployment ==
+
'''LATEST VERSION: GOCDBv5.6''' <br>
 +
https://github.com/GOCDB/gocdb
  
=== System prerequisites ===
+
For install see:
 +
https://github.com/GOCDB/gocdb/blob/master/INSTALL.md
  
GOCDB-4 regional module has two components: a database and a web front end. Both components can work on the same machine but it is very likely that in most environments they will be separated. This is what we would advise anyway. Machine requirements for these 2 components are described below.
+
<!--
 +
*Packaged V5.2: https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/tags/gocdb/GOCDB-5.2/GocDB-5.2.zip
 +
*svn v5.2:
 +
<pre>svn co https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/tags/gocdb/GOCDB-5.2
 +
</pre>
 +
*Latest dev/trunk svn:
 +
<pre>svn checkout https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/branches/gocdb/MultipleEndpointsGocDB/</pre>
 +
-->
  
==== Database ====
+
<!--<pre>svn checkout https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/branches/gocdb/Doctrine%20Web%20Portal</pre> -->
 +
<!--Note, for svn co, if you are asked to authenticate with a client certificate as below, you can dismiss by pressing Enter
 +
<pre>Authentication realm: https://www.sysadmin.hep.ac.uk:443
 +
Client certificate filename: &lt;ENTER to dismiss&gt;
 +
</pre>
 +
<br> '''OLD v4.4 Install doc has been relocated''' <br>
  
* '''Required database:''' Oracle 10g or higher (note: Oracle 10g Express edition, which comes with a free license, is perfectly suitable)
+
*https://wiki.egi.eu/wiki/GOCDB/v4/Regional_Module_Technical_Documentation
* '''Required space:''' 150 MB
 
  
==== Web frontend ====
+
<br>
 +
-->
 +
<br>
 +
 
 +
<!--
 +
== Prerequisites==
 +
=== System prerequisites  ===
 +
 
 +
GOCDB-5 has two components: a database and a web front end. Both components can work on the same machine but it is very likely that in most environments they will be separated. This is what we would advise. Machine requirements for these 2 components are described below.
 +
 
 +
==== Database  ====
 +
 
 +
Version 5 of GocDB uses Doctrine ORM (Object Relational Mapping) as it's interface to the datastore. This allows GocDB to be deployed to either a Oracle or MySQL database (Doctrine also supports other DBs but these are untested).
 +
 
 +
Oracle:
 +
 
 +
*Required database: Oracle 11g or higher (note: the free Oracle 11g XE Express Editions which comes with a  free license is perfectly suitable. 10g may also work but is untested)
 +
*Required space: 150 MB Dowload free Oracle XE from the following link and follow the installation instructions: http://www.oracle.com/technetwork/database/express-edition/overview/index.html
 +
*For gocdb admin tasks, we also recommend the SQL Developer tool.
 +
 
 +
<br>
 +
 
 +
MySQL:
 +
 
 +
*Required database: Any version of MySQL will work including the free MySQL Community Server edition
 +
*Required space: See MySQL install guide:http://dev.mysql.com/doc/refman/5.7/en/installing.html
 +
 
 +
<br>
 +
 
 +
==== Web frontend ====
  
 
The machine to use as the web frontend will need the following:  
 
The machine to use as the web frontend will need the following:  
  
* '''Apache http server''' version 2.0 or higher.
+
*'''Apache http server'''&nbsp;version 2.2 or higher.  
* '''PHP''' version 5.2 or higher.
+
*'''PHP''' version 5.3 or higher (version &lt;=5.2 has some OOP related bugs).  
** '''PHP''' oci8 extension
+
**If using Oracle: '''PHP oci8 extension''' and Oracle Instant client v10 or higher (downloadable from Oracle website)
** libxml2 and DOM support for '''PHP''' (Note: On RHEL, PHP requires the PHP XML RPM to be installed for this component to function).
+
**'''libxml2 and DOM support''' for PHP (Note: On RHEL, PHP requires the PHP XML RPM to be installed for this component to function).  
** OpenSSL Extension for '''PHP'''  
+
**'''OpenSSL Extension''' for PHP
* '''Oracle Instant client''' version 10 or higher (downloadable from Oracle website)
+
*'''An X509 host certificate''' for the machine
* a X509 host certificate for the machine
+
 
 +
<br>
 +
 
 +
==== Optional  ====
 +
 
 +
*'''PHP Unit''' for testing developments
 +
 
 +
<br>
 +
 
 +
== Preparing your installation  ==
 +
 
 +
=== Database preparation  ===
 +
 
 +
GocDB v5 comes with deploy script which will create the DB schema for GocDB (i.e. export the DDL to create the tables and sequences in the DB). The only preperation is that you have setup a database user/account in your chosen RDBMS and have the user access details which are required later in the installation when configuring GocDB for deployment.&nbsp;
 +
 
 +
Details for creating GOCDB user on specific RDBMS:
 +
* [[GOCDB/Regional_Module_Technical_Documentation/DeployOnOracle|Deploy on Oracle Details]]
 +
* [[GOCDB/Regional_Module_Technical_Documentation/DeployOnMySQL|Deploy on MySQL Details]]
 +
 
 +
=== GOCDB file system  ===
 +
 
 +
Place the GocDB source folder on your chosen web server.
 +
 
 +
=== PEAR  ===
 +
 
 +
Pear is recommended to install Doctrine and PHPUnit, many builds of PHP come pre-bundled with PEAR.&nbsp;
 +
 
 +
[http://pear.php.net/manual/en/installation.getting.php http://pear.php.net/manual/en/installation.getting.php]
 +
 
 +
Verify the PEAR installation by running pear version on the command line.
 +
<pre>$ pear version
 +
PEAR Version: 1.9.4
 +
PHP Version: 5.3.8
 +
Zend Engine Version: 2.3.0
 +
Running on: Windows NT ESCPC0095 6.1 build 7601 (Windows 7 Business Edition Service Pack 1) i586
 +
</pre>
 +
=== Doctrine  ===
 +
 
 +
Doctrine can be installed using PEAR. First add the Doctrine and Symfony channels to PEAR:
 +
<pre>$pear channel-discover pear.doctrine-project.org
 +
$pear channel-discover pear.symfony.com
 +
</pre>
 +
Then install Doctrine and it's dependencies:
 +
<pre>$pear install --alldeps doctrine/DoctrineORM
 +
</pre>
 +
Verify the Doctrine installation by running "doctrine --version" on the command line (or doctrine.bat --version if on Win):
 +
<pre>$ doctrine --version
 +
Doctrine Command Line Interface version 2.3.3
 +
</pre>
 +
[http://docs.doctrine-project.org/en/latest/ More information on Doctrine can be found here at the Doctrine2 site.]
 +
 
 +
=== PHPUnit  ===
 +
 
 +
PHPUnit is an optional choice for GOCDB users. GOCDB5 includes a test suite of unit tests that can be used to verify buisness logic and database connections for a deployed instance of GOCDB. In addition developers extending and modifying GOCDB can write unit tests for their own developements. To install PHPUnit use PEAR:
 +
<pre>$pear clear-cache
 +
$pear config-set auto_discover 1
 +
$pear install pear.phpunit.de/PHPUnit
 +
</pre>
 +
This install can then be verified using "phpunit --version" on the command line:
 +
<pre>$ phpunit --version
 +
PHPUnit 3.7.27 by Sebastian Bergmann.
 +
</pre>
 +
[http://phpunit.de/manual/current/en/automating-tests.html More information on PHPUnit can be found via the PHPUnit documenation here.]
 +
 
 +
== Deploying GOCDB5  ==
 +
 
 +
=== Database Connection ===
 +
You should now have all the required blocks in place to deploy GOCDB V5. To Deploy the database schema to your desired database using Doctrine:
 +
* Navigate to to '<gocDBSrcHome>/lib/Doctrine' folder.
 +
* Locate the provided template file: ''bootstrap_doctrine_TEMPLATE.php''. In this file you will find three blocks of code commented out, once for each of the supported databased, SQLite, Oracle and MySQL as shown below:
 +
* '''Copy this file to''' ''bootstrap_doctrine.php'' in the same dir as the template file and modify to specify your chosen DB connection details.
 +
 
 +
<pre>
 +
Un-comment the area for your chosen database and fill in the details for your chosen database.
 +
 
 +
        ///////////////////////SQLITE CONNECTION DETAILS/////////////////////////////////////////////
 +
//      $conn = array(
 +
//         'driver' => 'pdo_sqlite',
 +
//         'path' => __DIR__ . '/db.sqlite',
 +
//      );
 +
        /////////////////////////////////////////////////////////////////////////////////////////////
 +
 
 +
 +
///////////////////////ORACLE CONNECTION DETAILS////////////////////////////////////////////
 +
// $conn = array(
 +
// 'driver' => 'oci8',
 +
// 'user' => 'docsvn',
 +
// 'password' => 'doc',
 +
// 'host' => 'localhost',
 +
// 'port' => 1521,
 +
        //              /*'service' = true,*/  //This may be needed depending on your Oracle server
 +
// 'dbname' => 'XE'
 +
// );
 +
//  // Need to explicitly set the Oracle session date format [1]
 +
//  $evm = new EventManager();
 +
//  $evm->addEventSubscriber(new OracleSessionInit(array('NLS_TIME_FORMAT' => 'HH24:MI:SS')));
 +
        /////////////////////////////////////////////////////////////////////////////////////////////
 +
 
 +
 +
///////////////////////MYSQL CONNECTION DETAILS////////////////////////////////////////////
 +
//  $conn = array(
 +
// 'driver' => 'pdo_mysql',
 +
// 'user' => 'doctrine',
 +
// 'password' => 'doc',
 +
// 'host' => 'localhost',
 +
// 'dbname' => 'doctrine'
 +
//  );
 +
        /////////////////////////////////////////////////////////////////////////////////////////////
 +
</pre>
 +
 
 +
 
 +
Note: Doctrine can use APC caching however this is not suitable for all deployments. To disable comment out the APC configuration lines within the bootstrap_doctrine.php file:
 +
<pre>$config-&gt;setMetadataCacheImpl(new \Doctrine\Common\Cache\ApcCache());
 +
$config-&gt;setQueryCacheImpl(new \Doctrine\Common\Cache\ApcCache());
 +
</pre>
 +
 
 +
=== Deploying GOCDB  ===
 +
 
 +
GocDB can be deployed as a blank instance ready for use or as a sample instance with a small amount of example data to demonstrate GocDB. The deploy script can be found at ''/lib/Doctrine/deploy/deploy.sh'':<br>
 +
 
 +
'''Windows Users:''' These scripts are designed for deployment on a Linux machine (Cygwin on Windows is ok). 
 +
 
 +
 
 +
By supplying a flag when executing the script you can deploy either a new empty database or a sample database eg:
 +
 
 +
<pre>
 +
$./deploy.sh -s
 +
 
 +
Deploying GocDB with sample data
 +
</pre>
 +
 
 +
or
 +
<pre>
 +
$./deploy.sh -n
 +
 
 +
Deploying new empty GocDB instance
 +
</pre>
 +
 
 +
=== Apache Configuration  ===
 +
 
 +
Now that your database is deployed the final step is to configure Apache.
 +
 
 +
==== /etc/sysconfig/httpd - Oracle configuration ====
 +
 
 +
The Oracle environment must be set correctly before starting Apache so that PHP OCI8 works correctly. In general you should set the same variables that are set by the ''$ORACLE_HOME/bin/oracle_env.sh'' script. The necessary environment variables can be set in Apache's environment configuration file.
 +
On RedHat Linux and its derivatives with the default httpd package, this is ''/etc/sysconfig/httpd''.
 +
<pre>
 +
export ORACLE_HOME=/u01/app/oracle/product/12.1    # Adjust pathname to match your installation
 +
export LD_LIBRARY_PATH=$ORACLE_HOME/lib:$LD_LIBRARY_PATH
 +
</pre>
 +
 
 +
==== httpd.conf  ====
 +
 
 +
A few modules need to be enabled for GOCDB to work, check these are enabled on your Apache and if not enable them.&nbsp;
 +
 
 +
In ''httpd.conf'' enable ssl_module by un-commenting these lines:
 +
<pre>LoadModule ssl_module modules/mod_ssl.so</pre>
 +
 
 +
 
 +
 
 +
==== gocdbssl.conf  ====
 +
A sample ''gocdbssl.conf'' is provided in GocDBSrc/config. This file will define the alias and SSL settings used by Apache to connect to GocDB. 
 +
 
 +
===== Paths  =====
 +
 
 +
The first step is to setup the paths for the ''DocumentRoot, ErrorLog and TransferLog'' and define the ''ServerName'' and ''ServerAdmin'' details for your particular web service where you are hosting GocDB.
  
=== Preparing your installation ===
+
===== SSL Keys  =====
  
==== Database preparation ====
+
The ''SSLCertificateFile'' should point to the location of your server SSL key file. The ''SSLCertificateKeyFile'' -- The ''SSLCACertificationPath'' should point to the location of your CA certificates.
  
'''Important note: This section needs to be executed by Database System Administrators.'''
+
For development the ''SSLCertificatedFile'' and ''SSLCertificateKeyFile'' can be self signed certificates. However these must not be used in production.
  
* If you don't have admin rights on the DB you are using, please contact your DBAs with the instructions contained in this section.
+
===== Aliases  =====
  
===== 1- Create tablespaces for GOCDB =====
+
The final step is to set the Alias to map your desired directory for GocDB webportal and Programmatic Interface (PI) to the correct folder and ensure the correct rules are defined for your server.  
GOCDB-4 database contains 3 distinct groups of tables: Metadata or core data, GOCDB data, and local data. Although this is not mandatory, we recommend that 3 different tablespaces be created to store these different tables:
 
  
{|{{egi-table}}
+
For the webportal the following settings are an example:
! Tablespace !! Size !! Purpose
+
<pre>    Alias "/portal" "/gocDBsrc/htdocs/web_portal"
|-
+
    &lt;Directory "/gocDBsrc/htdocs/web_portal"&gt;
| TS_GRIDCORE || 50m || Will store the core tables containing schema metadata
+
            SSLVerifyClient  require
|-
+
            Options FollowSymLinks Indexes
| TS_GOCDBDATA || 50m || Will store GOCDB data tables (common structure to all GOCDB modules)
+
            Order deny,allow
|-
+
            Allow from 127.0.0.1
| TS_LOCALDATA || 50m || Will store your local tables if you have some local information to store
+
            deny from all 
|}
+
        &lt;/Directory&gt;
 +
</pre>
 +
The alias should and file location should also be set for the public PI and private PI. Public PI:
 +
<pre>Alias "/gocdbpi/public" "/gocDBsrc/htdocs/PI/public"
 +
&lt;Directory "/gocDBsrc/htdocs/PI/public"&gt;
 +
</pre>
 +
Private PI:
 +
<pre>Alias "/gocdbpi/private" "/gocDBsrc/htdocs/PI/private"
 +
&lt;Directory "/gocDBsrc/htdocs/PI/private"&gt;
 +
</pre>
  
'''Note:''' Choose whatever names you want for your tablespaces. You'll be able to configure the system to use whatever names your tablespaces have.  
+
=== Compiled Entities ===
 +
This step is optional, but for production servers this step is strongly recommended. When Doctrine uses an entity it creates a compiled version of the entity which by default is stored in the machines temporary folder. This is un-suitable for production machines as this may well be emptied. To avoid this uncomment the following line in bootstrap_doctrine.php:
 +
<pre>
 +
$config->setProxyDir(__DIR__."/compiledEntities");
 +
</pre>
  
===== 2- Create a DB user for GOCDB =====
+
You now need to create this folder in the same directory as the ''bootstrap_doctrine.php'' file:
 +
<pre>
 +
$mkdir compiledEntities
 +
</pre>
  
Any existing user is OK but we advise that a user be dedicated to run GOCDB.
+
Once this folder is created it, your apache server needs write permissions (the exact command may change depending on your apache server):
  
* Grant access and unlimited quotas to your GOCDB user on previously defined tablespaces.
+
<pre>
 +
$chown apache compiledEntities/
 +
</pre>
  
===== 3- Manage user privileges =====
+
<pre>
 +
$ls -ltrh
 +
total 28
 +
drwxr--r-- 2 apache root 4.0K Nov 20 16:11 entities
 +
-rw-r--r-- 1 apache root  131 Nov 20 16:11 README.txt
 +
-rw-r--r-- 1 apache root  219 Nov 20 16:11 cli-config.php
 +
-rw-r--r-- 1 apache root 1.6K Nov 20 16:11 bootstrap.php
 +
-rw-r--r-- 1 apache root 3.0K Nov 20 16:11 bootstrap_doctrine_TEMPLATE.php
 +
-rw-r--r-- 1 apache root 2.8K Nov 27 09:38 bootstrap_doctrine.php
 +
drwxr--r-- 2 apache root 4.0K Nov 27 09:39 compiledEntities
 +
</pre>
  
Grant the following privileges to your GOCDB user:
+
Finally use the doctrine command line client to generate the compiled entities and store them in the folder:
 +
<pre>
 +
doctrine orm:generate-proxies compiledEntities/
 +
</pre>
  
* CREATE SESSION
+
This folder is now configured with the compiledEntites. It can be copied and used for new instances of GocDB as long as there have been no changes made to any of the entities, or it can be recreated as demonstrated each time.
* CREATE TABLE
 
* CREATE TYPE
 
* CREATE SEQUENCE
 
* CREATE TRIGGER
 
* CREATE PROCEDURE
 
* CREATE MATERIALIZED VIEW
 
* CREATE JOB
 
  
==== Web machine preparation ====
+
=== First Use  ===
  
===== 1- install host certificate for the machine =====
+
You should now be able to navigate to the GocDB webportal on your host using the URL defined in your alias. You will need to install a browser certificate that is suitable for the SSL keys you defined for your host to be able to view GocDB.
 +
<pre>
 +
https://localhost/portal
 +
https://localhost/portal/GOCDB_monitor/index.php
 +
</pre>
  
* GOCDB web portal component needs the machine to run a https server which requires a server X509 certificate. Please check that Apache is properly configured to use the installed server certificate. Help about how to set up SSL configuration on Apache can be obtained from Apache mod_ssl online documentation.  
+
====Local_Info.xml====
 +
GocDB picks up a number of its settings and variables from the local_info.xml file located in the ''config'' folder. The ''web_portal_url'' will be output in the PI to create links from PI objects back to Portal views. The ''pi_url'' and ''server_base_url'' will both be used by the monitor. The monitor is a quick look status check for GocDB. The mointor can be found at your web_portal_url/GOCDB_monitor/. If these URL's are not set in the local config this feature will not work correctly.  
  
===== 2- Get and deploy GOCDB-4 code package =====
+
''default_scope'' defines which scope if any will be used if no scope is specified when running PI queries. This can be left blank or set to a scope of your choosing. ''default_scope_match'' is again used if no scope_match parameter is supplied with PI queries. This can be either all or any. The ''minimum_scopes'' section declares how many scopes an NGI, site, service or service group must have at creation. This can be left as 0 or set as 1 if you want all your users entities to belong to at least one scope or more as dictated by your use of GocDB.
  
* download GOCDB-4 regional package from: https://www.sysadmin.hep.ac.uk/svn/grid-monitoring/tags/gocdb/GOCDB-4.0d7_distrib/RPM/
+
It's important at this point to understand how the scopes work with GocDB v5 especially in relation to the output of the PI. If you specify a default scope within your local_info but none of your entities have this scope then nothing will show in the PI. For an in-depth look at the scopes mechanism the section please read the section 'Multiple Scopes and Projects' in the [https://wiki.egi.eu/w/images/d/d3/GOCDB5_Grid_Topology_Information_System.pdf GOCDB5 Grid Topology Information System] document on page 5.
* Install the GOCDB-4 RPM (rpm -i GOCDB-4.0-4.d7.noarch.rpm)
 
* Verify the user running httpd has read access to the directories/files. The files are often not accessible by the Apache user by default. (Default installation location: '''/usr/share/GOCDB''')
 
* Create the following Apache Aliases (or set up virtual hosts)
 
** Alias "/portal" "/usr/share/GOCDB/htdocs/web_portal"
 
** Alias "/admin" "/usr/share/GOCDB/htdocs/admin"
 
** Alias "/xml_input" "/usr/share/GOCDB/htdocs/xml_input"
 
* Configure Apache to use SSL and client certificate verification for the web portal section of the site. The user certificate DN's are used for authentication to the web front end.
 
* Ensure the web server port is open on your machine. As a first step, you probably want the port to be open internally only (giving the whole wide world access to your GOCDB admin page is probably not a good idea)
 
* Restart Apache so that the new aliases are loaded from the configuration file.
 
* Check that the pages can be correctly accessed by browsing to the newly created "admin" alias. Note that the system is not yet fully set up and will not work!
 
  
''Note: Creating and managing http aliases is part of Apache http server handling. Please check Apache documentation if you need details.''
+
====Setup an Admin User====
  
===== 3- Create and edit prom.conf configuration file =====
+
To get started with GocDB you will need an admin user. This is done by first registering as a user on GocDB by clicking the 'Register' link on the left menu bar at the bottom. Once you have registered yourself you will then need to set yourself as an admin. To do this you need to change the user record directly in your database. The users table has a field called 'isAdmin' which by default is set to 0. To change a user to admin set this to 1. Below is a sample of the SQL query used when using an Oracle database to set a user as admin.  
  
* Rename or copy ''/usr/share/GOCDB/config/prom.conf_TEMPLATE'' to ''/usr/share/GOCDB/config/prom.conf''
+
<pre>
* Edit ''prom.conf''. Under the [Oracle_server] section, specify the connection details to your DB. "host" can be a simple hostname or a full connection string (see examples below).
+
UPDATE users SET isadmin=1 WHERE forename='John' AND surname='Doe'  
 +
</pre>
  
'''All settings must be enclosed in quotation marks.'''
+
Once you have an admin user you can create Projects and NGI's and grant roles to other users over these entities to allow them to add to GocDB.
  
example 1: Specifying a simple hostname
+
== Testing ==
  
host="dbhostname.domain.org"
+
GocDB v5 comes with a suite of tests that can be run to validate the install and check that Doctrine and your chosen database are operating as expected. These tests require PHPUnit, the install instructions for this can be found in section 3.6. The tests can be found in the GocDB/tests/ folder.  
port="1521"
 
database="Database_Name"
 
user="GOCDB_USER"
 
password="gocDBpassWord"
 
  
example 2: Specifying a connection string (warning: the whole string has to be on one single line) )
+
===Install the Oracle OCI drivers for PDO===
 +
To run tests you will also need to install the Oracle OCI8 PDO (PHP Data Object) drivers for PHP since the DBUnit tests
 +
use PDO for their execution to validate that the results that Doctrine is returning are true. To install the OCI8 drivers for pdo. See: http://www.php.net/manual/en/pdo.drivers.php
  
host="(DESCRIPTION=(LOAD_BALANCE=yes)(FAILOVER=ON)(ADDRESS=(PROTOCOL=TCP)(HOST=dbhostname1.domain.org)\\
+
You can test that you have the OCI8 pdo drivers installed via php info. This can be called on the command line with $php -i or via a script with phpinfo(). There will be a section that lists your enabled pdo drivers, e.g. as below:
    (PORT = 1521))(ADDRESS = (PROTOCOL = TCP)(HOST = dbhostname2.domain.org)(PORT = 1521))\\
+
<pre>
    (CONNECT_DATA=(SERVICE_NAME=gocdb.domain.com)(FAILOVER_MODE=(TYPE=SESSION)(METHOD=BASIC))))"
+
            |-----------------------------|
port=
+
            |            PDO            |
database=
+
            |-----------------------------|
user="GOCDB_USER"
+
            | PDO support enabled  |
password="gocDBpassWord"
+
            | PDO drivers mysql,oci |
 +
            |-----------------------------|
 +
</pre>
  
===== 4- Create and edit local_info.xml configuration file =====
+
=== Deploying a Test Database ===
  
* Rename or copy ''/usr/share/GOCDB/config/local_info.xml_TEMPLATE'' to ''/usr/share/GOCDB/config/local_info.xml''
+
We STRONGLY recommend that you deploy a second database with different connection details that will be used for testing.
* Edit ''local_info.xml'' whith the following information:
+
* Create a second DB account/user for your test database (e.g. GOCDB5TEST).
** tablespace names, as configured in the previous section
+
* Copy ''bootstrap_doctrine_TEMPLATE.php'' file found in tests/doctrine to ''bootstrap_doctrine.php'' (in the same dir).
** Collection ID, which is a unique ID that will eventually be used to distinguish different GOCDB regional instances. Currently this should be left as 0.
+
* Modify ''bootstrap_doctrine.php'' to specify your GOCDB5TEST account/user. Complete the section for your database and ensure that the other connection details are deleted or commented out.
** instance type, which can be either "central" or "regional". This should be set to regional.
+
* Copy ''bootstrap_pdo_TEMPLATE.php'' to ''bootstrap_pdo.php''. Complete the details for the connection details for your database and ensure that the other 2 connections are either deleted or commented out, see below:
** web_portal_url, which is the full url of your GOCDB web portal as defined during the setup process above
 
  
===== 5- Create and edit local_schema.xml configuration file =====
+
<pre>
 +
Un-comment the area for your chosen database and fill in the details for your chosen database.  
  
* Rename or copy ''/usr/share/GOCDB/config/local_schema.xml_TEMPLATE'' to ''/usr/share/GOCDB/config/local_schema.xml''
+
    ///////////////////////SQLITE CONNECTION DETAILS/////////////////////////////////////////////
* You don't need to edit/modify this file now. How to use this file (and why) will be described in the Customisation section
+
    // $sqliteFile = __DIR__ . '/../db.sqlite';
 +
    // $pdo = new PDO("sqlite:" . $sqliteFile);
 +
    // return new PHPUnit_Extensions_Database_DB_DefaultDatabaseConnection($pdo, 'sqlite');
 +
    /////////////////////////////////////////////////////////////////////////////////////////////
 +
   
 +
    ///////////////////////ORACLE CONNECTION DETAILS/////////////////////////////////////////////
 +
    // $pdo = new PDO('oci:dbname=//localhost:1521/xe', 'DoctrineUnitTests', 'doc');     
 +
    // return new PHPUnit_Extensions_Database_DB_DefaultDatabaseConnection($pdo, 'USERS');
 +
    /////////////////////////////////////////////////////////////////////////////////////////////
 +
 +
    ///////////////////////MYSQL CONNECTION DETAILS//////////////////////////////////////////////
 +
    //  $pdo = new PDO('mysql:host=localhost;dbname=doctrine;charset=UTF8', 'doctrine', 'doc');
 +
    // return new PHPUnit_Extensions_Database_DB_DefaultDatabaseConnection($pdo);
 +
    /////////////////////////////////////////////////////////////////////////////////////////////
 +
</pre>
  
==== Final check ====
+
=== Running the Test Suite ===
  
If you have carefully followed all the previous steps, you should now have:
+
A initial test suite is provided that will excercise core functions of GocDB and Doctrine. This suite can be ran using the command:
 +
<pre>
 +
phpunit DoctrineTestSuite1.php
 +
</pre>
  
* An Oracle database where GOCDB will run, with connection details and proper privileges
+
You will be prompted to continue as this operation will drop any tables in your test database and then recreate the schema ready to run the tests. These tests should return with no errors to demonstrate that GocDB and Doctrine are installed correctly and are working as expected.
* A web machine that will host GOCDB front end
 
* On the web machine, the following configuration files appropriately edited:
 
** /usr/share/GOCDB/config/prom.conf, with proper database connection details
 
** /usr/share/GOCDB/config/local_info.xml, with proper tablespace information and your assigned collection id
 
** /usr/share/GOCDB/config/local_schema.xml, left as it is for now (content doesn't matter for the setup process as long as the file is here)
 
* An alias to GOCDB admin web page, available through your browser.
 
* An alias to GOCDB web front end, available through your browser.
 
* An alias to GOCDB xml input, available through your browser.
 
  
And now the moment of truth...
+
=== Running Individual Tests ===
* Open GOCDB admin web page in your browser (yes, the alias you have defined above)
 
* On the welcome page, click on the '''configuration check''' link
 
** If it says "your settings look fine", congratulations, you are ready to go to the next step and deploy GOCDB!
 
** If not, displayed error message should tell you what has gone wrong. Go through the preparation steps again and perform a configuration check until you have solved all problems
 
  
=== Running GOCDB-4 setup ===
+
Individual tests can be run by calling:
 +
<pre>phpunit <testNameFile>.php</pre>
 +
It is advised that at the beginning of a testing session you drop and recreate the database by running the recreateTestDB.sh script.
  
If you have followed all the steps of the previous section, have reached the "final check" step and have managed to display a nice "your settings look fine" on a web page, then deploying GOCDB-4 is one of the simplest things on earth:  
+
===Recreating the Test DB===
 +
You can run the following script found in the ''tests/doctrine'' folder to Drop and Recreate the test database whenever required:  
 +
<pre>
 +
./recreateTestDB.sh
 +
</pre>
  
* Open GOCDB admin web page in your browser
+
=== Writing Tests ===
* Browse to the ''Main Admin Menu''
 
* Click on the '''Deploy and setup GOCDB for the first time''' link
 
* Click on the '''start deployment''' button
 
* The system will then go through a configuration check again, and should display a success message (if not, then you've not followed previous steps properly!)
 
* Click on the '''deploy now''' button
 
** If you've got a success message then congratulations! You have successfully deployed GOCDB-4. Now browse to the "Administration" section for next steps
 
** If you receive any error messages, please browse to the errors and troubleshooting section.
 
  
=== Importing the Sample Data ===
+
If you intend to develop new functionality for your instance of GocDB you can support this development by writing unit tests for the new features. A simple example of a test can be found in GocDB/tests/exampleTests. 'FirstTest.php' demonstrates  how to create data and assert that it is as expected.
  
Executing the XML Input module without changing default configuration will import the sample data into the GOCDB-4 database. To do that, follow next steps:
+
A good tutorial for getting started with PHPUnit can be found [http://pear.php.net/manual/en/package.php.phpunit.intro.php here.]
  
==== Setting up an admin user within the sample data ====
+
==== Writing a Doctrine Test ====
  
The user management system currently prevents unprivileged users from editing data in the web portal. If you wish to become a privileged user you will need to edit the same data, adding your certificate DN as a member of the Admins group.
+
When working with Doctrine there are a number of setup functions that needed to be included in your test file. A template file has been provided in GocDBSrc/tests/exampleTests called 'DoctrineTestTemplate.php'. When executing any tests based on this template two files need to be present in the same folder as the test being executed:
  
The following steps explain this process:
+
<pre>
 +
bootstrap_doctrine.php
 +
truncateDataTables.xml
 +
</pre>
  
* Open the '''config/xml_input/input/SampleData/User_Admins.xml''' file.
+
The first holds your connection details and the second will initialize the database with the correct tables ready for testing.  
* identify the following tags:
 
  
<Certificate_DN key="primary" grid_id="0">/C=UK/O=eScience/OU=CLRC/L=RAL/CN=gilles mathieu</Certificate_DN>
+
You can write multiple test functions at the bottom of this skeleton file.
<title>Mr</title>
 
<forename>Gilles</forename>
 
<surname>Mathieu</surname>
 
  
* Change the certificate DN to the certificate you wish to grant Admin access to, and correspondingly update Name/surname information.
+
==== Doctrine Test Example ====
  
Note: if you want to set up more than one admin, just duplicate the whole of the <user> tag and all its children tag within the <results> tag, and put a different DN/forename/Surname each time.  
+
'DoctrineTestExample.php' shows the following example test. In this test we will create a site, populate the site with some data and then assert that the data is correct.  
  
==== Executing XML Input ====
+
'''This test will make use of the 'TestUtil.php' file which contains a few helper methods to quickly create objects. This file is located in GocDBSrc/test/doctrine. When following this tutorial execute 'DoctrineTestExample.php' from GocDBSrc/test/doctrine.'''
  
By browsing to the previously configured "xml_input" Apache alias, the data import will commence. The process completes by outputing "Done" to the web browser. This sample data can be shown through the web portal, presenting how the system displays data.
+
Creating the site:
 +
<pre>
 +
    public function testDoctrineExample() {
 +
        print __METHOD__ . "\n";
  
=== Testing ===
+
        //Create a site
 +
    $ourSite = TestUtil::createSampleSite("Our Example Site");
 +
 +
    }
 +
</pre>
  
If all of the above has been successful then your web portal instance should be ready for testing. Browse to the web_portal Apache alias created in an earlier step and see the data that have been imported.
+
We now have a site and will add some extra information to the site utilizing setters methods defined in the site entity which can be found in GocDBSrc/lib/Doctrine/entites. We will add an email, telephone and location to the site:
  
If everything has been successful up to this point then you have successfully completed the installation instructions for GOCDB-4!
+
<pre>
 +
//Create a site
 +
    $ourSite = TestUtil::createSampleSite("Our Example Site");
 +
 +
//Set some details of the site
 +
$ourSite->setEmail("myTest@email.com");
 +
$ourSite->setTelephone("012345678910");
 +
$ourSite->setLocation("United Kingdom");
 +
</pre>
  
=== Possible errors and troubleshooting ===
 
  
This documentation is still in a draft state and you might therefore not find here the error you are experiencing. Should that be the case, please contact us so that we can work together on it and feed documentation with this error and its solution.
+
We now must persist this object in memory by calling '$this->em->persist($outSite);'
  
==== Deployment is interrupted because the webserver timed out ====
+
However this now only exist in memory - it is not yet in the database. To check this we can query the database directly using the PDO connection we setup:
  
The set of operations carried on during initial deployment can sometimes take a long time. Your webserver might be configured to time out after a certain time without answer, and if this time is too short this can result in a flawed deployment if the script stops half way through. The best thing to do in such a case is:
+
<pre>
 +
//Get the site ID from the object
 +
$siteId = $ourSite->getId(); 
 +
 +
//Get a database connection    
 +
    $con = $this->getConnection();
 +
 +
//Search the database for this site
 +
$sql = "SELECT 1 FROM sites WHERE ID = '$siteId'";
 +
$result = $con->createQueryTable('', $sql);
  
* From your miserably looking, half blank page where your setup script has stopped, click on the ''main admin menu'' item in the top menu bar
+
        //We expect this query to return no rows as the site does not exist in the database yet
* You're back on the welcome page. Now click on the ''Object and Schema Management'' link
+
$this->assertEquals(0, $result->getRowCount());
* Hopefully you'll see nice tabs and a list of possible actions (refer to the "administration" section for further details)
+
</pre>
* click on the ''wipe clean'' link
 
* go again through the setup section as described above
 
  
If this doesn't help, go to the ''Object and Schema Management'' page again and deploy each module one after the other (see the "administration" section for details).
+
When running the test at this point the outcome should be:
 +
<pre>
 +
OK (1 test, 1 assertion)
 +
</pre>
  
If you still get a server timeout, you need to reconfigure Apache so that the timeout value is higher. Check the Apache documentation for that
+
Our assertion was correct, there were no sites with that ID in the database yet as it has not been committed, the site only exists in memory at the moment. To commit the site to the database we must call:
  
==== Portal doesn't work ====
+
<pre>
 +
      $this->em->flush();
 +
</pre>
  
Even if everything goes OK during the setup it might happen that you can't browse the web portal (and get some PHP fatal errors along the way). The most probable cause for that is that https is not fully enabled on the server. Check your Apache SSL configuration and Apache documentation. If this is not the cause of the problem pleas contact us (see "support" section below) with the error message you are getting
+
Now if we run the query again we expect one result:
 +
<pre>
 +
//Search the database for this site again
 +
$sql = "SELECT 1 FROM sites WHERE ID = '$siteId'";
 +
$result = $con->createQueryTable('', $sql);
 +
 +
//We expect this query to return 1 rows as the site now exists in the database
 +
$this->assertEquals(1, $result->getRowCount());
  
==== Support ====
+
</pre>
  
If you need to contact us, please do so with as many details as possible so that we can track down with you what's gone wrong. Support requests should be sent to mailto:gocdb-admins@mailtalk.ac.uk
+
This shows the process of creating an entity, using its get and set methods to enter and retrieve data and then committing it to the database. It also shows the process of using the PDO connection to check that the data exists in the database as we expect.  
  
== Administration ==
+
-->
  
=== Object management ===
 
  
== Customisation ==
 
  
[[GOCDB-4 Customisation]]
+
  
=== Adding a local schema ===
+
[[Category:GOCDB]]

Latest revision as of 17:02, 9 November 2016