Skip to content

Parameter validation: error source #31

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

Merged
merged 1 commit into from
Feb 9, 2024
Merged

Parameter validation: error source #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions src/main/java/com/apiflows/parser/OpenAPIWorkflowValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ List<String> validateStep(Step step, String workflowId ) {

if(step.getParameters() != null) {
for(Parameter parameter : step.getParameters()) {
errors.addAll(validateParameter(parameter, workflowId));
errors.addAll(validateParameter(parameter, workflowId, null));

if(step.getWorkflowId() != null) {
// when the step in context specifies a workflowId the parameter IN must be defined
Expand Down Expand Up @@ -208,9 +208,18 @@ List<String> validateStep(Step step, String workflowId ) {
return errors;
}

List<String> validateParameter(Parameter parameter, String workflowId ) {
List<String> validateParameter(Parameter parameter, String workflowId, String componentName ) {
List<String> SUPPORTED_VALUES = Arrays.asList("path", "query", "header", "cookie", "body", "workflow");

String source;

if(workflowId != null) {
source = "Workflow[" + workflowId + "]";
} else {
source = "Component[" + componentName + "]";

}

List<String> errors = new ArrayList<>();

if(parameter.get$ref() != null) {
Expand All @@ -221,27 +230,27 @@ List<String> validateParameter(Parameter parameter, String workflowId ) {
String name = parameter.getName();

if(name == null) {
errors.add("'Workflow[" + workflowId + "]' parameter has no name");
errors.add(source + " parameter has no name");
}
if(parameter.getIn() != null) {
if(!SUPPORTED_VALUES.contains(parameter.getIn())) {
if(name != null) {
errors.add("Parameter '" + name + "' type (" + parameter.getIn() + ") is invalid");
errors.add(source + "parameter " + name + " type (" + parameter.getIn() + ") is invalid");
} else {
errors.add("'Workflow[" + workflowId + "]' parameter type (" + parameter.getIn() + ") is invalid");
errors.add(source + " parameter type (" + parameter.getIn() + ") is invalid");
}
}
}
if(parameter.getValue() == null) {
if(name != null) {
errors.add("Parameter '" + name + "' has no value");
errors.add(source + " parameter " + name + " has no value");
} else {
errors.add("'Workflow[" + workflowId + "]' parameter has no value");
errors.add(source + " parameter has no value");
}
}
if(parameter.getTarget() != null) {
if(!isValidJsonPointer(parameter.getTarget())) {
errors.add("Parameter '" + name + "' target is not a valid Json Pointer");
errors.add(source + " parameter " + name + " target is not a valid Json Pointer");
}
}
}
Expand Down Expand Up @@ -365,9 +374,9 @@ List<String> validateComponents(Components components) {
}
}

for (Parameter parameter : components.getParameters().values()) {
errors.addAll(validateParameter(parameter, "Components"));
}
components.getParameters().entrySet().stream()
.forEach(entry -> errors.addAll(validateParameter(entry.getValue(), null, entry.getKey())));

}
if (components.getInputs() != null) {
for(String key : components.getInputs().keySet()) {
Expand Down
14 changes: 7 additions & 7 deletions src/test/java/com/apiflows/parser/OpenAPIWorkflowValidatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ void validateParameter() {
.in("path");
String worklowId = "q1";

assertEquals(0, validator.validateParameter(parameter, worklowId).size());
assertEquals(0, validator.validateParameter(parameter, worklowId, null).size());
}

@Test
Expand All @@ -218,7 +218,7 @@ void validateParameterInvalidIn() {
.in("dummy");
String worklowId = "q1";

assertEquals(1, validator.validateParameter(parameter, worklowId).size());
assertEquals(1, validator.validateParameter(parameter, worklowId, null).size());
}

@Test
Expand All @@ -229,7 +229,7 @@ void validateParameterWithoutValue() {
.in("query");
String worklowId = "q1";

assertEquals(1, validator.validateParameter(parameter, worklowId).size());
assertEquals(1, validator.validateParameter(parameter, worklowId, null).size());
}

@Test
Expand Down Expand Up @@ -502,12 +502,12 @@ void validateComponentsParameterInvalidIn() {
.name("param")
.value("1")
.in("dummy");
String worklowId = "q1";
String componentName = "user";

Components components = new Components();
components.addParameter("param1", parameter);

assertEquals(1, validator.validateParameter(parameter, worklowId).size());
assertEquals(1, validator.validateParameter(parameter, null, componentName).size());
}

@Test
Expand All @@ -516,12 +516,12 @@ void validateComponentsParameter() {
.name("page")
.value("1")
.in("query");
String worklowId = "q1";
String componentName = "user";

Components components = new Components();
components.addParameter("page", parameter);

assertEquals(0, validator.validateParameter(parameter, worklowId).size());
assertEquals(0, validator.validateParameter(parameter, null, componentName).size());
}

@Test
Expand Down