dcs/src/test/jdbc_test/README.rst

.. #* @@@ START COPYRIGHT @@@
#*
#* Licensed to the Apache Software Foundation (ASF) under one
#* or more contributor license agreements.  See the NOTICE file
#* distributed with this work for additional information
#* regarding copyright ownership.  The ASF licenses this file
#* to you under the Apache License, Version 2.0 (the
#* "License"); you may not use this file except in compliance
#* with the License.  You may obtain a copy of the License at
#*
#*   http://www.apache.org/licenses/LICENSE-2.0
#*
#* Unless required by applicable law or agreed to in writing,
#* software distributed under the License is distributed on an
#* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
#* KIND, either express or implied.  See the License for the
#* specific language governing permissions and limitations
#* under the License.
#*
#* @@@ END COPYRIGHT @@@
# */

==========================
Trafodion JDBC Test README
==========================

The Trafodion JDBC Test are written for JUnit, the tests are run by Maven, and the 
test reports are generated by the Maven Surefire Plugin.


Running Tests
*************

* First, add the bin directory of Java JDK 1.7 and Python 2.7 to your PATH ::

    export PATH=/<PATH_to_JAVA_JDK_1.7_Home>/bin:/<PATH_to_Python_2.7_Home>/bin:/<PATH_to_maven>/bin:$PATH

* Next, set the proxy environment variables if needed for your environment ::

    export http_proxy="http://someproxy.com:8088"
    export https_proxy="$http_proxy"
    export ftp_proxy="$http_proxy"

* Next, run ``jdbc_test.py`` to configure the Trafodion JDBC test and run it.

  **Example 1 - Running ALL Trafodion JDBC T4 Tests** ::

    ./jdbc_test.py --appid=jdbc_test --target=<Trafodion_Instance>:<Trafodion_Port> \
    --user=<Some_User> --pw=<Some_Password> --jdbctype=T4 \
    --javahome=<PATH_to_JAVA_JDK_1.7_Home> --jdbccp=<PATH_to_Trafodion_JDBC_T4_Driver>
    
  **Example 2 - Running specific Trafodion JDBC T4 Tests** ::

    ./jdbc_test.py --appid=jdbc_test --target=<Trafodion_Instance>:<Trafodion_Port> \
    --user=<Some_User> --pw=<Some_Password> --jdbctype=T4 \
    --javahome=<PATH_to_JAVA_JDK_1.7_Home> --jdbccp=<PATH_to_Trafodion_JDBC_T4_Driver> \
    --tests=<List_of_Tests_seperated_by_comma_and_no_space>


About this README
*****************

This README is written using `reStructuredText <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ format.  Using this
format, the `Sphinx <http://sphinx-doc.org/index.html>`_ tool can be used to create documentation in HTML, PDF, and other formats.


Other Resources
***************

* `JUnit <http://junit.org/>`_
* `Maven <http://maven.apache.org/>`_
* `Maven Surefire Plugin <http://maven.apache.org/surefire/maven-surefire-plugin/examples/junit.html>`_
* `How to Run JUnit Test with Maven <http://www.mkyong.com/maven/how-to-run-unit-test-with-maven/>`_