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

consistent namespace convention #458

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

consistent namespace convention #458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b82962f
consistent namespace convention
dschwartznyc Feb 5, 2025
67336bc
Merge branch 'main' into main
davidalk Feb 6, 2025
e387734
Merge branch 'main' into main
davidalk Feb 6, 2025
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
2 changes: 1 addition & 1 deletion ...on/src/test/resources/rune-serializer-error-handling-test/cardinality/cardinality.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace cardinality
namespace serialization.test.roundtripfail.cardinality
Copy link
Contributor

Choose a reason for hiding this comment

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

The round trip tests all take an input, deserialise it into a Rune object, then serialise it out and assert that the before input matches the resulting output. The error handling tests will assert an error when you attempt to serialise back out on that last step. Could we rename all these error namespaces to remove the roundtrip to avoid confusion. How about serialization.test.error...

Copy link
Contributor Author

@dschwartznyc dschwartznyc Feb 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Not plussed about the specific naming as long as there are no clashes and there's a clear delineation between the collection of tests that are expected to pass and the collection that are expected to fail. We use that distinction to automatically differentiate the tests according to their expected outcomes (assert pass vs assert fail).

For example:

passing tests: serialization.test.pass...
failing tests: serialization.test.fail...


annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
4 changes: 2 additions & 2 deletions ...src/test/resources/rune-serializer-error-handling-test/cardinality/too-many-elements.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model": "test.cardinality",
"@type": "test.cardinality.Root",
"@model": "serialization",
"@type": "serialization.test.roundtripfail.cardinality.Root",
"@version": "0.0.0",
"stringList": ["foo", "bar", "baz"]
}
4 changes: 2 additions & 2 deletions ...esources/rune-serializer-error-handling-test/parameterised/number-fraction-too-large.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model": "test.parameterised",
"@type": "test.parameterised.Root",
"@model": "serialization",
"@type": "serialization.test.roundtripfail.parameterised.Root",
"@version": "0.0.0",
"parameterisedNumber": 1.23456789
}
4 changes: 2 additions & 2 deletions ...rc/test/resources/rune-serializer-error-handling-test/parameterised/number-too-large.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model": "test.parameterised",
"@type": "test.parameterised.Root",
"@model": "serialization",
"@type": "serialization.test.roundtripfail.parameterised.Root",
"@version": "0.0.0",
"parameterisedNumber": 123456789
}
2 changes: 1 addition & 1 deletion ...rc/test/resources/rune-serializer-error-handling-test/parameterised/parameterised.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace parameterised
namespace serialization.test.roundtripfail.parameterised

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
4 changes: 2 additions & 2 deletions ...t/resources/rune-serializer-error-handling-test/parameterised/string-illegal-pattern.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model": "test.parameterised",
"@type": "test.parameterised.Root",
"@model": "serialization",
"@type": "serialization.test.roundtripfail.parameterised.Root",
"@version": "0.0.0",
"parameterisedString": "$$"
}
4 changes: 2 additions & 2 deletions ...rc/test/resources/rune-serializer-error-handling-test/parameterised/string-too-large.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model": "test.parameterised",
"@type": "test.parameterised.Root",
"@model": "serialization",
"@type": "serialization.test.roundtripfail.parameterised.Root",
"@version": "0.0.0",
"parameterisedString": "abcdefg"
}
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/basic/basic-types-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.basic.Root",
"@type" : "serialization.test.roundtrip.basic.Root",
"@version" : "0.0.0",
"basicList" : {
"booleanTypes" : [ true, false, true ],
Expand Down
2 changes: 1 addition & 1 deletion ...lization/src/test/resources/rune-serializer-round-trip-test/basic/basic-types-single.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.basic.Root",
"@type" : "serialization.test.roundtrip.basic.Root",
"@version" : "0.0.0",
"basicSingle" : {
"booleanType" : true,
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/basic/basic.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.basic
namespace serialization.test.roundtrip.basic

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion ...alization/src/test/resources/rune-serializer-round-trip-test/choicetype/choice-basic.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.choicetype.Root",
"@type" : "serialization.test.roundtrip.choicetype.Root",
"@version" : "0.0.0",
"choiceBasic" : {
"string" : "foo"
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/choicetype/choice-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.choicetype.Root",
"@type" : "serialization.test.roundtrip.choicetype.Root",
"@version" : "0.0.0",
"choiceData" : {
"A" : {
Expand Down
2 changes: 1 addition & 1 deletion ...ization/src/test/resources/rune-serializer-round-trip-test/choicetype/choice-mixed-1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.choicetype.Root",
"@type" : "serialization.test.roundtrip.choicetype.Root",
"@version" : "0.0.0",
"choiceMixed" : {
"B" : {
Expand Down
2 changes: 1 addition & 1 deletion ...ization/src/test/resources/rune-serializer-round-trip-test/choicetype/choice-mixed-2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.choicetype.Root",
"@type" : "serialization.test.roundtrip.choicetype.Root",
"@version" : "0.0.0",
"choiceMixed" : {
"string" : "foo"
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/choicetype/choice.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.choicetype
namespace serialization.test.roundtrip.choicetype

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/data/data-types.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.data.Root",
"@type" : "serialization.test.roundtrip.data.Root",
"@version" : "0.0.0",
"a" : {
"b" : [ { }, {
Expand Down
3 changes: 1 addition & 2 deletions serialization/src/test/resources/rune-serializer-round-trip-test/data/data.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
namespace serialization.test.data

namespace serialization.test.roundtrip.data
annotation rootType: <"Mark a type as a root of the rosetta model">

type A:
Expand Down
2 changes: 1 addition & 1 deletion ...ization/src/test/resources/rune-serializer-round-trip-test/enumtypes/enum-types-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.enumtypes.Root",
"@type" : "serialization.test.roundtrip.enumtypes.Root",
"@version" : "0.0.0",
"enumList" : {
"enumType" : [ "A", "B", "C", "B" ]
Expand Down
2 changes: 1 addition & 1 deletion ...ation/src/test/resources/rune-serializer-round-trip-test/enumtypes/enum-types-single.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.enumtypes.Root",
"@type" : "serialization.test.roundtrip.enumtypes.Root",
"@version" : "0.0.0",
"enumSingle" : {
"enumType" : "A"
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/enumtypes/enum.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.enumtypes
namespace serialization.test.roundtrip.enumtypes

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/extension/base-type.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.extension.Root",
"@type" : "serialization.test.roundtrip.extension.Root",
"@version" : "0.0.0",
"typeA" : {
"fieldA" : "foo"
Expand Down
4 changes: 2 additions & 2 deletions .../src/test/resources/rune-serializer-round-trip-test/extension/extended-type-concrete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"@model" : "serialization",
"@type" : "serialization.test.extension.Root",
"@type" : "serialization.test.roundtrip.extension.Root",
"@version" : "0.0.0",
"typeB" : {
"fieldB" : "foo",
"@type" : "serialization.test.extension.B"
"@type" : "serialization.test.roundtrip.extension.B"
}
}
4 changes: 2 additions & 2 deletions ...c/test/resources/rune-serializer-round-trip-test/extension/extended-type-polymorphic.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"@model" : "serialization",
"@type" : "serialization.test.extension.Root",
"@type" : "serialization.test.roundtrip.extension.Root",
"@version" : "0.0.0",
"typeA" : {
"fieldA" : "bar",
"fieldB" : "foo",
"@type" : "serialization.test.extension.B"
"@type" : "serialization.test.roundtrip.extension.B"
}
}
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/extension/extension.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.extension
namespace serialization.test.roundtrip.extension

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metakey/attribute-ref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metakey.Root",
"@type" : "serialization.test.roundtrip.metakey.Root",
"@version" : "0.0.0",
"attributeRef" : {
"dateField" : {
Expand Down
2 changes: 1 addition & 1 deletion ...on/src/test/resources/rune-serializer-round-trip-test/metakey/dangling-attribute-ref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metakey.Root",
"@type" : "serialization.test.roundtrip.metakey.Root",
"@version" : "0.0.0",
"attributeRef" : {
"dateReference" : {
Expand Down
2 changes: 1 addition & 1 deletion ...ization/src/test/resources/rune-serializer-round-trip-test/metakey/dangling-node-ref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metakey.Root",
"@type" : "serialization.test.roundtrip.metakey.Root",
"@version" : "0.0.0",
"nodeRef" : {
"aReference" : {
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metakey/meta-key.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.metakey
namespace serialization.test.roundtrip.metakey

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metakey/node-ref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metakey.Root",
"@type" : "serialization.test.roundtrip.metakey.Root",
"@version" : "0.0.0",
"nodeRef" : {
"typeA" : {
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metalocation/address.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metalocation.Root",
"@type" : "serialization.test.roundtrip.metalocation.Root",
"@version" : "0.0.0",
"typeA" : {
"b" : {
Expand Down
2 changes: 1 addition & 1 deletion ...ion/src/test/resources/rune-serializer-round-trip-test/metalocation/dangling-address.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metalocation.Root",
"@type" : "serialization.test.roundtrip.metalocation.Root",
"@version" : "0.0.0",
"bAddress" : {
"@ref:scoped" : "someLocation"
Expand Down
2 changes: 1 addition & 1 deletion ...ion/src/test/resources/rune-serializer-round-trip-test/metalocation/meta-location.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.metalocation
namespace serialization.test.roundtrip.metalocation

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metascheme/enum-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metascheme.Root",
"@type" : "serialization.test.roundtrip.metascheme.Root",
"@version" : "0.0.0",
"enumTypeList" : [ {
"@data" : "A",
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metascheme/enum-single.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metascheme.Root",
"@type" : "serialization.test.roundtrip.metascheme.Root",
"@version" : "0.0.0",
"enumType" : {
"@data" : "A",
Expand Down
2 changes: 1 addition & 1 deletion ...ization/src/test/resources/rune-serializer-round-trip-test/metascheme/meta-scheme.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.metascheme
namespace serialization.test.roundtrip.metascheme

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metascheme/node-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metascheme.Root",
"@type" : "serialization.test.roundtrip.metascheme.Root",
"@version" : "0.0.0",
"typeAList" : [ {
"fieldA" : {
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/metascheme/node-single.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.metascheme.Root",
"@type" : "serialization.test.roundtrip.metascheme.Root",
"@version" : "0.0.0",
"typeA" : {
"fieldA" : {
Expand Down
2 changes: 1 addition & 1 deletion ...lization/src/test/resources/rune-serializer-round-trip-test/record/record-types-list.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.record.Root",
"@type" : "serialization.test.roundtrip.record.Root",
"@version" : "0.0.0",
"recordList" : {
"dateType" : [ "2024-12-10", "2024-11-10", "2024-10-20" ],
Expand Down
2 changes: 1 addition & 1 deletion ...zation/src/test/resources/rune-serializer-round-trip-test/record/record-types-single.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"@model" : "serialization",
"@type" : "serialization.test.record.Root",
"@type" : "serialization.test.roundtrip.record.Root",
"@version" : "0.0.0",
"recordSingle" : {
"dateType" : "2024-12-10",
Expand Down
2 changes: 1 addition & 1 deletion serialization/src/test/resources/rune-serializer-round-trip-test/record/record.rosetta
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
namespace serialization.test.record
namespace serialization.test.roundtrip.record

annotation rootType: <"Mark a type as a root of the rosetta model">

Expand Down