Safe Haskell	None
Language	Haskell2010

Test.Serialization.Symbiote

Description

The project operates as follows:

Given two peers A and B and some communications transport T (utilizing a serialization format S), and a data type Q with some set of operations on that data type Op_Q, the following functions / procedures are assumed:

tAB: the function communicates some data in S from peer A to peer B tBA: the function communicates some data in S from peer B to peer A encode :: Q -> S decode :: S -> Q -- disregarding error handling

And the following property should exist, from peer A's perspective:

forall f in Op_Q, q in Q. f q == decode (tBA (f (tAB (encode q)))

where the left invocation of f occurs in peer A, and the right invocation occurs in peer B.

Synopsis

class SymbioteOperation a where
- data Operation a :: *
- perform :: Operation a -> a -> a
class SymbioteOperation a => Symbiote a s where
- encode :: a -> s
- decode :: s -> Maybe a
- encodeOp :: Operation a -> s
- decodeOp :: s -> Maybe (Operation a)
newtype EitherOp a = EitherOp (Either a (Operation a))
data Topic
type SymbioteT s m = ReaderT Bool (StateT (Map Topic (SymbioteState s)) m)
register :: forall a s m. Arbitrary a => Arbitrary (Operation a) => Symbiote a s => Eq a => MonadIO m => Topic -> Int -> Proxy a -> SymbioteT s m ()
firstPeer :: forall m s. MonadIO m => Show s => (First s -> m ()) -> m (Second s) -> (Topic -> m ()) -> (Failure Second s -> m ()) -> (Topic -> Float -> m ()) -> SymbioteT s m () -> m ()
secondPeer :: forall s m. MonadIO m => Show s => (Second s -> m ()) -> m (First s) -> (Topic -> m ()) -> (Failure First s -> m ()) -> (Topic -> Float -> m ()) -> SymbioteT s m () -> m ()
data First s
- = AvailableTopics (Map Topic Int)
- | FirstGenerating {
  - firstGeneratingTopic :: Topic
  - firstGenerating :: Generating s
  }
- | FirstOperating {
  - firstOperatingTopic :: Topic
  - firstOperating :: Operating s
  }
data Second s
- = BadTopics (Map Topic Int)
- | Start
- | SecondOperating {
  - secondOperatingTopic :: Topic
  - secondOperating :: Operating s
  }
- | SecondGenerating {
  - secondGeneratingTopic :: Topic
  - secondGenerating :: Generating s
  }
data Generating s
- = Generated {
  - genValue :: s
  - genOperation :: s
  }
- | BadResult s
- | YourTurn
- | ImFinished
- | GeneratingNoParseOperated s
data Operating s
- = Operated s
- | OperatingNoParseValue s
- | OperatingNoParseOperation s
data Failure them s
- = BadTopicsFailure {
  - badTopicsFirst :: Map Topic Int
  - badTopicsSecond :: Map Topic Int
  }
- | OutOfSyncFirst (First s)
- | OutOfSyncSecond (Second s)
- | TopicNonexistent Topic
- | WrongTopic {
  - wrongTopicExpected :: Topic
  - wrongTopicGot :: Topic
  }
- | CantParseOperated Topic s
- | CantParseGeneratedValue Topic s
- | CantParseGeneratedOperation Topic s
- | CantParseLocalValue Topic s
- | CantParseLocalOperation Topic s
- | BadOperating Topic (Operating s)
- | BadGenerating Topic (Generating s)
- | BadThem Topic (them s)
- | SafeFailure {
  - safeFailureTopic :: Topic
  - safeFailureExpected :: s
  - safeFailureGot :: s
  }
defaultSuccess :: Topic -> IO ()
defaultFailure :: Show (them s) => Show s => Failure them s -> IO ()
defaultProgress :: Topic -> Float -> IO ()
nullProgress :: Topic -> Float -> IO ()
simpleTest :: MonadBaseControl IO m => MonadIO m => Show s => SymbioteT s m () -> m ()

Documentation

class SymbioteOperation a where Source #

Associated Types

data Operation a :: * Source #

Methods

perform :: Operation a -> a -> a Source #

class SymbioteOperation a => Symbiote a s where Source #

A type and operation set over a serialization format

Methods

encode :: a -> s Source #

decode :: s -> Maybe a Source #

encodeOp :: Operation a -> s Source #

decodeOp :: s -> Maybe (Operation a) Source #

Instances

(ToJSON a, FromJSON a, ToJSON (Operation a), FromJSON (Operation a), SymbioteOperation a) => Symbiote a Value Source #
Instance details Defined in Test.Serialization.Symbiote.Aeson Methods encode :: a -> Value Source # decode :: Value -> Maybe a Source # encodeOp :: Operation a -> Value Source # decodeOp :: Value -> Maybe (Operation a) Source #
(Serialize a, Serialize (Operation a), SymbioteOperation a) => Symbiote a ByteString Source #
Instance details Defined in Test.Serialization.Symbiote.Cereal Methods encode :: a -> ByteString Source # decode :: ByteString -> Maybe a Source # encodeOp :: Operation a -> ByteString Source # decodeOp :: ByteString -> Maybe (Operation a) Source #
(Serialize a, Serialize (Operation a), SymbioteOperation a) => Symbiote a ByteString Source #
Instance details Defined in Test.Serialization.Symbiote.Cereal.Lazy Methods encode :: a -> ByteString Source # decode :: ByteString -> Maybe a Source # encodeOp :: Operation a -> ByteString Source # decodeOp :: ByteString -> Maybe (Operation a) Source #
SymbioteOperation a => Symbiote a (EitherOp a) Source #
Instance details Defined in Test.Serialization.Symbiote Methods encode :: a -> EitherOp a Source # decode :: EitherOp a -> Maybe a Source # encodeOp :: Operation a -> EitherOp a Source # decodeOp :: EitherOp a -> Maybe (Operation a) Source #

newtype EitherOp a Source #

The most trivial serialization medium for any a.

Constructors

EitherOp (Either a (Operation a))

Instances

SymbioteOperation a => Symbiote a (EitherOp a) Source #
Instance details Defined in Test.Serialization.Symbiote Methods encode :: a -> EitherOp a Source # decode :: EitherOp a -> Maybe a Source # encodeOp :: Operation a -> EitherOp a Source # decodeOp :: EitherOp a -> Maybe (Operation a) Source #
(Eq a, Eq (Operation a)) => Eq (EitherOp a) Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: EitherOp a -> EitherOp a -> Bool # (/=) :: EitherOp a -> EitherOp a -> Bool #
(Show a, Show (Operation a)) => Show (EitherOp a) Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> EitherOp a -> ShowS # show :: EitherOp a -> String # showList :: [EitherOp a] -> ShowS #

data Topic Source #

Unique name of a type, for a suite of tests

Instances

Eq Topic Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: Topic -> Topic -> Bool # (/=) :: Topic -> Topic -> Bool #
Ord Topic Source #
Instance details Defined in Test.Serialization.Symbiote Methods compare :: Topic -> Topic -> Ordering # (<) :: Topic -> Topic -> Bool # (<=) :: Topic -> Topic -> Bool # (>) :: Topic -> Topic -> Bool # (>=) :: Topic -> Topic -> Bool # max :: Topic -> Topic -> Topic # min :: Topic -> Topic -> Topic #
Show Topic Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> Topic -> ShowS # show :: Topic -> String # showList :: [Topic] -> ShowS #
IsString Topic Source #
Instance details Defined in Test.Serialization.Symbiote Methods fromString :: String -> Topic #

type SymbioteT s m = ReaderT Bool (StateT (Map Topic (SymbioteState s)) m) Source #

register Source #

Arguments

:: Arbitrary a
=> Arbitrary (Operation a)
=> Symbiote a s
=> Eq a
=> MonadIO m
=> Topic
-> Int	Max size
-> Proxy a
-> SymbioteT s m ()

Register a topic in the test suite

firstPeer Source #

Arguments

:: MonadIO m
=> Show s
=> (First s -> m ())	Encode and send first messages
-> m (Second s)	Receive and decode second messages
-> (Topic -> m ())	Report when Successful
-> (Failure Second s -> m ())	Report when Failed
-> (Topic -> Float -> m ())	Report on Progress
-> SymbioteT s m ()
-> m ()

secondPeer Source #

Arguments

:: MonadIO m
=> Show s
=> (Second s -> m ())	Encode and send second messages
-> m (First s)	Receive and decode first messages
-> (Topic -> m ())	Report when Successful
-> (Failure First s -> m ())	Report when Failed
-> (Topic -> Float -> m ())	Report on Progress
-> SymbioteT s m ()
-> m ()

data First s Source #

Messages sent by the first peer

Constructors

AvailableTopics (Map Topic Int)	Mapping of topics to their gen size
FirstGenerating
Fields firstGeneratingTopic :: Topic firstGenerating :: Generating s
FirstOperating
Fields firstOperatingTopic :: Topic firstOperating :: Operating s

Instances

Eq s => Eq (First s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: First s -> First s -> Bool # (/=) :: First s -> First s -> Bool #
Show s => Show (First s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> First s -> ShowS # show :: First s -> String # showList :: [First s] -> ShowS #

data Second s Source #

Messages sent by the second peer

Constructors

BadTopics (Map Topic Int)	Second's available topics with identical gen sizes
Start
SecondOperating
Fields secondOperatingTopic :: Topic secondOperating :: Operating s
SecondGenerating
Fields secondGeneratingTopic :: Topic secondGenerating :: Generating s

Instances

Eq s => Eq (Second s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: Second s -> Second s -> Bool # (/=) :: Second s -> Second s -> Bool #
Show s => Show (Second s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> Second s -> ShowS # show :: Second s -> String # showList :: [Second s] -> ShowS #

data Generating s Source #

Messages sent by a peer during their generating phase

Constructors

Generated
Fields genValue :: s genOperation :: s
BadResult s	Expected value
YourTurn
ImFinished
GeneratingNoParseOperated s

Instances

Eq s => Eq (Generating s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: Generating s -> Generating s -> Bool # (/=) :: Generating s -> Generating s -> Bool #
Show s => Show (Generating s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> Generating s -> ShowS # show :: Generating s -> String # showList :: [Generating s] -> ShowS #

data Operating s Source #

Messages sent by a peer during their operating phase

Constructors

Operated s	Serialized value after operation
OperatingNoParseValue s
OperatingNoParseOperation s

Instances

Eq s => Eq (Operating s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: Operating s -> Operating s -> Bool # (/=) :: Operating s -> Operating s -> Bool #
Show s => Show (Operating s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> Operating s -> ShowS # show :: Operating s -> String # showList :: [Operating s] -> ShowS #

data Failure them s Source #

Constructors

BadTopicsFailure
Fields badTopicsFirst :: Map Topic Int badTopicsSecond :: Map Topic Int
OutOfSyncFirst (First s)
OutOfSyncSecond (Second s)
TopicNonexistent Topic
WrongTopic
Fields wrongTopicExpected :: Topic wrongTopicGot :: Topic
CantParseOperated Topic s
CantParseGeneratedValue Topic s
CantParseGeneratedOperation Topic s
CantParseLocalValue Topic s
CantParseLocalOperation Topic s
BadOperating Topic (Operating s)
BadGenerating Topic (Generating s)
BadThem Topic (them s)
SafeFailure
Fields safeFailureTopic :: Topic safeFailureExpected :: s safeFailureGot :: s

Instances

(Eq s, Eq (them s)) => Eq (Failure them s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods (==) :: Failure them s -> Failure them s -> Bool # (/=) :: Failure them s -> Failure them s -> Bool #
(Show s, Show (them s)) => Show (Failure them s) Source #
Instance details Defined in Test.Serialization.Symbiote Methods showsPrec :: Int -> Failure them s -> ShowS # show :: Failure them s -> String # showList :: [Failure them s] -> ShowS #

defaultSuccess :: Topic -> IO () Source #

Via putStrLn

defaultFailure :: Show (them s) => Show s => Failure them s -> IO () Source #

Via putStrLn

defaultProgress :: Topic -> Float -> IO () Source #

Via putStrLn

nullProgress :: Topic -> Float -> IO () Source #

Do nothing

simpleTest :: MonadBaseControl IO m => MonadIO m => Show s => SymbioteT s m () -> m () Source #

Prints to stdout and uses a local channel for a sanity-check - doesn't serialize.