You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@river.apache.org by bu...@apache.org on 2010/11/24 13:01:24 UTC
svn commit: r779649 -
/websites/staging/river/trunk/content/river/building-river.html
Author: buildbot
Date: Wed Nov 24 12:01:24 2010
New Revision: 779649
URL: http://svn.apache.org/viewvc?rev=779649&view=rev
Log:
Staging update by buildbot
Modified:
websites/staging/river/trunk/content/river/building-river.html
Modified: websites/staging/river/trunk/content/river/building-river.html
URL: http://svn.apache.org/viewvc/websites/staging/river/trunk/content/river/building-river.html?rev=779649&r1=779648&r2=779649&view=diff
==============================================================================
--- websites/staging/river/trunk/content/river/building-river.html (original)
+++ websites/staging/river/trunk/content/river/building-river.html Wed Nov 24 12:01:24 2010
@@ -84,11 +84,26 @@
<p>Will build all the River JARs required. You will then find them in the ${RIVER_HOME}/lib* directories.</p>
+<h2 id="setting_up_the_ide">Setting up the IDE</h2>
+<h3 id="eclipse">Eclipse</h3>
+<p>Create your new IDE project using your prefered method (e.g. "Import from SVN" or create a new project using existing source, etc).<br />
+</p>
+<p>First you will need to create a new JDK system library. The normal JDK libraries that come in Eclipse have restrictions place on the <code>rt.jar</code> file which prevents the import of some proprietary Sun classes.<br />
+</p>
+<p>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.</p>
+<p>Then you need to add the JARs in <code>$RIVER_HOME/extlibs</code> to your classpath.<br />
+</p>
+<p>That should everything that Eclipse needs to be happy with the River code.</p>
+<h3 id="netbeans">NetBeans</h3>
+<p><em>TODO</em></p>
<h2 id="testing_river">Testing River</h2>
-<p>This build process runs the (limited) suite of unit tests that comes with River. River is tested predominantly by using <a href="http://openjdk.java.net/jtreg/">jtreg</a>.</p>
-<h3 id="using_the_ant_script">Using the Ant script</h3>
+<p>This build process runs the (limited) suite of unit tests that comes with River. River is tested predominantly by using <a href="http://openjdk.java.net/jtreg/">jtreg</a> and the QA test suite.</p>
+<h3 id="the_junit_tests">The JUnit tests</h3>
+<p>The JUnit tests can be found in <code>$RIVER_HOME/test/src</code> you must also add the JARs found in <code>$RIVER_HOME/test/lib</code> onto the classpath for your tests.</p>
+<p>It's easiest to run these tests from your IDE. In Eclipse, for example, once <code>$RIVER_HOME/test/src</code> is set at the test source directory, right-clicking the project and hitting "Run as JUnit test" is all that is required.</p>
+<h3 id="the_qa_test_suite">The QA Test Suite</h3>
<p>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.</p>
-<p>Make sure that you have the following in your build.properties file.</p>
+<p>Make sure that you have the following in your build.properties file which you will need to create in <code>$RIVER_HOME</code>.</p>
<div class="codehilite"><pre><span class="n">river</span><span class="o">.</span><span class="n">home</span><span class="o">=</span><span class="nv">$RIVER_HOME</span>
<span class="n">jtreg</span><span class="o">.</span><span class="n">home</span><span class="o">=</span><span class="sr">/path/</span><span class="n">to</span><span class="sr">/jtreg/i</span><span class="n">nstall</span>
<span class="n">jdk1</span><span class="o">.</span><span class="mi">5</span><span class="o">.</span><span class="n">home</span><span class="o">=</span><span class="sr">/path/</span><span class="n">to</span><span class="o">/</span><span class="n">java1</span><span class="o">.</span><span class="mi">5</span>
@@ -122,12 +137,7 @@
</pre></div>
-<h5 id="single_test_files">Single test files</h5>
-<p>The td files can be found in;</p>
-<div class="codehilite"><pre><span class="nv">$RIVER_HOME</span><span class="sr">/qa/s</span><span class="n">rc</span><span class="o">/**</span>
-</pre></div>
-
-
+<p>Existing QA tests can be found in the following path; <code>$RIVER_HOME/qa/src/com/sun/jini/test/**"</code></p>
<h4 id="categories">Categories</h4>
<p>The test categories are;</p>
<ol>
@@ -252,35 +262,26 @@
<li>url</li>
<li>url_spec</li>
</ol>
-<h3 id="using_jtreg_directly">Using jtreg directly</h3>
+<h3 id="jtreg_tests">JTREG tests</h3>
<p>You must first download and install jtreg following the instructions on their site.</p>
-<p>Execute the following:</p>
-<div class="codehilite"><pre><span class="n">cd</span> <span class="nv">$RIVER_HOME</span>
-<span class="n">cd</span> <span class="n">qa</span><span class="o">/</span><span class="n">jtreg</span>
-<span class="nb">mkdir</span> <span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span>
-<span class="n">cp</span> <span class="o">..</span><span class="sr">/lib/</span><span class="n">jsk</span><span class="o">-</span><span class="n">lib</span><span class="o">.</span><span class="n">jar</span> <span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span>
-<span class="n">cp</span> <span class="o">..</span><span class="sr">/lib/</span><span class="n">jsk</span><span class="o">-</span><span class="n">platform</span><span class="o">.</span><span class="n">jar</span> <span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span>
-<span class="n">cp</span> <span class="o">..</span><span class="sr">/lib/</span><span class="n">jsk</span><span class="o">-</span><span class="n">resources</span><span class="o">.</span><span class="n">jar</span> <span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span>
-<span class="n">cp</span> <span class="o">..</span><span class="sr">/lib/</span><span class="n">phoenix</span><span class="o">-</span><span class="n">init</span><span class="o">.</span><span class="n">jar</span> <span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span>
-<span class="n">cp</span> <span class="o">..</span><span class="sr">/lib-ext/</span><span class="n">jsk</span><span class="o">-</span><span class="n">policy</span><span class="o">.</span><span class="n">jar</span> <span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span>
-<span class="n">cd</span> <span class="nv">$RIVER_HOME</span>
+<p>The JTREG tests can then be run by execute the following:</p>
+<div class="codehilite"><pre><span class="n">cd</span> <span class="nv">$RIVER_HOME</span><span class="o">/</span><span class="n">qa</span>
+<span class="n">ant</span> <span class="n">jtreg</span>
</pre></div>
-<p>Then to run the jtreg tests execute the following:</p>
-<div class="codehilite"><pre><span class="n">jtreg</span> <span class="o">-</span><span class="n">verbose:all</span><span class="p">,</span><span class="n">nopass</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">cpa:</span><span class="o">.</span><span class="sr">/qa/</span><span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span><span class="n">jsk</span><span class="o">-</span><span class="n">lib</span><span class="o">.</span><span class="n">jar:</span><span class="o">\</span>
- <span class="o">.</span><span class="sr">/qa/</span><span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span><span class="n">jsk</span><span class="o">-</span><span class="n">platform</span><span class="o">.</span><span class="n">jar:</span><span class="o">\</span>
- <span class="o">.</span><span class="sr">/qa/</span><span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span><span class="n">jsk</span><span class="o">-</span><span class="n">resources</span><span class="o">.</span><span class="n">jar:</span><span class="o">\</span>
- <span class="o">.</span><span class="sr">/qa/</span><span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span><span class="o">/</span><span class="n">phoenix</span><span class="o">-</span><span class="n">init</span><span class="o">.</span><span class="n">jar:</span><span class="o">\</span>
- <span class="o">.</span><span class="n">jsk</span><span class="o">-</span><span class="n">policy</span><span class="o">.</span><span class="n">jar</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">jdk</span> <span class="sr">/path/</span><span class="n">to</span><span class="o">/</span><span class="n">jdk1</span><span class="o">.</span><span class="mi">5</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">Djsk</span><span class="o">.</span><span class="n">home</span><span class="o">=</span><span class="s">"/path/to/river/"</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">Djava</span><span class="o">.</span><span class="n">security</span><span class="o">.</span><span class="n">debug</span><span class="o">=</span><span class="n">access</span><span class="p">,</span><span class="n">failure</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">Djavatest</span><span class="o">.</span><span class="n">maxOutputSize</span><span class="o">=</span><span class="mi">500000</span> <span class="o">\</span>
- <span class="o">-</span><span class="n">Djtlib</span><span class="o">.</span><span class="n">tmp</span><span class="o">=.</span><span class="sr">/qa/</span><span class="n">jtreg</span><span class="o">/</span><span class="n">JTlib</span><span class="o">-</span><span class="n">tmp</span> <span class="o">\</span>
- <span class="o">.</span><span class="sr">/qa/</span><span class="n">jtreg</span><span class="o">/</span>
+<p>If you should cancel a test run, you must run the following before you can start the run again.</p>
+<div class="codehilite"><pre><span class="n">ant</span> <span class="n">jtreg</span><span class="o">-</span><span class="n">teardown</span>
</pre></div>
+
+
+<p>JTREG will create the directory <code>$RIVER_HOME/qa/jtreg/JTreport</code> which contains a report of the test run.</p>
+<p>It is known that test <code>net/jini/url/httpmd/TestEqual.java</code> fails. Please see <a href="https://issues.apache.org/jira/browse/RIVER-375">Jira issue River-375</a> for details.</p>
+<blockquote>
+<p><strong>There are problems with running these tests on Windows which are currently being investigated.</strong></p>
+</blockquote>
+<h4 id="running_specific_jtreg_tests">Running specific JTREG tests</h4>
+<p><em>todo</em></p>
</div>
</td>
<td valign="top">