river-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tho...@apache.org
Subject svn commit: r1038572 - /incubator/river/site/trunk/content/river/building-river.mdtext
Date Wed, 24 Nov 2010 12:01:11 GMT
Author: thobbs
Date: Wed Nov 24 12:01:11 2010
New Revision: 1038572

URL: http://svn.apache.org/viewvc?rev=1038572&view=rev
Log:
Added additional instructions on building and testing River

Modified:
    incubator/river/site/trunk/content/river/building-river.mdtext

Modified: incubator/river/site/trunk/content/river/building-river.mdtext
URL: http://svn.apache.org/viewvc/incubator/river/site/trunk/content/river/building-river.mdtext?rev=1038572&r1=1038571&r2=1038572&view=diff
==============================================================================
--- incubator/river/site/trunk/content/river/building-river.mdtext (original)
+++ incubator/river/site/trunk/content/river/building-river.mdtext Wed Nov 24 12:01:11 2010
@@ -53,15 +53,37 @@ Assume "$RIVER_HOME" is where you have c
 
 Will build all the River JARs required.  You will then find them in the ${RIVER_HOME}/lib*
directories.
 
+## Setting up the IDE
+
+### Eclipse
+
+Create your new IDE project using your prefered method (e.g. "Import from SVN" or create
a new project using existing source, etc).  
+
+First you will need to create a new JDK system library.  The normal JDK libraries that come
in Eclipse have restrictions place on the `rt.jar` file which prevents the import of some
proprietary Sun classes.  
+
+Since River is built with Ant this isn't strictly necessary, but it is if you don't want
the compiler error warnings flashing up.  Currently, River should be built with JDK 1.5, so
please ensure that you have this installed and your new library uses it.
+
+Then you need to add the JARs in `$RIVER_HOME/extlibs` to your classpath.  
+
+That should everything that Eclipse needs to be happy with the River code.
+
+### NetBeans
+*TODO*
+
 ## Testing River
 
-This build process runs the (limited) suite of unit tests that comes with River.  River is
tested predominantly by using [jtreg](http://openjdk.java.net/jtreg/).
+This build process runs the (limited) suite of unit tests that comes with River.  River is
tested predominantly by using [jtreg](http://openjdk.java.net/jtreg/) and the QA test suite.
+
+### The JUnit tests
+
+The JUnit tests can be found in `$RIVER_HOME/test/src` you must also add the JARs found in
`$RIVER_HOME/test/lib` onto the classpath for your tests.
 
-### Using the Ant script
+It's easiest to run these tests from your IDE.  In Eclipse, for example, once `$RIVER_HOME/test/src`
is set at the test source directory, right-clicking the project and hitting "Run as JUnit
test" is all that is required.
 
+### The QA Test Suite
 The QA tests can also be run from the Ant script.  You must make sure the Ant you are using
is using the correct JDK.  You can run "ant diagnostics" in the project directory to find
out which JVM Ant is using.
 
-Make sure that you have the following in your build.properties file.
+Make sure that you have the following in your build.properties file which you will need to
create in `$RIVER_HOME`.
 
     river.home=$RIVER_HOME
     jtreg.home=/path/to/jtreg/install
@@ -92,10 +114,7 @@ From the qa directory:
     
     ant -Drun.tests=com/sun/jini/test/spec/constraint/coreconstraint/PrincipalElementsTest.td
run-tests
 
-##### Single test files
-The td files can be found in;
-
-    $RIVER_HOME/qa/src/**
+Existing QA tests can be found in the following path; `$RIVER_HOME/qa/src/com/sun/jini/test/**"`
 
 #### Categories
 The test categories are;
@@ -222,33 +241,26 @@ The test categories are;
  1. url_spec
 
 
-### Using jtreg directly
+### JTREG tests
 
 You must first download and install jtreg following the instructions on their site.
 
-Execute the following:
+The JTREG tests can then be run by execute the following:
+
+    cd $RIVER_HOME/qa
+    ant jtreg
+
+If you should cancel a test run, you must run the following before you can start the run
again.
+
+    ant jtreg-teardown
+
+JTREG will create the directory `$RIVER_HOME/qa/jtreg/JTreport` which contains a report of
the test run.
+
+It is known that test `net/jini/url/httpmd/TestEqual.java` fails.  Please see [Jira issue
River-375](https://issues.apache.org/jira/browse/RIVER-375) for details.
+
+> **There are problems with running these tests on Windows which are currently being investigated.**
 
-    cd $RIVER_HOME
-    cd qa/jtreg
-    mkdir JTlib-tmp
-    cp ../lib/jsk-lib.jar JTlib-tmp/
-    cp ../lib/jsk-platform.jar JTlib-tmp/
-    cp ../lib/jsk-resources.jar JTlib-tmp/
-    cp ../lib/phoenix-init.jar JTlib-tmp/
-    cp ../lib-ext/jsk-policy.jar JTlib-tmp/
-    cd $RIVER_HOME
 
-Then to run the jtreg tests execute the following:
+#### Running specific JTREG tests
 
-    jtreg -verbose:all,nopass \
-          -cpa:./qa/JTlib-tmp/jsk-lib.jar:\
-               ./qa/JTlib-tmp/jsk-platform.jar:\
-               ./qa/JTlib-tmp/jsk-resources.jar:\
-               ./qa/JTlib-tmp/phoenix-init.jar:\
-               .jsk-policy.jar \
-         -jdk /path/to/jdk1.5 \
-         -Djsk.home="/path/to/river/" \
-         -Djava.security.debug=access,failure \
-         -Djavatest.maxOutputSize=500000 \
-         -Djtlib.tmp=./qa/jtreg/JTlib-tmp \
-         ./qa/jtreg/
\ No newline at end of file
+_todo_
\ No newline at end of file



Mime
View raw message