-
Notifications
You must be signed in to change notification settings - Fork 5
Add code-review profile, wire quality checks, and raise test coverage
#78
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
Draft
peter-lawrey
wants to merge
17
commits into
develop
Choose a base branch
from
adv/code-review
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
code-review profile, wire quality checks, and raise test coverage
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a shared
code-reviewprofile that runs Chronicle’s quality toolchain (Checkstyle, PMD, SpotBugs/FindSecBugs, JaCoCo) and adds focused tests to lift coverage, particularly around POSIX provider selection, affinity-mask sizing, and JNA wrappers. Documentation is normalised with numbered sections to improve navigability.Why
What changed
Docs
README.adoc,decision-log.adoc,project-requirements.adoc: enable:sectnums:and minor cleanups.Production code
PosixAPI.java:Clarify and tighten Javadoc; prefer concise, API-first descriptions.
Fix affinity mask sizing and access:
requiredMaskBytes(int)to size masks by CPU index, rounded toLong.BYTES.Safer
sched_setaffinity_range(...)with argument validation.Simplify
JNANULL handling inJNAPosixAPIviaPointer.NULL.PosixAPIHolder.java:getpid()) to force early fallback toNoOpPosixAPIwhen native loading fails.Tests (new)
PosixAffinityHelperTest: verifies mask sizing beyond 64 CPUs, range checks, and bit placement.PosixAPIHolderTest: enforces provider order and confirms No-Op fallback when native runtime is unavailable.JNAPosixAPITest: confirmsmmapwrapper passesPointer.NULLfor zero address and non-zero pointer otherwise.NoOpPosixAPITest: documents and asserts the no-op vs throwing behaviour surface of the fallback provider.RawPosixAPITest: asserts default memory-lock helpers remain no-ops/false in raw provider subclasses.How to run quality checks
mvn -Pcode-review -q verifycode-reviewprofile in the workflow to gate on Checkstyle, PMD, SpotBugs, and JaCoCo.Coverage impact
net.openhft.posix.*.Backwards compatibility
No breaking API changes.
Behavioural fixes:
NoOpPosixAPIyields clearer failure modes on misconfigured systems.Risks and mitigations
Follow-ups