Skip to content

Latest commit

 

History

History
224 lines (205 loc) · 9.7 KB

README.md

File metadata and controls

224 lines (205 loc) · 9.7 KB
Raw

net.cactusthorn.maven

Maven Demo project. Demonstrate:

  1. Submodules
  2. build-tools module
  3. Generated sources
    1. Build Helper Plugin: http://www.mojohaus.org/build-helper-maven-plugin/
  4. Integration tests
    1. Failsafe Plugin: https://maven.apache.org/surefire/maven-failsafe-plugin/
    2. https://www.petrikainulainen.net/programming/maven/integration-testing-with-maven/
  5. Checkstyle
    1. http://checkstyle.sourceforge.net/
    2. https://maven.apache.org/plugins/maven-checkstyle-plugin/usage.html
    3. it bound to the "validate" phase
  6. Spotbugs
    1. https://spotbugs.github.io/
    2. https://spotbugs.github.io/spotbugs-maven-plugin/spotbugs-mojo.html
    3. it bound to the "test" phase
  7. PMD
    1. https://pmd.github.io
    2. https://maven.apache.org/plugins/maven-pmd-plugin/plugin-info.html
    3. it bound to the "test" phase
  8. Cobertura
    1. http://cobertura.github.io/cobertura/
    2. Cobertura Plugin: http://www.mojohaus.org/cobertura-maven-plugin/
  9. "quiet" tests mode
  10. "all-jar", jar which including its dependencies
    1. Shade Plugin: https://maven.apache.org/plugins/maven-shade-plugin/
    2. example: /submodule-one/pom.xml
  11. jar archive of the source files
    1. Source Plugin: https://maven.apache.org/plugins/maven-source-plugin/
  12. JVM and Command Line Options with .mvn
    1. https://maven.apache.org/docs/3.3.1/release-notes.html
  13. The project local maven repository
    1. https://maven.apache.org/guides/mini/guide-multiple-repositories.html
  14. Enforce a minimum version of Maven in pom.xml
    1. Enforcer Plugin: https://maven.apache.org/enforcer/maven-enforcer-plugin/
    2. Note: since maven 3.5.0 prerequisites.maven is deprecated, so this solution with maven-enforcer-plugin is only way
      1. https://maven.apache.org/docs/3.5.0/release-notes.html
      2. https://issues.apache.org/jira/browse/MNG-5297
  15. SCM information
    1. https://maven.apache.org/pom.html#SCM
  16. ZIP-artifacts with parameterized configuration files
    1. example: /config/pom.xml
    2. Properties Plugin: https://www.mojohaus.org/properties-maven-plugin/
    3. Assembly Plugin: https://maven.apache.org/plugins/maven-assembly-plugin/
  17. Echo in maven output
    1. Maven AntRun Plugin: https://maven.apache.org/plugins/maven-antrun-plugin/
  18. ${revision} in version
    1. WARNING. this feature required at least maven 3.5.0-beta-1, otherwise flattenMode=resolveCiFriendliesOnly(flatten-maven-plugin) is not working
    2. https://issues.apache.org/jira/browse/MNG-5576
    3. https://maven.apache.org/maven-ci-friendly.html
    4. This is actually "Maven Continuous Delivery Friendly Versions"-feature, and it also can be used to have only one place in the project which set the version for all modules/sub-modules in the project
  19. Plugin deactivation
    1. using phase "none"
    2. example: /submodule-one/pom.xml
  20. org.eclipse.m2e
    1. https://www.eclipse.org/m2e/documentation/m2e-execution-not-covered.html
    2. Get rid of POM not found warning for org.eclipse.m2e:lifecycle-mapping
  21. OWASP Dependency-Check
    1. https://jeremylong.github.io/DependencyCheck/dependency-check-maven/index.html
  22. maven.build.timestamp.format & maven.build.timestamp
    1. https://maven.apache.org/guides/introduction/introduction-to-the-pom.html#Available_Variables
  23. Git commit-SHA & Branch in MANIFEST.MF
    1. https://www.mojohaus.org/buildnumber-maven-plugin/
  24. Bill of Materials (BOM) POM
    1. https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html#bill-of-materials-bom-poms

How to

How to run integration tests:

mvn verify -Pintegration-test

How to run "quiet" tests mode:

mvn test -Ptest-quiet
mvn verify -Ptest-quiet

How to generate cobertura site report (generated site in target/site/cobertura/ )

mvn cobertura:cobertura

How to build "config.zip" with configuration for environment "super":

mvn verify -Penvironment-super

How to multiple Profiles:

mvn clean verify -Ptest-quiet -Pintegration-test -Penvironment-super -Pwithout-all

How to switch off generation of "-all.jar" in the submodule-one

mvn clean verify -Pwithout-all

How to exclude sub-modules from processing

mvn --projects "!build-tools,!config" verify

How to run with spotbugs

mvn -Pspotbugs verify

How to run with PMD

mvn -Ppmd verify

How to run OWASP Dependency-Check

mvn -Powasp verify

How to check maven plugin versions

mvn versions:display-plugin-updates

How to analyze dependency

mvn dependency:analyze

checkstyle

Here we have a bit tricky configuration to make it possible to use the same configuration files (checks & suppressions) in IDE plugins:

Path to the suppressions file from property (checkstyle_checks.xml):

<module name="Checker">
...
	<module name="SuppressionFilter">
		<property name="file" value="${suppressionsFile}" />
		<property name="optional" value="false" />
	</module>
...
</module>

and in the pom.xml we provide value for the "suppressionsFile" property:

<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${plugin.version.maven.checkstyle}</version>
<configuration>
	...
	<propertyExpansion>suppressionsFile=/checkstyle_suppressions.xml</propertyExpansion>
</configuration>

"quiet" tests mode

You definitely is using Logging in the project. And eventually you (by default) is using debug log-level in unit/integration test (which is fine and wanted). However, it could be unnecessary to get multi-megabyte "debug"-logs when you need to build the whole projects (e.g. "mvn clean install") Solution: use the profile(s) which substitute "default" logging configuration with "quiet"(log-level = error) logging configuration.

The project local maven repository

Sometimes you are dealing with jar(s) which are not available on maven.org :). And you do not have "private" artifact repository (like Nexus or Artifactory ), where you can simple place it.

How to configure such jar as dependency? Scope system make it possible, but it's very special scope. This scope is working similar with scope provided: e.g. the jar(s) will not included in target war, it will ignored by maven-shade-plugin and so on.

The best option for having local jar files as a dependency is to create local maven repository directly in the project folder (and as result it will be part of your project sources)

  1. mvn install:install-file with with -DlocalRepositoryPath will do all the work.
  2. To avoid the "Could not validate integrity of download ... Checksum validation failed, no checksums available" warning - use checksumPolicy = ignore in the pom.xml, which is fine for such local repository.

ZIP-artifacts with parameterized configuration files

Sometimes it's nice to have ZIP-artifacts with different configuration files (and resources) which will be late used during deployment the project in various environments(e.g. deployment with Jenkins). So, for each environment we want to have specific ZIP, filled with specific (for the environment) configurations, resources and so on. Note: It support default configurations/properties and overriding default configuration/properties.

couple of maven hints

mvnd - the Maven Daemon: https://github.com/mvndaemon/mvnd

Takari Extensions: http://takari.io/book/30-team-maven.html

List of predefined Maven properties: https://github.com/cko/predefined_maven_properties/blob/master/README.md

Get artifact in the local repository with all dependencies:

mvn org.apache.maven.plugins:maven-dependency-plugin:3.0.2:get -Dartifact=io.swagger:swagger-codegen-cli:2.3.1

Add jar in the local repository:

mvn install:install-file -Dfile=myjar-{version}.jar -DgroupId=my.group.id -DartifactId=my-artifact-it -Dversion={version} -Dpackaging=jar

Add jar in the project local repository:

mvn install:install-file -Dfile=myjar-{version}.jar -DgroupId=my.group.id -DartifactId=my-artifact-it -Dversion={version} -Dpackaging=jar -DlocalRepositoryPath=../project-maven-repository

Add "all" jar in the project local repository :

mvn install:install-file -Dfile=checkstyle-8.12-all.jar -DgroupId=com.puppycrawl.tools -DartifactId=checkstyle -Dversion=8.12 -Dpackaging=jar -Dclassifier=all -DlocalRepositoryPath=../project-maven-repository

Change property in the pom.xml (including all sub-modules)

mvn org.codehaus.mojo:versions-maven-plugin:2.7:set-property -Dproperty=MyProperty -DnewVersion=MyValue org.codehaus.mojo:versions-maven-plugin:2.7:commit

Change version in the pom.xml (including all sub-modules)

mvn org.codehaus.mojo:versions-maven-plugin:2.7:set-DnewVersion=MyNewVersion org.codehaus.mojo:versions-maven-plugin:2.7:commit

Copy artifact from the local Maven repository to the folder

mvn org.apache.maven.plugins:maven-dependency-plugin:3.1.1:copy -Dartifact=net.cactusthorn.gradle:submodules-spring-boot-simple-war:1.0.0:jar:sources -DoutputDirectory=C:\Temp\1

Displays all dependencies that have newer versions available.

mvn versions:display-dependency-updates

License

Released under the BSD 2-Clause License

Copyright (C) 2018, Alexei Khatskevich
All rights reserved.

Licensed under the BSD 2-clause (Simplified) License (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://opensource.org/licenses/BSD-2-Clause