[teiid-commits] teiid SVN: r1649 - trunk/test-integration/db/src/main/resources.

[teiid-commits at lists.jboss.org]

Author: vhalbert at redhat.com
Date: 2009-12-11 13:32:04 -0500 (Fri, 11 Dec 2009)
New Revision: 1649

Modified:
   trunk/test-integration/db/src/main/resources/qe-test.properties
Log:
Teiid 781 - documenting the qe config props file

Modified: trunk/test-integration/db/src/main/resources/qe-test.properties
===================================================================
--- trunk/test-integration/db/src/main/resources/qe-test.properties	2009-12-11 16:09:22 UTC (rev 1648)
+++ trunk/test-integration/db/src/main/resources/qe-test.properties	2009-12-11 18:32:04 UTC (rev 1649)
@@ -1,25 +1,41 @@
-#  NOTES:
-#	- ${queryset.dir} property is expected to come from the scenario file, indicating which queryset of files to use (because each scenario could be different)
+#  	The qe-test.properties is used by the bulk client testing .
+#	This file provides properties to the process in 2 ways:
+#	1.	It acts as a template when property substitution is involved.   Meaning the property value will be derived
+#		at execution time.  
+#	2.	The other properties will be static.
 
-#  Need to setup the following system properties that will be picked up and substituted 
-# - query.artifacts.dir  - indicating where all query sets can be found
-# - vdb.artifacts.dir - indicates where all the vdb can be found
 
+##--- The following properties are expected to come from the scenario file
+#	- ${queryset.dir} indicate which queryset of files to use (because each scenario could be different, bqt, sp, etc)
+#	- ${test.queries.dir} indicates which directory in the ${queryset.dir} to find the queries to run.
+#	- ${expected.results.dir} indicates which directory in the ${queryset.dir} to find the expected results.  This may be different when 
+#			multiple scenarios use the same queries but have different expected results   
 
+
+##--- The following properties are expected to be passed in as system properties
+#	- ${queryset.artifacts.dir} indicates where all query sets can be found
+#	- ${vdb.artifacts.dir} indicates where the vdbs can be found
+
+
+# the location where a specific query set can be found
 queryfiles.loc=${queryset.artifacts.dir}/${queryset.dir}/${test.queries.dir}
 
+# the location where the specific expected result files can be found
 results.loc=${queryset.artifacts.dir}/${queryset.dir}/${expected.results.dir}
 
 #
-#  3 - where to find the vdb's, which is used to define the vdb.definition setting in the deploy.properties
+#  where to find the vdb's, which is used to define the vdb.definition setting in the deploy.properties
 vdb.loc=${vdb.artifacts.dir}
 
 # turn off the configuration of the datastores (data refresh) and connector bindings (seting the datastore connection info)
 disable_datastore=true
 
-
+# the location where newly generated expected results will be created (resultmode = generate)
 generatedir=target/bulk-query-tests/${queryset.dir}/generate
+# the comparison reports for each query set
 outputdir=target/bulk-query-tests/${queryset.dir}/output
+
+# write the summary files out to this location to make it easier to assimilate the files
 summarydir=target/bulk-query-tests
 
 
@@ -28,7 +44,10 @@
 transaction-type=offwrap
 #transaction-type=local
 
-
+#  resultmode options:
+#	-	compare :  compare actual results to expected results
+#	-	generate : create new expected results
+#	-	none :  run the queries, only report when errors occur
 resultmode=compare