= Publish output directly into Trac

== Description

This plugin is an !OutputStream for Java, which lets you easily publish direcly into Trac as a wiki page. This is accomplished running trac-admin over an ssh-pki-authenticated-remote-shell-connection. It also contains goodies for hyperlinking class names directly into Trac's source browser.

Key features:
 * Integrate either [http://junit.org/ JUnit] or [http://cruisecontrol.sourceforge.net/ CruiseControl] into [http://trac.edgewall.com/ Trac].
 * Publish your test reports directly into Trac's wiki.
 * Hyperlink your Java class names directly into the source browser.


Suppose you have test results you would like to publish directly into Trac. Or perhaps you want to create a [http://loggging.apache.org/log4j/ Log4J] Logging Module publish their results into Trac. This plugin usage is fairly simple: once you configure it (by creating a simple 'trac.properties' file in your classpath, or by doing the hardcoded-way), you can easily create a new and start using:

{{{#!java
import junit.framework.TestCase;
import br.eng.leal.trac.WikiPageOutputStream;

public class MyTestCaseWhichReportsAsAWiki extends TestCase {
  private PrintStream printStream;
  
  /**
   * Try to setup an WikiOutputStream, resorting do System.out as a fallback measure
   */
  protected void setUp() {
    try {
      this.printStream = new PrintStream(new WikiPageOutputStream(this.getName().substring("test";.length()), true);
    } catch (Exception exc) {
      this.printStream = System.out;
    }
  }

  /**
   * Somewhere later...
   */
  protected void tearDown() {
    this.printStream.close();
  }

  /**
   *  On Sucessfull connection, this must create a page named "Something" over on trac's Wiki
   */
  public void testSomething() {
    this.printStream("[[br]]Hello, Trac![[br]]");
  }
}
}}}

It uses [http://www.jcraft.com/jsch/ Java Secure Channel (JSch)] from [http://www.jcraft.com/ JCraft], which itself is BSD licensed.

== Bugs/Feature Requests

Existing bugs and feature requests for WikiOutputStreamPlugin are 
[report:9?COMPONENT=WikiOutputStreamPlugin here].

If you have any issues, create a 
[/newticket?component=WikiOutputStreamPlugin new ticket].

[[TicketQuery(component=WikiOutputStreamPlugin&group=type,format=progress)]]

== Download

Download the zipped source from [export:wikioutputstreamplugin here].

== Source

You can check out WikiOutputStreamPlugin from [/svn/wikioutputstreamplugin here] using Subversion, or [source:wikioutputstreamplugin browse the source] with Trac.

== Installation

General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.

== Recent Changes

[[ChangeLog(wikioutputstreamplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:aldrinleal] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''