Add spotless support

[Leo6Leo]

Fixes #3166

Proposed Changes

• Added the support for Spotless
• Automate the formatting by integrating this with update-codegen.sh
• Add the format check to the CI testing set

Release Note

Added Spotless as the Java formatter support

[knative-prow]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[Leo6Leo]

/cc @pierDipi I will push the code changes for those reformatted .java file if you don't see any problem with the all the changes I have made so far!

[Leo6Leo]

/retest

[codecov]

Codecov Report

Merging #3171 (7a641d9) into main (e8ba86f) will increase coverage by 0.03%.
The diff coverage is 80.71%.

@@             Coverage Diff              @@
##               main    #3171      +/-   ##
============================================
+ Coverage     63.42%   63.46%   +0.03%     
+ Complexity      755      753       -2     
============================================
  Files           167      167              
  Lines         11805    11815      +10     
  Branches        241      246       +5     
============================================
+ Hits           7487     7498      +11     
+ Misses         3754     3750       -4     
- Partials        564      567       +3     

Flag	Coverage Δ
java-unittests	79.88% <80.71%> (+0.11%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
control-plane/pkg/contract/contract.pb.go	7.44% <ø> (ø)
...nting/kafka/broker/dispatcher/ResponseHandler.java	0.00% <0.00%> (ø)
...ka/broker/dispatcher/impl/NoopResponseHandler.java	0.00% <0.00%> (ø)
...ng/kafka/broker/dispatcher/main/DispatcherEnv.java	0.00% <0.00%> (ø)
...ve/eventing/kafka/broker/dispatcher/main/Main.java	0.00% <0.00%> (ø)
...venting/kafka/broker/receiver/IngressProducer.java	100.00% <ø> (ø)
...eventing/kafka/broker/receiver/RequestContext.java	100.00% <ø> (ø)
...eceiver/impl/IngressProducerReconcilableStore.java	83.50% <ø> (-0.66%)	⬇️
...g/kafka/broker/receiver/impl/ReceiverVerticle.java	68.57% <ø> (+2.85%)	⬆️
...ker/receiver/impl/StrictRequestToRecordMapper.java	75.00% <ø> (ø)
... and 67 more

[Leo6Leo]

/retest

[Leo6Leo]

/meow

[knative-prow]

@Leo6Leo:

In response to this:

/meow

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Leo6Leo]

@pierDipi Currently, the maven version on my local machine is 3.8.6, but on GitHub the maven version is 3.8.3. I am wondering that should we bump up the maven version, or I downgrade to 3.8.3 instead?

#1301

[debasishbsws]

The google.java.format uses 2 spaces as indentation by default for Java code, which I don't like personally. Is it possible to overwrite it?
Or we can use palantir-java-format which is a fork of google.java.format with some better features IG, example. It may also reduce code changes in this PR as well.

Let's see what others have to say about this.

[pierDipi]

@pierDipi Currently, the maven version on my local machine is 3.8.6, but on GitHub the maven version is 3.8.3. I am wondering that should we bump up the maven version, or I downgrade to 3.8.3 instead?

#1301

What's the problem with that?

[pierDipi]

The google.java.format uses 2 spaces as indentation by default for Java code, which I don't like personally. Is it possible to overwrite it? Or we can use palantir-java-format which is a fork of google.java.format with some better features IG, example. It may also reduce code changes in this PR as well.

Let's see what others have to say about this.

Regarding the format, I don't have strong opinions, I just like a consistent style, the shared link does make valid arguments in favor of the Palantir format, up to you all on which format you think is the best for our project

[Leo6Leo]

/retest

[Leo6Leo]

/retest

[debasishbsws]

/retest-required

[debasishbsws]

I think the build-tests is failing because you have added a new module and that should be reflected in /data-plane/THIRD-PARTY.txt
Run ./hack/update-codegen.sh And commit the modified THIRD-PARTY.txt file

[pierDipi]

This patch might fix the problem:

diff --git a/hack/update-codegen.sh b/hack/update-codegen.sh
index af3b8106a..d77b1000b 100755
--- a/hack/update-codegen.sh
+++ b/hack/update-codegen.sh
@@ -77,14 +77,13 @@ group "Update deps post-codegen"
 if ! ${GITHUB_ACTIONS:-false}; then
   "${REPO_ROOT_DIR}"/hack/generate-proto.sh
 
+  pushd "${REPO_ROOT_DIR}/data-plane"
   # Update Java third party file
-  pushd data-plane
   ./mvnw -Dlicense.outputDirectory=. license:aggregate-add-third-party
-  popd
-
   # Run maven command to apply spotless formatting
-  pushd "${REPO_ROOT_DIR}/data-plane"
-  mvn spotless:apply
+  ./mvnw spotless:apply
+  # Clean target directories
+  ./mvnw clean
   popd
 fi
 
...skipping...
+  ./mvnw clean
   popd
 fi
 
diff --git a/hack/verify-codegen.sh b/hack/verify-codegen.sh
index 1286dc245..2766c5a71 100755
--- a/hack/verify-codegen.sh
+++ b/hack/verify-codegen.sh
@@ -38,7 +38,13 @@ mkdir -p "${TMP_DIFFROOT}"
 DIRS=(
   "/go.mod"
   "/go.sum"
-  "/data-plane"
+  "/data-plane/contract"
+  "/data-plane/core"
+  "/data-plane/dispatcher"
+  "/data-plane/dispatcher-vertx"
+  "/data-plane/receiver"
+  "/data-plane/receiver-vertx"
+  "/data-plane/tests"
   "/control-plane/pkg/core/config"
   "/control-plane/pkg/apis"
   "/control-plane/pkg/client"

[pierDipi]

Because the error says that the target directory and binary files are different so we need to avoid comparing those

[Leo6Leo]

/cc @pierDipi Ready for review

[knative-prow]

@Leo6Leo: GitHub didn't allow me to request PR reviews from the following users: Ready, for, review.

Note that only knative-sandbox members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @pierDipi Ready for review

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[Leo6Leo]

/retest

[Leo6Leo]

/retest

[Leo6Leo]

/retest

[Leo6Leo]

/cc @pierDipi

Ready for review again

[pierDipi]

/lgtm
/approve

[knative-prow]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Leo6Leo, pierDipi

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [pierDipi]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment