Skip to content
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.

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

GEODE-5804: Improve checkPom task #2569

Merged
merged 3 commits into from Oct 15, 2018

Conversation

PurelyApplied
Copy link
Member

  • Add updateExpectedPom task to perform copy of actual to expected.

Thank you for submitting a contribution to Apache Geode.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced in the commit message?

  • Has your PR been rebased against the latest commit within the target branch (typically develop)?

  • Is your initial contribution a single, squashed commit?

  • Does gradlew build run cleanly?

  • Have you written or updated unit tests to verify your changes?

  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and
submit an update to your PR as soon as possible. If you need help, please send an
email to dev@geode.apache.org.

task updateExpectedPom(dependsOn: generatePomFileForMavenPublication, type: Copy) {
description 'After having verified changes with checkPom, this task will perform the copy.'

def expectedPomFile = sourceSets.test.resources.find() { it.name == "expected-pom.xml" }
Copy link
Member

Choose a reason for hiding this comment

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

Why does the expected file need to exist in order to update/place. We could use this task to generate the baseline for a newly-minted module.

Copy link
Member Author

Choose a reason for hiding this comment

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

I suppose it doesn't!

…e uEP when no changes have actually been made...
@PurelyApplied
Copy link
Member Author

I had been poking at it to make sure it's still good. I was getting some strange behavior where ./gradlew uEP updates the assembly pom with

diff --git a/geode-assembly/src/test/resources/expected-pom.xml b/geode-assembly/src/test/resources/expected-pom.xml
index 3f8abf5e57..b22bc8f393 100644
--- a/geode-assembly/src/test/resources/expected-pom.xml
+++ b/geode-assembly/src/test/resources/expected-pom.xml
@@ -20,7 +20,7 @@
   <groupId>org.apache.geode</groupId>
   <artifactId>apache-geode</artifactId>
   <version>1.8.0-SNAPSHOT</version>
-  <packaging>pom</packaging>
+  <packaging>tgz</packaging>
   <name>Apache Geode</name>
   <description>Apache Geode provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing</description>
   <url>http://geode.apache.org</url>

It had been the dependency block I'd messed with to make sure I hadn't broken checkPom, so I don't know if there is just some dirty artifact there. Need to play with it a little more.

@PurelyApplied
Copy link
Member Author

It seems like the actual checkPom task is only examining <dependency> blocks and not any other data. So, on the one hand, the existing behavior was "copy the actual pom to the expected pom" is what's happening, but a developer will then need to examine which difference should actually be added to their commit.

So that's strange and we should decide if checkPom should also be checking, for instance, the <packaging> for consistency. Or decide that what goes into a diff is just developer responsibility.

@rhoughton-pivot rhoughton-pivot merged commit 11807ba into apache:develop Oct 15, 2018
@PurelyApplied PurelyApplied deleted the geode-5804 branch January 9, 2019 00:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants