Skip to content

Commit

Permalink
avoid printing too long argument in Pipeline Steps visualisation
Browse files Browse the repository at this point in the history
In some cases it is possible that node argument will be impossible to
wrap properly and is displayed as single line. In this case pipeline
steps view becomes hard to read because right most columns are moved
beyond the screen. This requires scrolling which is not so convenient.
Also status colum is outside of screen.

This change cuts arguments list to 80 characters which should be fine
for most of usages.

Signed-off-by: Artur Harasimiuk <[email protected]>
  • Loading branch information
ArturHarasimiuk committed Aug 24, 2018
1 parent 8105510 commit ea2fba4
Show file tree
Hide file tree
Showing 2 changed files with 93 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
package org.jenkinsci.plugins.workflow.support.visualization.table;

import hudson.Extension;
import org.apache.commons.lang.StringUtils;
import org.jenkinsci.plugins.workflow.actions.ArgumentsAction;
import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.visualization.table.FlowNodeViewColumn;
Expand All @@ -39,7 +40,7 @@ public class ArgumentsColumn extends FlowNodeViewColumn {
@DataBoundConstructor public ArgumentsColumn() {}

public String get(FlowNode node) {
return ArgumentsAction.getStepArgumentsAsString(node);
return StringUtils.substring(ArgumentsAction.getStepArgumentsAsString(node), 0, 80);
}

@Extension public static class DescriptorImpl extends FlowNodeViewColumnDescriptor {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
/*
* The MIT License
*
* Copyright (c) 2018, Intel Corporation
*
* 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 org.jenkinsci.plugins.workflow.support.visualization;

import static org.junit.Assert.*;
import org.junit.Test;

import java.util.ArrayList;
import java.util.Map;
import java.util.Set;

import org.jenkinsci.plugins.workflow.graph.FlowNode;
import org.jenkinsci.plugins.workflow.graph.StepNode;
import org.jenkinsci.plugins.workflow.steps.Step;
import org.jenkinsci.plugins.workflow.steps.StepContext;
import org.jenkinsci.plugins.workflow.steps.StepDescriptor;
import org.jenkinsci.plugins.workflow.steps.StepExecution;
import org.jenkinsci.plugins.workflow.support.visualization.table.ArgumentsColumn;

public class ArgumentsColumnTest extends Step {

private static final class DescriptorMock extends StepDescriptor {
@Override
public String getFunctionName() {
return "func";
}

@Override
public Set<? extends Class<?>> getRequiredContext() {
return null;
}

@Override
public String argumentsToString(Map<String, Object> namedArgs) {
return "123123123123123123123123123123123123123123123123123123123123123123123123123123123123123123123123";
}
}

private class TestedNode extends FlowNode implements StepNode {
public TestedNode() {
super(null, "1", new ArrayList<FlowNode>());
}

@Override
public StepDescriptor getDescriptor() {
return new DescriptorMock();
}

@Override
protected String getTypeDisplayName() {
return null;
}
}

@Test
public void testLongStepArguments() {
FlowNode f = new TestedNode();
ArgumentsColumn col = new ArgumentsColumn();

String s = col.get(f);
assertTrue(s.length()<=80);
}


@Override public StepExecution start(final StepContext context) throws Exception {
return null;
}

}

0 comments on commit ea2fba4

Please sign in to comment.