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.

Sign up for GitHub

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

Jump to bottom

Issue/1175/improve open api final 2 #1224

Open
wants to merge 32 commits into
base: main
Choose a base branch
from
Open

Issue/1175/improve open api final 2 #1224

wants to merge 32 commits into from

Conversation

tschlat
Copy link
Collaborator

@tschlat tschlat commented Oct 5, 2024 •
edited
Loading

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:

  1. 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
  1. 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
  1. 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

This was referenced Oct 5, 2024
Closed
Closed
Closed
@tschlat 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
@bbortt 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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
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
@bbortt
chore(citrus-test-api-core): review and code cleanup
f638d79 
pr: #1224

`citrus-test-api-core` module.
@bbortt 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 added a commit that referenced this pull request Oct 28, 2024
@bbortt
chore(citrus-openapi): review and code cleanup
e8afc7b 
pr: #1224

`citrus-openapi` module.
Thorsten Schlathoelter and others added 27 commits October 29, 2024 08:53
@bbortt
feat(#1175): improve random data generation for test data generator
5e266eb
@bbortt
feat(#1175): added random generator framework
72d0f69 
Framework was added in favour of OpenApiTestDataGenerator implementation
@bbortt
feat(#1156): provide test api generator
ce3f6dc
@bbortt
chore: remove author annotations
843c39b
@bbortt
chore: add license to new files
499d433
@bbortt
chore: cleanup generator tests
da34aab
@bbortt
chore: improve OpenApi example
4f5f8f4
@bbortt
ci: connect openapi generator to maven reactor
ba680a7
@bbortt
feat(#1156): generate Java models alongside citrus classes
59c5978
@bbortt
new api generation
2ac6e82
@bbortt
feat(#1175): adds open api validation by standard citrus schema valid…
7e59c29 
…aton mechanism
@bbortt
feat: improve open api generator
39406f8 
- support java dsl
- streamline implementation with standard citrus builder pattern
- support open api parameter serialization
@bbortt
fix: pom structure
964566c
@bbortt
chore(citrus-openapi): review and code cleanup
8b78af4 
pr: #1224

`citrus-openapi` module.
@bbortt
chore(citrus-api): review and code cleanup
0962d45 
pr: #1224

`citrus-api` module.
@bbortt
chore(citrus-base): review and code cleanup
369d41b 
pr: #1224

citrus-base` module.
@bbortt
chore(citrus-spring): review and code cleanup
9e12d8e 
pr: #1224

`citrus-spring` module.
@bbortt
chore(citrus-http): review and code cleanup
e5ad217 
pr: #1224

`citrus-http` module.
@bbortt
chore(citrus-jms): review and code cleanup
01d234a 
pr: #1224

`citrus-jms` module.
@bbortt
chore(citrus-rmi): review and code cleanup
1b73b1b 
pr: #1224

`citrus-rmi` module.
@bbortt
docs(#1175): review
0be7a60
@bbortt
chore(citrus-test-api-core): review and code cleanup
50491b5 
pr: #1224

`citrus-test-api-core` module.
@bbortt
chore(citrus-test-api-generator-core): review and code cleanup
f8ab5a3 
pr: #1224

`citrus-test-api-generator-core` module.
@bbortt
chore(citrus-test-api-generator-maven-plugin): review and code cleanup
edc4d04 
pr: #1224

`citrus-test-api-generator-maven-plugin` module.
@bbortt
chore(citrus-test-api-spring): review and code cleanup
5d5d518 
pr: #1224

`citrus-test-api-spring` module.
@bbortt
chore(citrus-validation): review and code cleanup
1df0c70 
pr: #1224

`citrus-validation` module and sub-modules.
@bbortt
ci: fix citrus java codegen test with root folder
e946c4c
@bbortt bbortt force-pushed the issue/1175/improve_open_api_final_2 branch from 435dc94 to e946c4c Compare October 29, 2024 07:56
@bbortt
Copy link
Collaborator

bbortt commented Oct 29, 2024

found the last ci/cd bug. it was actually a case-sensitivity problem, which didn't occur on windows. we should expect to see a green build.

@tschlat
Copy link
Collaborator Author

tschlat commented Oct 30, 2024

@ueberfuhr - as a user of the current OpenAPI feature, i would be interested in your feedback on this new feature. Especially in the context of OAS validation, which might be breaking, once we merge this MR (see MR description for details). I advise to check this class that tests all aspects of the generated API.

org.citrusframework.openapi.generator.GeneratedRestApiIT

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbortt bbortt bbortt requested changes

@christophd christophd Awaiting requested review from christophd

Assignees

@tschlat tschlat

Labels
Prio: High State: Review If pull-request has been opened an is ready/in review State: To discuss In case there are open questions concerning the issue Type: Feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tschlat @bbortt