Skip to content

Commit

Permalink
Merge pull request #184 from RepreZen/task/183
Browse files Browse the repository at this point in the history 
#183 Schema validation doesn't work with YAML Aliases
  • Loading branch information
@tfesenko
tfesenko authored Aug 19, 2016
2 parents 8d92c18 + 177a369 commit ddefe92
Show file tree
Hide file tree
Showing 2 changed files with 215 additions and 70 deletions.
282 changes: 213 additions & 69 deletions com.reprezen.swagedit.tests/src/com/reprezen/swagedit/validation/ValidatorTest.xtend
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import org.eclipse.core.resources.IMarker
import org.junit.Test

import static org.hamcrest.core.IsCollectionContaining.*
import static org.hamcrest.CoreMatchers.*
import static org.junit.Assert.*

class ValidatorTest {
Expand All @@ -26,6 +27,7 @@ class ValidatorTest {

@Test
def shouldNotReturnErrorsIfDocumentIsValid() throws IOException {

// valid document
val content = '''
swagger: '2.0'
Expand All @@ -47,12 +49,13 @@ class ValidatorTest {

@Test
def shouldReturnSingleErrorIfMissingRootProperty() throws IOException {

// missing property paths
val content = '''
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
'''

document.set(content)
Expand All @@ -66,13 +69,14 @@ class ValidatorTest {

@Test
def shouldReturnSingleErrorIfTypeOfPropertyIsIncorrect() throws IOException {

// incorrect value type for property paths
val content = '''
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths: 'Hello'
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths: 'Hello'
'''

document.set(content)
Expand All @@ -86,16 +90,17 @@ class ValidatorTest {

@Test
def shouldReturnSingleErrorIfTypeOfDeepPropertyIsIncorrect() throws IOException {

// invalid responses type
val content = '''
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/:
get:
responses: 'Hello'
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/:
get:
responses: 'Hello'
'''

document.set(content)
Expand All @@ -109,18 +114,19 @@ class ValidatorTest {

@Test
def shouldReturnSingleErrorIfInvalidResponseCode() throws IOException {

// invalid response code
val content = '''
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/:
get:
responses:
'0':
description: OK
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/:
get:
responses:
'0':
description: OK
'''

document.set(content)
Expand All @@ -134,21 +140,22 @@ class ValidatorTest {

@Test
def shouldReturnErrorForInvalidScheme() throws IOException {

// invalid scheme foo
val content = '''
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
schemes:
- http
- foo
paths:
/:
get:
responses:
'200':
description: OK
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
schemes:
- http
- foo
paths:
/:
get:
responses:
'200':
description: OK
'''

document.set(content)
Expand All @@ -162,27 +169,28 @@ class ValidatorTest {

@Test
def void shouldReturnCorrectErrorPositionOnPathWithHierarchy() throws IOException {

// invalid property schema
val content = '''
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/foo/{bar}:
get:
responses:
'200':
description: OK
schema:
swagger: '2.0'
info:
version: 0.0.0
title: Simple API
paths:
/foo/{bar}:
get:
responses:
'200':
description: OK
schema:
'''

document.set(content)
val errors = validator.validate(document, null)

assertEquals(1, errors.size())

errors.forEach[
errors.forEach [
assertTrue(it.line == 10 || it.line == 11)
assertEquals(IMarker.SEVERITY_ERROR, it.level)
]
Expand All @@ -208,10 +216,11 @@ class ValidatorTest {
val errors = validator.validate(document, null)

assertEquals(2, errors.size())
assertThat(errors, hasItems(
new SwaggerError(1, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "swagger")),
new SwaggerError(2, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "swagger"))
))
assertThat(errors,
hasItems(
new SwaggerError(1, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "swagger")),
new SwaggerError(2, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "swagger"))
))
}

@Test
Expand Down Expand Up @@ -259,10 +268,11 @@ class ValidatorTest {
val errors = validator.validate(document, null)

assertEquals(2, errors.size())
assertThat(errors, hasItems(
new SwaggerError(3, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "version")),
new SwaggerError(4, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "version"))
))
assertThat(errors,
hasItems(
new SwaggerError(3, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "version")),
new SwaggerError(4, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "version"))
))
}

@Test
Expand Down Expand Up @@ -290,10 +300,11 @@ class ValidatorTest {
val errors = validator.validate(document, null)

assertEquals(2, errors.size())
assertThat(errors, hasItems(
new SwaggerError(10, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "in")),
new SwaggerError(11, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "in"))
))
assertThat(errors,
hasItems(
new SwaggerError(10, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "in")),
new SwaggerError(11, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "in"))
))
}

@Test
Expand All @@ -318,11 +329,144 @@ class ValidatorTest {
val errors = validator.validate(document, null)

assertEquals(2, errors.size())
assertThat(errors, hasItems(
new SwaggerError(8, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "responses")),
new SwaggerError(11, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "responses"))
))
assertThat(errors,
hasItems(
new SwaggerError(8, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "responses")),
new SwaggerError(11, IMarker.SEVERITY_WARNING, String.format(Messages.error_duplicate_keys, "responses"))
))
}

}
@Test
def void correctAliasAfterAnchor() {
val content = '''
swagger: "2.0"
info:
version: 1.0.0
title: Uber parameters
paths: {}
parameters:
law:
name: law_applicability
in: query
description: scope of a law
required: false
type: string
enum: &scope_values
- GLOBAL
- REGIONAL
- LOCAL
brand:
name: brand_reach
in: query
description: where a brand name is used
type: string
enum: *scope_values
'''

document.set(content)
document.onChange()

assertThat(document.yamlError, nullValue)
assertThat(document.jsonError, nullValue)

val errors = validator.validate(document, null)
assertEquals(0, errors.size())
}

@Test
def void correctAliasBeforeAnchor() {
val content = '''
swagger: "2.0"
info:
version: 1.0.0
title: Uber parameters
paths: {}
parameters:
brand:
name: brand_reach
in: query
description: where a brand name is used
type: string
enum: *scope_values
law:
name: law_applicability
in: query
description: scope of a law
required: false
type: string
enum: &scope_values
- GLOBAL
- REGIONAL
- LOCAL
'''

document.set(content)
document.onChange()

assertThat(document.yamlError, notNullValue)
assertThat(document.yamlError.message,
equalTo(
"null; found undefined alias scope_values; in 'reader', line 15, column 11:\n enum: *scope_values\n ^"))

assertThat(document.jsonError, nullValue)

val errors = validator.validate(document, null)
assertEquals(0, errors.size())
}

@Test
def void invlaidAlias() {
val content = '''
swagger: "2.0"
info:
version: 1.0.0
title: Uber parameters
paths: {}
parameters:
law:
name: law_applicability
in: query
description: scope of a law
required: false
type: string
enum: &scope_values
- GLOBAL
- REGIONAL
- LOCAL
brand:
name: brand_reach
in: query
description: where a brand name is used
type: string
enum: *scope_values_BROKEN
'''

document.set(content)
document.onChange()

assertThat(document.yamlError, notNullValue)
assertThat(document.yamlError.message,
equalTo(
"null; found undefined alias scope_values_BROKEN; in 'reader', line 26, column 11:\n enum: *scope_values_BROKEN\n ^"))

assertThat(document.jsonError, nullValue)

val errors = validator.validate(document, null)
assertEquals(0, errors.size())

}

}
3 changes: 2 additions & 1 deletion com.reprezen.swagedit/src/com/reprezen/swagedit/editor/SwaggerDocument.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,8 @@ private void parseYaml(String content) {

private void parseJson(String content) {
try {
jsonContent = mapper.readTree(content);
Object expandedYamlObject = new com.fasterxml.jackson.dataformat.yaml.snakeyaml.Yaml().load(content);
jsonContent = mapper.valueToTree(expandedYamlObject);
jsonError = null;
} catch (Exception e) {
jsonContent = null;
Expand Down

0 comments on commit ddefe92

Please sign in to comment.