├── .github
└── workflows
│ ├── ci.yml
│ ├── memory-releases.yml
│ └── memorycheck.yml
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE.txt
├── Makefile
├── README.md
├── bench-tools-maven
├── pom.xml
└── src
│ ├── main
│ └── java
│ │ └── org
│ │ └── quickperf
│ │ └── maven
│ │ └── bench
│ │ ├── AllocationCsvExporter.java
│ │ ├── AllocationTimePair.java
│ │ ├── ExecutionContextTextExporter.java
│ │ ├── commands
│ │ ├── InstallMavenVersionIfNotExists.java
│ │ └── MavenBuildFromGitSourceInstall.java
│ │ ├── config
│ │ ├── BenchConfiguration.java
│ │ ├── BenchConfigurationFileBasedResolver.java
│ │ └── DefaultBenchConfigurationResolver.java
│ │ └── projects
│ │ ├── Maven3Version.java
│ │ └── TestingProject.java
│ └── test
│ ├── java
│ └── org
│ │ └── quickperf
│ │ └── maven
│ │ └── bench
│ │ └── config
│ │ ├── BenchConfigurationFileBasedResolverTestCase.java
│ │ └── DefaultBenchConfigurationResolverTest.java
│ └── resources
│ ├── log4j.properties
│ ├── maven-bench.properties
│ └── org
│ └── quickperf
│ └── maven
│ └── bench
│ └── config
│ └── test.properties
├── bench-tools
├── pom.xml
└── src
│ ├── main
│ └── java
│ │ └── org
│ │ └── quickperf
│ │ └── maven
│ │ └── bench
│ │ ├── Command.java
│ │ ├── commands
│ │ ├── GitClone.java
│ │ ├── HttpGet.java
│ │ ├── InstallWithHttpGet.java
│ │ └── ZipExtractor.java
│ │ └── config
│ │ └── BenchConfigurationResolver.java
│ └── test
│ ├── java
│ └── org.quickperf.maven.bench.commands
│ │ ├── GitCloneTest.java
│ │ ├── HttpGetTest.java
│ │ ├── PropertiesUtils.java
│ │ └── PropertiesUtilsTest.java
│ └── resources
│ ├── bench-tools.properties
│ ├── data
│ └── index.txt
│ ├── download
│ └── .gitkeep
│ └── log4j.properties
├── maven-perf
├── NEXT_STEP.md
├── measures
│ ├── Maven3.2.5-JMC.5.5JPG.jpg
│ ├── execution-context-2019-09-01-18-48-41.txt
│ ├── maven-memory-allocation-2019-09-01-18-48-41.csv
│ └── mvn-validate-on-camel.png
├── pom.xml
└── src
│ └── test
│ ├── java
│ └── org
│ │ └── quickperf
│ │ └── maven
│ │ └── bench
│ │ ├── MvnValidateAllocationByMaven3VersionTest.java
│ │ ├── MvnValidateMaxAllocation.java
│ │ └── MvnValidateProfilingTest.java
│ └── resources
│ ├── log4j.properties
│ └── maven-bench.properties
└── pom.xml
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 |
3 | on:
4 | push:
5 | branches: [ master ]
6 | pull_request:
7 | branches: [ master ]
8 |
9 | jobs:
10 | build:
11 | runs-on: ubuntu-latest
12 | env:
13 | TESTING_PROJECT_VERSION: camel-3.0.0
14 | steps:
15 | - uses: actions/checkout@v2
16 | - name: Set up JDK 11
17 | uses: actions/setup-java@v1
18 | with:
19 | java-version: 11
20 | - name: Cache Maven dependencies
21 | uses: actions/cache@v2
22 | with:
23 | path: ~/.m2
24 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
25 | restore-keys: ${{ runner.os }}-m2
26 | - name: Build
27 | run: make ci
28 |
--------------------------------------------------------------------------------
/.github/workflows/memory-releases.yml:
--------------------------------------------------------------------------------
1 | name: Releases Memory Bench
2 |
3 | on: workflow_dispatch
4 |
5 | jobs:
6 | build:
7 | runs-on: ubuntu-latest
8 | env:
9 | TESTING_PROJECT_VERSION: camel-3.0.0
10 | MAVEN_VERSION_FROM: 3.6.0
11 | MAVEN_VERSION_TO: master
12 | WARM_UP_NUMBER: 1
13 | MEASURES_NUMBER_BY_MAVEN_VERSION: 10
14 | steps:
15 | - uses: actions/checkout@v2
16 | - name: Set up JDK 11
17 | uses: actions/setup-java@v1
18 | with:
19 | java-version: 11
20 | - name: Cache Maven dependencies
21 | uses: actions/cache@v2
22 | with:
23 | path: ~/.m2
24 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
25 | restore-keys: ${{ runner.os }}-m2
26 | - name: Bench allocation of Maven Releases
27 | run: make runMeasures
28 |
--------------------------------------------------------------------------------
/.github/workflows/memorycheck.yml:
--------------------------------------------------------------------------------
1 | name: Daily Memory Check
2 |
3 | on:
4 | schedule:
5 | - cron: '0 6 * * *'
6 |
7 | jobs:
8 | build:
9 | runs-on: ubuntu-latest
10 | env:
11 | TESTING_PROJECT_VERSION: camel-3.0.0
12 | steps:
13 | - uses: actions/checkout@v2
14 | - name: Set up JDK 11
15 | uses: actions/setup-java@v1
16 | with:
17 | java-version: 11
18 | - name: Cache Maven dependencies
19 | uses: actions/cache@v2
20 | with:
21 | path: ~/.m2
22 | key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
23 | restore-keys: ${{ runner.os }}-m2
24 | - name: Run validation max allocation
25 | run: make runValidateMaxAllocation
26 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Maven
2 | target
3 |
4 | # IntelliJ
5 | .idea
6 | *.iml
7 | out
8 |
9 | # Eclipse
10 | .classpath
11 | .project
12 | .settings
13 |
14 | # NetBeans
15 | .nbattrs
16 |
17 | # local conf
18 | local.*.properties
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | In the interest of fostering an open and welcoming environment, we as
6 | contributors and maintainers pledge to making participation in our project and
7 | our community a harassment-free experience for everyone, regardless of age, body
8 | size, disability, ethnicity, sex characteristics, gender identity and expression,
9 | level of experience, education, socio-economic status, nationality, personal
10 | appearance, race, religion, or sexual identity and orientation.
11 |
12 | ## Our Standards
13 |
14 | Examples of behavior that contributes to creating a positive environment
15 | include:
16 |
17 | * Using welcoming and inclusive language
18 | * Being respectful of differing viewpoints and experiences
19 | * Gracefully accepting constructive criticism
20 | * Focusing on what is best for the community
21 | * Showing empathy towards other community members
22 |
23 | Examples of unacceptable behavior by participants include:
24 |
25 | * The use of sexualized language or imagery and unwelcome sexual attention or
26 | advances
27 | * Trolling, insulting/derogatory comments, and personal or political attacks
28 | * Public or private harassment
29 | * Publishing others' private information, such as a physical or electronic
30 | address, without explicit permission
31 | * Other conduct which could reasonably be considered inappropriate in a
32 | professional setting
33 |
34 | ## Our Responsibilities
35 |
36 | Project maintainers are responsible for clarifying the standards of acceptable
37 | behavior and are expected to take appropriate and fair corrective action in
38 | response to any instances of unacceptable behavior.
39 |
40 | Project maintainers have the right and responsibility to remove, edit, or
41 | reject comments, commits, code, wiki edits, issues, and other contributions
42 | that are not aligned to this Code of Conduct, or to ban temporarily or
43 | permanently any contributor for other behaviors that they deem inappropriate,
44 | threatening, offensive, or harmful.
45 |
46 | ## Scope
47 |
48 | This Code of Conduct applies both within project spaces and in public spaces
49 | when an individual is representing the project or its community. Examples of
50 | representing a project or community include using an official project e-mail
51 | address, posting via an official social media account, or acting as an appointed
52 | representative at an online or offline event. Representation of a project may be
53 | further defined and clarified by project maintainers.
54 |
55 | ## Enforcement
56 |
57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
58 | reported by contacting the project team at jean.bisutti@gmail.com. All
59 | complaints will be reviewed and investigated and will result in a response that
60 | is deemed necessary and appropriate to the circumstances. The project team is
61 | obligated to maintain confidentiality with regard to the reporter of an incident.
62 | Further details of specific enforcement policies may be posted separately.
63 |
64 | Project maintainers who do not follow or enforce the Code of Conduct in good
65 | faith may face temporary or permanent repercussions as determined by other
66 | members of the project's leadership.
67 |
68 | ## Attribution
69 |
70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72 |
73 | [homepage]: https://www.contributor-covenant.org
74 |
75 | For answers to common questions about this code of conduct, see
76 | https://www.contributor-covenant.org/faq
77 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | SHELL := /bin/bash # Use bash syntax
2 |
3 | .PHONY: help build runMeasures runValidateMaxAllocation
4 |
5 | help:
6 | @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
7 |
8 | clean: ## Cleanup project files (basically run `mvn clean`)
9 | mvn clean
10 |
11 | build: ## Build project with running all tests (basically run `mvn package`)
12 | mvn package -B
13 |
14 | ci:
15 | mvn package -B -P ci
16 |
17 | install-only-bench-tools: ## Install locally all tools lib necessary to run maven perf tests.
18 | mvn install -DskipTests -pl bench-tools-maven -am -B
19 |
20 | runValidateMaxAllocation: install-only-bench-tools ## Running only memory allocation needed for last commit from Maven GIT Repository on master branch
21 | mvn test -pl maven-perf -Dtest=org.quickperf.maven.bench.MvnValidateMaxAllocation -B
22 |
23 | runMeasures: install-only-bench-tools ## Running only measures
24 | mvn test -pl maven-perf -Dtest=org.quickperf.maven.bench.MvnValidateAllocationByMaven3VersionTest -B
25 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
Measure and investigate heap memory allocation of Apache Maven
20 |
21 | This project is a test bench based on [QuickPerf](https://github.com/quick-perf/quickperf) to benchmark and understand heap memory allocation caused by `mvn validate` on a project source code.
22 |
23 | Feel free to use this project re-execute measures, play with it on measuring any build, tweak its code and contribute back to it!
24 |
25 | # Overview
26 |
27 | This project contains two types of measures against Maven build execution, each provided as a JUnit unit test (in ```src/test/java```):
28 | - `MvnValidateProfilingTest` can be used to investigate the origin of memory allocation (using QuickPerf [@ProfileJvm](https://github.com/quick-perf/doc/wiki/JVM-annotations#Profile-or-check-your-JVM)) during one build with a given Maven version,
29 | - `MvnValidateAllocationByMaven3VersionTest` can be used to measure the heap allocation (using QuickPerf [@MeasureHeapAllocation](https://github.com/quick-perf/doc/wiki/JVM-annotations#Verify-heap-allocation)) for every Maven release in a version range.
30 |
31 | # General setup
32 |
33 | This general setup part describes configuration common to both tests, done in `src/test/resourrces/maven-bench.properties` file:
34 | - the `testing.project.path` represents the path of the project on which `mvn validate` will be applied,
35 | - the `maven.binaries.path` property corresponds to the path where the needed Maven distributions will be automatically downloaded by the tests.
36 | The other properties are only used by `MvnValidateAllocationByMaven3VersionTest`.
37 |
38 | The measures shown here are done against the Apache Camel project because it contains more than 800 Maven modules: such a huge build is perfect to get significant measures. But you can choose your own target.
39 |
40 | _Note: currently, every day, a job @TravisCI run `org.quickperf.maven.bench.MvnValidateMaxAllocation` in order to watch
41 | over Apache Maven project and observe if new features on Apache Maven needs more memory then yesterday._
42 |
43 |
44 | For reproducibility of our measures, a precisely defined commit of this project was chosen:
45 | ```
46 | git clone -n https://github.com/apache/camel.git
47 | git checkout c409ab7aabb971065fc8384a861904d2a2819be5
48 | ```
49 |
50 | If you want to apply measures on build done with Maven HEAD, that cannot be downloaded from public releases, you can execute the following commands where {maven-distrib-location} has to be replaced with the url given by the `maven.binaries.path` property of `maven-bench.properties` file:
51 | ```
52 | git clone https://github.com/apache/maven.git
53 | cd maven
54 | mvn -DdistributionTargetDir="{maven-distrib-location}/apache-maven-head" package
55 | ```
56 |
57 | Heap size is fixed with the help of [@HeapSize](https://github.com/quick-perf/doc/wiki/JVM-annotations#heapsize).
58 |
59 | # Contributing
60 |
61 | ## Building the project
62 |
63 | ```bash
64 | git clone https://github.com/pcavezzan/maven-test-bench.git
65 | make build
66 | ```
67 |
68 | The above commandline will run behind the scene several actions:
69 | * run ```mvn package -B```
70 |
71 | During the test phase, we are going to :
72 | * clone Apache Camel project (commit ```c409ab7aabb971065fc8384a861904d2a2819be5```) into ```test-classes/camel```
73 | * install different version of maven into ```test-classes/maven```
74 | * for Releases version, we are going to :
75 | * download releases from ```https://archive.apache.org/dist/maven/maven-3//binaries/apache-maven--bin.zip```
76 | * unzip into ```test-classes/maven/apache-maven-```
77 | * for HEAD version, we are going to :
78 | * clone Apache Maven mainstream from ```https://gitbox.apache.org/repos/asf/maven-sources.git```
79 | * build from source Apache Maven latest development version,
80 | * rename the built maven to ```test-classes/maven/apache-maven-master```,
81 |
82 | __*Note:*__ *the build above could be stuck depending on your machine settings. If it is the case, I would suggest you to create a custom build (see below).*
83 |
84 | ## Custom Build
85 |
86 | If you prefer to override some settings without editing the default configuration (```maven-bench.propertiers```),
87 | you have several options:
88 |
89 | * environment variable
90 | * you can create a local configuration files ```local.maven-bench.properties``` without any risk to version it because
91 | this file is ignored by GIT. In this file, just override the settings you want.
92 |
93 | ### Overriding by setting environment variable
94 |
95 | ```bash
96 | export MAVEN_VERSION_FROM=3.6.1
97 | export MAVEN_VERSION_TO=3.6.2
98 | make build
99 | ```
100 |
101 | ### Overriding by creating local.maven-bench.properties
102 |
103 | ```bash
104 | cat << EOF > src/main/resources/local.maven-bench.properties
105 | maven.version.from=3.6.1
106 | maven.version.to=3.6.2
107 | EOF
108 | make build
109 | ```
110 |
111 | ### Running only some tests
112 |
113 | This project contains a Makefile to easily orchestrate how to build or run specific test.
114 | To get more info, do not hesitate to run basic ```make``` or ```make help```:
115 |
116 | ```bash
117 | $ make
118 | build Build project with running all tests (basically run `mvn package`)
119 | clean Cleanup project files (basically run `mvn clean`)
120 | runMeasures Running only measures
121 | runValidateMaxAllocation Running only memory allocation needed for last commit from Maven GIT Repository on master branch
122 | ```
123 |
124 | #### Memory allocation on head maven version
125 |
126 | ```bash
127 | $ make runValidateMaxAllocation
128 | ```
129 |
130 |
131 | #### Measures maven version
132 |
133 | ```bash
134 | $ make runMeasureOnHead
135 | ```
136 |
137 |
138 | ## Developing
139 |
140 | If you want to help us and make some code, you can easily get the project and open it up with your favorite IDE.
141 |
142 |
143 | ### NOTE: if you want to debug head version of Maven
144 |
145 | First configure the project to use only head version of maven. For example, by creating a ```local.maven-bench.properties```
146 | in ```src/main/resources``` directory:
147 |
148 | ```bash
149 | cat << EOF > src/main/resources/local.maven-bench.properties
150 | maven.version.from=head
151 | maven.version.to=head
152 | EOF
153 | make build
154 | ```
155 |
156 | Then just open your favorite IDE or running your test.
157 |
158 |
159 | # Benchmark heap allocation of several Maven releases
160 |
161 | `org.quickperf.maven.bench.MvnValidateAllocationByMaven3VersionTest` test allows to benchmark the heap allocation level on several Maven 3 distributions.
162 |
163 | Heap allocation level is measured with the help of [@MeasureHeapAllocation](https://github.com/quick-perf/doc/wiki/JVM-annotations#Verify-heap-allocation) QuickPerf annotation. This annotation measures the heap allocation level of the thread running the method annotated with @Test.
164 | Feel free to contribute to QuickPerf by adding a feature allowing to measure the allocation level aggregated across all the threads! With `mvn validate`, we have checked that Maven code is not multithreaded during this validate phase by profiling the JVM with the help of [@ProfileJvm](https://github.com/quick-perf/doc/wiki/JVM-annotations#ProfileJvm).
165 |
166 | Please read [General setup](#General-setup) to get some of the setup requirements.
167 |
168 | You also have to give a value for the following properties contained in the [maven-bench.properties](src/test/resources/maven-bench.properties) file:
169 | * `maven.version.from`
170 | * `maven.version.to`
171 | * `warmup.number`
172 | * `measures.number-by-maven-version`
173 |
174 | The meaning of these properties is given in the [maven-bench.properties](src/test/resources/maven-bench.properties) file.
175 |
176 | Measures can be launched with this command line: ```mvn -Dtest=org.quickperf.maven.bench.MvnValidateAllocationByMaven3VersionTest test```.
177 | Before doing it, you can close your IDE, web browser or other applications to free memory.
178 |
179 | The benchmark results are exported into a `maven-memory-allocation-{date-time}.csv` file. The execution context (processor, OS, ...) is reported in an `execution-context-{date-time}.txt` file.
180 |
181 | For several Maven versions, the following graph gives the average of ten heap allocations caused by the application of `mvn validate` on Apache Camel:
182 |
183 |
184 |
185 |
186 | For this graph, you can consult:
187 | * [the measures](maven-perf/measures/maven-memory-allocation-2019-09-01-18-48-41.csv)
188 | * [the execution context](maven-perf/measures/execution-context-2019-09-01-18-48-41.txt)
189 |
190 | Measures took around one hour and a quarter.
191 |
192 | From Maven versions 3.2.5 to 3.6.2, heap allocation level is the highest with Maven 3.2.5 and the smallest with Maven 3.6.2. *The heap allocation decreases from ~7 Gb with Maven 3.6.1 to ~3 Gb with Maven 3.6.2*.
193 |
194 | Control and reduce heap allocation is an important matter for Maven project. Indeed, a part of the heap allocation is going to be garbage collected and the garbage collection activity is succeptible to slow down your build. In addition, less heap allocation means that you may execute Maven with a smaller heap size.
195 |
196 | But where the allocation comes from? In the following part we will see how to spot the Java methods allocating a lot.
197 |
198 | # Investigate where heap allocation comes from
199 |
200 | You can use `org.quickperf.maven.bench.MvnValidateProfilingTest` to understand the origin of heap allocation.
201 | Some of the set up requirements can be found in [General setup](#General-setup) part.
202 |
203 | The Maven version under test can be set with the `MAVEN_3_VERSION` constant:
204 | ``` java
205 | public static org.quickperf.maven.bench.projects.Maven3Version MAVEN_3_VERSION = org.quickperf.maven.bench.projects.Maven3Version.V_3_6_2;
206 | ```
207 |
208 | A test method is annotated with [@ProfileJvm](https://github.com/quick-perf/doc/wiki/JVM-annotations#Profile-or-check-your-JVM) to profile the test method with Java Flight Recorder (JFR).
209 |
210 | The JFR file location is going to be displayed in the console:
211 | ```
212 | [QUICK PERF] JVM was profiled with Java File Recorder (JFR).
213 | The recording file can be found here: C:\Users\JEANBI~1\AppData\Local\Temp\QuickPerf-46868616\jvm-profiling.jfr
214 | You can open it with Java Mission Control (JMC).
215 | ```
216 |
217 | You can open it with Java Mission Control (JMC) to discover the methods contributing the most to heap allocation.
218 |
219 | Below a JFR file for Maven 3.2.5 and opened with JMC 5.5:
220 |
221 |
222 |
223 |
224 |
225 | By the way, you can also benefit from an automatic performance analysis with [@ExpectNoJvmIssue](https://github.com/quick-perf/doc/wiki/JVM-annotations#ExpectNoJvmIssue).
226 | For example, the following warning is reported with Maven 3.2.5:
227 | ```
228 | Rule: Thrown Exceptions
229 | Severity: WARNING
230 | Score: 97
231 | Message: The program generated 20 482 exceptions per second during 26,722 s starting at
232 | 03/09/19 17:08:31.
233 | ```
234 |
235 | # Perspectives
236 | We have developed a test bench that is able to compare the heap allocation level between several Maven versions. We also have given a method to understand the origin of heap allocation.
237 |
238 | Feel free to play with this bench and [QuickPerf](https://github.com/quick-perf/doc/wiki/QuickPerf), to perform measures (heap allocation, execution time, ...) with different plugins/goals, use different JDK or garbage collectors, ..., suggest new ideas, create new features or share your measures with PR!
239 | Some issues are also available [here](https://github.com/quick-perf/maven-test-bench/issues)!
240 |
241 | You also have [QuickPerf issues](https://github.com/quick-perf/quickperf/issues) to build new performance tools!
242 |
243 | # Contributors
244 | Many thanks to all our contributors!
245 |
246 |
6 | 7 |
184 | 
222 | 
251 | 
263 | 
273 | 
282 |