QuickPerf is a testing library for Java to quickly evaluate and improve some performance-related properties

Last update: Dec 15, 2022

Overview

QuickPerf is a testing library for Java to quickly evaluate and improve some performance-related properties

quickperf.io

📙 Documentation

Annotations

👉 Core

👉 JVM

👉 SQL

more...

Frameworks and Test Frameworks

👉 Spring

more...

👉 JUnit 4

👉 JUnit 5

👉 TestNG

more...

Frequently Asked Questions

more...

Usage

JVM annotations

    @MeasureHeapAllocation
    @HeapSize(value = 1, unit = AllocationUnit.GIGA_BYTE)
    @Test
    public void execute_batch() {
        ...
    }

📙 All the JVM annotations 🔎 Examples with JUnit4, Junit5, TestNG 🔎 Heap allocation of Apache Maven

SQL annotations

    @ExpectSelect(1)
    @Test
    public void should_find_all_players() {
     ...
    }

[PERF] You may think that <1> select statement was sent to the database
       But there are in fact <10>...

💣 You may have even more select statements with production data.
Be careful with the cost of JDBC roundtrips: https://blog.jooq.org/2017/12/18/the-cost-of-jdbc-server-roundtrips/

Auto-detection of Hibernate and Spring Data JPA:

💡 Perhaps you are facing an N+1 select issue
	* With Hibernate, you may fix it by using JOIN FETCH
	                                       or LEFT JOIN FETCH
	                                       or FetchType.LAZY
	                                       or ...

	* With Spring Data JPA, you may fix it by adding @EntityGraph(attributePaths = { "..." })
      	  on repository method: https://docs.spring.io/spring-data/jpa/docs/current/reference/ht

📙 All the SQL annotations 🔎 Spring Boot & JUnit 4 🔎 Spring Boot & JUnit 5

Talks and videos

Something to ask us?

📧 [email protected]

💬 Want to chat with us? Join us on gitter

Do you prefer to use a Github issue to ask a question? Create a question issue

Show your support

Please ⭐ this repository or if this project helped you!

Contributing

You are very welcome to contribute to QuickPerf! You can contribute in many ways. Some relatively easy things can be done. Other issues are more challenging. Each contribution is appreciated. Read our contributing guide to learn more.

Contributors

Many thanks to all our contributors!

_{Jean Bisutti} 💻 ⚠ 📖 🎨 💡 👀 📢	_{Guillaume Raghoumandan} 💻 ⚠	_{Patrice Cavezzan} 💻 🚇 📖	_{Alexandre Blanchard} 🐛 💻	_{Eric McDowell} 💻	_{Jan Krüger} 💻	_{Loïc Mathieu} 💻 💡 📖
_{Daniel Bentley} 🚇	_{Gaurav Deshpande} ⚠	_rdm100 📖	_{Artus de Benque} 🐛 💻	_{Minh-Trieu Ha} 💻	_{Bakary Djiba} 💻	_{C Faisal} 💻
_{Thami Inaflas} 💻	_{José Paumard} 💻	_{Edward Rose} 💻	_{Ubaid ur Rehman} 💻	_{Giuseppe B.} 💻	_Fabrice 💻 📖	_{Navneet Kumar} 💻
_{Charles Sabourdin} 📖	_{Mohamed Karaga} 🐛 💻	_{Hervé Boutemy} 📦	_{Franck Demeyer} 🐛 💻

emoji key

License

Apache License 2.0

Comments

Add Junit5 JVM annotations

This is a draft PR to gather feeback on JVM annotations with JUnit 5. It contains some code around forking that still needs improvements. It also provides disabling forking wich should be discussed.

This is buid on top of PR #22 that needs to be merged first.

opened by loicmathieu 36
Provides a JUnit 5 extension

Description Currentlly, only JUnit 4 is supported.

Implementation ideas There should be a JUnit 5 extension to be able to use quickperf with JUnit 5. I can try to work on it.
:sparkles: feature :construction: work-in-progress junit5

opened by loicmathieu 28
Add @ExpectMaxDelete
Description

The aim of this annotation is to check the maximum number of DELETE statements.

For example, a test method having @ExpectMaxDelete(2) annotation will fail if more than two DELETE statements are executed.

Implementation steps

Create the @ExpectMaxDelete annotation here

Example: @ExpectDelete

Create a test class in this package and add automatic tests

Example: ExpectDeleteTest.java

In this package add a performance measure extractor and a performance issue verifier.

Examples:

DeleteCountMeasureExtractor.java

NumberOfSqlDeletePerfIssueVerifier.java

MaxOfSelectsPerfIssueVerifier.java

Create an AnnotationConfig in SqlAnnotationsConfig. This new AnnotationConfig will use the previously created performance measure extractor, performance issue verifier together with a PersistenceSqlRecorder.

Example:

static final AnnotationConfig MAX_SQL_SELECT = new AnnotationConfig.Builder() .perfRecorderClass(PersistenceSqlRecorder.class) .perfMeasureExtractor(SelectCountMeasureExtractor.INSTANCE) .perfIssueVerifier(MaxOfSelectsPerfIssueVerifier.INSTANCE) .build(ExpectMaxSelect.class);

Use the new AnnotationConfig in loadAnnotationConfigs() method of SqlConfigLoader

Complete the measure extractor and the performance issue verifier to make the tests green. Refactor to clean the code.

In SqlAnnotationBuilder, add a static method to can build the new annotation. This method can be used to define the annotation with a global scope.

If you start to work on this issue, please leave a comment I start to work on this issue, so we can assign it to you. Do not hesitate to ask for information about the issue.
:sparkles: feature :thumbsup: good first issue sql
opened by jeanbisutti 23
Add Javadoc to SQL annotations

SQL annotations are documented in QuickPerf wiki.

The goal of this issue is to add Javadoc to SQL annotations that are located in sql-annotations Maven module.

The documentation contained in QuickPerf wiki can be used to add Javadoc to the SQL annotations. Don't hesitate to improve it.
:ledger: documentation :thumbsup: good first issue

opened by jeanbisutti 15
Test NG / Spring Boot

A QuickPerf Test NG listener is developed (see #32 and 3932345 ).

A Spring Boot application is tested with QuickPerf+JUnit4 and QuickPerf+Junit5.

The aim of this issue is to provide a Github repository containing this Spring Boot application with tests using QuickPerf and Test NG.

opened by jeanbisutti 15
Make @ProfileJvm display the young GC count #71
add display the number of young collections.

a private method getYoungGcCount(IItemCollection jfrEvents) add in DisplayJvmProfilingValueVerifier class

display Young: (number of collections) below Longest GC pause
opened by ubaid4j 12
Have configurable verbosity on none passing test

Description Some Feedback on non-working test (for instance N+1 select) are very long. It's useful but it could be drawing (overwhelming) sometime. It also could fill the CI system

It could be nice have its verbosity configurable Implementation ideas (If you have any implementation ideas, they can go here.) It would be great to works with -Dquickperf.hints=0
:sparkles: feature

opened by kanedafromparis 11
Instrument dynamic JUnit 5 tests

Description Great project, I really like the idea and the configuration model.

I'd love to have the alternative to instrument dynamic tests as well, which AFAIK does not respect annotations but would instead need some programmatic API alternative. Alternatively provide an example on how these could be wired up manually with the current model and some before and after lambdas?

https://junit.org/junit5/docs/current/user-guide/#writing-tests-dynamic-tests
:sparkles: feature junit5

opened by billybong 11

Make @ProfileJvm display the allocation rate

Description

With @ProfileJvm annotation, the JVM is profiled with the JDK Flight Recorder, an event recorder built into the JVM.

With this annotation, some JVM data are displayed in the standard output.

Example:

 ALLOCATION (estimations)  |   GARBAGE COLLECTION           |  THROWABLE
 Total:        3,7 GiB     |   Total pause: 1,087 s         | Exception: 0
 Inside TLAB:  3,69 GiB    |   Longest GC pause: 160,438 ms | Error: 36
 Outside TLAB: 10,3 MiB    |                                | Throwable: 36

The aim of this issue is to add the allocation rate.

Implementation ideas

Class displaying JVM data: DisplayJvmProfilingValueVerifier
Total allocation can be computed by using JdkAggregators.ALLOCATION_TOTAL.

   IQuantity totatlAlloc =(IQuantity) itemCollection.getAggregate(JdkAggregators.ALLOCATION_TOTAL);
   long allocationInBytes = totatlAlloc.longValue();

The duration can be computed in the following way:

Filter IItemCollection by inside and outside TLAB events:

   itemCollection.apply(JdkFilters.ALLOC_INSIDE_TLAB)       
   itemCollection.apply(JdkFilters.ALLOC_OUTSIDE_TLAB)

Retrieve the min and max timestamps Code to get the timestamp of a JFR event below

IType<IItem> type= (IType<IItem>) item.getType();
IMemberAccessor<IQuantity, IItem> endTimeAccessor = JfrAttributes.END_TIME.getAccessor(type);
IQuantity quantityEndTime = endTimeAccessor.getMember(jfrEvent);
long timeStampInMs = quantityEndTime.longValueIn(UnitLookup.EPOCH_MS);

Compute the difference between the min and max time stamps

Compute (total allocation)/duration

:sparkles: feature :thumbsup: good first issue jvm JDK Flight Recorder

opened by jeanbisutti 10

Add bytes to allocation display
Some annotations, like @MeasureHeapAllocation, can display allocation in console. The allocation is formatted with the help of ByteAllocationMeasureFormatter class.

For example:

Measured heap allocation: 3.1 Giga bytes

Now, we want that the formatted allocation also displays the allocation in bytes between parentheses if the allocation has a magnitude of kilo bytes, mega bytes or giga bytes.

For example:

3.9 Kilo bytes (4 056 bytes)

The test class to update is ByteAllocationMeasureFormatterTest.

If you start to work on this issue, please leave a comment "I start to work on this issue", so we can assign it to you.
:thumbsup: good first issue hacktoberfest
opened by jeanbisutti 10

Add @DisableQueriesWithoutBindParameters and @EnableQueriesWithoutBindParameters

Why

Using bind parameters is recommanded for performance. Moreover, bind parameters can prevent SQL injections.

References:

Oracle Performance Survival Guide: A Systematic Approach to Database Optimization
https://use-the-index-luke.com/sql/where-clause/bind-parameters
https://dzone.com/articles/why-sql-bind-variables-are-important-for-performan
https://blogs.oracle.com/sql/improve-sql-query-performance-by-using-bind-variables
https://www.ibm.com/developerworks/library/se-bindvariables/index.html)
...

The role of @DisableQueriesWithoutBindParameters is to prevent the execution of requests without bind parameters. This annotation could be used whith a global scope, that is to say applied on each QuickPerf test.

@EnableQueriesWithoutBindParameters will cancel the behavior of @DisableQueriesWithoutBindParameters. @EnableQueriesWithoutBindParameters may be applied on a specific test method where some values can influence the execution plan (https://use-the-index-luke.com/sql/where-clause/bind-parameters).