-
Notifications
You must be signed in to change notification settings - Fork 382
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[incubator-kie-kogito-runtimes#2608] Testing multiple DMNs, importing dmn #1888
Merged
gitgabrio
merged 7 commits into
apache:main
from
gitgabrio:incubator-kie-kogito-runtimes#2608
Mar 8, 2024
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
b68fafe
[incubator-kie-kogito-runtimes#2608] Testing multiple DMNs, importing…
8cba0fb
[incubator-kie-kogito-runtimes#2608] Restored dmn-quarkus-example. Cr…
ca93360
[incubator-kie-kogito-runtimes#2608] Restored dmn-quarkus-example. Cr…
16b67dc
[incubator-kie-kogito-runtimes#2608] Removed commented block
36b7238
Merge remote-tracking branch 'origin/main' into incubator-kie-kogito-…
20df190
[incubator-kie-kogito-runtimes#2608] Fixed as per PR suggestion
7e4998a
Merge remote-tracking branch 'origin/main' into incubator-kie-kogito-…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
171 changes: 171 additions & 0 deletions
171
kogito-quarkus-examples/dmn-multiple-models-quarkus-example/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
# DMN + Quarkus example with multiple models | ||
|
||
## Description | ||
|
||
A simple DMN service to evaluate different models (traffic violation, habitability) with also importing feature (traffic violation). | ||
|
||
Demonstrates DMN on Kogito capabilities, including REST interface code generation. | ||
|
||
## Installing and Running | ||
|
||
### Prerequisites | ||
|
||
You will need: | ||
- Java 11+ installed | ||
- Environment variable JAVA_HOME set accordingly | ||
- Maven 3.8.6+ installed | ||
|
||
When using native image compilation, you will also need: | ||
- [GraalVM 19.3.1](https://github.com/oracle/graal/releases/tag/vm-19.3.1) installed | ||
- Environment variable GRAALVM_HOME set accordingly | ||
- Note that GraalVM native image compilation typically requires other packages (glibc-devel, zlib-devel and gcc) to be installed too. You also need 'native-image' installed in GraalVM (using 'gu install native-image'). Please refer to [GraalVM installation documentation](https://www.graalvm.org/docs/reference-manual/aot-compilation/#prerequisites) for more details. | ||
|
||
### Compile and Run in Local Dev Mode | ||
|
||
``` | ||
mvn clean compile quarkus:dev | ||
``` | ||
|
||
### Package and Run in JVM mode | ||
|
||
``` | ||
mvn clean package | ||
java -jar target/quarkus-app/quarkus-run.jar | ||
``` | ||
|
||
or on Windows | ||
|
||
``` | ||
mvn clean package | ||
java -jar target\quarkus-app\quarkus-run.jar | ||
``` | ||
|
||
### Package and Run using Local Native Image | ||
Note that this requires GRAALVM_HOME to point to a valid GraalVM installation | ||
|
||
``` | ||
mvn clean package -Pnative | ||
``` | ||
|
||
To run the generated native executable, generated in `target/`, execute | ||
|
||
``` | ||
./target/dmn-multiple-models-quarkus-example-runner | ||
``` | ||
|
||
Note: This does not yet work on Windows, GraalVM and Quarkus should be rolling out support for Windows soon. | ||
|
||
## OpenAPI (Swagger) documentation | ||
[Specification at swagger.io](https://swagger.io/docs/specification/about/) | ||
|
||
You can take a look at the [OpenAPI definition](http://localhost:8080/openapi?format=json) - automatically generated and included in this service - to determine all available operations exposed by this service. For easy readability you can visualize the OpenAPI definition file using a UI tool like for example available [Swagger UI](https://editor.swagger.io). | ||
|
||
In addition, various clients to interact with this service can be easily generated using this OpenAPI definition. | ||
|
||
When running in either Quarkus Development or Native mode, we also leverage the [Quarkus OpenAPI extension](https://quarkus.io/guides/openapi-swaggerui#use-swagger-ui-for-development) that exposes [Swagger UI](http://localhost:8080/swagger-ui/) that you can use to look at available REST endpoints and send test requests. | ||
|
||
## Test DMN Model using Maven | ||
|
||
Validate the functionality of DMN models before deploying them into a production environment by defining test scenarios in Test Scenario Editor. | ||
|
||
To define test scenarios you need to create a .scesim file inside your project and link it to the DMN model you want to be tested. Run all Test Scenarios, executing: | ||
|
||
```sh | ||
mvn clean test | ||
``` | ||
See results in surefire test report `target/surefire-reports` | ||
|
||
## Example Usage | ||
|
||
Once the service is up and running, you can use the following example to interact with the service. | ||
|
||
### POST /Traffic Violation | ||
|
||
Returns penalty information from the given inputs -- driver and violation: | ||
|
||
Given inputs: | ||
|
||
```json | ||
{ | ||
"Driver":{"Points":2}, | ||
"Violation":{ | ||
"Type":"speed", | ||
"Actual Speed":120, | ||
"Speed Limit":100 | ||
} | ||
} | ||
``` | ||
|
||
Curl command (using the JSON object above): | ||
|
||
```sh | ||
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{"Driver":{"Points":2},"Violation":{"Type":"speed","Actual Speed":120,"Speed Limit":100}}' http://localhost:8080/Traffic%20Violation | ||
``` | ||
or on Windows: | ||
|
||
```sh | ||
curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -d "{\"Driver\":{\"Points\":2},\"Violation\":{\"Type\":\"speed\",\"Actual Speed\":120,\"Speed Limit\":100}}" http://localhost:8080/Traffic%20Violation | ||
``` | ||
|
||
As response, penalty information is returned. | ||
|
||
Example response: | ||
|
||
```json | ||
{ | ||
"Violation":{ | ||
"Type":"speed", | ||
"Speed Limit":100, | ||
"Actual Speed":120 | ||
}, | ||
"Driver":{ | ||
"Points":2 | ||
}, | ||
"Fine":{ | ||
"Points":3, | ||
"Amount":500 | ||
}, | ||
"Should the driver be suspended?":"No" | ||
} | ||
``` | ||
|
||
The difference from the [dmn-quarkus-example](../dmn-quarkus-example) is that, in the current one, the `Traffic Model` features the import declaration, with definitions coming from the ` Imported Model`. | ||
|
||
### POST /habitability | ||
|
||
Returns habitability information from the given inputs -- oxygen and temperature: | ||
|
||
Given inputs: | ||
|
||
```json | ||
{ | ||
"oxygene": 70, | ||
"temperature": 30 | ||
} | ||
``` | ||
|
||
Curl command (using the JSON object above): | ||
|
||
```sh | ||
curl -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{"oxygene": 70, "temperature": 30}' http://localhost:8080/habitability | ||
``` | ||
or on Windows: | ||
|
||
```sh | ||
curl -X POST -H "Accept: application/json" -H "Content-Type: application/json" -d "{\"oxygene\": 70, \"temperature\": 30}" http://localhost:8080/habitability | ||
``` | ||
|
||
As response, habitability information is returned. | ||
|
||
Example response: | ||
|
||
```json | ||
{ | ||
"oxygene": 70, | ||
"temperature": 30, | ||
"habitability": "somehow doable" | ||
} | ||
``` | ||
|
||
|
||
|
118 changes: 118 additions & 0 deletions
118
kogito-quarkus-examples/dmn-multiple-models-quarkus-example/pom.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<!-- | ||
Licensed to the Apache Software Foundation (ASF) under one | ||
or more contributor license agreements. See the NOTICE file | ||
distributed with this work for additional information | ||
regarding copyright ownership. The ASF licenses this file | ||
to you under the Apache License, Version 2.0 (the | ||
"License"); you may not use this file except in compliance | ||
with the License. You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, | ||
software distributed under the License is distributed on an | ||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
KIND, either express or implied. See the License for the | ||
specific language governing permissions and limitations | ||
under the License. | ||
--> | ||
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
<modelVersion>4.0.0</modelVersion> | ||
<parent> | ||
<groupId>org.kie.kogito.examples</groupId> | ||
<artifactId>kogito-quarkus-examples</artifactId> | ||
<version>999-SNAPSHOT</version> | ||
</parent> | ||
<artifactId>dmn-multiple-models-quarkus-example</artifactId> | ||
<name>Kogito Example :: DMN :: Multiple Models</name> | ||
<properties> | ||
<quarkus-plugin.version>3.2.10.Final</quarkus-plugin.version> | ||
<quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id> | ||
<quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id> | ||
<quarkus.platform.version>3.2.10.Final</quarkus.platform.version> | ||
<kogito.bom.group-id>org.kie.kogito</kogito.bom.group-id> | ||
<kogito.bom.artifact-id>kogito-bom</kogito.bom.artifact-id> | ||
<kogito.bom.version>999-SNAPSHOT</kogito.bom.version> | ||
<version.org.kie.kogito>999-SNAPSHOT</version.org.kie.kogito> | ||
</properties> | ||
<dependencyManagement> | ||
<dependencies> | ||
<dependency> | ||
<groupId>${quarkus.platform.group-id}</groupId> | ||
<artifactId>${quarkus.platform.artifact-id}</artifactId> | ||
<version>${quarkus.platform.version}</version> | ||
<type>pom</type> | ||
<scope>import</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>${kogito.bom.group-id}</groupId> | ||
<artifactId>${kogito.bom.artifact-id}</artifactId> | ||
<version>${kogito.bom.version}</version> | ||
<type>pom</type> | ||
<scope>import</scope> | ||
</dependency> | ||
</dependencies> | ||
</dependencyManagement> | ||
<dependencies> | ||
<dependency> | ||
<groupId>org.drools</groupId> | ||
<artifactId>drools-quarkus-decisions</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-resteasy</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-arc</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-resteasy-jackson</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-smallrye-openapi</artifactId> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-junit5</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.rest-assured</groupId> | ||
<artifactId>rest-assured</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.kie.kogito</groupId> | ||
<artifactId>kogito-scenario-simulation</artifactId> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>io.quarkus</groupId> | ||
<artifactId>quarkus-smallrye-health</artifactId> | ||
</dependency> | ||
</dependencies> | ||
<build> | ||
<finalName>${project.artifactId}</finalName> | ||
<plugins> | ||
<plugin> | ||
<groupId>${quarkus.platform.group-id}</groupId> | ||
<artifactId>quarkus-maven-plugin</artifactId> | ||
<version>${quarkus-plugin.version}</version> | ||
<executions> | ||
<execution> | ||
<goals> | ||
<goal>build</goal> | ||
</goals> | ||
</execution> | ||
</executions> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
</project> |
35 changes: 35 additions & 0 deletions
35
...uarkus-examples/dmn-multiple-models-quarkus-example/src/main/resources/Imported_Model.dmn
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<dmn:definitions xmlns="http://www.trisotech.com/dmn/definitions/_f27bb64b-6fc7-4e1f-9848-11ba35e0df36" | ||
xmlns:dc="http://www.omg.org/spec/DMN/20180521/DC/" | ||
xmlns:di="http://www.omg.org/spec/DMN/20180521/DI/" | ||
xmlns:dmndi="https://www.omg.org/spec/DMN/20230324/DMNDI/" | ||
xmlns:feel="https://www.omg.org/spec/DMN/20230324/FEEL/" | ||
xmlns:dmn="https://www.omg.org/spec/DMN/20230324/MODEL/" | ||
xmlns:tc="http://www.omg.org/spec/DMN/20160719/testcase" | ||
xmlns:xsd="http://www.w3.org/2001/XMLSchema" | ||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
exporter="DMN Modeler" | ||
exporterVersion="6.0.3.201802231629" | ||
id="_f27bb64b-6fc7-4e1f-9848-11ba35e0df36" | ||
name="Imported Model" | ||
namespace="http://www.trisotech.com/dmn/definitions/_f27bb64b-6fc7-4e1f-9848-11ba35e0df36"> | ||
<dmn:extensionElements> | ||
</dmn:extensionElements> | ||
<dmn:itemDefinition id="_63824D3F-9173-446D-A940-6A7F0FA056BB" name="tDriver" isCollection="false"> | ||
<dmn:itemComponent id="_9DAB5DAA-3B44-4F6D-87F2-95125FB2FEE4" name="Name" isCollection="false"> | ||
<dmn:typeRef>string</dmn:typeRef> | ||
</dmn:itemComponent> | ||
<dmn:itemComponent id="_856BA8FA-EF7B-4DF9-A1EE-E28263CE9955" name="Age" isCollection="false"> | ||
<dmn:typeRef>number</dmn:typeRef> | ||
</dmn:itemComponent> | ||
<dmn:itemComponent id="_FDC2CE03-D465-47C2-A311-98944E8CC23F" name="State" isCollection="false"> | ||
<dmn:typeRef>string</dmn:typeRef> | ||
</dmn:itemComponent> | ||
<dmn:itemComponent id="_D6FD34C4-00DC-4C79-B1BF-BBCF6FC9B6D7" name="City" isCollection="false"> | ||
<dmn:typeRef>string</dmn:typeRef> | ||
</dmn:itemComponent> | ||
<dmn:itemComponent id="_7110FE7E-1A38-4C39-B0EB-AEEF06BA37F4" name="Points" isCollection="false"> | ||
<dmn:typeRef>number</dmn:typeRef> | ||
</dmn:itemComponent> | ||
</dmn:itemDefinition> | ||
</dmn:definitions> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@gitgabrio not an issue with your PR, I guess we need to update the JDK and maven versions in all examples considering that now the engines require jdk 17 and maven 3.9.5, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤔
Yes, I think we should update all the readme... maybe another ticket, anyway, to do an atomic change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In my opinion, it can be done in this PR #1885, I already asked if is possible. If not, we can create a new PR