Skip to content

Fix order of names in steps #641

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timja merged 5 commits into from
Apr 23, 2025
Merged

Fix order of names in steps #641

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3fd1f3d
Update ConsoleLogCard.tsx
janfaracik Apr 23, 2025
9dd5ebd
Push
janfaracik Apr 23, 2025
38b40ff
Fix tests
janfaracik Apr 23, 2025
3212375
Update PipelineStepApi.java
janfaracik Apr 23, 2025
a8aed24
Trigger Build
janfaracik Apr 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 4 additions & 9 deletions src/main/frontend/pipeline-console-view/pipeline-console/main/ConsoleLogCard.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,10 @@ export default function ConsoleLogCard(props: ConsoleLogCardProps) {
status={props.step.state}
percentage={props.step.completePercent}
/>
<span style={{ fontWeight: "450" }}>{props.step.name}</span>
<span
style={{
color: "var(--text-color-secondary)",
fontFamily: "var(--font-family-mono)",
}}
>
{props.step.title}
</span>

{props.step.title !== "" && <span>{props.step.title}</span>}

{props.step.name !== "" && <span>{props.step.name}</span>}

<svg
xmlns="http://www.w3.org/2000/svg"
Expand Down
8 changes: 6 additions & 2 deletions src/main/frontend/pipeline-console-view/pipeline-console/main/console-log-card.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,13 @@
max-width: 80%;
overflow: hidden;
text-overflow: ellipsis;
color: var(--text-color-secondary);
font-family: var(--font-family-mono);

&:empty {
display: none;
&:first-of-type {
color: var(--text-color);
font-weight: var(--font-bold-weight);
font-family: var(--font-family-sans);
}
}

Expand Down
8 changes: 6 additions & 2 deletions src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineStepApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,17 @@
displayName = cleanTextContent(displayName);
logger.debug("DisplayName After: '" + displayName + "'.");

// Ignore certain titles
if (title.equals("Shell Script") || title.equals("Print Message")) {

Check warning on line 49 in src/main/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineStepApi.java

View check run for this annotation

ci.jenkins.io / Code Coverage

Partially covered line 

Line 49 is only partially covered, one branch is missing
Copy link
Member

@timja timja Apr 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May need to check display name is set. I think there’s some times when the display name is thrown away with shell scripts

Copy link
Member Author

@janfaracik janfaracik Apr 23, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrapped it in an if to confirm display name is set.

title = "";
}

return new PipelineStep(
flowNodeWrapper.getId(),
displayName,
PipelineState.of(flowNodeWrapper.getStatus()),
flowNodeWrapper.getType().name(),
title, // TODO blue ocean uses timing information: "Passed in
// 0s"
title,
stageId,
flowNodeWrapper.getTiming());
})
Expand Down
68 changes: 34 additions & 34 deletions src/test/java/io/jenkins/plugins/pipelinegraphview/utils/PipelineStepApiLegacyTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ void unstableSmokes(JenkinsRule j) throws Exception {
List<PipelineStep> steps = api.getLegacySteps(unstableOneId).getSteps();
assertThat(steps, hasSize(3));
assertThat(steps.get(0).getName(), is("foo"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("oops-one"));
assertThat(steps.get(1).getTitle(), is("Set stage result to unstable"));
assertThat(steps.get(2).getName(), is("bar"));
assertThat(steps.get(2).getTitle(), is("Print Message"));
assertThat(steps.get(2).getTitle(), is(""));

steps = api.getSteps(successId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("baz"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(unstableTwoId).getSteps();
assertThat(steps, hasSize(2));
Expand Down Expand Up @@ -87,25 +87,25 @@ void complexParallelBranchesHaveCorrectSteps(JenkinsRule j) throws Exception {
List<PipelineStep> steps = api.getLegacySteps(nonParallelId).getSteps();
assertThat(steps, hasSize(2));
assertThat(steps.get(0).getName(), is("This stage will be executed first."));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));

// Check 'Branch A'
steps = api.getSteps(branchAId).getSteps();
assertThat(steps, hasSize(2));
assertThat(steps.get(0).getName(), is("On Branch A - 1"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("On Branch A - 2"));
assertThat(steps.get(1).getTitle(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));

// Check 'Branch B'
steps = api.getSteps(branchBId).getSteps();
assertThat(steps, hasSize(2));
assertThat(steps.get(0).getName(), is("On Branch B - 1"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("On Branch B - 2"));
assertThat(steps.get(1).getTitle(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));

// Check 'Branch C'
steps = api.getSteps(branchCId).getSteps();
Expand All @@ -115,17 +115,17 @@ void complexParallelBranchesHaveCorrectSteps(JenkinsRule j) throws Exception {
steps = api.getSteps(branchNested1Id).getSteps();
assertThat(steps, hasSize(2));
assertThat(steps.get(0).getName(), is("In stage Nested 1 - 1 within Branch C"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("In stage Nested 1 - 2 within Branch C"));
assertThat(steps.get(1).getTitle(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));

// Check 'Nested 2'
steps = api.getSteps(branchNested2Id).getSteps();
assertThat(steps, hasSize(2));
assertThat(steps.get(0).getName(), is("In stage Nested 2 - 1 within Branch C"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("In stage Nested 2 - 2 within Branch C"));
assertThat(steps.get(1).getTitle(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));
}

@Test
Expand All @@ -152,7 +152,7 @@ void nestedStagesHaveCorrectSteps(JenkinsRule j) throws Exception {
List<PipelineStep> steps = api.getSteps(childAId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("In child A"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

// Check 'Child A'
steps = api.getSteps(childBId).getSteps();
Expand All @@ -162,7 +162,7 @@ void nestedStagesHaveCorrectSteps(JenkinsRule j) throws Exception {
steps = api.getSteps(grandchildBId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("In grandchild B"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

// Check 'Child C'
steps = api.getSteps(childCId).getSteps();
Expand All @@ -176,7 +176,7 @@ void nestedStagesHaveCorrectSteps(JenkinsRule j) throws Exception {
steps = api.getSteps(greatGrandchildCId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("In great-grandchild C"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
}

@Test
Expand All @@ -193,26 +193,26 @@ void getAllStepsReturnsStepsForComplexParallelBranches(JenkinsRule j) throws Exc
List<PipelineStep> steps = api.getAllSteps().getSteps();
assertThat(steps, hasSize(11));
assertThat(steps.get(0).getName(), is("This stage will be executed first."));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));
assertThat(steps.get(2).getName(), is("On Branch A - 1"));
assertThat(steps.get(2).getTitle(), is("Print Message"));
assertThat(steps.get(2).getTitle(), is(""));
assertThat(steps.get(3).getName(), is("On Branch A - 2"));
assertThat(steps.get(3).getTitle(), is("Print Message"));
assertThat(steps.get(3).getTitle(), is(""));
assertThat(steps.get(4).getName(), is("On Branch B - 1"));
assertThat(steps.get(4).getTitle(), is("Print Message"));
assertThat(steps.get(4).getTitle(), is(""));
assertThat(steps.get(5).getName(), is("On Branch B - 2"));
assertThat(steps.get(5).getTitle(), is("Print Message"));
assertThat(steps.get(5).getTitle(), is(""));

assertThat(steps.get(6).getName(), is("In stage Nested 1 - 1 within Branch C"));
assertThat(steps.get(6).getTitle(), is("Print Message"));
assertThat(steps.get(6).getTitle(), is(""));
assertThat(steps.get(7).getName(), is("In stage Nested 1 - 2 within Branch C"));
assertThat(steps.get(7).getTitle(), is("Print Message"));
assertThat(steps.get(7).getTitle(), is(""));
assertThat(steps.get(8).getName(), is("In stage Nested 2 - 1 within Branch C"));
assertThat(steps.get(8).getTitle(), is("Print Message"));
assertThat(steps.get(8).getTitle(), is(""));
assertThat(steps.get(9).getName(), is("In stage Nested 2 - 2 within Branch C"));
assertThat(steps.get(9).getTitle(), is("Print Message"));
assertThat(steps.get(9).getTitle(), is(""));
assertThat(steps.get(10).getName(), is("Get contextual object from internal APIs"));
assertThat(steps.get(10).getTitle(), is(""));
}
Expand All @@ -229,11 +229,11 @@ void getAllStepsReturnsStepsForNestedStages(JenkinsRule j) throws Exception {
List<PipelineStep> steps = api.getAllSteps().getSteps();
assertThat(steps, hasSize(3));
assertThat(steps.get(0).getName(), is("In child A"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
assertThat(steps.get(1).getName(), is("In grandchild B"));
assertThat(steps.get(1).getTitle(), is("Print Message"));
assertThat(steps.get(1).getTitle(), is(""));
assertThat(steps.get(2).getName(), is("In great-grandchild C"));
assertThat(steps.get(2).getTitle(), is("Print Message"));
assertThat(steps.get(2).getTitle(), is(""));
}

@Issue("GH#92")
Expand Down Expand Up @@ -271,37 +271,37 @@ void githubIssue92RegressionTest(JenkinsRule j) throws Exception {
List<PipelineStep> steps = api.getLegacySteps(linux8CheckoutId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Checking out linux-8"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(linux8BuildId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Building linux-8"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(linux8ArchiveId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Archiving linux-8"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(linux11CheckoutId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Checking out linux-11"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(linux11BuildId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Building linux-11"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(linux11ArchiveId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Archiving linux-11"));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));

steps = api.getSteps(deployStageId).getSteps();
assertThat(steps, hasSize(1));
assertThat(steps.get(0).getName(), is("Deploying..."));
assertThat(steps.get(0).getTitle(), is("Print Message"));
assertThat(steps.get(0).getTitle(), is(""));
}

@Issue("GH#213")
Expand Down
Loading