Added tests for isOAS3 in validateParam function.

This commit is contained in:
Owen Conti
2017-10-11 18:34:24 -06:00
parent a0f8f9a05d
commit 7344315c34
5 changed files with 465 additions and 404 deletions

View File

@@ -137,10 +137,13 @@ export function changeParam( path, paramName, paramIn, value, isXml ){
} }
} }
export function validateParams( payload ){ export const validateParams = ( payload, isOAS3 ) =>{
return { return {
type: VALIDATE_PARAMS, type: VALIDATE_PARAMS,
payload:{ pathMethod: payload } payload:{
pathMethod: payload,
isOAS3
}
} }
} }

View File

@@ -51,14 +51,14 @@ export default {
}) })
}, },
[VALIDATE_PARAMS]: ( state, { payload: { pathMethod } } ) => { [VALIDATE_PARAMS]: ( state, { payload: { pathMethod, isOAS3 } } ) => {
let operation = state.getIn( [ "resolved", "paths", ...pathMethod ] ) let operation = state.getIn( [ "resolved", "paths", ...pathMethod ] )
let isXml = /xml/i.test(operation.get("consumes_value")) let isXml = /xml/i.test(operation.get("consumes_value"))
return state.updateIn( [ "resolved", "paths", ...pathMethod, "parameters" ], fromJS([]), parameters => { return state.updateIn( [ "resolved", "paths", ...pathMethod, "parameters" ], fromJS([]), parameters => {
return parameters.withMutations( parameters => { return parameters.withMutations( parameters => {
for ( let i = 0, len = parameters.count(); i < len; i++ ) { for ( let i = 0, len = parameters.count(); i < len; i++ ) {
let errors = validateParam(parameters.get(i), isXml) let errors = validateParam(parameters.get(i), isXml, isOAS3)
parameters.setIn([i, "errors"], fromJS(errors)) parameters.setIn([i, "errors"], fromJS(errors))
} }
}) })

View File

@@ -13,3 +13,7 @@ export const executeRequest = (ori, { specActions }) => (req) => {
specActions.logRequest(req) specActions.logRequest(req)
return ori(req) return ori(req)
} }
export const validateParams = (ori, { specSelectors }) => (req) => {
return ori(req, specSelectors.isOAS3())
}

View File

@@ -537,12 +537,12 @@ export const validateMinLength = (val, min) => {
} }
// validation of parameters before execute // validation of parameters before execute
export const validateParam = (param, isXml) => { export const validateParam = (param, isXml, isOAS3 = false) => {
let errors = [] let errors = []
let value = isXml && param.get("in") === "body" ? param.get("value_xml") : param.get("value") let value = isXml && param.get("in") === "body" ? param.get("value_xml") : param.get("value")
let required = param.get("required") let required = param.get("required")
let paramDetails = param.get("schema") || param let paramDetails = isOAS3 ? param.get("schema") : param
let maximum = paramDetails.get("maximum") let maximum = paramDetails.get("maximum")
let minimum = paramDetails.get("minimum") let minimum = paramDetails.get("minimum")
let type = paramDetails.get("type") let type = paramDetails.get("type")
@@ -618,7 +618,7 @@ export const validateParam = (param, isXml) => {
if ( !value.count() ) { return errors } if ( !value.count() ) { return errors }
itemType = param.getIn(["items", "type"]) itemType = paramDetails.getIn(["items", "type"])
value.forEach((item, index) => { value.forEach((item, index) => {
let err let err

View File

@@ -274,20 +274,73 @@ describe("utils", function() {
}) })
describe("validateParam", function() { describe("validateParam", function() {
describe("OAS3 specs", function() {
let param = null let param = null
let result = null let result = null
it("skips validation when `type` is not specified", function() { it("should check the isOAS3 flag when validating parameters", function() {
// invalid type // This should "skip" validation because there is no `schema.type` property
// and we are telling `validateParam` this is an OAS3 spec
param = fromJS({ param = fromJS({
required: false, value: "",
type: undefined, required: true,
value: "" schema: {
notTheTypeProperty: "string"
}
}) })
result = validateParam( param, false ) result = validateParam( param, false, true )
expect( result ).toEqual( [] ) expect( result ).toEqual( [] )
}) })
// Test a couple examples of validateParam()
it("validates required strings", function() {
// invalid string
param = fromJS({
value: "",
required: true,
schema: {
type: "string"
}
})
result = validateParam( param, false, true )
expect( result ).toEqual( ["Required field is not provided"] )
})
it("validates required arrays", function() {
// invalid array, items do not match correct type
param = fromJS({
required: true,
value: [1],
schema: {
type: "array",
items: {
type: "string"
}
}
})
result = validateParam( param, false, true )
expect( result ).toEqual( [{index: 0, error: "Value must be a string"}] )
})
it("validates required numbers", function() {
// invalid number, string instead of a number
param = fromJS({
required: true,
value: "test",
schema: {
type: "number"
}
})
result = validateParam( param, false, true )
expect( result ).toEqual( ["Required field is not provided"] )
})
})
describe("Swagger 2.0 specs", function() {
let param = null
let result = null
it("validates required strings", function() { it("validates required strings", function() {
// invalid string // invalid string
param = fromJS({ param = fromJS({
@@ -734,6 +787,7 @@ describe("utils", function() {
expect( result ).toEqual( [] ) expect( result ).toEqual( [] )
}) })
}) })
})
describe("fromJSOrdered", () => { describe("fromJSOrdered", () => {
it("should create an OrderedMap from an object", () => { it("should create an OrderedMap from an object", () => {