From b5f51e64a8cc111520e48aff1e31972146b326ec Mon Sep 17 00:00:00 2001 From: Artur Harasimiuk Date: Thu, 23 Aug 2018 23:04:41 +0200 Subject: [PATCH 1/2] avoid printing too long argument in Pipeline Steps visualisation 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 --- .../visualization/table/ArgumentsColumn.java | 3 +- .../visualization/ArgumentsColumnTest.java | 91 +++++++++++++++++++ 2 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java diff --git a/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java b/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java index af8537ec..7b5c1f8f 100644 --- a/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java +++ b/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java @@ -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; @@ -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 { diff --git a/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java b/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java new file mode 100644 index 00000000..fd77b0c4 --- /dev/null +++ b/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java @@ -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> getRequiredContext() { + return null; + } + + @Override + public String argumentsToString(Map namedArgs) { + return "123123123123123123123123123123123123123123123123123123123123123123123123123123123123123123123123"; + } + } + + private class TestedNode extends FlowNode implements StepNode { + public TestedNode() { + super(null, "1", new ArrayList()); + } + + @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; + } + +} From ee8f83b529b17a6d82f89a4f01936115f3865240 Mon Sep 17 00:00:00 2001 From: Artur Harasimiuk Date: Tue, 11 Jun 2019 18:12:59 +0200 Subject: [PATCH 2/2] truncate node argument at 77 and add '...' at the end Signed-off-by: Artur Harasimiuk --- .../workflow/support/visualization/table/ArgumentsColumn.java | 4 +++- .../workflow/support/visualization/ArgumentsColumnTest.java | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java b/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java index 7b5c1f8f..0068f0f4 100644 --- a/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java +++ b/src/main/java/org/jenkinsci/plugins/workflow/support/visualization/table/ArgumentsColumn.java @@ -40,7 +40,9 @@ public class ArgumentsColumn extends FlowNodeViewColumn { @DataBoundConstructor public ArgumentsColumn() {} public String get(FlowNode node) { - return StringUtils.substring(ArgumentsAction.getStepArgumentsAsString(node), 0, 80); + if(StringUtils.length(ArgumentsAction.getStepArgumentsAsString(node))>77) + return StringUtils.substring(ArgumentsAction.getStepArgumentsAsString(node), 0, 77) + "..."; + return ArgumentsAction.getStepArgumentsAsString(node); } @Extension public static class DescriptorImpl extends FlowNodeViewColumnDescriptor { diff --git a/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java b/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java index fd77b0c4..5a6d932d 100644 --- a/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java +++ b/src/test/java/org/jenkinsci/plugins/workflow/support/visualization/ArgumentsColumnTest.java @@ -31,6 +31,7 @@ import java.util.Map; import java.util.Set; +import org.apache.commons.lang.StringUtils; import org.jenkinsci.plugins.workflow.graph.FlowNode; import org.jenkinsci.plugins.workflow.graph.StepNode; import org.jenkinsci.plugins.workflow.steps.Step; @@ -81,6 +82,7 @@ public void testLongStepArguments() { String s = col.get(f); assertTrue(s.length()<=80); + assertTrue(StringUtils.right(s, 3).equals("...")); }