skjolber/3d-bin-container-packing/maven

Maven Multi-Module Build

This project is a Maven multi-module build. The root pom.xml is the parent; all dependency versions and plugin versions are declared there as properties.

Module Names (for -pl)

Common Commands

# Build and test one module (and its dependencies)
mvn test -pl <module> -am
 
# Build without running tests
mvn package -pl <module> -am -DskipTests
 
# Install all modules
mvn install
 
# Install everything, skip tests
mvn install -DskipTests

Plugin Reference

Surefire — running tests

mvn test -pl <module> -am

Version is maven-surefire-plugin.version in root pom.xml.

Slow integration tests — differential verification against the 4.x reference

The slow-tests profile runs the *IT classes of core with the Failsafe plugin (same version as Surefire). They compare the 5.0 brute force packagers with the ported 4.x recursive search, the reference oracle in core/src/test/java/.../packer/bruteforce/reference, over thousands of seeded scenarios and the order-9 Bouwkamp codes which are too slow for the ordinary tests. The profile is off by default: a default build has no Failsafe execution, and *IT classes are not run by test. Run the tier locally, on four cores, with:

taskset -c 0-3 ./mvnw -B -ntp -Pdev,slow-tests -Dmaven.build.cache.enabled=false -pl core -am verify

It takes a few minutes, and the forked JVM is stopped after 30 minutes. The tier runs on master in CI and weekly (.github/workflows/maven.yml, job slow-tests, also on demand). To run one class while developing, name it with Surefire: -Dtest=BouwkampReferenceIT -Dsurefire.failIfNoSpecifiedTests=false test.

JaCoCo — code coverage

mvn test jacoco:report -pl <module> -am
# Report lands in target/site/jacoco/index.html

Spotless — code formatting

mvn spotless:check          # fail if formatting is off
mvn spotless:apply          # auto-fix formatting

Maven Shade — fat JAR (jmh module)

mvn package -pl jmh -am -DskipTests
java -jar jmh/target/benchmark.jar

PiTest — mutation testing

./mvnw -B -ntp -Pdev test-compile org.pitest:pitest-maven:mutationCoverage -pl <module> -am -DfailWhenNoMutations=false

-DfailWhenNoMutations=false is needed because -am also runs PIT on upstream modules. Narrow a run with -DtargetClasses=<pattern> -DtargetTests=<pattern> (for example -DtargetClasses='com.github.skjolber.packing.ep.points2d.*'); a whole module takes long. JUnit 5 support comes from pitest-junit5-plugin in the root POM.

SpotBugs — static analysis

./mvnw -B -ntp -Pdev,spotbugs -DskipTests -Dmaven.build.cache.enabled=false clean verify -pl api,points,validators,core -am

The spotbugs profile runs the check goal at verify (effort max, threshold low) and writes <module>/target/spotbugsXml.xml; the build fails on findings. spotbugs-exclude.xml in the root excludes findings which are by design or reviewed (mutable inputs and outputs are not copied, no serialization, extension points). Use clean: Moditect fails on an already modular JAR otherwise.

OWASP Dependency Check

mvn dependency-check:check -pl <module>

Dependency Management Rules

• All versions live in root `pom.xml` as `<properties>` — never hardcode a version in a child POM.
• Use ${property.version} references in child POMs.
• <dependencyManagement> in the root POM controls all third-party and inter-module versions.
• Inter-module dependencies use ${project.version}.

Key Version Properties

Release to Maven Central

Uses maven-release-plugin + maven-gpg-plugin + Sonatype Central Portal plugin.

mvn release:prepare
mvn release:perform