Update dependencies and docs for 4.1 release #797

MarkEWaite · 2019-12-16T13:10:05Z

Update docs and dependencies

Update the dependencies and the documentation page as preparation for eventual release of git plugin 4.1.

Checklist

I have read the CONTRIBUTING doc
Unit tests pass locally with my changes
I have added documentation as necessary
No Javadoc warnings were introduced with my changes
No spotbugs warnings were introduced with my changes
Any dependent changes have been merged and published in upstream modules (like git-client-plugin)

Types of changes

Dependency or infrastructure update

MarkEWaite · 2019-12-16T13:15:20Z

@slonopotamus I would also like to update to parent pom 3.54, but when I attempt that, it fails to compile. There seems to be a signature change in the jenkins test harness that I don't understand how to resolve.

[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] /home/mwaite/git/jenkins/git-plugin/src/test/java/org/jenkinsci/plugins/gittagmessage/AbstractGitTagMessageExtensionTest.java:[161,26] no suitable method found for buildAndAssertSuccess(J)
    method org.jvnet.hudson.test.JenkinsRule.<J,R>buildAndAssertSuccess(J) is not applicable
      (inference variable R has incompatible bounds
        equality constraints: R
        upper bounds: hudson.model.Run<J,R>,hudson.model.Queue.Executable)
    method org.jvnet.hudson.test.JenkinsRule.buildAndAssertSuccess(hudson.model.FreeStyleProject) is not applicable
      (argument mismatch; J cannot be converted to hudson.model.FreeStyleProject)
[INFO] 1 error
[INFO] -------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  17.207 s
[INFO] Finished at: 2019-12-16T06:12:40-07:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.8.1:testCompile (default-testCompile) on project git: Compilation failure
[ERROR] /home/mwaite/git/jenkins/git-plugin/src/test/java/org/jenkinsci/plugins/gittagmessage/AbstractGitTagMessageExtensionTest.java:[161,26] no suitable method found for buildAndAssertSuccess(J)
[ERROR]     method org.jvnet.hudson.test.JenkinsRule.<J,R>buildAndAssertSuccess(J) is not applicable
[ERROR]       (inference variable R has incompatible bounds
[ERROR]         equality constraints: R
[ERROR]         upper bounds: hudson.model.Run<J,R>,hudson.model.Queue.Executable)
[ERROR]     method org.jvnet.hudson.test.JenkinsRule.buildAndAssertSuccess(hudson.model.FreeStyleProject) is not applicable
[ERROR]       (argument mismatch; J cannot be converted to hudson.model.FreeStyleProject)

I believe that was a change you made to the Jenkins test harness. Can you help me understand what needs to change in the plugin to adapt to the harness change?

slonopotamus · 2019-12-16T14:31:32Z

@MarkEWaite Whoops. Didn't think that this method could be proxied through other generics :(

Here's a patch that fixes AbstractGitTagMessageExtensionTest. If you want a proper PR from it, it'll take some time.

For the reference, compilation failure is caused by jenkinsci/jenkins-test-harness #167.

slonopotamus · 2019-12-16T17:54:37Z

See #798, it fixes AbstractGitSCMSourceTest.when_commits_added_during_discovery_we_do_not_crash failure when run against newer JTH. I dunno whether you'd like to incorporate it into this PR or merge standalone or create a new PR that will fix all things related to upgrade of parent pom to 3.54, I'm OK with any route.

slonopotamus · 2019-12-16T20:18:22Z

~~I suspect that GitTagActionTest was broken even before this PR. But because assertion fails in the different thread, older hamcrest didn't properly mark test as failed.~~

Hmmm... No, it is working on master branch.

MarkEWaite · 2019-12-17T01:42:56Z

The GitTagActionTest has a race condition that is sometimes visible. I created the test while investigating SECURITY-1095. If it continues to be unreliable, I am very willing to delete the test.

The GitTagAction is a legacy operation in the plugin. It creates a tag in a workspace after the build has completed. The assumption is that the workspace exists after the build completes. That assumption is not valid with ephemeral agents. It does not push the tag anywhere, so the only repository which contains the tag is the repository inside the workspace. Without pushing the tag anywhere, no other users will see the tag.

GitTagAction has no viable use case as far as I can tell. It remains in the plugin because I don't want to spend the time or energy to delete the capability, document its deletion, and explain why the use case is not relevant. It is easier to leave it as idle code than to remove it.

You can read the diffs to see the types of horrors I created while trying to assure that I did not break the GitTagAction by adding the RequirePOST annotation.

Upgrade to more recent parent pom will require that the test dependency on hamcrest is declared explicitly.

MarkEWaite · 2019-12-17T02:23:09Z

src/main/java/jenkins/plugins/git/traits/CleanBeforeCheckoutTrait.java

@@ -50,6 +50,8 @@ public CleanBeforeCheckoutTrait() {

    /**
     * Stapler constructor.
+     *
+     * @param extension the option to clean subdirectories which contain git repositories.


@darxriggs I'm open to a better way to describe this parameter and the same parameter on the other trait.

If you have a look at the other traits they more or less only link to the type of the parameter. Maybe keep it like this and not duplicate the description of the extension or come up with another description for it.

Unclear why the test is failing on ci.jenkins.io when it regularly succeeds in my Windows environments. Test is not valuable enough to justify a long research project to identify why it behaves differently on ci.jenkins.io than on other Windows computers. Test runs on Linux. Test coverage is measured on Linux.

Includes imnprovements in the Jenkins test harness

Since git plugin 4.0 has released, the stable-3.x branch can be left to sit more quietly.

Image of plus sign by <a href="https://pixabay.com/users/michael-kouassi-4074806/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=1923369">michael-kouassi</a> from <a href="https://pixabay.com/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=1923369">Pixabay</a> Attribution not required.

Adapt to Jenkins test harness changes

MarkEWaite force-pushed the update-dependencies branch from 8c65fa9 to 55c5ad0 Compare December 16, 2019 18:25

MarkEWaite added 2 commits December 16, 2019 19:20

Test with hamcrest 2.2 (for later pom upgrades)

c17b9ad

Upgrade to more recent parent pom will require that the test dependency on hamcrest is declared explicitly.

Test with latest workflow multibranch plugin

d6da0c5

MarkEWaite force-pushed the update-dependencies branch from c5a6c8a to 59e3ad2 Compare December 17, 2019 02:21

MarkEWaite added the documentation Improvements or additions to documentation label Dec 17, 2019

MarkEWaite commented Dec 17, 2019

View reviewed changes

MarkEWaite force-pushed the update-dependencies branch 2 times, most recently from 089db3c to afb6cca Compare December 18, 2019 23:41

MarkEWaite added 4 commits December 19, 2019 03:06

Use try with resources to close repository after use

3049648

Use try with resources to close repository in test

c6884b1

Use try with resources to close repository after use

221c2c7

MarkEWaite force-pushed the update-dependencies branch from f4b45cd to 06642a4 Compare December 19, 2019 10:20

MarkEWaite added 8 commits December 19, 2019 04:47

Use parent pom 3.54

b674c6b

Includes imnprovements in the Jenkins test harness

Add javadoc for new trait parameters

a63cbf7

Dependabot target the master branch

ac31959

Since git plugin 4.0 has released, the stable-3.x branch can be left to sit more quietly.

Dependabot label PR's with 'dependencies'

5f8ff72

Add badges, move TOC after intro

b1d5509

Adapt AbstractGitTagMessageExtensionTest for latest JTH

53f6553

Adapt to Jenkins test harness changes

Prefer sentence per line in README

02c1558

MarkEWaite force-pushed the update-dependencies branch from 06642a4 to 02c1558 Compare December 19, 2019 11:47

Improve README phrasing

6e1af2f

MarkEWaite merged commit f25db72 into jenkinsci:master Dec 19, 2019

MarkEWaite deleted the update-dependencies branch December 19, 2019 14:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependencies and docs for 4.1 release #797

Update dependencies and docs for 4.1 release #797

MarkEWaite commented Dec 16, 2019 •

edited

Loading

MarkEWaite commented Dec 16, 2019 •

edited

Loading

slonopotamus commented Dec 16, 2019 •

edited

Loading

slonopotamus commented Dec 16, 2019 •

edited

Loading

slonopotamus commented Dec 16, 2019 •

edited

Loading

MarkEWaite commented Dec 17, 2019

MarkEWaite Dec 17, 2019

darxriggs Dec 17, 2019

Update dependencies and docs for 4.1 release #797

Update dependencies and docs for 4.1 release #797

Conversation

MarkEWaite commented Dec 16, 2019 • edited Loading

Update docs and dependencies

Checklist

Types of changes

MarkEWaite commented Dec 16, 2019 • edited Loading

slonopotamus commented Dec 16, 2019 • edited Loading

slonopotamus commented Dec 16, 2019 • edited Loading

slonopotamus commented Dec 16, 2019 • edited Loading

MarkEWaite commented Dec 17, 2019

MarkEWaite Dec 17, 2019

Choose a reason for hiding this comment

darxriggs Dec 17, 2019

Choose a reason for hiding this comment

MarkEWaite commented Dec 16, 2019 •

edited

Loading

MarkEWaite commented Dec 16, 2019 •

edited

Loading

slonopotamus commented Dec 16, 2019 •

edited

Loading

slonopotamus commented Dec 16, 2019 •

edited

Loading

slonopotamus commented Dec 16, 2019 •

edited

Loading