[JWebUnit-development] [ jwebunit-Feature Requests-3476459 ] Provide sample logback.xml in quick start guide

[SourceForge.net <no...@so...>]

Feature Requests item #3476459, was opened at 2012-01-19 20:04
Message generated for change (Comment added) made by jevonwright
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=497985&aid=3476459&group_id=61302

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: None
Status: Open
Priority: 7
Private: No
Submitted By: Jevon Wright (jevonwright)
Assigned to: Nobody/Anonymous (nobody)
Summary: Provide sample logback.xml in quick start guide

Initial Comment:
By default, if you extract JWebUnit into a new project with no existing logger configuration, JWebUnit now uses the logback logging framework. However the quick start documentation says nothing about this framework, or how to configure it. By default, ALL debug messages -- including debugging at the level of the sockets in HttpClient -- will be printed when executing a test.

At the very least, the quick start guide should include a sample logback.xml file such as the one I discuss on StackOverflow: http://stackoverflow.com/questions/4915414/disable-httpclient-logging/8936580#8936580

That is:

<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>

  <root level="ERROR">
    <!-- appender referenced after it is defined -->
    <appender-ref ref="STDOUT"/>
  </root> 
</configuration>

----------------------------------------------------------------------

>Comment By: Jevon Wright (jevonwright)
Date: 2012-01-24 15:32

Message:
I don't mind either option, it just needs to be well documented :-) If
JWebUnit includes HtmlUnit, then it should also include some logging
framework (if a logging framework is necessary) and documentation on how to
confiugre it (if necessary).

Perhaps you can keep it an optional dependency for people who use
Maven/POM, but for users who download the JWebUnit JARs directly, include
logback & a sample logback.xml in those JARs. Alternatively, include log4j
and sample log4j.properties.

----------------------------------------------------------------------

Comment By: Julien HENRY (henryju)
Date: 2012-01-20 01:15

Message:
Just checked and you are right, logback is in the dependency list. Seems
that the optional flag is not working with dependency management...
http://jira.codehaus.org/browse/MNG-4600

My purpose was to let users choose the logging framework they want. I see
two options:

A - don't provide any slf4j implementation by default. Mean users are
forced to add another dependency in their poms (it was my first intention)
B - continue to provide logback by default. Users that don't want logback
can add an exclusion (it is the current situation)

WDYT?

----------------------------------------------------------------------

Comment By: Julien HENRY (henryju)
Date: 2012-01-20 01:07

Message:
JWebUnit should not use logback but slf4j. Logback is an optional
dependency that should not be taken transitively and is used for our unit
tests. It is up to the end user to choose an slf4j implementation (logback,
slf4j-log4j12, slf4j-jcl, ...) and provide the configuration.
But you are right that it should be documented.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=497985&aid=3476459&group_id=61302