Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quick-perf/quickperf-live

Ease your work on Spring Boot applications: quickly generate functional non-regression tests, diagnose performance and generate non-regression tests on performance-related properties.
https://github.com/quick-perf/quickperf-live

allocation java n-plus-1 nplus1 performance performance-metrics performance-monitoring spring spring-boot test-automation test-generation test-generator testing-tools

Last synced: about 2 months ago
JSON representation

Ease your work on Spring Boot applications: quickly generate functional non-regression tests, diagnose performance and generate non-regression tests on performance-related properties.

Host: GitHub
URL: https://github.com/quick-perf/quickperf-live
Owner: quick-perf
License: apache-2.0
Created: 2021-09-29T14:03:06.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-01-10T13:01:39.000Z (almost 2 years ago)
Last Synced: 2024-10-17T12:29:52.895Z (2 months ago)
Topics: allocation, java, n-plus-1, nplus1, performance, performance-metrics, performance-monitoring, spring, spring-boot, test-automation, test-generation, test-generator, testing-tools
Language: Java
Homepage:
Size: 219 KB
Stars: 11
Watchers: 2
Forks: 7
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# QuickPerf live

A tool to ease your work as a developer, not only regarding performance. Make your developer job easier.

---

📺 QuickPerf live demo (in French)

---

## Main features

### Diagnose performance-related properties
```
GET 200 http://localhost:8080/owners?lastName=
* [WARNING] N+1 select suspicion - 453 SELECT
```

```
GET 200 http://localhost:8080/owners/2/edit
* [WARNING] Heap allocation is greater than 10 000 000 bytes: 17 509 888 bytes
```
👉 [Learn more](./doc/performance_diagnostics.md)

💡 You can use the performance diagnostic features during development or to help you diagnose the performance of a deployed application.

### Generate non-regression tests

The generated tests ensure a non-regression on:
* ***functional behavior***
* ***performance-related properties***

👉 [Learn more](./doc/test_generation.md)

## Some use cases

You have many things to do or think about in your daily job.
You may not have enough time to improve the following issues that would ease your daily job or improve the user experience. _QuickPerf live_ could help you!

### You work on an application lacking automated tests on business behavior
Are you not confident that your new development will not break another feature? _QuickPerf live_ allows you to generate automated tests!
More [here](./doc/test_generation.md).

### You want to fix an N+1 select
_QuickPerf live_ can generate an automatic test reproducing the N+1 select. You can use it to investigate the cause of the N+1 select. The produced test will also ensure non-regression on the absence of N+1 select as well as on the functional behavior.

### Your application allocates a lot
_QuickPerf live_ allows you to measure the heap allocation generated by each HTTP call.

### You want to know how a web service handles the business data
Finding out what types of business data a web service handles may be challenging.
Sometimes, as a developer, we may also be tempted to load more data than necessary to implement a business behavior, potentially impacting performance. In both cases, _QuickPerf live_ can help you by displaying the selected columns from the database (cf. *Selected columns* part in [Database diagnostics](./doc/database_diagnostics.md)), or [creating the database dataset
of a generated web service test](./doc/test_generation.md).

## Add _QuickPerf live_ to your project

### Current limitations
_QuickPerf live_ works today for web applications developed with Spring Boot 2.

⚠ _Today, we don't recommend enabling the tool in a production environment._

### Add _QuickPerf live_ dependency
```xml

org.quickperf
quick-perf-live-springboot2
0.12

```

### Enable _QuickPerf live_

From a _yaml_ file:

```yaml
quickperf:
enabled: true
```

From a _.properties_ file:

```
quickperf.enabled=true
```

## Enable _QuickPerf live_ features

### Enable the performance diagnostic and test generation features

You can configure the performance diagnostics and the test generation with properties.
You can also update the configuration after the application startup with the help of MBeans.

👉 [**Performance diagnostics**](./doc/performance_diagnostics.md)

👉 [**Test generation**](./doc/test_generation.md)

### Tip
QuickPerf MBeans are unavailable? Read [this](./doc/faq.md).

### Configuration examples

👉 [A _yaml_ file example](./spring-boot-2/src/test/resources/quickperf-properties-test.yml)

👉 [A _.properties_ file example](./spring-boot-2/src/test/resources/quickperf-properties-test.properties)

## Export _QuickPerf live_ information

### Display info on application logs

```properties
logging.level.org.quickperf.*=INFO
```

### Implement custom exports
Create Spring beans implementing ```QuickPerfHttpCallInfoWriter``` or ```QuickPerfHttpCallWarningWriter``` interfaces.
You can use this feature to generate a performance diagnostic report or record the history of performance-related properties.