content: -- Note: these tests are dependent on Data.Aeson, both because the Serde depends on Data.Aeson
  --       and because of the particular serialization style.
  
  module Hydra.Staging.Json.SerdeSpec where
  
  import Hydra.Kernel
  import Hydra.Dsl.Terms
  import Hydra.Staging.Json.Serde
  import qualified Hydra.Dsl.Types as Types
  
  import Hydra.TestData
  import Hydra.TestUtils
  
  import qualified Test.Hspec as H
  import qualified Data.List as L
  import qualified Test.QuickCheck as QC
  import qualified Data.Maybe as Y
  
  
  checkLiterals :: H.SpecWith ()
  checkLiterals = H.describe "Test literal values" $ do
  
    H.it "Booleans become 'true' and 'false'" $ do
      QC.property $ \b -> checkSerialization jsonStringCoder
        (TypedTerm (boolean b) $ Types.boolean)
        (if b then "true" else "false")
  
    H.it "int32's become numbers, and are serialized in the obvious way" $ do
      QC.property $ \i -> checkSerialization jsonStringCoder
        (TypedTerm (int32 i) $ Types.int32)
        (show i)
  
    H.it "uint8's and other finite integer types become numbers, and are serialized in the obvious way" $ do
      QC.property $ \i -> checkSerialization jsonStringCoder
        (TypedTerm (uint8 i) $ Types.uint8)
        (show i)
  
    H.it "bigints become numbers" $ do
      QC.property $ \i -> checkSerialization jsonStringCoder
        (TypedTerm (bigint i) $ Types.bigint)
        (show i)
  
  checkOptionals :: H.SpecWith ()
  checkOptionals = H.describe "Test and document serialization of optionals" $ do
  
    H.it "A 'nothing' becomes 'null' (except when it appears as a field)" $
      QC.property $ \mi -> checkSerialization jsonStringCoder
        (TypedTerm
          (optional $ (Just . int32) =<< mi)
          (Types.optional Types.int32))
        (Y.maybe "null" show mi)
  
    H.it "Nested optionals case #1: just x? :: optional<optional<int32>>" $
      QC.property $ \mi -> checkSerialization jsonStringCoder
        (TypedTerm
          (optional $ Just $ optional $ (Just . int32) =<< mi)
          (Types.optional $ Types.optional Types.int32))
        ("[" ++ Y.maybe "null" show mi ++ "]")
  
    H.it "Nested optionals case #2: nothing :: optional<optional<int32>>" $
      QC.property $ \() -> checkSerialization jsonStringCoder
        (TypedTerm
          (optional Nothing)
          (Types.optional $ Types.optional Types.int32))
        "[]"
  
  checkRecordsAndUnions :: H.SpecWith ()
  checkRecordsAndUnions = H.describe "Test and document handling of optionals vs. nulls for record and union types" $ do
  
    H.it "Empty records become empty objects" $
      QC.property $ \() -> checkSerialization jsonStringCoder
        (TypedTerm unit Types.unit)
        "{}"
  
    H.it "Simple records become simple objects" $
      QC.property $ \() -> checkSerialization jsonStringCoder
        (TypedTerm (latlonRecord 37 (negate 122)) testTypeLatLon)
        "{\"lat\":37,\"lon\":-122}"
  
    -- TODO: restore me
  --  H.it "Optionals are omitted from record objects if 'nothing'" $
  --    QC.property $ \() -> checkSerialization jsonStringCoder
  --      (TypedTerm
  --        (record testTypeName [Field (Name "one") $ optional $ Just $ string "test", Field (Name "two") $ optional Nothing])
  --        (TypeRecord $ RowType testTypeName [Types.field "one" $ Types.optional Types.string, Types.field "two" $ Types.optional Types.int32]))
  --      "{\"one\":\"test\"}"
  
    -- TODO: restore me
  --  H.it "Simple unions become simple objects, via records" $
  --    QC.property $ \() -> checkSerialization jsonStringCoder
  --      (TypedTerm
  --        (inject testTypeName $ Field (Name "left") $ string "test")
  --        (TypeUnion $ RowType testTypeName [Types.field "left" Types.string, Types.field "right" Types.int32]))
  --      "{\"left\":\"test\"}"
  
  jsonByteStringCoderIsInformationPreserving :: H.SpecWith ()
  jsonByteStringCoderIsInformationPreserving = H.describe "Verify that a round trip from a type+term, to serialized JSON, and back again is a no-op" $ do
  
    H.it "Generate arbitrary type/term pairs, serialize the terms to JSON, deserialize them, and compare" $
      QC.property (checkSerdeRoundTrip jsonByteStringCoder)
  
  spec :: H.Spec
  spec = do
    checkLiterals
    checkOptionals
    checkRecordsAndUnions
  --  jsonByteStringCoderIsInformationPreserving -- TODO: restore me
  