Allure server for store / aggregate / manage Allure results and generate / manage Allure Reports.
There is only API in first major version with Swagger(OpenAPI) Description.
Just use Spring Boot Jar from Release Page.
Works on WebUI is in progress to next major (2.0.0) version.
Running as Docker container look at: readme
Get the latest release Releases
Download allure-server.jar
Update your jre(jdk) up to Java 11
Execute command java -jar allure-server.jar
Got to http://localhost:8080
- will redirect to OpenAPI (Swagger UI)
Only allure2 supported
Make some allure results and create zip
archive with these results, for example allure-results.zip
in your root dir
curl --location --request POST 'http://localhost:8080/api/result' \
--form 'allureResults=@/allure-results.zip;type=application/zip'
Response:
{
"fileName": "allure-results.zip",
"uuid": "1037f8be-68fb-4756-98b6-779637aa4670"
}
Save uuid
Don't forget specify form item Content type as application/zip
. Server works with zip
archives only!
For generate new report execute POST
request with json
body:
curl --location --request POST 'http://localhost:8080/api/report' \
--header 'Content-Type: application/json' \
--data-raw '{
"reportSpec": {
"path": [
"master",
"666"
],
"executorInfo": {
"buildName": "#666"
}
},
"results": [
"1037f8be-68fb-4756-98b6-779637aa4670"
],
"deleteResults": false
}'
Response:
{
"path": "master/666",
"url": "http://localhost:8080/allure/reports/master/666/index.html"
}
Memorize url
After generating you can access the report byhttp://localhost:8080/allure/reports/master/666/index.html
You may get all reports
curl --location --request GET 'http://localhost:8080/api/report'
Or by path as branch name master
curl --location --request GET 'http://localhost:8080/api/report?path=master'
You may get all uploaded results:
curl --location --request GET 'http://localhost:8080/api/result'
Clear results or reports:
curl --location --request DELETE 'http://localhost:8080/api/result'
curl --location --request DELETE 'http://localhost:8080/api/report'