[JENKINS-54532] Document how to get parameters from a Run #3724

ringerc · 2018-11-08T03:08:14Z

See JENKINS-54532.

Proposed changelog entries

Document how to get build parameters from a Run

Submitter checklist

JIRA issue is well described
Changelog entry appropriate for the audience affected by the change (users or developer, depending on the change). Examples
* Use the Internal: prefix if the change has no user-visible impact (API, test frameworks, etc.)
Appropriate autotests or explanation to why this change has no tests
For dependency updates: links to external changelogs and, if possible, full diffs

oleg-nenashev · 2018-12-20T11:30:45Z

I will poke the build once the PR builder is fixed

ringerc · 2018-12-21T00:43:23Z

Thanks for the fixes, sorry this was a bit fire-and-forget.

oleg-nenashev · 2019-01-31T00:42:56Z

Neither blueocean nor common UI show what is the root cause easily.
@abayer @dwnusbaum would appreciate some Pipeline advice

dwnusbaum · 2019-01-31T03:57:10Z

From the logs it looks like a test failed? Not sure why it didn't show up in the test view in Blue Ocean or classic UI:

03:24:32 [ERROR] Tests run: 2, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 13.48 s <<< FAILURE! - in jenkins.model.StartupTest
03:24:32 [ERROR] noWarnings(jenkins.model.StartupTest)  Time elapsed: 9.746 s  <<< FAILURE!
03:24:32 java.lang.AssertionError: expected:<[]> but was:<[Running Jenkins with Java 11 which is available in the preview mode only. A custom experimental update center will be used: https://updates.jenkins.io/temporary-experimental-java11/]>
03:24:32 	at org.junit.Assert.fail(Assert.java:88)
03:24:32 	at org.junit.Assert.failNotEquals(Assert.java:834)
03:24:32 	at org.junit.Assert.assertEquals(Assert.java:118)
03:24:32 	at org.junit.Assert.assertEquals(Assert.java:144)
03:24:32 	at jenkins.model.StartupTest.noWarnings(StartupTest.java:49)
03:24:32 	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
03:24:32 	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
03:24:32 	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
03:24:32 	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
03:24:32 	at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
03:24:32 	at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
03:24:32 	at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
03:24:32 	at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
03:24:32 	at org.jvnet.hudson.test.JenkinsRule$1.evaluate(JenkinsRule.java:549)
03:24:32 	at org.junit.internal.runners.statements.FailOnTimeout$CallableStatement.call(FailOnTimeout.java:298)
03:24:32 	at org.junit.internal.runners.statements.FailOnTimeout$CallableStatement.call(FailOnTimeout.java:292)
03:24:32 	at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
03:24:32 	at java.base/java.lang.Thread.run(Thread.java:834)

oleg-nenashev · 2019-02-01T14:07:49Z

From the logs it looks like a test failed? Not sure why it didn't show up in the test view in Blue Ocean or classic UI:

@dwnusbaum It is a separate issue, see #3811 by @jglick . It does not impact the build, because the test is retried after that. We will cleanup up this misleading error in few week once Java 11 is in GA

dwnusbaum · 2019-02-01T15:40:11Z

The build failed in the Windows JDK 8 branch because of a Javadoc error:

C:\Jenkins\workspace\Core_jenkins_PR-3724\core\src\main\java\hudson\model\Run.java:147: error: reference not found
 * accessible via {@link Action#getAllActions} and {@link #getAction(Class)}.

Looks like a visualization bug in BlueOcean. If you click on the Windows JDK 8 branch then it does show the failing step at the end, so I'm not sure what happened. I looked through Jira but didn't find a similar bug already reported, so maybe it's a regression from some other fix?

oleg-nenashev · 2019-02-03T10:53:07Z

Thanks @dwnusbaum !

daniel-beck · 2019-04-10T18:48:48Z

core/src/main/java/hudson/model/Run.java

-     * It will use a gzip-compressed log file (log.gz) if that exists.
+     *
+     * It will use a gzip-compressed log file (log.gz) if that exists, decompressing
+     * it on the fly to return the uncompressed data.


Not a fan of this being documented in the API (strictly speaking, this means JEP-210 is invalid), but at least this PR doesn't add it.

Yeah to complement #3963 I would suggest simply deleting this sentence. How or where the log text is stored is a matter of no concern to the caller of this method, and for Pipeline there is no built-in gzip support (this implementation is not used).

+1, also this would become wrong indeed if we ended up merging #3966

Removing it at all since there is a consensus. Not much related to the PR anyway

jglick · 2019-04-11T01:25:37Z

core/src/main/java/hudson/model/Run.java

-     * It will use a gzip-compressed log file (log.gz) if that exists.
+     *
+     * It will use a gzip-compressed log file (log.gz) if that exists, decompressing
+     * it on the fly to return the uncompressed data.


Yeah to complement #3963 I would suggest simply deleting this sentence. How or where the log text is stored is a matter of no concern to the caller of this method, and for Pipeline there is no built-in gzip support (this implementation is not used).

jglick · 2019-04-11T01:26:25Z

core/src/main/java/hudson/model/Run.java

+ * Many details of a run are contained in {@link Action} instances
+ * accessible via {@link Actionable#getAllActions} and {@link #getAction(Class)}.
+ * For example, build access to build parameters is obtained with
+ * <code>run.getAction(hudson.model.ParametersAction.class)</code> to


Suggested change

* <code>run.getAction(hudson.model.ParametersAction.class)</code> to

* {@code run.getAction(ParametersAction.class)} to

jglick · 2019-04-11T01:27:58Z

core/src/main/java/hudson/model/Run.java

    }

+    /**
+     * Returns a Reader that reads from the log file.


Suggested change

* Returns a Reader that reads from the log file.

* Reads from the log file.

Stating the return type of a method (and without @code or @link, at that) is not helpful.

jglick · 2019-04-11T01:29:17Z

core/src/main/java/hudson/model/Run.java

+    /**
+     * Returns a Reader that reads from the log file.
+     *
+     * This is the simplest way to access the job's console log.


Well…not necessarily. Depends on what you wanted to accomplish. For example, this will contain raw console notes, which might be unwanted in some contexts. getLogText is the most general way to access the log, as you can use that to work with the log in a variety of ways.

Agreed, we should not be doing arguable suggestions, especially if we return to JEP-207

Suggested change

* This is the simplest way to access the job's console log.

The previous code was missing a change to getLogFile(), that was not applied due to the deprecation of getLogFile() in the upstream code. This led to the new files never being read. The new code will pick up compressed log files regardless of their extension, as long as they are named "log" or "log.*" -- with the uncompressed version always being preferred. Also: - Extended the logging to give some additional feedback to the users in case of errors or missing files - Rephrased the API docs to no longer refer to log files (See: jenkinsci#3724)

daniel-beck · 2019-04-21T21:14:52Z

@batmat Why is this assigned to you?

batmat · 2019-04-22T11:55:13Z

@daniel-beck no particular reason. IIRC was just a way to add it to my bucket and get it over the fence. But I failed since.
Please anyone feel free to move without me, and/or reassign to someone else.

oleg-nenashev · 2019-05-22T07:41:05Z

core/src/main/java/hudson/model/Run.java

-     * It will use a gzip-compressed log file (log.gz) if that exists.
+     *
+     * It will use a gzip-compressed log file (log.gz) if that exists, decompressing
+     * it on the fly to return the uncompressed data.


Suggested change

* it on the fly to return the uncompressed data.

oleg-nenashev · 2019-05-22T07:41:57Z

core/src/main/java/hudson/model/Run.java

-     * It will use a gzip-compressed log file (log.gz) if that exists.
+     *
+     * It will use a gzip-compressed log file (log.gz) if that exists, decompressing
+     * it on the fly to return the uncompressed data.


Removing it at all since there is a consensus. Not much related to the PR anyway

oleg-nenashev · 2019-05-22T07:42:21Z

core/src/main/java/hudson/model/Run.java

     * Returns an input stream that reads from the log file.
-     * It will use a gzip-compressed log file (log.gz) if that exists.
+     *
+     * It will use a gzip-compressed log file (log.gz) if that exists, decompressing


Suggested change

* It will use a gzip-compressed log file (log.gz) if that exists, decompressing

oleg-nenashev

I have no permission to push to the original repository, so I cannot apply the proposed changes.
@ringerc if you are still interested to get it over the line, please apply changes so that we can integrate it

batmat · 2019-09-19T14:22:35Z

Given no answer since May, we will close this Pull Request on next pass.

Thanks a lot for your understanding.

fcojfernandez · 2019-10-03T10:01:34Z

Closing since there is no answer since May and it's proposed for close. Please reopen the PR if you plan keep on working on it.

[JENKINS-54532] Document how to get parameters from a Run

c6a4b46

ringerc force-pushed the JENKINS-54532 branch from b7fe96a to c6a4b46 Compare November 8, 2018 04:28

oleg-nenashev added 2 commits November 16, 2018 21:43

[JENKINS-54532] - Fix formatting of Javadoc

075f462

[JENKINS-54532] - More fixes

4c6fdd6

oleg-nenashev self-requested a review December 20, 2018 11:30

oleg-nenashev self-assigned this Dec 20, 2018

jvz approved these changes Dec 20, 2018

View reviewed changes

Update Run.java

ae778a1

Fix Javadoc

cdcb613

daniel-beck self-assigned this Apr 9, 2019

daniel-beck approved these changes Apr 10, 2019

View reviewed changes

daniel-beck unassigned daniel-beck and oleg-nenashev Apr 10, 2019

daniel-beck reviewed Apr 10, 2019

View reviewed changes

jglick reviewed Apr 11, 2019

View reviewed changes

batmat self-assigned this Apr 11, 2019

oleg-nenashev reviewed May 22, 2019

View reviewed changes

oleg-nenashev requested changes May 22, 2019

View reviewed changes

rsandell added the needs-comments-resolved Comments in the PR need to be addressed before it can be considered for merging label Aug 1, 2019

batmat added the proposed-for-close There is no consensus about feasibility of this PR, and maintainers do not see a way forward for it label Sep 19, 2019

fcojfernandez closed this Oct 3, 2019

	* <code>run.getAction(hudson.model.ParametersAction.class)</code> to
	* {@code run.getAction(ParametersAction.class)} to

	* Returns a Reader that reads from the log file.
	* Reads from the log file.

Uh oh!

[JENKINS-54532] Document how to get parameters from a Run #3724

[JENKINS-54532] Document how to get parameters from a Run #3724

Uh oh!

Conversation

ringerc commented Nov 8, 2018

Proposed changelog entries

Submitter checklist

Uh oh!

oleg-nenashev commented Dec 20, 2018

Uh oh!

ringerc commented Dec 21, 2018

Uh oh!

oleg-nenashev commented Jan 31, 2019

Uh oh!

dwnusbaum commented Jan 31, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oleg-nenashev commented Feb 1, 2019

Uh oh!

dwnusbaum commented Feb 1, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oleg-nenashev commented Feb 3, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daniel-beck commented Apr 21, 2019

Uh oh!

batmat commented Apr 22, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oleg-nenashev left a comment

Choose a reason for hiding this comment

Uh oh!

batmat commented Sep 19, 2019

Uh oh!

fcojfernandez commented Oct 3, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

dwnusbaum commented Jan 31, 2019 •

edited

Loading

dwnusbaum commented Feb 1, 2019 •

edited

Loading