dqexec

The dqexec component executes the RQA configuration by utilizing state-of-the-art monitoring, load testing, and resilience testing tooling. The specification is received in a generic format and then mapped to the input models of the external analysis tooling. Besides delegating the RQA execution, dqexec is also responsible for choosing the most appropriate analysis tool, repeating tests to reach a certain accuracy, and enriching the tests with tool-specific default values.

A more detailed description of this component's architecture is provided in the arc42 document.

Usage

Docker

• This package is published via a GitHub Workflow to ghcr.io
• docker pull ghcr.io/dqualizer/dqexec

Maven

To setup your maven for using this package, have a look the "Authenticating to GitHub Packages" guide.

In short:

1. Copy the template from the guide to your ~/.m2/settings.xml or %userprofile%\.m2\settings.xml.
2. Replace the repository URL with https://maven.pkg.github.com/dqualizer/dqlang. Do not use uppercase letters here!
3. Create a (classic) personal access token (PAT) with read:packages permissions.
4. Enter your GitHub user name and PAT (as password) for the 'github' server.

Then you can use:

<dependency>
    <groupId>dqualizer</groupId>
    <artifactId>dqlang</artifactId>
    <version>${dqlang.version}</version>
</dependency>

Gradle

The gradle setup is very similar to the maven setup:

1. Create a gradle.properties file in %userprofile%\.gradle\.
2. Create a (classic) personal access token (PAT) with read:packages permissions.
3. Paste the following content into your gradle.properties:

   gprUsername=YOUR_GITHUB_USERNAME
   gprPassword=YOUR_GITHUB_ACCESS_TOKEN
   

4. Paste the following code into your projects build.gradle or build.gradle.kts file:

Groovy:

repositories {
    maven {
        name = 'gpr'
        url = uri("https://maven.pkg.github.com/dqualizer/dqlang")
        credentials(PasswordCredentials)
    }
}

Kotlin:

repositories {
   maven {
       name="gpr"
       url = uri("https://maven.pkg.github.com/dqualizer/dqlang")
       credentials(PasswordCredentials::class)
   }
}

Then you can use dqlang in your gradle dependency declaration:

Groovy:

dependencies {
    implementation("io.github.dqualizer:dqlang:{version}")
}

Kotlin:

dependencies {
    implementation("io.github.dqualizer:dqlang:{version}")
}

How to build

Locally

• Set your credentials gprUsername=YOUR_GITHUB_USERNAME and gprPassword=YOUR_GITHUB_ACCESS_TOKEN in either $GRADLE_USER_HOME/gradle.properties or gradle.properties (be careful not to publish your GitHub Token to Git)
• If you set the credentials build with ./gradlew build -x test
• If you didn't set your credentials build with ./gradlew build -x test -PgprUsername=YOUR_GITHUB_USERNAME -PgprPassword=YOUR_GITHUB_ACCESS_TOKEN

Docker

• docker buildx build --tag ghcr.io/dqualizer/dqexec:latest --build-arg="GITHUB_USER=someUser" --build-arg="GITHUB_TOKEN=someToken" .

Deploy to Packages

• There is a GitHub action set up, that automatically pushes the dqExec image to Github Container Registry

Development

Executing the project requires to configure Gradle according to the instructions in the dqlang documentation.