wiki:WikiOutputStreamPlugin

Version 4 (modified by aldrinleal, 8 years ago) (diff)

--

WikiOutputStreamPlugin

Description

Do you love Continuous Integration? Want to better integrate either JUnit, CruiseControl along with Trac? Sometimes you want to either publish your test reports directly into Trac's Wiki (why not?). Perhaps you want to also let you directly hyperlink your Java class names direcly into the source browser, right?

If you answered 'yes' to some of the questions, there is an answer right here!

WikiOutputStreamPlugin is a OutputStream for Java which lets you easily publish direcly into Trac as an Wiki Article. It accomplishes this by 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.

Bugs/Feature Requests

Existing bugs and feature requests for WikiOutputStreamPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out WikiOutputStreamPlugin from here using Subversion, or browse the source with Trac.

Example

Suppose you have a testCase/suite you'd like to let you publish results directly into trac. Or perhaps you want to create a Log4J Logging Module publish their results into trac. WikiOutputStreamPlugin 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:

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]]");
  }
}

Recent Changes

[1446] by aldrinleal on 2006-10-24 02:51:51

WikiOutputStreamPlugin:

  • Added mode for complete Disabling of WikiPageOutputStream
[1413] by aldrinleal on 2006-10-20 18:11:25

WikiOutputStreamPlugin:

  • JSch LICENSE.JSch added;
[1411] by aldrinleal on 2006-10-20 10:51:11

WikiOutputStreamPlugin:

  • Sample trac.properties added, sourcefolder also

Author/Contributors

Author: aldrinleal
Contributors: