Repository navigation
Adopt the MetricsHub formatter profile and jawk's checkstyle.xml, gate the build on both - #119
Conversation
#118) * metricshub-eclipse-formatter.xml and checkstyle.xml copied byte for byte from jawk * formatter-maven-plugin 2.29.0 validates the main and test sources at the validate phase * maven-checkstyle-plugin 3.6.0 check bound with failOnViolation=true (same version and configLocation as the report inherited from oss-parent) * .gitattributes from jawk, so Java/XML/Markdown files are normalized to LF in the index * README.md and AGENTS.md document mvn formatter:format and CHECKSTYLE.OFF/ON Co-Authored-By: Claude Opus 5.5 <[email protected]>
Pure formatting, no other change: produced by running mvn formatter:format with the MetricsHub Eclipse formatter profile. Listed in .git-blame-ignore-revs. Co-Authored-By: Claude Opus 5.5 <[email protected]>
* FinalClass: IpmiClient, IpmiResultConverter, Utils, DeviceDescription, ReadingTypeDescription and MessageComposer only have private constructors * VisibilityModifier: the protected fields of AbstractIpmiRunner, MessageHandler and IpmiLanMessage are now private with protected accessors; the never-read ConfidentialityAlgorithm.sik is removed and IntegrityAlgorithm.sik is private * HiddenField: parameters renamed where they shadowed a field (no behavior change) * ConstantName: static final loggers renamed LOGGER, sessionlessTag SESSIONLESS_TAG * NeedBraces, UpperEll, NewlineAtEndOfFile: mechanical fixes * Suppressed with CHECKSTYLE.OFF/ON: TypeName on IntegrityHmacMd5_128, IntegrityHmacSha1_96 and IntegrityHmacSha256_128 (public class names mirroring the IPMI algorithm names), AvoidStarImport on the ReadingType lookup table The remaining 24 TodoComment warnings do not fail the build. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a2015b24b8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
) Review feedback: subclasses outside the library lost access to the former protected fields. Add protected getIpmiConfiguration() to AbstractIpmiRunner and getSik() to ConfidentialityAlgorithm and IntegrityAlgorithm (the ConfidentialityAlgorithm.sik field is kept, now private). Co-Authored-By: Claude Opus 5.5 <[email protected]>
Same typo as in jawk's checkstyle.xml, reported upstream as jawkio/jawk#612. Co-Authored-By: Claude Opus 5.5 <[email protected]>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 59f1a46d6f
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Review feedback: getSik() promises the key passed to initialize(), which IntegrityNone no longer stored. Add protected IntegrityAlgorithm.setSik() and call it from IntegrityNone, which still skips the MAC initialization. Co-Authored-By: Claude Opus 5.5 <[email protected]>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: af0171c654
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
…#117) Review feedback: subclasses lost access to the sliding-window state when the field became private. Co-Authored-By: Claude Opus 5.5 <[email protected]>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: dbe00f2705
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Review feedback: the API change was described only in the PR. Add an "Upgrading from 1.2.02" section to the site and point to it from README.md. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Fixes #117, fixes #118.
Commits (please merge, don't squash:
.git-blame-ignore-revsreferences the reformat commit by hash)metricshub-eclipse-formatter.xmlandcheckstyle.xmlcopied from jawk (same blob SHAs as jawk'smain, except theallowInSwitchCasetypo fix incheckstyle.xml, reported upstream as checkstyle.xml: trailing space in AvoidNestedBlocks property name allowInSwitchCase jawkio/jawk#612),formatter-maven-plugin2.29.0validateat thevalidatephase (main + test sources),maven-checkstyle-plugin3.6.0checkwithfailOnViolation=true(same version andconfigLocationas the report inherited from oss-parent),.gitattributesfrom jawk (minus its jawk-specificsrc/site/resources/getrule), README "Code format" section, AGENTS.md updated.mvn formatter:format: pure formatting, 256 files.NewlineAtEndOfFile)..git-blame-ignore-revslisting commit 2 (git config blame.ignoreRevsFile .git-blame-ignore-revs, documented in README; GitHub uses it automatically).getIpmiConfiguration()andgetSik()accessors; trailing space removed from theallowInSwitchCaseproperty name.Checkstyle fixes
finalon classes that only have private constructorsAbstractIpmiRunner,MessageHandler,IpmiLanMessagemade private with protected accessors;ConfidentialityAlgorithm.sikandIntegrityAlgorithm.sikprivate with protectedgetSik()(IntegrityNonestores the key with the new protectedsetSik(), without MAC initialization)logger→LOGGER,sessionlessTag→SESSIONLESS_TAGCHECKSTYLE.OFF/ON: renaming the publicIntegrityHmacMd5_128,IntegrityHmacSha1_96,IntegrityHmacSha256_128classes would break the APIReadingTypeDescriptionis a lookup table over ~240ReadingTypeconstantsThe 24
TodoCommentwarnings (TODO, tracked by #100, #106, #107, #108) don't fail the build.API note: subclasses outside this library that accessed the former protected fields (
AbstractIpmiRunner.connector/handle/nextRecId/ipmiConfiguration,MessageHandler.messageQueue/connection/lastReceivedSequenceNumber,IpmiLanMessage.networkFunction,ConfidentialityAlgorithm.sik,IntegrityAlgorithm.sik) must switch to the accessors (getIpmiConfiguration(),getConnector(),getHandle(),getNextRecId()/setNextRecId(),getMessageQueue(),getConnection(),getNetworkFunctionCode()/setNetworkFunctionCode(),getSik()/setSik(),getLastReceivedSequenceNumber()/setLastReceivedSequenceNumber()). These are protocol internals, not theIpmiClientAPI used by MetricsHub.Verification (JDK 17, as in CI)
mvn clean verify site: BUILD SUCCESS, 23 tests pass, 0 Checkstyle violations, Javadoc jar (doclintall,-missing) has no warnings.formatter:validate, and a leftover redundantfinalfailedcheckstyle:check.mainand this branch (same site configuration).🤖 Generated with Claude Code