Skip to content
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-issues#1605] DMN JIT Executor successfully executing invalid DMN #2142

Merged
merged 10 commits into from
Nov 15, 2024

Conversation

AthiraHari77
Copy link
Contributor

Fixes apache/incubator-kie-issues#1605

Needs apache/incubator-kie-drools#6146

In this PR, DMN evaluation errors are detected and propagated by throwing an exception upon identification.
In the event of an exception, a valid status is returned to reflect the error state accurately.

How to replicate CI configuration locally?

Build Chain tool does "simple" maven build(s), the builds are just Maven commands, but because the repositories relates and depends on each other and any change in API or class method could affect several of those repositories there is a need to use build-chain tool to handle cross repository builds and be sure that we always use latest version of the code for each repository.

build-chain tool is a build tool which can be used on command line locally or in Github Actions workflow(s), in case you need to change multiple repositories and send multiple dependent pull requests related with a change you can easily reproduce the same build by executing it on Github hosted environment or locally in your development environment. See local execution details to get more information about it.

How to retest this PR or trigger a specific build:
  • for pull request checks
    Please add comment: Jenkins retest this

  • for a specific pull request check
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] tests

  • for quarkus branch checks
    Run checks against Quarkus current used branch
    Please add comment: Jenkins run quarkus-branch

  • for a quarkus branch specific check
    Run checks against Quarkus current used branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] quarkus-branch

  • for quarkus main checks
    Run checks against Quarkus main branch
    Please add comment: Jenkins run quarkus-main

  • for a specific quarkus main check
    Run checks against Quarkus main branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] quarkus-main

  • for quarkus lts checks
    Run checks against Quarkus lts branch
    Please add comment: Jenkins run quarkus-lts

  • for a specific quarkus lts check
    Run checks against Quarkus lts branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] quarkus-lts

  • for native checks
    Run native checks
    Please add comment: Jenkins run native

  • for a specific native check
    Run native checks
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] native

  • for native lts checks
    Run native checks against quarkus lts branch
    Please add comment: Jenkins run native-lts

  • for a specific native lts check
    Run native checks against quarkus lts branch
    Please add comment: Jenkins (re)run [kogito-apps|kogito-examples] native-lts

How to backport a pull request to a different branch?

In order to automatically create a backporting pull request please add one or more labels having the following format backport-<branch-name>, where <branch-name> is the name of the branch where the pull request must be backported to (e.g., backport-7.67.x to backport the original PR to the 7.67.x branch).

NOTE: backporting is an action aiming to move a change (usually a commit) from a branch (usually the main one) to another one, which is generally referring to a still maintained release branch. Keeping it simple: it is about to move a specific change or a set of them from one branch to another.

Once the original pull request is successfully merged, the automated action will create one backporting pull request per each label (with the previous format) that has been added.

If something goes wrong, the author will be notified and at this point a manual backporting is needed.

NOTE: this automated backporting is triggered whenever a pull request on main branch is labeled or closed, but both conditions must be satisfied to get the new PR created.

Quarkus-3 PR check is failing ... what to do ? The Quarkus 3 check is applying patches from the `.ci/environments/quarkus-3/patches`.

The first patch, called 0001_before_sh.patch, is generated from Openrewrite .ci/environments/quarkus-3/quarkus3.yml recipe. The patch is created to speed up the check. But it may be that some changes in the PR broke this patch.
No panic, there is an easy way to regenerate it. You just need to comment on the PR:

jenkins rewrite quarkus-3

and it should, after some minutes (~20/30min) apply a commit on the PR with the patch regenerated.

Other patches were generated manually. If any of it fails, you will need to manually update it... and push your changes.

athira added 2 commits November 6, 2024 21:16
…1605

# Conflicts:
#	jitexecutor/jitexecutor-dmn/src/main/java/org/kie/kogito/jitexecutor/dmn/DMNEvaluator.java
@kie-ci3
Copy link
Contributor

kie-ci3 commented Nov 8, 2024

PR job #2 was: UNSTABLE
Possible explanation: This should be test failures

Reproducer

build-chain build full_downstream -f 'https://raw.githubusercontent.com/${AUTHOR:apache}/incubator-kie-kogito-pipelines/${BRANCH:main}/.ci/buildchain-config-pr-cdb.yaml' -o 'bc' -p apache/incubator-kie-kogito-apps -u #2142 --skipParallelCheckout

NOTE: To install the build-chain tool, please refer to https://github.com/kiegroup/github-action-build-chain#local-execution

Please look here: https://ci-builds.apache.org/job/KIE/job/kogito/job/main/job/pullrequest_jobs/job/kogito-apps-pr/job/PR-2142/2/display/redirect

Test results:

  • PASSED: 1695
  • FAILED: 1

Those are the test failures:

org.kie.kogito.jobs.embedded.EmbeddedJobsServiceTest.testJobService java.util.ConcurrentModificationException
at java.base/java.util.ArrayList.forEach(ArrayList.java:1513)
at java.base/java.util.Collections$UnmodifiableCollection.forEach(Collections.java:1092)
at org.kie.kogito.jobs.embedded.EmbeddedJobsServiceTest.testJobService(EmbeddedJobsServiceTest.java:99)
at java.base/java.lang.reflect.Method.invoke(Method.java:568)
at io.quarkus.test.junit.QuarkusTestExtension.runExtensionMethod(QuarkusTestExtension.java:1013)
at io.quarkus.test.junit.QuarkusTestExtension.interceptTestMethod(QuarkusTestExtension.java:827)
at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

@AthiraHari77 AthiraHari77 marked this pull request as ready for review November 12, 2024 10:46
Copy link
Contributor

@gitgabrio gitgabrio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

HI @AthiraHari77 - many thanks for you PR!
I've just some doubts about it

@Test
public void testManageResponseWithSuccess() {
Supplier<Response> responseSupplier = () -> Response.ok("Success").build();
Response response = DMNResourceHelper.manageResponse(responseSupplier);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @AthiraHari77
many thanks for the PR!
Could you please implement the auto-closeable try-with-resources here ?

public void testManageResponseWithFailure() {
Supplier<Response> responseSupplier = mock(Supplier.class);
when(responseSupplier.get()).thenThrow(new IllegalStateException("Error : Failed to validate"));
Response response = DMNResourceHelper.manageResponse(responseSupplier);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above (try-with resources)

@Test
void testFromXMLSuccessModel() {
String modelXML = model;
when(dmnRuntime.getModels()).thenReturn(Collections.singletonList(dmnModel));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the need of this mocked
when(dmnRuntime.getModels()).thenReturn(Collections.singletonList(dmnModel)); ? 🤔

public static void setup() throws IOException {
model = getModelFromIoUtils("invalid_models/DMNv1_x/test.dmn");
invalidModel = getModelFromIoUtils("invalid_models/DMNv1_5/DMN-Invalid.dmn");
dmnRuntime = mock(DMNRuntime.class);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the need of those mocked instances ? 🤔

@Test
public void testFromXMLModelWithError() {
String modelXML = invalidModel;
when(dmnRuntime.getModels()).thenReturn(Collections.singletonList(dmnModel));
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above

Copy link
Contributor

@yesamer yesamer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this PR @AthiraHari77 . I think this change will enforce the error management of the JIT executor and that is great.

My comments:

  • Why JITDMNResource.jitdmn(..) method doesn't manage the Response as you did in jitdmnResult and jitEvaluateAndExplain?
  • Same question for SchemaResource endpoints: why some of them are not managed?

@AthiraHari77
Copy link
Contributor Author

I have fixed the review comments and pushed the changes.
@yesamer I have introduced changes in the fromXML method in DMNEvaluator to identify the errors and manage exceptions. Hence we are managing the response only in places where the fromXML method is invoked.

@yesamer
Copy link
Contributor

yesamer commented Nov 13, 2024

Thank you @AthiraHari77 for your reply.
I checked and I noticed that JITDMNResource.jitdmn(..) indirectly calls fromXML() method via jitdmnService.evaluateModel(), so I would consider wrapping that endpoint as well to have a consistent behavior over all endpoints.
About the endpoints in SchemaResource, I agree that those don't call fromXML() method, but I would argue that some exceptions may be thrown during the execution, so it would be nice to have the same Response management.
WDTY? :)

Copy link
Contributor

@yesamer yesamer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @AthiraHari77, excellent job!

@kie-ci3
Copy link
Contributor

kie-ci3 commented Nov 13, 2024

PR job #7 was: UNSTABLE
Possible explanation: This should be test failures

Reproducer

build-chain build full_downstream -f 'https://raw.githubusercontent.com/${AUTHOR:apache}/incubator-kie-kogito-pipelines/${BRANCH:main}/.ci/buildchain-config-pr-cdb.yaml' -o 'bc' -p apache/incubator-kie-kogito-apps -u #2142 --skipParallelCheckout

NOTE: To install the build-chain tool, please refer to https://github.com/kiegroup/github-action-build-chain#local-execution

Please look here: https://ci-builds.apache.org/job/KIE/job/kogito/job/main/job/pullrequest_jobs/job/kogito-apps-pr/job/PR-2142/7/display/redirect

Test results:

  • PASSED: 1765
  • FAILED: 1

Those are the test failures:

org.kie.kogito.index.ProcessDataIndexMongoDBIT.testProcessInstanceEvents 1 expectation failed.
JSON path data.UserTaskInstances[0].potentialGroups[0] doesn't match.
Expected: managers
Actual: null

Copy link
Contributor

@gitgabrio gitgabrio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @AthiraHari77 !!! LGTM

@yesamer
Copy link
Contributor

yesamer commented Nov 15, 2024

@gitgabrio Can we merge it?

@gitgabrio gitgabrio merged commit 18776c5 into apache:main Nov 15, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DMN JIT Executor successfully executing invalid DMN
4 participants