@@ -1,170 +1,144 @@
1−{-# LANGUAGE DerivingVia #-}
2−{-# LANGUAGE LambdaCase #-}
31{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE RecordWildCards #-}
52{-# LANGUAGE StandaloneDeriving #-}
3+{-# LANGUAGE RecordWildCards #-}
64{-# LANGUAGE TypeApplications #-}
7−{-# LANGUAGE RankNTypes #-}
8−{-# LANGUAGE FlexibleContexts #-}
9−{-# LANGUAGE AllowAmbiguousTypes #-}
10−{-# LANGUAGE ScopedTypeVariables #-}
11−{-# LANGUAGE DataKinds #-}
12−{-# OPTIONS_GHC -fno-warn-orphans #-}
13−{-# LANGUAGE TypeFamilies #-}
5+{-# LANGUAGE LambdaCase #-}
6+{-# LANGUAGE DerivingVia #-}
147
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)
8+{-# OPTIONS_GHC -fno-warn-orphans #-}
209import qualified Foo
10+import qualified Seeded
11+import qualified Valid
2112import qualified Headers
22−import qualified Nested
2313import qualified Post
24−import qualified Put
2514import 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
31−import Test.Hspec
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 )
15+import qualified Breakdown
16+import qualified Nested
3517
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((>=>))
18+import Test.Hspec.Core.Spec(ResultStatus(Failure,Success),resultStatus,itemExample,FailureReason(Reason),mapSpecItem_)
19+import Data.Dynamic(toDyn)
20+import qualified Roboservant as RS
21+import Test.Hspec
22+import Data.Void ( Void )
23+import Data.Maybe ( isNothing )
24+import Data.Hashable ( Hashable(hash) )
4125
4226main :: IO ()
4327main = hspec spec
4428
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 })
29+noCheck :: IO ()
30+noCheck = pure ()
31+
32+defaultConfig :: RS.Config
33+defaultConfig = RS.Config
34+ { RS.seed = []
35+ , RS.maxRuntime = 0.5
36+ , RS.maxReps = 1000
37+ , RS.rngSeed = 0
38+ , RS.coverageThreshold = 0
39+ }
6440
6541spec :: Spec
6642spec = do
6743 describe "Basic usage" $ do
6844 describe "noError" $ do
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)
81−
82−
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)
86−
45+ it "finds no error in a valid app" $ do
46+ RS.fuzz @Valid.Api Valid.server defaultConfig noCheck
47+ >>= (`shouldSatisfy` isNothing)
48+ it "finds no error in a valid generic app" $ do
49+ RS.fuzz @Valid.RoutedApi Valid.routedServer defaultConfig noCheck
50+ >>= (`shouldSatisfy` isNothing)
51+
52+ it "does fail coverage check" $ do
53+ r <- RS.fuzz @Valid.Api Valid.server defaultConfig { RS.coverageThreshold = 0.6 } noCheck
54+ fmap (RS.failureReason . RS.rsException) r `shouldSatisfy`
55+ (\case
56+ Just (RS.InsufficientCoverage _) -> True
57+ _ -> False)
58+
59+ describe "posted body" $ do
60+ it "passes a coverage check using a posted body" $ do
61+ RS.fuzz @Post.Api Post.server defaultConfig { RS.coverageThreshold = 0.99 } noCheck
62+ >>= (`shouldSatisfy` isNothing)
8763
8864 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)
65+ shouldFail $
66+ it "finds an error using information passed in" $
67+ let res = Seeded.Seed 1 in
68+ RS.fuzz @Seeded.Api Seeded.server (defaultConfig{ RS.seed = [(toDyn res,hash res) ] }) noCheck
69+ >>= (`shouldSatisfy` isNothing)
70+ describe "Foo" $ do
71+ it "finds an error in a basic app" $
72+ RS.fuzz @Foo.Api Foo.server defaultConfig noCheck
73+ >>= (`shouldSatisfy` serverFailure)
9374
94− describe "Foo" $
95− fuzzBoth @Foo.Api "finds an error in a basic app" Foo.server R.defaultConfig (`shouldSatisfy` serverFailure)
75+ describe "BuildFrom" $ do
76+ describe "headers (and sum types)" $ do
77+ it "should find a failure that's dependent on using header info" $ do
78+ RS.fuzz @Headers.Api Headers.server defaultConfig noCheck
79+ >>= (`shouldSatisfy` serverFailure)
9680
97− describe "QueryParams" $
98− fuzzBoth @QueryParams.Api "can handle query params" QueryParams.server R.defaultConfig { R.seed = [R.hashedDyn (12::Int)] }
99− (`shouldSatisfy` isNothing)
81+ describe "product types" $ do
82+ it "should find a failure that's dependent on creating a product" $ do
83+ RS.fuzz @Product.Api Product.server defaultConfig { RS.seed = [RS.hashedDyn 'a', RS.hashedDyn (1::Int)]} noCheck
84+ >>= (`shouldSatisfy` serverFailure)
10085
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)
10986 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)
117−
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
87+ it "handles products" $ do
88+ RS.fuzz @Breakdown.ProductApi Breakdown.productServer defaultConfig noCheck
89+ >>= (`shouldSatisfy` serverFailure)
12490
125−deriving via (R.Atom Foo.Foo) instance R.Breakdown Foo.Foo
91+ it "handles sums" $ do
92+ RS.fuzz @Breakdown.SumApi Breakdown.sumServer defaultConfig noCheck
93+ >>= (`shouldSatisfy` serverFailure)
12694
127−deriving via (R.Atom Foo.Foo) instance R.BuildFrom Foo.Foo
95+ describe "flattening" $ do
96+ -- | we don't actually do much here, this is just here to document the appropriate response
97+ -- if you get a type error with a nested api.
98+ it "can handle nested apis" $ do
99+ RS.fuzz @(Nested.FlatApi) Nested.server defaultConfig { RS.coverageThreshold = 0.99 } noCheck
100+ >>= (`shouldSatisfy` isNothing)
128101
129−deriving via (R.Atom Headers.Foo) instance R.Breakdown Headers.Foo
130102
131−deriving via (R.Atom Headers.Foo) instance R.BuildFrom Headers.Foo
132103
133−deriving via (R.Atom Seeded.Seed) instance R.Breakdown Seeded.Seed
104+serverFailure :: Maybe RS.Report -> Bool
105+serverFailure = \case
106+ Just RS.Report{..} ->
107+ let RS.RoboservantException{..} = rsException
108+ in failureReason /= RS.NoPossibleMoves
109+ _ -> False
134110
135−deriving via (R.Atom Seeded.Seed) instance R.BuildFrom Seeded.Seed
136111
137−deriving via (R.Atom Void) instance R.BuildFrom Void
112+deriving via (RS.Atom Foo.Foo) instance RS.Breakdown Foo.Foo
113+deriving via (RS.Atom Foo.Foo) instance RS.BuildFrom Foo.Foo
138114
139−deriving via (R.Atom Post.FooPost) instance R.Breakdown Post.FooPost
140−deriving via (R.Atom Post.FooPost) instance R.BuildFrom Post.FooPost
115+deriving via (RS.Atom Headers.Foo) instance RS.Breakdown Headers.Foo
116+deriving via (RS.Atom Headers.Foo) instance RS.BuildFrom Headers.Foo
141117
142−deriving via (R.Atom Put.Foo) instance R.Breakdown Put.Foo
143−deriving via (R.Atom Put.Foo) instance R.BuildFrom Put.Foo
118+deriving via (RS.Atom Seeded.Seed) instance RS.Breakdown Seeded.Seed
119+deriving via (RS.Atom Seeded.Seed) instance RS.BuildFrom Seeded.Seed
144120
145121
122+-- instance RS.BuildFrom Seeded.Seed
146123
147−deriving via (R.Compound Breakdown.Foo) instance R.Breakdown Breakdown.Foo
124+deriving via (RS.Atom Void) instance RS.BuildFrom Void
148125
149−deriving via (R.Compound Product.Foo) instance R.BuildFrom Product.Foo
126+deriving via (RS.Atom Post.FooPost) instance RS.BuildFrom Post.FooPost
127+deriving via (RS.Atom Post.FooPost) instance RS.Breakdown Post.FooPost
150128
151−deriving via (R.Compound Breakdown.SomeSum) instance R.Breakdown Breakdown.SomeSum
129+deriving via (RS.Compound Product.Foo) instance RS.BuildFrom Product.Foo
130+deriving via (RS.Compound Breakdown.Foo) instance RS.Breakdown Breakdown.Foo
131+deriving via (RS.Compound Breakdown.SomeSum) instance RS.Breakdown Breakdown.SomeSum
152132
153133-- | `shouldFail` allows you to assert that a given `Spec` should contain at least one failing test.
154134-- this is often useful when testing tests.
155135shouldFail :: SpecWith a -> SpecWith a
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− )
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+ })