-
Notifications
You must be signed in to change notification settings - Fork 70
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
Added lenientValidation support to REMReM generate #170
Conversation
This PR depends on eiffel-community/eiffel-remrem-semantics#128 where I just posted some comments. I'll hold off the review until that PR progresses. |
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.
even though we declare the default values in the API, it is always prefered to be sent by the users.
Can we add that part in documentation.
Also the CLI is non-backwards compatible if the lv is not provided. so should that be also handled ?
CLI works as backward compatibility. API default values from the user is a separate part issue |
wiki/markdown/usage/generate-cli.md
Outdated
@@ -20,6 +20,8 @@ usage: java -jar | |||
|
|||
-mp,--messaging_protocol name of messaging protocol to be used, e.g. eiffelsemantics | |||
|
|||
-lv,--lenientValidation lenientValidation will perform the only mandatory field validation and non-mandatory validation failures will place in Eiffel message as a new property(remremGenerateFailures) |
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.
only on
wiki/markdown/usage/generate-cli.md
Outdated
@@ -20,6 +20,8 @@ usage: java -jar | |||
|
|||
-mp,--messaging_protocol name of messaging protocol to be used, e.g. eiffelsemantics | |||
|
|||
-lv,--lenientValidation lenientValidation will perform the only mandatory field validation and non-mandatory validation failures will place in Eiffel message as a new property(remremGenerateFailures) |
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 customData
## Lenient Validation | ||
The Lenient validation introduced in REMReM Generate since the version 2.1.0 | ||
|
||
Using the lenient validation user continue the Eiffel generate with non-fatal fields in the message. |
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.
eiffel event generation
[Eiffel REMReM semantics](https://github.com/eiffel-community/eiffel/tree/master/schemas) | ||
for more about mandatory and optional fields. | ||
|
||
The Lenient validation will perform the only mandatory field validation and non-mandatory validation failures will place in Eiffel message as a new property(remremGenerateFailures) |
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.
customData
] | ||
``` | ||
|
||
The lenient validation created new message property with "remremGenerateFailures" |
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.
new element in customData
If no other comments, I will merge the PR. |
Applicable Issues
#171
Description of the Change
Added Lenient Validation support to REMReM Generate, The Lenient Validation will perform the only mandatory field validation and non-mandatory validation failures will place in Eiffel message as a new property(remremGenerateFailures)
Alternate Designs
Benefits
The REMReM generate validation will not fail on non-fetal Eiffel message field issues. This feature is an option to the user, the user can decide the enable/disable the Lenient Validation. By default it is disabled.
Possible Drawbacks
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: @raja-maragani