Issue/1175/improve open api final 2 #1224

tschlat · 2024-10-05T17:43:05Z

This is the final PR for the new OpenAPI feature.

I apologize for the large size of this PR. It includes the following major changes:

Updates to the OpenAPI Connector:

Improved test coverage.
Replaced validation using "Citrus Control Message" with OAS schema validation based on the Atlassian OpenAPI Validator framework. (This is quite a drastical change and I would appreciate Christophs Feedback on this). I am pretty sure that this is breaking, as the OpenAPI Validator might be stricter than the previous implementation.
Enhanced random message generation capabilities and test coverage

Revised Implementation of TestAPI Generator:

Now uses the Citrus Builder Pattern.
Added extensive tests to verify the generated test API against various aspects of OpenAPI.
Introduced multipartmessage support.
Included support for all different types of parameter serialization.
Added an initial implementation of a SOAP Test API generator. While the benefits of this API are somewhat limited, it becomes useful when OpenAPI and SOAP are used together, as both service types can now be handled in a consistent way. Note: the SOAP Test API is in an early stage, with basic functionality and limited testing.
org.citrusframework.openapi.generator.GeneratedRestApiIT gives an overview on how to use the generated REST API
org.citrusframework.openapi.generator.GeneratedSoapApiIT same for SOAP although only very little, yet

Enhanced Server-Side Header Validation for Parameter Serialization:

Improved header validation to support arrays of parameters, particularly focusing on different aspects of array-type parameter serialization.
see org.citrusframework.http.message.HttpQueryParamHeaderValidator for details

pr: #1224 `citrus-openapi` module.

pr: #1224 `citrus-api` module.

pr: #1224 `citrus-openapi` module.

pr: #1224 `citrus-api` module.

pr: #1224 citrus-base` module.

pr: #1224 `citrus-spring` module.

pr: #1224 `citrus-http` module.

pr: #1224 `citrus-jms` module.

pr: #1224 `citrus-rmi` module.

pr: #1224 `citrus-http` module.

pr: #1224 `citrus-jms` module.

pr: #1224 `citrus-rmi` module.

pr: #1224 `citrus-test-api-core` module.

pr: #1224 `citrus-openapi` module.

…aton mechanism

- support java dsl - streamline implementation with standard citrus builder pattern - support open api parameter serialization

pr: #1224 `citrus-openapi` module.

pr: #1224 `citrus-api` module.

pr: #1224 citrus-base` module.

pr: #1224 `citrus-spring` module.

pr: #1224 `citrus-http` module.

pr: #1224 `citrus-jms` module.

pr: #1224 `citrus-rmi` module.

pr: #1224 `citrus-test-api-core` module.

pr: #1224 `citrus-test-api-generator-core` module.

pr: #1224 `citrus-test-api-generator-maven-plugin` module.

pr: #1224 `citrus-test-api-spring` module.

pr: #1224 `citrus-validation` module and sub-modules.

bbortt

I've rebased this PR onto origin/main.

/lgtm

need to talk to @christophd about merging-strategies.

bbortt · 2024-12-09T13:35:04Z

endpoints/citrus-camel/src/test/java/org/citrusframework/camel/integration/CamelJBangIT.java

+        }
+
+        if (!TestUtils.isNetworkReachable()) {
+            throw new SkipException("Test skipped because network is not reachable. We are probably running behind a proxy and JBang download is not possible.");


removed this duplicate check.

bbortt · 2024-12-09T13:36:33Z

test-api-generator/citrus-test-api-generator-core/pom.xml

@@ -284,6 +282,26 @@
                            </configOptions>
                        </configuration>
                    </execution>
+<!--                    <execution>-->


I've removed this.

...ints/citrus-http/src/main/java/org/citrusframework/http/client/HttpResponseErrorHandler.java

This was referenced Oct 5, 2024

feat(#1175): adds open api validation by standard citrus schema valid… #1193

Closed

fix(#1175): OpenAPI connector enhancements for simulator random messa… #1177

Closed

feat(#1156): provide test api generator #1160

Closed

tschlat force-pushed the issue/1175/improve_open_api_final_2 branch 2 times, most recently from 31731e3 to 7b85d6a Compare October 5, 2024 17:58

tschlat requested review from bbortt and christophd October 5, 2024 18:07

bbortt force-pushed the issue/1175/improve_open_api_final_2 branch 2 times, most recently from af4b223 to 18ae70b Compare October 21, 2024 14:42

bbortt added a commit that referenced this pull request Oct 23, 2024

chore(citrus-openapi): pr review and code cleanup

c565059

pr: #1224 `citrus-openapi` module.

bbortt added a commit that referenced this pull request Oct 23, 2024

chore(citrus-openapi): pr review and code cleanup

cce754e

pr: #1224 `citrus-openapi` module.

bbortt added a commit that referenced this pull request Oct 23, 2024

chore(citrus-api): review and code cleanup

0e463de

pr: #1224 `citrus-api` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-openapi): review and code cleanup

42ce36a

pr: #1224 `citrus-openapi` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-api): review and code cleanup

0f41890

pr: #1224 `citrus-api` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-base): review and code cleanup

800d702

pr: #1224 citrus-base` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-spring): review and code cleanup

bc1a818

pr: #1224 `citrus-spring` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-spring): review and code cleanup

53d09e0

pr: #1224 `citrus-spring` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-http): review and code cleanup

875c8c4

pr: #1224 `citrus-http` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-jms): review and code cleanup

fa0f5a3

pr: #1224 `citrus-jms` module.

bbortt added a commit that referenced this pull request Oct 24, 2024

chore(citrus-rmi): review and code cleanup

19c13af

pr: #1224 `citrus-rmi` module.

bbortt added a commit that referenced this pull request Oct 26, 2024

chore(citrus-http): review and code cleanup

749aaeb

pr: #1224 `citrus-http` module.

bbortt added a commit that referenced this pull request Oct 26, 2024

chore(citrus-jms): review and code cleanup

601955a

pr: #1224 `citrus-jms` module.

bbortt added a commit that referenced this pull request Oct 26, 2024

chore(citrus-rmi): review and code cleanup

bfa1315

pr: #1224 `citrus-rmi` module.

bbortt added a commit that referenced this pull request Oct 26, 2024

chore(citrus-test-api-core): review and code cleanup

f638d79

pr: #1224 `citrus-test-api-core` module.

bbortt added State: To discuss In case there are open questions concerning the issue Type: Feature Prio: High State: Review If pull-request has been opened an is ready/in review labels Oct 28, 2024

bbortt assigned tschlat Oct 28, 2024

bbortt added a commit that referenced this pull request Oct 28, 2024

chore(citrus-openapi): review and code cleanup

e8afc7b

pr: #1224 `citrus-openapi` module.

Thorsten Schlathoelter and others added 22 commits December 9, 2024 14:18

new api generation

9c38674

feat(#1175): adds open api validation by standard citrus schema valid…

96477ed

…aton mechanism

feat: improve open api generator

99ead8c

- support java dsl - streamline implementation with standard citrus builder pattern - support open api parameter serialization

fix: pom structure

c5e9bb2

chore(citrus-openapi): review and code cleanup

8d0b58c

pr: #1224 `citrus-openapi` module.

chore(citrus-api): review and code cleanup

6ff63ba

pr: #1224 `citrus-api` module.

chore(citrus-base): review and code cleanup

541231f

pr: #1224 citrus-base` module.

chore(citrus-spring): review and code cleanup

e1fa672

pr: #1224 `citrus-spring` module.

chore(citrus-http): review and code cleanup

47d89b2

pr: #1224 `citrus-http` module.

chore(citrus-jms): review and code cleanup

496f074

pr: #1224 `citrus-jms` module.

chore(citrus-rmi): review and code cleanup

813b407

pr: #1224 `citrus-rmi` module.

docs(#1175): review

51b2d25

chore(citrus-test-api-core): review and code cleanup

ba6fa33

pr: #1224 `citrus-test-api-core` module.

chore(citrus-test-api-generator-core): review and code cleanup

15b5f9b

pr: #1224 `citrus-test-api-generator-core` module.

chore(citrus-test-api-generator-maven-plugin): review and code cleanup

7c98a84

pr: #1224 `citrus-test-api-generator-maven-plugin` module.

chore(citrus-test-api-spring): review and code cleanup

4856c9b

pr: #1224 `citrus-test-api-spring` module.

chore(citrus-validation): review and code cleanup

9e1f8ad

pr: #1224 `citrus-validation` module and sub-modules.

ci: fix citrus java codegen test with root folder

0b9cf12

feat: changes on open api feature due to first beta tests

40db0f9

chore: bump maven reactor to 4.5.0-SNAPSHOT

4952226

feat: changes on open api feature due to first beta tests

bb1c5d5

feat: changes on open api feature due to first beta tests

6619f23

bbortt force-pushed the issue/1175/improve_open_api_final_2 branch from d275274 to 6619f23 Compare December 9, 2024 13:37

bbortt reviewed Dec 9, 2024

View reviewed changes

bbortt and others added 4 commits December 10, 2024 08:37

chore(deps): remove duplicate spring.version declaration

bae7bfc

feat: add option to specify OpenApiValidationPolicy

1c29c58

chore: fix test errors

5458925

fix: throwsException strategy throws stack overflow exception

1a20729

tschlat commented Dec 12, 2024

View reviewed changes

...ints/citrus-http/src/main/java/org/citrusframework/http/client/HttpResponseErrorHandler.java Show resolved Hide resolved

fix: accept only json and plain text for random message generation

f5282b1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue/1175/improve open api final 2 #1224

Issue/1175/improve open api final 2 #1224

tschlat commented Oct 5, 2024 •

edited

Loading

bbortt left a comment •

edited

Loading

bbortt Dec 9, 2024

bbortt Dec 9, 2024

Issue/1175/improve open api final 2 #1224

Are you sure you want to change the base?

Issue/1175/improve open api final 2 #1224

Conversation

tschlat commented Oct 5, 2024 • edited Loading

bbortt left a comment • edited Loading

Choose a reason for hiding this comment

bbortt Dec 9, 2024

Choose a reason for hiding this comment

bbortt Dec 9, 2024

Choose a reason for hiding this comment

tschlat commented Oct 5, 2024 •

edited

Loading

bbortt left a comment •

edited

Loading