bazel-contrib / bazel-contrib/rules_jvm

Checkstyle errors are no longer reported to stdout starting with v0.28.0

Open
#392 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
54
Forks
98
Avg merge
6d 2h
Merged PRs (30d)
7

Description

Prior to release v0.28.0, if a checkstyle error occurred it was reported via stdout. For example:

==================== Test output for //projects/cxp/cdc-s3-eraser:lib-checkstyle:
Checkstyle ends with 1 errors.
Starting audit...
[ERROR] projects/cxp/cdc-s3-eraser/src/main/java/com/sugarcrm/cxp/cdc/s3/eraser/Config.java:20: Line is longer than 120 characters (found 217). [LineLength]
Audit done.
================================================================================

After v0.28.0, this information is no longer sent to stdout and only a test.xml file with the information is created:

==================== Test output for //projects/cxp/cdc-s3-eraser:lib-checkstyle:
Checkstyle ends with 1 errors.
================================================================================
cat test.xml
<?xml version="1.0" encoding="UTF-8"?><testsuites><testsuite package="Checkstyle" name="projects/cxp/cdc-s3-eraser/src/main/java/com/sugarcrm/cxp/cdc/s3/eraser/Config.java" tests="1" errors="1">

<testcase name="com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck" classname="projects/cxp/cdc-s3-eraser/src/main/java/com/sugarcrm/cxp/cdc/s3/eraser/Config.java"><error type="com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck" message="Line 20: Line is longer than 120 characters (found 217)."/></testcase>

This looks to have been introduced per https://github.com/bazel-contrib/rules_jvm/pull/283

Was this change to behavior intentional?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing rules_jvm pull request #283 and comparing the v0.28.0 Checkstyle output with the earlier stdout example and the generated test.xml. Trace the checkstyle test entry point and determine whether diagnostic output is intentionally redirected; done means the behavior is explained and, if unintended, stdout reporting is restored with a regression test.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.