git.iko.soy/typeable/openapi3
on master help sign in
Add some tests for schema inlining
148d95aNickolay Kudasov
test/Data/Swagger/SchemaSpec.hs+137
compare with master
unifiedsplit
@@ -37,6 +37,19 @@ checkDefs proxy names =
37 where
37 where
38 defs = execDeclare (declareNamedSchema proxy) mempty
38 defs = execDeclare (declareNamedSchema proxy) mempty
39
39
40+checkInlinedSchema :: ToSchema a => Proxy a -> Value -> Spec
41+checkInlinedSchema proxy js = toInlinedSchema proxy <=> js
42+
43+checkInlinedSchemas :: ToSchema a => [String] -> Proxy a -> Value -> Spec
44+checkInlinedSchemas names proxy js = inlineSchemas (map Text.pack names) defs schema <=> js
45+ where
46+ (defs, schema) = runDeclare (declareSchema proxy) mempty
47+
48+checkInlinedRecSchema :: ToSchema a => Proxy a -> Value -> Spec
49+checkInlinedRecSchema proxy js = inlineNonRecursiveSchemas defs schema <=> js
50+ where
51+ (defs, schema) = runDeclare (declareSchema proxy) mempty
52+
40spec :: Spec
53spec :: Spec
41spec = do
54spec = do
42 describe "Generic ToSchema" $ do
55 describe "Generic ToSchema" $ do
@@ -70,6 +83,12 @@ spec = do
70 context "Character" $ checkDefs (Proxy :: Proxy Character) ["Player", "Point"]
83 context "Character" $ checkDefs (Proxy :: Proxy Character) ["Player", "Point"]
71 context "MyRoseTree" $ checkDefs (Proxy :: Proxy MyRoseTree) ["RoseTree"]
84 context "MyRoseTree" $ checkDefs (Proxy :: Proxy MyRoseTree) ["RoseTree"]
72 context "[Set (Unit, Maybe Color)]" $ checkDefs (Proxy :: Proxy [Set (Unit, Maybe Color)]) ["Unit", "Color"]
85 context "[Set (Unit, Maybe Color)]" $ checkDefs (Proxy :: Proxy [Set (Unit, Maybe Color)]) ["Unit", "Color"]
86+ describe "Inlining Schemas" $ do
87+ context "Paint" $ checkInlinedSchema (Proxy :: Proxy Paint) paintInlinedSchemaJSON
88+ context "Character" $ checkInlinedSchema (Proxy :: Proxy Character) characterInlinedSchemaJSON
89+ context "Character (inlining only Player)" $ checkInlinedSchemas ["Player"] (Proxy :: Proxy Character) characterInlinedPlayerSchemaJSON
90+ context "Light" $ checkInlinedSchema (Proxy :: Proxy Light) lightInlinedSchemaJSON
91+ context "MyRoseTree (inlineNonRecursiveSchemas)" $ checkInlinedRecSchema (Proxy :: Proxy MyRoseTree) myRoseTreeSchemaJSON
73
92
74main :: IO ()
93main :: IO ()
75main = hspec spec
94main = hspec spec
@@ -196,6 +215,22 @@ paintSchemaJSON = [aesonQQ|
196}
215}
197|]
216|]
198
217
218+paintInlinedSchemaJSON :: Value
219+paintInlinedSchemaJSON = [aesonQQ|
220+{
221+ "type": "object",
222+ "properties":
223+ {
224+ "color":
225+ {
226+ "type": "string",
227+ "enum": ["Red", "Green", "Blue"]
228+ }
229+ },
230+ "required": ["color"]
231+}
232+|]
233+
199-- ========================================================================
234-- ========================================================================
200-- Email (newtype with unwrapUnaryRecords set to True)
235-- Email (newtype with unwrapUnaryRecords set to True)
201-- ========================================================================
236-- ========================================================================
@@ -407,6 +442,89 @@ characterSchemaJSON = [aesonQQ|
407}
442}
408|]
443|]
409
444
445+characterInlinedSchemaJSON :: Value
446+characterInlinedSchemaJSON = [aesonQQ|
447+{
448+ "type": "object",
449+ "properties":
450+ {
451+ "PC":
452+ {
453+ "type": "object",
454+ "properties":
455+ {
456+ "position":
457+ {
458+ "type": "object",
459+ "properties":
460+ {
461+ "x": { "type": "number" },
462+ "y": { "type": "number" }
463+ },
464+ "required": ["x", "y"]
465+ }
466+ },
467+ "required": ["position"]
468+ },
469+ "NPC":
470+ {
471+ "type": "object",
472+ "properties":
473+ {
474+ "npcName": { "type": "string" },
475+ "npcPosition":
476+ {
477+ "type": "object",
478+ "properties":
479+ {
480+ "x": { "type": "number" },
481+ "y": { "type": "number" }
482+ },
483+ "required": ["x", "y"]
484+ }
485+ },
486+ "required": ["npcName", "npcPosition"]
487+ }
488+ },
489+ "maxProperties": 1,
490+ "minProperties": 1
491+}
492+|]
493+
494+characterInlinedPlayerSchemaJSON :: Value
495+characterInlinedPlayerSchemaJSON = [aesonQQ|
496+{
497+ "type": "object",
498+ "properties":
499+ {
500+ "PC":
501+ {
502+ "type": "object",
503+ "properties":
504+ {
505+ "position":
506+ {
507+ "$ref": "#/definitions/Point"
508+ }
509+ },
510+ "required": ["position"]
511+ },
512+ "NPC":
513+ {
514+ "type": "object",
515+ "properties":
516+ {
517+ "npcName": { "type": "string" },
518+ "npcPosition": { "$ref": "#/definitions/Point" }
519+ },
520+ "required": ["npcName", "npcPosition"]
521+ }
522+ },
523+ "maxProperties": 1,
524+ "minProperties": 1
525+}
526+|]
527+
410-- ========================================================================
528-- ========================================================================
411-- Light (sum type with unwrapUnaryRecords)
529-- Light (sum type with unwrapUnaryRecords)
412-- ========================================================================
530-- ========================================================================
@@ -436,3 +554,22 @@ lightSchemaJSON = [aesonQQ|
436}
554}
437|]
555|]
438
556
557+lightInlinedSchemaJSON :: Value
558+lightInlinedSchemaJSON = [aesonQQ|
559+{
560+ "type": "object",
561+ "properties":
562+ {
563+ "LightFreq": { "type": "number" },
564+ "LightColor":
565+ {
566+ "type": "string",
567+ "enum": ["Red", "Green", "Blue"]
568+ },
569+ "LightWaveLength": { "type": "number" }
570+ },
571+ "maxProperties": 1,
572+ "minProperties": 1
573+}
574+|]
575+