Add before hooks and a function instance to Example #1750
Conversation
| instance YesodDispatch site => Hspec.Example (r -> SIO (YesodExampleData site) a) where | ||
| type Arg (r -> SIO (YesodExampleData site) a) = | ||
| (TestApp site, r) | ||
|
|
||
| evaluateExample example params action = | ||
| Hspec.evaluateExample | ||
| (action $ \(testApp, r) -> do | ||
| yed <- yesodExampleDataFromTestApp testApp | ||
| _ <- evalSIO (example r) yed | ||
| return ()) | ||
| params | ||
| ($ ()) |
There was a problem hiding this comment.
This lets us use beforeApp and provide the value created as a lambda.
beforeApp (pure "asdf") $ do
it "has asdf" $ \asdf -> do
pure () :: YesodExample site ()
liftIO $ asdf `shouldBe` "asdf"| , yedResponse = Nothing | ||
| } | ||
| yed <- yesodExampleDataFromApp site | ||
| evalSIO y yed |
There was a problem hiding this comment.
So, a problem with the current implementation (as surfaced in the pending test), is that we can't persist state from the YesodExampleData that is generated. We're doing evalSIO y yed and throwing away the modified state.
This means our beforeApp and beforeWithApp hooks can modify the database and return database entities, but those entities (and any changes made to the app, like sessions or logins) won't be kept.
A proper fix would probably thread the YesodExampleData through the whole thing, and then only let it get cleared out in the Example instance.
There was a problem hiding this comment.
I haven't looked in depth yet, but would using a mutable variable be a solution here?
There was a problem hiding this comment.
The SIO stuff is already a mutable variable. We're just not threading it through and re-using it afterwards.
| describe "Root Route" $ do | ||
| beforeApp (get ("/" :: Text)) $ do | ||
| it "can do stuff" $ \() -> do | ||
| liftIO $ pendingWith "This test currently fails because the SIO type can't share the state. When we do an `evalSIO` in `beforeApp`, that throws away all the changes made, so requests are not persisted." |
Before submitting your PR, check that you've:
@sincedeclarations to the Haddocks for new, public APIsAfter submitting your PR: