Skip to content

Commit

Permalink
Using console note instead of log filter.
Browse files Browse the repository at this point in the history
  • Loading branch information
dblock committed Sep 3, 2011
1 parent 4084b92 commit a653c40
Show file tree
Hide file tree
Showing 10 changed files with 309 additions and 32 deletions.
24 changes: 24 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* The MIT License
*
* Copyright (c) 2011 Daniel Doubrovkine
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/

4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

<build>
<plugins>
<!-- Enforce Java 6.0 compatibility. -->
<!-- Enforce Java 5.0 compatibility. -->
<plugin>
<groupId>org.jvnet</groupId>
<artifactId>animal-sniffer</artifactId>
Expand All @@ -39,7 +39,7 @@
<configuration>
<signature>
<groupId>org.jvnet.animal-sniffer</groupId>
<artifactId>java1.6</artifactId>
<artifactId>java1.5</artifactId>
<version>1.0</version>
</signature>
</configuration>
Expand Down
139 changes: 139 additions & 0 deletions src/main/java/hudson/plugins/ansicolor/AnsiColorBuildWrapper.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
/*
* The MIT License
*
* Copyright (c) 2011 Daniel Doubrovkine
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.plugins.ansicolor;

import hudson.Extension;
import hudson.Launcher;
import hudson.console.LineTransformationOutputStream;
import hudson.model.AbstractBuild;
import hudson.model.AbstractProject;
import hudson.model.BuildListener;
import hudson.tasks.BuildWrapper;
import hudson.tasks.BuildWrapperDescriptor;

import java.io.IOException;
import java.io.OutputStream;

import org.kohsuke.stapler.DataBoundConstructor;

/**
* Build wrapper that decorates the build's logger to insert a
* {@link AnsiColorNote} on each output line.
*
* @author Daniel Doubrovkine
*/
public final class AnsiColorBuildWrapper extends BuildWrapper {

/**
* Create a new {@link AnsiColorBuildWrapper}.
*/
@DataBoundConstructor
public AnsiColorBuildWrapper() {

}

/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
@Override
public Environment setUp(AbstractBuild build, Launcher launcher,
BuildListener listener) throws IOException, InterruptedException {
return new Environment() {
};
}

/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked")
@Override
public OutputStream decorateLogger(AbstractBuild build, OutputStream logger) {
return new AnsiColorOutputStream(logger);
}

/**
* Output stream that writes each line to the provided delegate output
* stream after inserting a {@link AnsiColorNote}.
*/
private static class AnsiColorOutputStream extends
LineTransformationOutputStream {

/**
* The delegate output stream.
*/
private final OutputStream delegate;

/**
* Create a new {@link AnsiColorOutputStream}.
*
* @param delegate
* the delegate output stream
*/
private AnsiColorOutputStream(OutputStream delegate) {
this.delegate = delegate;
}

/**
* {@inheritDoc}
*/
@Override
protected void eol(byte[] b, int len) throws IOException {
new AnsiColorNote(new String(b, 0, len)).encodeTo(delegate);
delegate.write(b, 0, len);
}

/**
* {@inheritDoc}
*/
@Override
public void close() throws IOException {
super.close();
delegate.close();
}
}

/**
* Registers {@link AnsiColorBuildWrapper} as a {@link BuildWrapper}.
*/
@Extension
public static final class DescriptorImpl extends BuildWrapperDescriptor {

/**
* {@inheritDoc}
*/
@Override
public String getDisplayName() {
return Messages.DisplayName();
}

/**
* {@inheritDoc}
*/
@Override
public boolean isApplicable(AbstractProject<?, ?> item) {
return true;
}
}
}

This file was deleted.

94 changes: 94 additions & 0 deletions src/main/java/hudson/plugins/ansicolor/AnsiColorNote.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/*
* The MIT License
*
* Copyright (c) 2011 Daniel Doubrovkine
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.plugins.ansicolor;

import hudson.Extension;
import hudson.MarkupText;
import hudson.console.ConsoleAnnotationDescriptor;
import hudson.console.ConsoleAnnotator;
import hudson.console.ConsoleNote;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.logging.Level;
import java.util.logging.Logger;

@SuppressWarnings("unchecked")
public class AnsiColorNote extends ConsoleNote {

private static final long serialVersionUID = 1L;
private static final Logger LOG = Logger.getLogger(AnsiColorNote.class.getName());
private String data;

public AnsiColorNote(String data) {
this.data = data;
}

/**
* Annotate output that contains ANSI codes and hide raw text.
*/
@Override
public ConsoleAnnotator annotate(Object context, MarkupText text, int charPos) {
try {
String colorizedData = colorize(this.data);
if (! colorizedData.contentEquals(this.data)) {
text.addMarkup(charPos, colorizedData);
text.addMarkup(charPos, charPos + text.length(), "<span style=\"display: none;\">", "</span>");
}
} catch (IOException e) {
LOG.log(Level.WARNING, "Failed to add markup to \"" + text + "\"", e);
}
return null;
}

/**
* Process a string, convert ANSI markup to HTML.
* @param data string that may contain ANSI escape characters
* @return HTML string
* @throws IOException
*/
public static String colorize(String data) throws IOException {
ByteArrayOutputStream out = new ByteArrayOutputStream();
AnsiColorizer colorizer = new AnsiColorizer(out, Charset.defaultCharset());
colorizer.eol(data.getBytes(), data.length());
return out.toString();
}

public static String encodeTo(String html) {
try {
return new AnsiColorNote(html).encode();
} catch (IOException e) {
LOG.log(Level.WARNING, "Failed to serialize "+ AnsiColorNote.class, e);
return "";
}
}

@Extension
public static final class DescriptorImpl extends ConsoleAnnotationDescriptor {
public String getDisplayName() {
return "ANSI Color";
}
}
}
2 changes: 1 addition & 1 deletion src/main/java/hudson/plugins/ansicolor/AnsiColorizer.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
import java.nio.charset.Charset;

/**
* Time-stamp note that is inserted into the console output.
* ANSI color note that is inserted into the console output.
*
* @author Daniel Doubrovkine
*/
Expand Down
23 changes: 23 additions & 0 deletions src/main/java/hudson/plugins/ansicolor/AnsiHtmlOutputStream.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
/*
* The MIT License
*
* Copyright (c) 2011 Daniel Doubrovkine
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.plugins.ansicolor;

import java.io.IOException;
Expand Down
25 changes: 24 additions & 1 deletion src/main/java/hudson/plugins/ansicolor/PluginImpl.java
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
/*
* The MIT License
*
* Copyright (c) 2011 Daniel Doubrovkine
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.plugins.ansicolor;

import hudson.Plugin;
Expand All @@ -8,6 +31,6 @@ public class PluginImpl extends Plugin {
private final static Logger LOG = Logger.getLogger(PluginImpl.class.getName());

public void start() throws Exception {
LOG.info("starting AnsiColor plugin");
LOG.info("starting ansicolor plugin (https://github.com/dblock/jenkins-ansicolor-plugin)");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.

DisplayName = Add ANSI Color to the Console Output
DisplayName = Color ANSI Console Output
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@
import static org.junit.Assert.assertThat;

import java.io.IOException;
import java.nio.charset.Charset;

import org.codehaus.plexus.util.StringOutputStream;
import org.junit.Test;

/**
Expand Down Expand Up @@ -70,10 +68,6 @@ public void testGreenOnWhite() throws IOException {
}

private String colorize(String text) throws IOException {
StringOutputStream out = new StringOutputStream();
AnsiColorizer colorizer = new AnsiColorizer(out, Charset
.defaultCharset());
colorizer.eol(text.getBytes(), text.length());
return out.toString();
return AnsiColorNote.colorize(text);
}
}

0 comments on commit a653c40

Please sign in to comment.