Output pipeline summary #66

mrginglymus · 2020-12-30T15:56:31Z

Relating to jenkinsci/github-checks-plugin#89

Very much a draft, as I've bent a lot of plumbing to get this working, which I'll fix if it's felt this is something worth pursuing.

This piggy-backs on the logic from the FlowGraphTable to generate a simple textual representation of the pipeline graph.

It produces an output that looks something like:

In progress

Simple Stage (61 ms)
In parallel (running)
- p1 (running)
  - p1s1 (43 ms)
    Unstable: something went wrong
  - p1s2 (running)
- p2 (44 ms)

Complete

Simple Stage (61 ms)
In parallel (0.25 sec)
- p1 (10 ms)
  - p1s1 (43 ms)
    Unstable: something went wrong
  - p1s2 (17 ms)
- p2 (44 ms)
Fails (41 ms)
Error: hudson.AbortException: something went very wrong

Note that I've removed the checkout listener, as that will now be handled by the graph listener.

mrginglymus · 2020-12-30T16:00:21Z

I've just realised those URLs are API urls - I'll work out where the display urls are hidden.

timja

Looks good, need to test out myself, not sure if using blueoceans internals is the best

src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java

mrginglymus · 2020-12-30T17:52:37Z

I've removed links for now, until we can work out how to make them useful, as there doesn't appear to be a way to easily deep link to a flow node.

timja · 2020-12-30T20:53:56Z

I've removed links for now, until we can work out how to make them useful, as there doesn't appear to be a way to easily deep link to a flow node.

Tests failure example here:
https://github.com/timja-org/junit-attachments-test/pull/4/checks?check_run_id=1627758985

Compilation failure:
https://github.com/timja-org/junit-attachments-test/pull/7/checks?check_run_id=1627774960

Example for inspiration of how the CloudBees SCM reporter shows failures:
https://github.com/cloudbees-sticky-dev/dow/pull/2/checks?check_run_id=925770699

it would be good if we could get the script that caused the failure in there

mrginglymus · 2020-12-30T21:13:18Z

Should be easy enough, will have a play tomorrow.

Even bumping to 1.3.0, revapi is unhappy about removal of a public class (which was only public because @Extension) and reduction of ctor visibility (because checkstyle/spotbugs/someone told me to).

Not that the version fettling particularly matters right now, but it'd be nice to get something green.

timja · 2020-12-30T21:18:36Z

Should be easy enough, will have a play tomorrow.

Even bumping to 1.3.0, revapi is unhappy about removal of a public class (which was only public because @Extension) and reduction of ctor visibility (because checkstyle/spotbugs/someone told me to).

Not that the version fettling particularly matters right now, but it'd be nice to get something green.

I think you can add an exclusion for that

XiongKezhi · 2020-12-31T06:37:20Z

For the table view, maybe you'll need: https://github.github.com/gfm/#tables-extension-

src/test/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisherITest.java

timja · 2020-12-31T08:20:01Z

To be honest I’m not sure the Graph is terrible interesting, in larger pipelines it will be huge, aren’t we just interested in failed steps? And the input and output of those steps. Along with the stage / branch it failed on

mrginglymus · 2020-12-31T12:20:58Z

This new design will push the full tree view into ChecksOutput text, and summarise results in the summary:

Summary

`In parallel / p1 / p1s1 / Set stage result to unstable`

Warning in unstable step, with arguments something went wrong.

something went wrong

`Fails / Archive the artifacts`

Error in archiveArtifacts step.

No artifacts found that match the file pattern "oh dear". Configuration error?

Stack trace

hudson.AbortException: No artifacts found that match the file pattern "oh dear". Configuration error?
	at hudson.tasks.ArtifactArchiver.perform(ArtifactArchiver.java:258)
	at org.jenkinsci.plugins.workflow.steps.CoreStep$Execution.run(CoreStep.java:80)
	at org.jenkinsci.plugins.workflow.steps.CoreStep$Execution.run(CoreStep.java:67)
	at org.jenkinsci.plugins.workflow.steps.SynchronousNonBlockingStepExecution.lambda$start$0(SynchronousNonBlockingStepExecution.java:47)
	at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511)
	at java.util.concurrent.FutureTask.run(FutureTask.java:266)
	at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624)
	at java.lang.Thread.run(Thread.java:748)

Text

Simple Stage (50 ms)
In parallel (0.25 sec)
- p1 (5 ms)
  - p1s1 (44 ms)
    Unstable: something went wrong
  - p1s2 (18 ms)
- p2 (45 ms)
Fails (0.28 sec)
Error: No artifacts found that match the file pattern "oh dear". Configuration error?

I'll need to check limits on output sizes...

mrginglymus · 2020-12-31T12:33:14Z

Once again, thwarted by revapi :(

timja · 2020-12-31T13:04:09Z

Junit has some code around limiting the output if you check it’s publisher

uhafner · 2020-12-31T13:50:36Z

Once again, thwarted by revapi :(

When you are developing a new feature you should increase the minor version in pom.xml. Patch versions are reserved for bug fixes that do not change the API.

mrginglymus · 2020-12-31T14:09:21Z

Once again, thwarted by revapi :(

When you are developing a new feature you should increase the minor version in pom.xml. Patch versions are reserved for bug fixes that do not change the API.

👍

That’s fine, but my frustration is that revapi passes locally!

mrginglymus · 2020-12-31T14:46:45Z

revapi still not happy :(

Co-authored-by: Tim Jacomb <21194782+timja@users.noreply.github.com>

src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java

src/main/java/io/jenkins/plugins/checks/status/FlowExecutionAnalyzer.java

src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java

timja · 2021-01-31T13:22:34Z

Any other planned work? I'll try test it out soon

mrginglymus · 2021-01-31T13:52:18Z

Nothing planned for now

timja · 2021-01-31T14:09:48Z

New lines don't seem to be working for the build log / some issue:

https://github.com/timja-org/junit-attachments-test/pull/7/checks?sha=b438cc8ff4005d214221edeaf94474572d44c165

also see what happens with ansi colours:

https://github.com/timja-org/junit-attachments-test/pull/7/checks?check_run_id=1801300909

tbh I think it might just be a spacing issue with the markdown needing another new line

mrginglymus · 2021-01-31T14:55:13Z

Yep, missing a trailing newline...I think just that...

timja · 2021-01-31T15:01:57Z

Didn't seem to fix it

https://github.com/timja-org/junit-attachments-test/pull/7/checks?sha=b438cc8ff4005d214221edeaf94474572d44c165

timja · 2021-01-31T15:17:33Z

Fixed with another new line:
https://github.com/timja-org/junit-attachments-test/pull/7/checks?check_run_id=1801505585

Possible enhancement would be to strip ansi colour code's before sending
https://github.com/timja-org/junit-attachments-test/runs/1801514492

timja · 2021-01-31T15:22:50Z

Could we set a better message on the failure reason on the check?

failed in 'stage' or sh step failed in 'stage' ?

or another suggestion

timja · 2021-01-31T15:26:47Z

If you prefer we ship we can do that and create a new issue for the above ^^

mrginglymus · 2021-01-31T15:53:11Z

Ahh the mysteries of GitHub flavoured markdown

timja · 2021-01-31T17:24:39Z

@mrginglymus #66 (comment) ?

XiongKezhi

An amazing feature, huge thanks!!!

src/main/java/io/jenkins/plugins/checks/status/FlowExecutionAnalyzer.java

XiongKezhi · 2021-02-03T08:59:22Z

Could we set a better message on the failure reason on the check?

failed in 'stage' or sh step failed in 'stage' ?

or another suggestion

include both stage and step name would be great

justinmchase · 2021-02-05T19:30:12Z

Successful build! 🚀

I'm looking forward to updating this plugin in Jenkins.

Co-authored-by: Kezhi Xiong <august.xkz@gmail.com>

jglick · 2021-02-08T14:25:23Z

I'll need to check limits on output sizes

FYI https://github.community/t/undocumented-65535-character-limit-on-requests/117564/5?u=jglick

timja · 2021-02-08T14:31:42Z

I'll need to check limits on output sizes

FYI github.community/t/undocumented-65535-character-limit-on-requests/117564/5?u=jglick

ended up being implemented here btw: jenkinsci/github-checks-plugin#101

and API side: #68

mrginglymus force-pushed the graph-listener branch from e8595dd to bff4661 Compare December 30, 2020 15:57

mrginglymus force-pushed the graph-listener branch from bff4661 to b65b844 Compare December 30, 2020 16:00

timja reviewed Dec 30, 2020

View reviewed changes

src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java Outdated Show resolved Hide resolved

mrginglymus force-pushed the graph-listener branch from 26ca1c3 to 5b2d618 Compare December 30, 2020 17:50

mrginglymus mentioned this pull request Dec 30, 2020

It would be nice to show each Stage and Step in the check summary jenkinsci/github-checks-plugin#89

Closed

mrginglymus force-pushed the graph-listener branch from 5b2d618 to f4ffe8c Compare December 30, 2020 17:53

XiongKezhi added the enhancement New feature or request label Dec 31, 2020

XiongKezhi reviewed Dec 31, 2020

View reviewed changes

src/test/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisherITest.java Show resolved Hide resolved

mrginglymus added 6 commits December 31, 2020 12:21

Output pipeline summary

c015552

Remove blueocean dependency, links

4cfcdcc

Fix existing tests

cbfeffe

Satisfy linting

5dcb2df

Output more useful summary

788a362

Make revapi happy

af2ae02

mrginglymus force-pushed the graph-listener branch from e5836cd to af2ae02 Compare December 31, 2020 12:22

Tidy imports

5f56e4d

Bump version

91e8713

mrginglymus and others added 3 commits January 12, 2021 08:32

Merge branch 'master' into graph-listener

d360ff8

Use new truncated string builder

ae3a89e

Fix spotbugs log issue

7e573a4

Co-authored-by: Tim Jacomb <21194782+timja@users.noreply.github.com>

XiongKezhi reviewed Jan 14, 2021

View reviewed changes

mrginglymus added 2 commits January 31, 2021 12:06

Split out row processing logic

d3cca47

Add logging

a4c9c91

timja reviewed Jan 31, 2021

View reviewed changes

src/main/java/io/jenkins/plugins/checks/status/BuildStatusChecksPublisher.java Outdated Show resolved Hide resolved

Actually log the exception

6b51f2e

mrginglymus requested a review from XiongKezhi January 31, 2021 12:57

Add missing trailing newline

0b7a12e

Fix new line

87ae8a1

XiongKezhi approved these changes Feb 3, 2021

View reviewed changes

src/main/java/io/jenkins/plugins/checks/status/FlowExecutionAnalyzer.java Outdated Show resolved Hide resolved

src/main/java/io/jenkins/plugins/checks/status/FlowExecutionAnalyzer.java Outdated Show resolved Hide resolved

Apply suggestions from code review

0b2930f

Co-authored-by: Kezhi Xiong <august.xkz@gmail.com>

timja merged commit 22f6a7c into jenkinsci:master Feb 5, 2021

dduportal mentioned this pull request Mar 5, 2021

Feature Request: Option to NOT expose build logs #92

Closed

batmat mentioned this pull request Mar 17, 2021

Dependency on workflow-support instead of workflow-job #94

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Output pipeline summary #66

Output pipeline summary #66

mrginglymus commented Dec 30, 2020 •

edited

Loading

mrginglymus commented Dec 30, 2020

timja left a comment

mrginglymus commented Dec 30, 2020 •

edited

Loading

timja commented Dec 30, 2020

mrginglymus commented Dec 30, 2020

timja commented Dec 30, 2020

XiongKezhi commented Dec 31, 2020

timja commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

timja commented Dec 31, 2020

uhafner commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

timja commented Jan 31, 2021

mrginglymus commented Jan 31, 2021

timja commented Jan 31, 2021 •

edited

Loading

mrginglymus commented Jan 31, 2021

timja commented Jan 31, 2021

timja commented Jan 31, 2021 •

edited

Loading

timja commented Jan 31, 2021

timja commented Jan 31, 2021

mrginglymus commented Jan 31, 2021

timja commented Jan 31, 2021

XiongKezhi left a comment

XiongKezhi commented Feb 3, 2021 •

edited

Loading

justinmchase commented Feb 5, 2021

jglick commented Feb 8, 2021

timja commented Feb 8, 2021

Output pipeline summary #66

Output pipeline summary #66

Conversation

mrginglymus commented Dec 30, 2020 • edited Loading

In progress

Complete

mrginglymus commented Dec 30, 2020

timja left a comment

Choose a reason for hiding this comment

mrginglymus commented Dec 30, 2020 • edited Loading

timja commented Dec 30, 2020

mrginglymus commented Dec 30, 2020

timja commented Dec 30, 2020

XiongKezhi commented Dec 31, 2020

timja commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

Summary

In parallel / p1 / p1s1 / Set stage result to unstable

Fails / Archive the artifacts

Text

mrginglymus commented Dec 31, 2020

timja commented Dec 31, 2020

uhafner commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

mrginglymus commented Dec 31, 2020

timja commented Jan 31, 2021

mrginglymus commented Jan 31, 2021

timja commented Jan 31, 2021 • edited Loading

mrginglymus commented Jan 31, 2021

timja commented Jan 31, 2021

timja commented Jan 31, 2021 • edited Loading

timja commented Jan 31, 2021

timja commented Jan 31, 2021

mrginglymus commented Jan 31, 2021

timja commented Jan 31, 2021

XiongKezhi left a comment

Choose a reason for hiding this comment

XiongKezhi commented Feb 3, 2021 • edited Loading

justinmchase commented Feb 5, 2021

jglick commented Feb 8, 2021

timja commented Feb 8, 2021

mrginglymus commented Dec 30, 2020 •

edited

Loading

mrginglymus commented Dec 30, 2020 •

edited

Loading

`In parallel / p1 / p1s1 / Set stage result to unstable`

`Fails / Archive the artifacts`

timja commented Jan 31, 2021 •

edited

Loading

timja commented Jan 31, 2021 •

edited

Loading

XiongKezhi commented Feb 3, 2021 •

edited

Loading