Merge branch 'master' into fix/readme-platform-support

Author: pervazea

script/coding_style.md

@@ -21,7 +21,7 @@ Another measure of the function is the number of local variables.  They shouldn'
 
 **PRINTF** Refrain from using `printf` and `std::cout`. Instead use the logging macros, such as LOG_LEVEL_INFO, in `common/logger.h`.
 
-**DON'T REINVENT THE MACROS** Use `PL_ASSERT` in `common/macros.h` instead of regular `assert`. This header file icontains a number of macros that you should use, rather than explicitly coding some variant of them yourself.
+**DON'T REINVENT THE MACROS** Use `PELOTON_ASSERT` in `common/macros.h` instead of regular `assert`. This header file icontains a number of macros that you should use, rather than explicitly coding some variant of them yourself.
 
 **PLAFORM-SPECIFIC CODE** Add platform-specific code only to `common/platform.h`.
 
@@ -53,7 +53,7 @@ The example above illustrates a valid use of the `inline` keyword for the defini
 
 **EDITOR MODELINES** Some editors can interpret configuration information embedded in source files, indicated with special markers.  For example, emacs interprets lines marked like this:	-*- mode: c -*-. Do NOT include any of these in source files. People have their own personal editor configurations, and your source files should not override them.
 
-**ALLOCATING MEMORY** Use `PL_MEMCPY` macro in `common/macros.h`. Always use smart pointers, such as `std::unique_ptr`, to simplify memory management.
+**ALLOCATING MEMORY** Use `PELOTON_MEMCPY` macro in `common/macros.h`. Always use smart pointers, such as `std::unique_ptr`, to simplify memory management.
 
 **PRINTING PELOTON MESSAGES** Peloton developers like to be seen as literate. Do mind the spelling of messages to make a good impression. Do not use crippled words like "dont"; use "do not" or "don't" instead.  Make the messages concise, clear, and unambiguous. Use appropriate log levels, such as LOG_LEVEL_TRACE, in `common/logger.h`. Coming up with good debugging messages can be quite a challenge; and once you have them, they can be a huge help for troubleshooting.
 

script/testing/jdbc/README.md

@@ -1,10 +1,23 @@
 ## Simple JDBC test for Peloton
 
-The java program here provides simple JDBC operation tests for Peloton database. To run the test, simply type:
+The java program here provides simple JDBC operation tests for Peloton
+database.
 
-test_jdbc.sh <type>
+To run the test:
+1. Start peloton. Typically, locally, so hostname would be localhost
+and if default port would be 15721
 
-Where 'type' is either 'basic', 'stats', or 'copy'
+2. Compile and run the test:
+test_jdbc.sh <type> <hostname> <port>
+
+e.g. test_jdbc.sh PelotonBasicTest localhost 15721
+
+Where 'type' is one of:
+      PelotonBasicTest 
+      PelotonErrorTest
+      PelotonTypeTest
+      StocklevelTest
+      SSLTest
 
 The program performs the following tests:
 

script/testing/junit/.gitignore

@@ -1,2 +1,3 @@
 
-!Makefile
+!Makefile
+!lib/*.jar

script/testing/junit/InsertPSTest.java

@@ -111,8 +111,6 @@ public void testPS_1Tuple_CS_1() throws SQLException {
      * Prepared statement, 1 tuple insert, with columns inserted
      * in different order from schema.
      */
-
-    // Currently fails. See #1197
     @Test
     public void testPS_1Tuple_CS_2() throws SQLException {
 
@@ -135,8 +133,6 @@ public void testPS_1Tuple_CS_2() throws SQLException {
      * Prepared statement, 1 tuple insert, with columns inserted
      * in different order from schema, with one constant column.
      */
-
-    // Currently fails. See #1197
     @Test
     public void testPS_1Tuple_CS_3() throws SQLException {
 
@@ -182,8 +178,6 @@ public void testPS_1Tuple_CS_4() throws SQLException {
      * Prepared statement, 1 tuple insert, with columns inserted
      * in schema order, one constant column
      */
-    // Works, due to use of insert rather than push back
-
     @Test
     public void testPS_1Tuple_CS_5() throws SQLException {
 
@@ -205,8 +199,6 @@ public void testPS_1Tuple_CS_5() throws SQLException {
     /**
      * Prepared statement, 1 tuple insert, all constants
      */
-    // Works, due to use of insert rather than push back
-
     @Test
     public void testPS_1Tuple_CS_6() throws SQLException {
 
@@ -295,7 +287,6 @@ public void testPS_2Tuple_CS_1() throws SQLException {
      * Prepared statement, 2 tuple insert, with columns inserted
      * in different order from schema.
      */
-    // Currently fails. See #1197
     @Test
     public void testPS_2Tuple_CS_2() throws SQLException {
 
@@ -325,7 +316,6 @@ public void testPS_2Tuple_CS_2() throws SQLException {
      * Prepared statement, 2 tuple insert, with columns inserted
      * in different order from schema, with one constant column.
      */
-    // Currently fails. See #1197
     @Test
     public void testPS_2Tuple_CS_3() throws SQLException {
 
@@ -355,7 +345,6 @@ public void testPS_2Tuple_CS_3() throws SQLException {
      * in different order from schema, with one constant column.
      * Variant of above, with constant column last.
      */
-    // Currently fails. See #1197
     @Test
     public void testPS_2Tuple_CS_3a() throws SQLException {
 
@@ -384,7 +373,6 @@ public void testPS_2Tuple_CS_3a() throws SQLException {
      * Prepared statement, 2 tuple insert, with columns inserted
      * in schema order, with 2nd column missing.
      */
-    // Currently failing. See comments in #1197
     @Test
     public void testPS_2Tuple_CS_4() throws SQLException {
 
@@ -419,7 +407,7 @@ public void testPS_2Tuple_CS_4() throws SQLException {
     /**
      * 1 tuple insert, with no column specification.
      */
-    //@Test
+    @Test
     public void test_1Tuple_NCS() throws SQLException {
 
         String sql = "INSERT INTO tbl VALUES (1, 2, 3);";
@@ -440,7 +428,7 @@ public void test_1Tuple_NCS() throws SQLException {
     /**
      * 1 tuple insert, with columns inserted in schema order.
      */
-    //@Test
+    @Test
     public void test_1Tuple_CS_1() throws SQLException {
 
         String sql = "INSERT INTO tbl (c1, c2, c3) VALUES (1, 2, 3);";
@@ -461,7 +449,7 @@ public void test_1Tuple_CS_1() throws SQLException {
     /**
      * 1 tuple insert, with columns inserted in different order from schema.
      */
-    //@Test
+    @Test
     public void test_1Tuple_CS_2() throws SQLException {
 
         String sql = "INSERT INTO tbl (c3, c1, c2) VALUES (3, 1, 2);";
@@ -484,7 +472,7 @@ public void test_1Tuple_CS_2() throws SQLException {
     /**
      * 2 tuple insert, with no column specification.
      */
-    //@Test
+    @Test
     public void test_2Tuple_NCS() throws SQLException {
 
         String sql = "INSERT INTO tbl VALUES (1, 2, 3), (11, 12, 13);";

script/testing/junit/Makefile

@@ -28,9 +28,10 @@ clean:
 test:	$(CLASSES)
 	java -jar lib/junit-platform-console-standalone-1.1.0.jar \
 	  --class-path $(CP) \
-          -c InsertPSTest
-#         -c UpdateTest
-#	  -c InsertPSTest -c InsertTPCCTest
+	  -c InsertTPCCTest \
+	  -c InsertPSTest \
+          -c UpdateTest
+
 
 
 

script/testing/junit/Readme.txt

@@ -1,20 +1,72 @@
 
 
-This directory contains tests using Junit4 and JDBC and prepared statements.
+This directory contains tests using Junit4 and JDBC.
 
-To compile:
-make
+Note:
+- These tests are not yet integrated into the continuous integration
+  process (i.e. Travis or Jenkins). They will be integrated as soon
+  as feasible.
 
-To run, using the Junit console:
-1. Start up the database server, manually, e.g.
+  In the meantime, run the tests manually. Instructions follow.
+
+Installation and pre-requisites
+-------------------------------
+You'll need
+- java JDK or JRE
+
+Other than that, no explicit installation is required.
+
+The necessary Java libraries supporting these tests are included in the
+lib directory.
+
+Running the tests
+-----------------
+
+1. Compile the tests.
+   make
+
+2. To run the tests, first start Peloton manually in a separate shell, e.g. 
    ./peloton
 
-2. Run the tests, (from this directory):
+3. Run the tests, (from this directory):
    make test
 
+Adding new tests
+----------------
+Add the tests to the Makefile for compilation and execution.
+
+Code structure for tests
+------------------------
+- PLTestBase contains supporting functions shared across tests. Supplement
+  as needed. Avoid duplicating code in tests.
+
+- Add a new XXX.java file for each new test class. Each class may
+  contain as many tests as desired. The current tests use
+  one schema for the class.
+
+- See UpdateTest.java for an example of a simple test.
+  - Each test will need a Connection variable and SQL statements
+    to setup the tables.
 
-If the JUnit console output style is not to your taste,
-they can be run more directly using the Junit runner. Copy the following
+- See InsertPSTest.java for additional examples, including use
+  of prepared statements. Most likely you'll want to implement
+  using normal statements rather than prepared statements.
+
+- Setup() is called prior to each test
+- Teardown() is called after each test
+  If you need different granularity, see the JUnit4 documentation. Class
+  level setup / teardown is possible.
+
+- Functions annotated with @Test are the actual tests.
+  Tests may be temporarily disabled by commented out the annotation, e.g.
+  //@Test.
+
+
+Alternatives
+------------
+
+If the JUnit console output style is not to your taste when running the
+tests, they can be run more directly using the Junit runner. Copy the following
 code into a file, and invoke it from this directory, e.g.
    bash run_tests.sh
 
@@ -24,15 +76,3 @@ CP=".:lib/hamcrest-core-1.3.jar:lib/postgresql-9.4.1209.jre6.jar:lib/junit-4.12.
 # execute the InsertPSTest class. More than one test class may be
 # supplied on the command line
 java -cp $CP org.junit.runner.JUnitCore InsertPSTest
-
-
-Test notes
-----------
-
-1. The InsertTPCCTest uses a table schema and insert statment from the
-   TPPC benchmark.
-   Peloton fails this test. It will be enabled once fixed.
-
-2. InsertPSTest contains a set of prepared statement tests. The tests that
-   currently do not pass on Peloton are disabled.
-   	     

script/testing/junit/UpdateTest.java

@@ -67,9 +67,10 @@ public void setValues(PreparedStatement pstmt,
     }
 
     /**
-     * xxx
+     * Update columns in non-schema order. Exercises issue #1223.
      */
-    @Test
+    // Disable until #1223 is fixed
+    //@Test
     public void test_Update_1() throws SQLException {
 
         String sql_1 = "INSERT INTO tbl VALUES (5, 400);";