Revision: 954
          http://jwebunit.svn.sourceforge.net/jwebunit/?rev=954&view=rev
Author:   henryju
Date:     2012-08-16 19:41:52 +0000 (Thu, 16 Aug 2012)
Log Message:
-----------
[3476459] Do not include logback transitively and provide documentation on how 
to use it.

Modified Paths:
--------------
    trunk/jwebunit-htmlunit-plugin/pom.xml
    trunk/jwebunit-webdriver-plugin/pom.xml
    trunk/src/changes/changes.xml
    trunk/src/site/site.xml
    trunk/src/site/xdoc/quickstart.xml

Modified: trunk/jwebunit-htmlunit-plugin/pom.xml
===================================================================
--- trunk/jwebunit-htmlunit-plugin/pom.xml      2012-08-16 19:40:21 UTC (rev 
953)
+++ trunk/jwebunit-htmlunit-plugin/pom.xml      2012-08-16 19:41:52 UTC (rev 
954)
@@ -53,6 +53,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
+            <optional>true</optional>
         </dependency>
         <dependency>
             <groupId>javax.servlet</groupId>

Modified: trunk/jwebunit-webdriver-plugin/pom.xml
===================================================================
--- trunk/jwebunit-webdriver-plugin/pom.xml     2012-08-16 19:40:21 UTC (rev 
953)
+++ trunk/jwebunit-webdriver-plugin/pom.xml     2012-08-16 19:41:52 UTC (rev 
954)
@@ -61,6 +61,7 @@
         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
+            <optional>true</optional>
         </dependency>
         <dependency>
             <groupId>javax.servlet</groupId>

Modified: trunk/src/changes/changes.xml
===================================================================
--- trunk/src/changes/changes.xml       2012-08-16 19:40:21 UTC (rev 953)
+++ trunk/src/changes/changes.xml       2012-08-16 19:41:52 UTC (rev 954)
@@ -31,6 +31,10 @@
     </properties>
     <body>
         <release version="3.1" date="UNKNOW" description="Cleanup for 
Webdriver integration">
+            <action type="update" dev="henryju" issue="3476459" due-to="Jevon 
Wright">
+                Updated dependencies to not provide logback transitively. 
Added a section in documentation
+                to explain how to use logback. 
+            </action>
             <action type="update" dev="henryju">
                 Updated to HtmlUnit 2.10.
             </action>

Modified: trunk/src/site/site.xml
===================================================================
--- trunk/src/site/site.xml     2012-08-16 19:40:21 UTC (rev 953)
+++ trunk/src/site/site.xml     2012-08-16 19:41:52 UTC (rev 954)
@@ -54,8 +54,12 @@
             <item name="Installation" href="installation.html" />
             <item name="Quick start" href="quickstart.html"
                 collapse="true">
-                <item name="Creating a TestCase"
-                    href="#Creating_a_TestCase" />
+                <item name="JUnit 4"
+                    href="#Creating_a_JUnit_4_TestCase" />
+                <item name="JUnit 3 (deprecated)"
+                    href="#Creating_a_JUnit_3_TestCase_deprecated" />
+                <item name="Configuring logging"
+                    href="#Configuring_logging" />
                 <item name="Selecting a plugin"
                        href="#Selecting_the_plugin_you_want_to_use" />
                 <item name="Site Navigation"

Modified: trunk/src/site/xdoc/quickstart.xml
===================================================================
--- trunk/src/site/xdoc/quickstart.xml  2012-08-16 19:40:21 UTC (rev 953)
+++ trunk/src/site/xdoc/quickstart.xml  2012-08-16 19:41:52 UTC (rev 954)
@@ -35,13 +35,13 @@
 <p>
        JWebUnit uses two approaches for creating JUnit 4 test cases: static 
import and delegation. The simplest is
        to statically import all methods of 
net.sourceforge.jwebunit.junit.JWebUnit.
-
-       <source>
+</p>
+<source>
 import static net.sourceforge.jwebunit.junit.JWebUnit.*;
 
 public class ExampleWebTestCase {
        
-       @Before
+    @Before
     public void prepare() {
         setBaseUrl("http://localhost:8080/test";);
     }
@@ -56,12 +56,12 @@
         submit();
         assertTitleEquals("Welcome, test!");
     }
-}
-       </source>
+}</source>
+<p>
        An alternative is to include an instance of the WebTester class in your 
TestCase and delegate navigation
        and assertions to it.  This is provided in case you need or prefer 
delegation.
-       
-       <source>
+</p>   
+<source>
 import net.sourceforge.jwebunit.junit.WebTester;
 
 public class ExampleWebTestCase {
@@ -83,8 +83,8 @@
         tester.submit();
         tester.assertTitleEquals("Welcome, test!");
     }
-}
-       </source>
+}</source>
+<p>
 In the following samples, JUnit 4 and static import will be used.
 </p>
 </subsection>
@@ -93,8 +93,8 @@
 <p>
        JWebUnit uses two approaches for creating JUnit 3 test cases: 
inheritance and delegation. The simplest is
        to inherit from WebTestCase rather than junit.framework.TestCase.
-
-       <source>
+</p>
+<source>
 import net.sourceforge.jwebunit.junit.WebTestCase;
 
 public class ExampleWebTestCase extends WebTestCase {
@@ -113,13 +113,14 @@
         submit();
         assertTitleEquals("Welcome, test!");
     }
-}
-       </source>
+}</source>
+<p>
        An alternative is to include an instance of the WebTester class in your 
TestCase and delegate navigation
-       and assertions to it.  This is provided in case you need or prefer 
delegation.
+       and assertions to it.  This is provided in case you need or prefer 
delegation.<br/>
        <b>WARNING: WebTester was migrated to JUnit 4. As a result all assertXX 
will throw java.lang.AssertionError 
        instead of old junit.framework.AssertionFailedError.</b>
-       <source>
+</p>
+<source>
 import junit.framework.TestCase;
 import net.sourceforge.jwebunit.junit.WebTester;
 
@@ -141,37 +142,59 @@
         tester.submit();
         tester.assertTitleEquals("Welcome, test!");
     }
-}
-       </source>
-</p>
+}</source>
+
 </subsection>
 
-<subsection name="Configuring Logback">
+<subsection name="Configuring logging">
 <p>
-       <a href="http://hc.apache.org/";>Apache Commons' HTTP Components 
project</a>, one of the dependencies of JWebUnit, uses the <a 
href="http://logback.qos.ch/";>logback logging framework</a> extensively.
-       This means that if you do not have logback correctly configured, you 
will get <a 
href="http://stackoverflow.com/questions/4915414/disable-httpclient-logging";>a 
lot of debug information</a> piped to stdout.
+       JWebUnit use <a href="http://www.slf4j.org/";>SLF4J</a> to log. SLF4J is 
only a facade so with the default 
+       Maven configuration you will only get slf4j-api in your classpath with 
no implementation. If you run your tests
+       you will see a message like this:
 </p>
+<source>
+SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
+SLF4J: Defaulting to no-operation (NOP) logger implementation
+SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further 
details.</source>
+<p>
+       but no log at all.
+</p>
+<p>
+       Many popular logging framework do support SLF4J: log4j, jcl, logback, 
... For example here are the steps to 
+       configure <a href="http://logback.qos.ch/";>logback logging 
framework</a>:<br/>
+       <br/>
+       First you should add logback JAR to your classpath. If you are using 
Maven, simply add:
+</p>
+<source><![CDATA[
+    <dependency>
+        <groupId>ch.qos.logback</groupId>
+        <artifactId>logback-classic</artifactId>
+        <version>1.0.6</version>
+        <scope>test</scope>
+    </dependency>]]></source>
 
 <p>
-       A simple way to configure logback is to create a file called 
<i>logback.xml</i> with the following contents, and placing it in your source 
folder (for example, <i>src</i>).
-       This will suppress all debugging messages unless they are at the ERROR 
level or higher.
+       Now if you run your tests everything will be logged to console. Some 
components are very verbose so here is a sample logback configuration
+       to reduce verbosity. Just create a file called logback-test.xml in your 
classpath (<tt>src/test/resources</tt> is a good place if you are following
+       Maven conventions).     This will suppress all debugging messages 
unless they are at the ERROR level or higher.
 </p>
+<source><![CDATA[
+<configuration debug="false">
+       <!-- definition of appender STDOUT -->
+       <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+               <encoder>
+                       <pattern>%-4relative [%thread] %-5level %logger{35} - 
%msg %n</pattern>
+               </encoder>
+       </appender>
 
-<source>
-&lt;configuration debug="false"&gt;
-  &lt;!-- definition of appender STDOUT --&gt;
-  &lt;appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"&gt;
-    &lt;encoder&gt;
-      &lt;pattern&gt;%-4relative [%thread] %-5level %logger{35} - %msg 
%n&lt;/pattern&gt;
-    &lt;/encoder&gt;
-  &lt;/appender&gt;
-
-  &lt;root level="ERROR"&gt;
-    &lt;!-- appender referenced after it is defined --&gt;
-    &lt;appender-ref ref="STDOUT"/&gt;
-  &lt;/root&gt; 
-&lt;/configuration&gt;
-</source>
+       <root level="ERROR">
+               <!-- appender referenced after it is defined -->
+               <appender-ref ref="STDOUT" />
+       </root>
+</configuration>]]></source>
+<p>
+       Please read <a 
href="http://logback.qos.ch/manual/configuration.html";>logback 
documentation</a> for more details.
+</p>
 </subsection>
 
 <subsection name="Selecting the plugin you want to use">

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
Live Security Virtual Conference
Exclusive live event will cover all the ways today's security and 
threat landscape has changed and how IT managers can respond. Discussions 
will include endpoint security, mobile security and the latest in malware 
threats. http://www.accelacomm.com/jaw/sfrnl04242012/114/50122263/
_______________________________________________
JWebUnit-development mailing list
JWebUnit-development@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/jwebunit-development

Reply via email to