docs: add documentation for gradle tasks

Author: Adela

build.gradle

@@ -241,15 +241,15 @@ tasks.withType(Test).configureEach {
     }
 }
 
-task unitTest(type: Test) {
+task unitTest(type: Test, group: 'verification') {
     useJUnitPlatform { excludeTags 'longRunningTest' }
 
     def unitTestTimeout = project.hasProperty('unitTestTimeout') ? project.getProperty('unitTestTimeout') : '5s'
     systemProperty 'junit.jupiter.execution.timeout.lifecycle.method.default', unitTestTimeout
     systemProperty 'junit.jupiter.execution.timeout.testable.method.default', unitTestTimeout
 }
 
-task longRunningTest(type: Test) {
+task longRunningTest(type: Test, group: 'verification') {
     useJUnitPlatform { includeTags 'longRunningTest' }
 
     def longRunningTestTimeout = project.hasProperty('longRunningTestTimeout') ? project.getProperty('longRunningTestTimeout') : '30s'

docs/development/gradle.md

@@ -0,0 +1,45 @@
+# Gradle Tasks
+
+## Content
+
+- [Gradle Tasks](#Gradle-Tasks)
+    - [Content](#Content)
+    - [Purpose](#Purpose)
+    - [Gradle Build Tasks](#Gradle Build Tasks)
+    - [Gradle Docker Tasks](#Gradle-Docker-Tasks)
+    - [Gradle Documentation Tasks](#Gradle-Documentation-Tasks)
+    - [Gradle Release Tasks](#Gradle-Release-Tasks)
+    - [Gradle Verification Tasks](#Gradle-Verification-Tasks)
+
+## Purpose
+
+This document describes the custom gradle tasks and their particularities used for the automation of the repetitive tasks in NeonBee.
+
+## Gradle Build Tasks
+The Gradle **build** task is responsible for building the project, including running all tests, producing the production artifacts. In our project, the build task is overriden by a custom build task and it requires the following tasks to be executed:
+  - **coreJar** - builds and packages NeonBee as a *neonbee-core.jar* and places it into the build folder. This jar does not contain any dependent jars
+  - **distTar** - builds and packages a NeonBee dist .tar.gz archive including folder structure, start scripts etc. into the build folder
+  - **javadocJar** - builds the jar for the Javadoc
+  - **shadowJar** - builds a fat/uber jar. The shadowDistZip and shadowDistTar tasks are removed to ensure that our own (standard) dist jar build is used.
+  - **sourcesJar** - builds the *neonbee-core-sources.jar*, containing only the source code
+  - **testJar** - creates the *neonbee-core-test.jar* of all the test binaries
+  - **testJavadocJar** - builds the jar for the test Javadoc
+  - **testSourcesJar** - builds the test source jar, *neonbee-core-test-sources.jar*
+
+## Gradle Docker Tasks
+- docker - builds the docker image based on the defined configuration
+
+## Gradle Documentation Tasks
+- javadoc - generates HTML API documentation for Java classes
+
+## Gradle Release Tasks
+- changelog - generates the changelog containing all the commit messages
+- release - requires a project parameter, *-PnextVersion=<nextVersion>* and updates the NeonBee version in *build.gradle* to *nextVersion*, as well as the *Changelog*. The task creates a commit with the changed files for release.
+
+## Gradle Verification Tasks
+- **jacocoTestReport** - provides code coverage report for the project. The task requires the tests to run before generating the report. When the test task executes the `unitTest` and `longRunningTest` tasks, the jacocoTestReport task will read both of the two `*.exec` files as input
+- **longRunningTest** - executes the JUnit tests which require more than 5s to run. These tests are identified by applying the `@Tag('longRunningTest)` annotation at the class-level or at the test-level. The task extends the standard test task by providing, a global timeout of 30s for the tests identified as 'long running'. To override the default timeout of 30s to *timeout*, the task can be executed with `-PlongRunningTestTimeout=<timeout>`
+- **sonarqube** - runs SonarQube analysis. The task requires some global properties to be configured, like the sonar server and the absolute paths of the JaCoCo and JUnit reports
+- **test** - executes all the JUnit tests. The task accepts a project parameter, *-PtestPlan=<default/withGlobalTimeout>*. If the task is called without a parameter, the 'default' test plan is chosen and all the tests run with a timeout of 30s. If it is called with `-PtestPlan=withGlobalTimeout`, the task is calling the tasks `unitTest` and `longRunningUnitTest`, which allow modifying the global timeout for each of these tasks by using `-PlongRunningTestTimeout=<timeout>` and/or  `-PunitTestTimeout=<timeout>`
+- **unitTest** - executes the JUnit tests which do not require more than 5s to execute. The task extends the standard test task by providing, a global timeout of 5s for the JUnit tests and excludes the tests marked as 'long running'. To override the 5s timeout to *timeout*, the task can be executed with `-PunitTestTimeout=<timeout>`.
+- **violations** - parses report files from static code analysis and fails the build depending on the violations found, like failed JUnit tests, PMD violations, "bug patterns" identified by SpotBugs