@@ -1,144 +1,170 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE StandaloneDeriving #-}
3−{-# LANGUAGE StandaloneDeriving #-}
4−
5−{-# LANGUAGE DerivingVia #-}
61{-# LANGUAGE DerivingVia #-}
7−
8−{-# LANGUAGE TypeApplications #-}
92{-# LANGUAGE LambdaCase #-}
10−{-# LANGUAGE DerivingVia #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE RecordWildCards #-}
115{-# LANGUAGE StandaloneDeriving #-}
12−
6+{-# LANGUAGE TypeApplications #-}
7+{-# LANGUAGE RankNTypes #-}
8+{-# LANGUAGE FlexibleContexts #-}
9+{-# LANGUAGE AllowAmbiguousTypes #-}
10+{-# LANGUAGE ScopedTypeVariables #-}
11+{-# LANGUAGE DataKinds #-}
1312{-# OPTIONS_GHC -fno-warn-orphans #-}
13+{-# LANGUAGE TypeFamilies #-}
14+
15+import qualified Breakdown
16+import Data.Dynamic (toDyn)
17+import Data.Hashable (Hashable (hash))
18+import Data.Maybe (isNothing)
19+import Data.Void (Void)
1420import qualified Foo
15−import qualified Seeded
16−import qualified Valid
1721import qualified Headers
22+import qualified Nested
1823import qualified Post
19−import Test.Hspec.Core.Spec
20−
21−import Data.Dynamic(toDyn)
22−import qualified Roboservant as RS
24+import qualified Put
25+import qualified Product
26+import qualified QueryParams
27+import qualified Roboservant as R
28+import qualified Roboservant.Server as RS
29+import qualified Roboservant.Client as RC
30+import qualified Seeded
2331import Test.Hspec
24−import Data.Void
25−import Data.Maybe
26−import Data.Hashable
32+import Test.Hspec.Core.Spec (FailureReason (Reason), ResultStatus (Failure, Success), itemExample, mapSpecItem_, resultStatus)
33+import qualified Valid
34+import Servant ( Server, Proxy(..), serve, Endpoints, HasServer )
35+
36+import Servant.Client(ClientEnv, mkClientEnv, baseUrlPort, parseBaseUrl,HasClient,ClientM)
37+import Network.Wai(Application)
38+import qualified Network.Wai.Handler.Warp as Warp
39+import Network.HTTP.Client (newManager, defaultManagerSettings)
40+import Control.Monad((>=>))
2741
2842main :: IO ()
2943main = hspec spec
3044
31−noCheck :: IO ()
32−noCheck = pure ()
33−
34−defaultConfig :: RS.Config
35−defaultConfig = RS.Config
36− { RS.seed = []
37− , RS.maxRuntime = 0.5
38− , RS.maxReps = 1000
39− , RS.rngSeed = 0
40− , RS.coverageThreshold = 0
41− }
45+fuzzBoth
46+ :: forall a .
47+ (R.ToReifiedApi (Endpoints a), HasServer a '[], RS.FlattenServer a, RC.ToReifiedClientApi (Endpoints a), RC.FlattenClient a,
48+ HasClient ClientM a)
49+ => String -> Server a -> R.Config -> (Maybe R.Report -> IO ()) -> Spec
50+fuzzBoth name server config condition = do
51+ it (name <> " via server") $
52+ RS.fuzz @a server config >>= condition
53+
54+ around (withServer (serve (Proxy :: Proxy a) server)) $
55+ it (name <> " via client") $ \(clientEnv::ClientEnv) -> do
56+ RC.fuzz @a clientEnv config >>= condition
57+
58+withServer :: Application -> ActionWith ClientEnv -> IO ()
59+withServer app action = Warp.testWithApplication (pure app) (genClientEnv >=> action)
60+ where genClientEnv port = do
61+ baseUrl <- parseBaseUrl "http://localhost"
62+ manager <- newManager defaultManagerSettings
63+ pure $ mkClientEnv manager (baseUrl { baseUrlPort = port })
4264
4365spec :: Spec
4466spec = do
4567 describe "Basic usage" $ do
4668 describe "noError" $ do
47− it "finds no error in a valid app" $ do
48− RS.fuzz @Valid.Api Valid.server defaultConfig noCheck
49− >>= (`shouldSatisfy` isNothing)
50− it "finds no error in a valid generic app" $ do
51− RS.fuzz @Valid.RoutedApi Valid.routedServer defaultConfig noCheck
52− >>= (`shouldSatisfy` isNothing)
53−
54− it "does fail coverage check" $ do
55− r <- RS.fuzz @Valid.Api Valid.server defaultConfig { RS.coverageThreshold = 0.6 } noCheck
56− fmap (RS.failureReason . RS.rsException) r `shouldSatisfy`
57− (\case
58− Just (RS.InsufficientCoverage _) -> True
59− _ -> False)
60−
61− describe "posted body" $ do
62− it "passes a coverage check using a posted body" $ do
63− RS.fuzz @Post.Api Post.server defaultConfig { RS.coverageThreshold = 0.99 } noCheck
64− >>= (`shouldSatisfy` isNothing)
69+ fuzzBoth @Valid.Api "find no error in a basic app" Valid.server R.defaultConfig (`shouldSatisfy` isNothing)
70+ fuzzBoth @Valid.RoutedApi "finds no error in a valid generic app" Valid.routedServer R.defaultConfig (`shouldSatisfy` isNothing)
71+ fuzzBoth @Valid.Api "fails coverage check" Valid.server R.defaultConfig {R.coverageThreshold = 0.6}
72+ (\r ->
73+ fmap (R.failureReason . R.rsException) r
74+ `shouldSatisfy` ( \case
75+ Just (R.InsufficientCoverage _) -> True
76+ _ -> False
77+ ))
78+ describe "posted body" $
79+ fuzzBoth @Post.Api "passes a coverage check using a posted body" Post.server R.defaultConfig {R.coverageThreshold = 0.99}
80+ (`shouldSatisfy` isNothing)
6581
66− describe "seeded" $ do
67− shouldFail $
68− it "finds an error using information passed in" $
69− let res = Seeded.Seed 1 in
70− RS.fuzz @Seeded.Api Seeded.server (defaultConfig{ RS.seed = [(toDyn res,hash res) ] }) noCheck
71− >>= (`shouldSatisfy` isNothing)
72− describe "Foo" $ do
73− it "finds an error in a basic app" $
74− RS.fuzz @Foo.Api Foo.server defaultConfig noCheck
75− >>= (`shouldSatisfy` isJust)
7682
77− -- describe "headers" $ do
78− -- it "should find a failure that's dependent on using header info" $ do
79− -- RS.fuzz @Headers.Api Headers.server defaultConfig noCheck
80− -- >>= (`shouldSatisfy` isJust)
83+ describe "PUTted body" $
84+ fuzzBoth @Put.Api "passes a coverage check using a posted body" Put.server R.defaultConfig {R.coverageThreshold = 0.99}
85+ (`shouldSatisfy` isNothing)
8186
82− -- describe "can build from pieces" $ do
83− -- it "should find a failure that requires some assembly" $ do
84− -- RS.fuzz @RS.BuildFrom.Api RS.BuildFrom.server defaultConfig noCheck
85− -- >>= (`shouldSatisfy` isJust)
8687
88+ describe "seeded" $ do
89+ let res = Seeded.Seed 1
90+ shouldFail $ fuzzBoth @Seeded.Api "finds an error using information passed in" Seeded.server
91+ (R.defaultConfig {R.seed = [(toDyn res, hash res)]})
92+ (`shouldSatisfy` isNothing)
8793
94+ describe "Foo" $
95+ fuzzBoth @Foo.Api "finds an error in a basic app" Foo.server R.defaultConfig (`shouldSatisfy` serverFailure)
8896
89− -- -- -- The UnsafeIO checker does not actually really use the contextually aware stuff, though it
90− -- -- -- could: it's mostly here to show how to test for concurrency problems.
91− -- describe "concurrency bugs" $ do
92− -- before UnsafeIO.makeServer $ do
93− -- describe "sequential checking" $ do
94− -- it "safe use" $ \unsafeServer -> do
95− -- hedgehog $ RS.prop_sequential @UnsafeIO.UnsafeApi unsafeServer []
97+ describe "QueryParams" $
98+ fuzzBoth @QueryParams.Api "can handle query params" QueryParams.server R.defaultConfig { R.seed = [R.hashedDyn (12::Int)] }
99+ (`shouldSatisfy` isNothing)
96100
97− -- modifyMaxSuccess (const 10000) $
98− -- shouldFail $
99− -- describe "concurrent" $ do
100− -- it "concurrent, dangerous use" $ \unsafeServer -> do
101− -- RS.prop_concurrent @UnsafeIO.UnsafeApi unsafeServer []
101+ describe "BuildFrom" $ do
102+ describe "headers (and sum types)" $
103+ fuzzBoth @Headers.Api "should find a failure that's dependent on using header info" Headers.server R.defaultConfig
104+ (`shouldSatisfy` serverFailure)
105+ describe "product types" $
106+ fuzzBoth @Product.Api "should find a failure that's dependent on creating a product" Product.server
107+ R.defaultConfig {R.seed = [R.hashedDyn 'a', R.hashedDyn (1 :: Int)]}
108+ (`shouldSatisfy` serverFailure)
109+ describe "Breakdown" $ do
110+ fuzzBoth @Breakdown.ProductApi "handles products" Breakdown.productServer R.defaultConfig
111+ (`shouldSatisfy` serverFailure)
112+ fuzzBoth @Breakdown.SumApi "handles sums" Breakdown.sumServer R.defaultConfig
113+ (`shouldSatisfy` serverFailure)
114+ describe "flattening" $
115+ fuzzBoth @Nested.FlatApi "can handle nested apis" Nested.server R.defaultConfig {R.coverageThreshold = 0.99}
116+ (`shouldSatisfy` isNothing)
102117
118+serverFailure :: Maybe R.Report -> Bool
119+serverFailure = \case
120+ Just R.Report {..} ->
121+ let R.RoboservantException {..} = rsException
122+ in failureReason /= R.NoPossibleMoves
123+ _ -> False
103124
104−deriving via (RS.Atom Foo.Foo) instance RS.Breakdown Foo.Foo
105−deriving via (RS.Atom Foo.Foo) instance RS.BuildFrom Foo.Foo
125+deriving via (R.Atom Foo.Foo) instance R.Breakdown Foo.Foo
106126
107−deriving via (RS.Atom Headers.Foo) instance RS.Breakdown Headers.Foo
108−deriving via (RS.Atom Headers.Foo) instance RS.BuildFrom Headers.Foo
127+deriving via (R.Atom Foo.Foo) instance R.BuildFrom Foo.Foo
109128
110−deriving via (RS.Atom Seeded.Seed) instance RS.Breakdown Seeded.Seed
111−deriving via (RS.Atom Seeded.Seed) instance RS.BuildFrom Seeded.Seed
129+deriving via (R.Atom Headers.Foo) instance R.Breakdown Headers.Foo
112130
131+deriving via (R.Atom Headers.Foo) instance R.BuildFrom Headers.Foo
113132
114−-- instance RS.BuildFrom Seeded.Seed
133+deriving via (R.Atom Seeded.Seed) instance R.Breakdown Seeded.Seed
115134
116−deriving via (RS.Atom Void) instance RS.BuildFrom Void
135+deriving via (R.Atom Seeded.Seed) instance R.BuildFrom Seeded.Seed
117136
118−deriving via (RS.Atom Post.FooPost) instance RS.BuildFrom Post.FooPost
119−deriving via (RS.Atom Post.FooPost) instance RS.Breakdown Post.FooPost
137+deriving via (R.Atom Void) instance R.BuildFrom Void
120138
139+deriving via (R.Atom Post.FooPost) instance R.Breakdown Post.FooPost
140+deriving via (R.Atom Post.FooPost) instance R.BuildFrom Post.FooPost
121141
122−--deriving via (Compound RS.BuildFrom.Wrapped) instance RS.BuildFrom RS.BuildFrom.Wrapped
123−--deriving via (Compound RS.BuildFrom.Wrapped) instance RS.Breakdown RS.BuildFrom.Wrapped
142+deriving via (R.Atom Put.Foo) instance R.Breakdown Put.Foo
143+deriving via (R.Atom Put.Foo) instance R.BuildFrom Put.Foo
124144
125145
126146
127−-- deriving via (RS.Atom Void) instance RS.BuildFrom Void
147+deriving via (R.Compound Breakdown.Foo) instance R.Breakdown Breakdown.Foo
128148
129−-- instance RS.Breakdown Post.FooPost
130−-- instance RS.BuildFrom Post.FooPost
149+deriving via (R.Compound Product.Foo) instance R.BuildFrom Product.Foo
131150
151+deriving via (R.Compound Breakdown.SomeSum) instance R.Breakdown Breakdown.SomeSum
132152
133153-- | `shouldFail` allows you to assert that a given `Spec` should contain at least one failing test.
134154-- this is often useful when testing tests.
135155shouldFail :: SpecWith a -> SpecWith a
136−shouldFail = mapSpecItem_ (\i -> i {
137− itemExample = \p a cb -> do
138− r <- (itemExample i) p a cb
139− pure r {resultStatus = case resultStatus r of
140− Success -> Failure Nothing (Reason "Unexpected success")
141− Failure _ _ -> Success
142− x -> x
143− }
144− })
156+shouldFail =
157+ mapSpecItem_
158+ ( \i ->
159+ i
160+ { itemExample = \p a cb -> do
161+ r <- itemExample i p a cb
162+ pure
163+ r
164+ { resultStatus = case resultStatus r of
165+ Success -> Failure Nothing (Reason "Unexpected success")
166+ Failure _ _ -> Success
167+ x -> x
168+ }
169+ }
170+ )