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

binding config schema validation for unused properties #929

Merged
merged 11 commits into from
Apr 25, 2024
Merged

binding config schema validation for unused properties #929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
288236d
Kafka binding config schema validation for unused properties
ankitk-me Apr 16, 2024
0794d5e
update to make attributes inclusive, not exclusive
ankitk-me Apr 17, 2024
7426807
binding-ws schema update
ankitk-me Apr 18, 2024
39fca0f
binding-tls schema update
ankitk-me Apr 18, 2024
b15989a
binding-mqtt schema update
ankitk-me Apr 18, 2024
6edfd38
binding-http schema update
ankitk-me Apr 18, 2024
32e6dfc
binding-grpc schema update
ankitk-me Apr 18, 2024
b59fb7b
Merge branch 'develop' into kafkaSchemaFix
ankitk-me Apr 22, 2024
ff627a6
addressing review comments
ankitk-me Apr 22, 2024
5849513
build fix
ankitk-me Apr 22, 2024
f12e255
fix to support `"additionalProperties": false` at `binding` level config
ankitk-me Apr 23, 2024
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
3 changes: 0 additions & 3 deletions ...main/scripts/io/aklivity/zilla/specs/binding/grpc/config/client.when.binary.metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ bindings:
app0:
type: grpc
kind: client
options:
services:
- protobuf/echo.proto
routes:
- exit: net0
when:
Expand Down
3 changes: 0 additions & 3 deletions ...g-grpc.spec/src/main/scripts/io/aklivity/zilla/specs/binding/grpc/config/client.when.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ bindings:
app0:
type: grpc
kind: client
options:
services:
- protobuf/echo.proto
routes:
- exit: net0
when:
Expand Down
58 changes: 40 additions & 18 deletions ....spec/src/main/scripts/io/aklivity/zilla/specs/binding/grpc/schema/grpc.schema.patch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,6 @@
"enum": [ "server", "client"]
},
"vault": false,
"options":
{
"properties":
{
"services":
{
"title": "Services",
"type": "array",
"items":
{
"title": "Service",
"type": "string"
},
"deprecated": true
}
},
"additionalProperties": false
},
"routes":
{
"items":
Expand Down Expand Up @@ -115,6 +97,46 @@
"routes"
]
}
],
"oneOf":
[
{
"properties":
{
"kind":
{
"const": "server"
},
"options":
{
"properties":
{
"services":
{
"title": "Services",
"type": "array",
"items":
{
"title": "Service",
"type": "string"
},
"deprecated": true
}
},
"additionalProperties": false
}
}
},
{
"properties":
{
"kind":
{
"const": "client"
},
"options": false
}
}
]
}
}
Expand Down
33 changes: 33 additions & 0 deletions ...nding-grpc.spec/src/test/java/io/aklivity/zilla/specs/binding/grpc/config/SchemaTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public class SchemaTest
public final ConfigSchemaRule schema = new ConfigSchemaRule()
.schemaPatch("io/aklivity/zilla/specs/binding/grpc/schema/grpc.schema.patch.json")
.schemaPatch("io/aklivity/zilla/specs/engine/schema/guard/test.schema.patch.json")
.schemaPatch("io/aklivity/zilla/specs/engine/schema/catalog/test.schema.patch.json")
.configurationRoot("io/aklivity/zilla/specs/binding/grpc/config");

@Test
Expand All @@ -48,4 +49,36 @@ public void shouldValidateClient()

assertThat(config, not(nullValue()));
}

@Test
public void shouldValidateClientWhen()
{
JsonObject config = schema.validate("client.when.yaml");

assertThat(config, not(nullValue()));
}

@Test
public void shouldValidateServerWhenBinaryMetadata()
{
JsonObject config = schema.validate("server.when.binary.metadata.yaml");

assertThat(config, not(nullValue()));
}

@Test
public void shouldValidateClientWhenBinaryMetadata()
{
JsonObject config = schema.validate("client.when.binary.metadata.yaml");

assertThat(config, not(nullValue()));
}

@Test
public void shouldValidateServerWhenCatalog()
{
JsonObject config = schema.validate("server.when.catalog.yaml");

assertThat(config, not(nullValue()));
}
}
29 changes: 29 additions & 0 deletions ....spec/src/main/scripts/io/aklivity/zilla/specs/binding/http/schema/http.schema.patch.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,35 @@
"routes"
]
}
],
"oneOf":
[
{
"properties":
{
"kind":
{
"const": "server"
}
}
},
{
"properties":
{
"kind":
{
"const": "client"
},
"options":
{
"properties":
{
"access-control": false,
"authorization": false
}
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that server options are a superset of client options, is there not a way to specify the common subset once, and then conditionally include the additional options properties for server?

]
}
}
Expand Down
9 changes: 9 additions & 0 deletions ...nding-http.spec/src/test/java/io/aklivity/zilla/specs/binding/http/config/SchemaTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ public class SchemaTest
public final ConfigSchemaRule schema = new ConfigSchemaRule()
.schemaPatch("io/aklivity/zilla/specs/binding/http/schema/http.schema.patch.json")
.schemaPatch("io/aklivity/zilla/specs/engine/schema/guard/test.schema.patch.json")
.schemaPatch("io/aklivity/zilla/specs/engine/schema/model/test.schema.patch.json")
.configurationRoot("io/aklivity/zilla/specs/binding/http/config");

@Test
Expand Down Expand Up @@ -170,6 +171,14 @@ public void shouldValidateHttp2Client()
assertThat(config, not(nullValue()));
}

@Test
public void shouldValidateHttp2ClientWithValidation()
{
JsonObject config = schema.validate("v2/client.validation.yaml");

assertThat(config, not(nullValue()));
}

@Test
public void shouldValidateHttp2ClientOverride()
{
Expand Down
3 changes: 0 additions & 3 deletions ...c/src/main/scripts/io/aklivity/zilla/specs/binding/kafka/config/cache.options.merged.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ bindings:
app0:
type: kafka
kind: cache_client
options:
merged:
- test
routes:
- exit: cache0
when:
Expand Down
2 changes: 0 additions & 2 deletions .../src/main/scripts/io/aklivity/zilla/specs/binding/kafka/config/client.options.merged.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,4 @@ bindings:
options:
servers:
- localhost:9092
merged:
- test
exit: net0
Loading