[JENKINS-53511] Improve discovery and readability of WebClient #3618

Wadeck · 2018-09-11T21:01:24Z

downstream of [JENKINS-53511] Improve discovery and readability of WebClient jenkins-test-harness#109
update of commons-io from 2.4 to 2.6 to be ok with JTH:2.42. It's fully compatible with 2.4 cf upgrade to 2.5 and upgrade to 2.6.

See JENKINS-53511.

Proposed changelog entries

Developer: Improve discovery and readability of WebClient most popular options.

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

jeffret-b

This cleans things up nicely.

test/pom.xml

test/src/test/java/hudson/TcpSlaveAgentListenerTest.java

oleg-nenashev · 2019-01-28T20:37:01Z

@Wadeck are you still interested in it? There are merge conflicts, and there will be more if it is not merged soon

Wadeck · 2019-01-29T09:51:14Z

For the information, the upgrade from jenkins-test-harness:2.41.1 to jenkins-test-harness:2.46 had at least 2 broken backward compabitility issues:

XmlPage removed the method getContent that was deprecated, so I replace it call by getWebResponse().getContentAsString(), in ViewTest.
WebResponse changed the signature of the method getContentAsString(String) by getContentAsString(Charset), so I replaced "UTF-8" by StandardCharsets.UTF_8 in ComputerTest.

oleg-nenashev · 2019-01-29T09:58:01Z

For the information, the upgrade from jenkins-test-harness:2.41.1 to jenkins-test-harness:2.46 had 2 broken backward compabitility issues:

It has broken even more. I tried updating from 2.41 to 2.42 in #3661 , but finally I gave up and released 2.41.1

Wadeck · 2019-01-29T10:05:14Z

It has broken even more

Seems I have only discovered the top of the iceberg :p will try to correct them...

Other breakages:

WebResponse#getContentCharset() returned a String, now it's a Charset.
HtmlElement#getHtmlElementsByTagName(String) was removed
JavaScriptEngine#callFunction signature changed

=> "only" 64 tests failures (= 16 as we have 4 different env).

Due to the space added in jenkins-test-harness#89 the temp folder is causing troubles (both linux and windows) for the test hudson.model.ItemsTest#overwriteNonexistentTarget. This test is passing with 2.42, but not with 2.46.
- The problem with the space is that StreamResult#new convert the file to URI and so, convert the space into %20, that is not recognized as a file.
- Only failing when trying to use the itemGroupMixIn.createTopLevelItem(req, rsp);
- To solve those problems, I created a special JenkinsRuleWithoutSpace that save/write/reload the system property to be compliant with the legacy behavior.
Same for all except (need further investigation)
- hudson.model.ProjectTest#testGetScmCheckoutRetryCount
  - Change in the way the click is done on an element, the form does not receive the information and so there is a missing boolean in the form submission.
  - Using .click(new Event(), true) has the legacy behavior, so it's the new ignoreVisibility option with a default value that change the legacy behavior. Introduced in 2.42 with the update of HtmlUnit (I bet on jenkins-test-harness#103).
- jenkins.bugs.Jenkins19124Test#interrelatedFormValidation
  - The setValueAttribute is no longer triggering the JavaScript onChange event, so I needed to trigger it manually (legacy behavior present until 2.42)
- lib.form.PasswordTest#testCheckMethod
  - Like setValueAttribute but for setText of password fields

jvz

Nice cleanup!

vilacides · 2019-01-29T16:49:04Z

test-pom/pom.xml

@@ -54,7 +54,9 @@ THE SOFTWARE.
    <dependency>
      <groupId>${project.groupId}</groupId>
      <artifactId>jenkins-test-harness</artifactId>
-      <version>2.41.1</version>
+<!--      <version>2.41.1</version>-->


Are these versions commented on purpose?

I am still correcting the tests, so it's WiP (label added)

Ho actually I thought I pushed the 2.46 after the failing try with 2.42. Thx for the heads up!

I think this bump should actually be reverted in not required for the scope of that PR. This seems like something that can (and if can, then should) be handled in a dedicated PR for clarity (and more speedy reviews because less code, good for everyone).

This has been marked as ready for merge but the code is still commented. Shouldn't we just remove it?

Suggested change

Wadeck · 2019-01-29T17:31:01Z

Next step, try using system property to enforce the withoutSpace behavior to avoid troubles with the temp directories.

batmat · 2019-01-30T12:44:05Z

in 72bafd9

Re-put the 2.46 that is the target

Why is this actually the target?

Wadeck · 2019-01-30T14:13:43Z

As discussed with Baptiste, this PR will only focus on inclusion of the JTH version that provide the initial desired methods, not all the change with the space issue. So putting the JTH to 2.42 only.

Due to this update, I was forced to bump as well the commons-io lib to 2.6. It's fully compatible with 2.4 cf upgrade to 2.5 and upgrade to 2.6.

jglick · 2019-01-30T23:21:05Z

The problem with the space is that StreamResult#new convert the file to URI and so, convert the space into %20, that is not recognized as a file.

Sounds like a legitimate bug, or what am I missing?

Wadeck · 2019-01-31T09:13:05Z

Sounds like a legitimate bug, or what am I missing?

The constructor transforms the File into URI but that's the good behavior at this point. I thought it was the root cause but actually it's the interpretation of this URI that is badly done. That bad interpretation is only present in the Xalan version included in the JTH.

I tested JTH-2.42 with / without space, same behavior. Using hpi:run, (with JTH:2.42) it works with and without space.

The JTH:2.46 has trouble with space but not without. And if I run the hpi:run with JTH:2.46, it works with and without space.

Conclusion, it's only a problem in test and so, not a "production" bug.

Thanks @thomasgl-orange for the so simple PR that solves my annoying issue!
Are you OK if we merge this PR and then you can adjust yours to just rebase it on the master after the merge? As it's that simple (removal of a dep) it should be easy. Otherwise I can integrate your change here, let me know what you prefer!

thomasgl-orange · 2019-01-31T09:38:57Z

Are you OK if we merge this PR and then you can adjust yours to just rebase it on the master after the merge?

Sure, sounds good, once this one gets merged I will update mine.

Wadeck · 2019-01-31T09:43:45Z

I revoked the previous approval as I made changes since their creation

fcojfernandez

It still looks good to me!

Wadeck · 2019-02-01T08:28:02Z

Seems we are good with this one, I will request a merge later today if nobody complains!

alecharp

two comments to remove on test/pom.xml and it's good.

alecharp · 2019-02-01T09:23:01Z

test-pom/pom.xml

@@ -54,7 +54,9 @@ THE SOFTWARE.
    <dependency>
      <groupId>${project.groupId}</groupId>
      <artifactId>jenkins-test-harness</artifactId>
-      <version>2.41.1</version>
+<!--      <version>2.41.1</version>-->


Suggested change

alecharp · 2019-02-01T09:23:24Z

test-pom/pom.xml

-      <version>2.41.1</version>
+<!--      <version>2.41.1</version>-->
+      <version>2.42</version>
+<!--      <version>2.46</version>-->


Suggested change

alecharp

I don't understand why Github showed me outdated content in the review..

Wadeck · 2019-02-01T09:34:08Z

Seems that Isa got the same issue

- And thus, adapt the code due to the breaking changes in JTH sub-lib

Wadeck · 2019-02-01T14:19:21Z

Squash of the commits to separate clearly what was required for the JTH bump (due to breaking change in HTMLUnit new version) and what's for the discovery of the new features.

vilacides · 2019-02-01T14:25:43Z

All good! 👍

oleg-nenashev

Thanks @Wadeck ! Will merge once the tests pass.

oleg-nenashev · 2019-02-01T17:22:27Z

i doubt this is related, but...

Stacktrace
java.lang.AssertionError
at hudson.slaves.PingThreadTest.failedPingThreadResetsComputerChannel(PingThreadTest.java:90)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.base/java.lang.reflect.Method.invoke(Method.java:566)
at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
at org.jvnet.hudson.test.JenkinsRule$1.evaluate(JenkinsRule.java:552)
at org.junit.internal.runners.statements.FailOnTimeout$CallableStatement.call(FailOnTimeout.java:298)
at org.junit.internal.runners.statements.FailOnTimeout$CallableStatement.call(FailOnTimeout.java:292)
at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
at java.base/java.lang.Thread.run(Thread.java:834)

batmat · 2019-02-03T10:47:02Z

I strongly suspect Oleg was planning to close/reopen to retrigger the build.

oleg-nenashev · 2019-02-03T10:51:23Z

@batmat Definitely. Sorry for forgetting about the second step :(

batmat · 2019-02-03T11:09:28Z

No problem at all Oleg. It's happened to me many times :)

Wadeck · 2019-02-04T07:47:28Z

And now it's passing, thx @batmat / @oleg-nenashev

oleg-nenashev · 2019-02-04T08:31:49Z

That's why I do poke commits instead of close/reopen :(

oleg-nenashev · 2019-02-07T22:38:38Z

Will merge it once the build passes

Wadeck mentioned this pull request Sep 11, 2018

[JENKINS-53511] Improve discovery and readability of WebClient jenkinsci/jenkins-test-harness#109

Merged

jeffret-b approved these changes Sep 11, 2018

View reviewed changes

fcojfernandez approved these changes Sep 12, 2018

View reviewed changes

oleg-nenashev added the on-hold This pull request depends on another event/release, and it cannot be merged right now label Sep 27, 2018

jglick reviewed Sep 28, 2018

View reviewed changes

test/pom.xml Outdated Show resolved Hide resolved

test/src/test/java/hudson/TcpSlaveAgentListenerTest.java Outdated Show resolved Hide resolved

oleg-nenashev added the unresolved-merge-conflict There is a merge conflict with the target branch. label Sep 28, 2018

oleg-nenashev assigned Wadeck Jan 28, 2019

Wadeck force-pushed the JENKINS-53511_WEBCLIENT_DISCOVERY_IMPROVEMENT branch 2 times, most recently from cc1a05e to d97361b Compare January 29, 2019 09:46

Wadeck removed on-hold This pull request depends on another event/release, and it cannot be merged right now unresolved-merge-conflict There is a merge conflict with the target branch. labels Jan 29, 2019

Wadeck removed their assignment Jan 29, 2019

Wadeck requested review from jglick and oleg-nenashev January 29, 2019 09:52

jvz approved these changes Jan 29, 2019

View reviewed changes

vilacides reviewed Jan 29, 2019

View reviewed changes

Wadeck added the work-in-progress The PR is under active development, not ready to the final review label Jan 29, 2019

Wadeck force-pushed the JENKINS-53511_WEBCLIENT_DISCOVERY_IMPROVEMENT branch from 0e643c0 to 297104a Compare January 30, 2019 14:13

Wadeck mentioned this pull request Jan 30, 2019

JTH 2.46 #3872

Merged

4 tasks

Wadeck requested a review from jvz January 31, 2019 09:42

Wadeck requested a review from jeffret-b January 31, 2019 09:43

fcojfernandez approved these changes Jan 31, 2019

View reviewed changes

jvz approved these changes Jan 31, 2019

View reviewed changes

Wadeck added ready-for-merge The PR is ready to go, and it will be merged soon if there is no negative feedback and removed work-in-progress The PR is under active development, not ready to the final review labels Feb 1, 2019

alecharp suggested changes Feb 1, 2019

View reviewed changes

vilacides approved these changes Feb 1, 2019

View reviewed changes

alecharp approved these changes Feb 1, 2019

View reviewed changes

Wadeck added 3 commits February 1, 2019 15:15

[JENKINS-53511] Update commons-io to prepare bump of JTH

bc02823

[JENKINS-53511] Bump of JTH to include new methods in WebClient

3bb56b8

- And thus, adapt the code due to the breaking changes in JTH sub-lib

[JENKINS-53511] Improve discoverability of new feature in WebClient

73c6974

Wadeck force-pushed the JENKINS-53511_WEBCLIENT_DISCOVERY_IMPROVEMENT branch from 297104a to 73c6974 Compare February 1, 2019 14:18

oleg-nenashev approved these changes Feb 1, 2019

View reviewed changes

jeffret-b approved these changes Feb 1, 2019

View reviewed changes

oleg-nenashev closed this Feb 2, 2019

batmat reopened this Feb 3, 2019

oleg-nenashev self-assigned this Feb 7, 2019

oleg-nenashev merged commit fab1662 into jenkinsci:master Feb 8, 2019

[JENKINS-53511] Improve discovery and readability of WebClient #3618

[JENKINS-53511] Improve discovery and readability of WebClient #3618

Conversation

Wadeck commented Sep 11, 2018 • edited Loading

Proposed changelog entries

Submitter checklist

jeffret-b left a comment

Choose a reason for hiding this comment

oleg-nenashev commented Jan 28, 2019

Wadeck commented Jan 29, 2019 • edited Loading

oleg-nenashev commented Jan 29, 2019

Wadeck commented Jan 29, 2019 • edited Loading

jvz left a comment

Choose a reason for hiding this comment

vilacides Jan 29, 2019

Choose a reason for hiding this comment

Wadeck Jan 29, 2019 • edited Loading

Choose a reason for hiding this comment

Wadeck Jan 29, 2019 • edited Loading

Choose a reason for hiding this comment

batmat Jan 30, 2019

Choose a reason for hiding this comment

vilacides Feb 1, 2019

Choose a reason for hiding this comment

alecharp Feb 1, 2019

Choose a reason for hiding this comment

Wadeck commented Jan 29, 2019

batmat commented Jan 30, 2019

Wadeck commented Jan 30, 2019

jglick commented Jan 30, 2019

Wadeck commented Jan 31, 2019

thomasgl-orange commented Jan 31, 2019

Wadeck commented Jan 31, 2019

fcojfernandez left a comment

Choose a reason for hiding this comment

Wadeck commented Feb 1, 2019

alecharp left a comment

Choose a reason for hiding this comment

alecharp Feb 1, 2019

Choose a reason for hiding this comment

alecharp Feb 1, 2019

Choose a reason for hiding this comment

alecharp left a comment

Choose a reason for hiding this comment

Wadeck commented Feb 1, 2019

Wadeck commented Feb 1, 2019

vilacides commented Feb 1, 2019

oleg-nenashev left a comment

Choose a reason for hiding this comment

oleg-nenashev commented Feb 1, 2019

batmat commented Feb 3, 2019

oleg-nenashev commented Feb 3, 2019

batmat commented Feb 3, 2019

Wadeck commented Feb 4, 2019

oleg-nenashev commented Feb 4, 2019

oleg-nenashev commented Feb 7, 2019

Wadeck commented Sep 11, 2018 •

edited

Loading

Wadeck commented Jan 29, 2019 •

edited

Loading

Wadeck commented Jan 29, 2019 •

edited

Loading

Wadeck Jan 29, 2019 •

edited

Loading

Wadeck Jan 29, 2019 •

edited

Loading