Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ability to send non-valid Json payload in the request. #131

Merged
merged 3 commits into from
Mar 29, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 28 additions & 6 deletions test/integration/Main.hs
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE QuasiQuotes #-}

module Main where

Expand All @@ -23,7 +24,13 @@ import Network.HTTP.Types.Status
import Test.Hspec
( SpecWith, afterAll, beforeAll, describe, hspec, it, shouldBe )
import Test.Integration.Framework.DSL
( Context (..), expectResponseCode, request )
( Context (..)
, Headers (..)
, Payload (..)
, expectResponseCode
, json
, request
)

import qualified Cardano.Wallet.Network.HttpBridgeSpec as HttpBridge
import qualified Cardano.WalletSpec as Wallet
Expand Down Expand Up @@ -111,18 +118,33 @@ dummySetup = do
respCodesSpec :: SpecWith Context
respCodesSpec = do
it "GET; Response code 200" $ \ctx -> do
response <- request @Value ctx ("GET", "/get?my=arg") Nothing Nothing
response <- request @Value ctx ("GET", "/get?my=arg") Default Empty
expectResponseCode @IO status200 response

it "GET; Response code 404" $ \ctx -> do
response <- request @Value ctx ("GET", "/get/nothing") Nothing Nothing
response <- request @Value ctx ("GET", "/get/nothing") Default Empty
expectResponseCode @IO status404 response

it "POST; Response code 200" $ \ctx -> do
let header = [("dummy", "header")]
response <- request @Value ctx ("POST", "/post") (Just header) Nothing
let headers = Headers [("dummy", "header")]
let payload = Json [json| {
"addressPoolGap": 70,
"assuranceLevel": "strict",
"name": "Wallet EOS"
} |]
response <- request @Value ctx ("POST", "/post") headers payload
expectResponseCode @IO status200 response

it "POST; Response code 200" $ \ctx -> do
let headers = Headers [("dummy", "header")]
let payloadInvalid = NonJson "{\
\\"addressPoolGap: 70,\
\\"assuranceLevel\": strict,\
\\"name\": \"Wallet EOS\"\
\}"
response <- request @Value ctx ("POST", "/post") headers payloadInvalid
expectResponseCode @IO status200 response

it "POST; Response code 405" $ \ctx -> do
response <- request @Value ctx ("POST", "/get") Nothing Nothing
response <- request @Value ctx ("POST", "/get") None Empty
expectResponseCode @IO status405 response
10 changes: 9 additions & 1 deletion test/integration/Test/Integration/Framework/DSL.hs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ module Test.Integration.Framework.DSL
, expectSuccess
, expectError
, expectResponseCode
, Headers(..)
, Payload(..)
, RequestException(..)

-- * Helpers
Expand All @@ -35,7 +37,13 @@ import Language.Haskell.TH.Quote
import Test.Hspec.Expectations.Lifted
( shouldBe )
import Test.Integration.Framework.Request
( Context (..), RequestException (..), request, unsafeRequest )
( Context (..)
, Headers (..)
, Payload (..)
, RequestException (..)
, request
, unsafeRequest
)
import Web.HttpApiData
( ToHttpApiData (..) )

Expand Down
45 changes: 32 additions & 13 deletions test/integration/Test/Integration/Framework/Request.hs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
module Test.Integration.Framework.Request
( request
, unsafeRequest
, Headers(..)
, Payload(..)
, RequestException(..)
, Context(..)
) where
Expand All @@ -24,8 +26,6 @@ import Data.Aeson
( FromJSON )
import Data.ByteString.Lazy
( ByteString )
import Data.Maybe
( fromMaybe )
import Data.Text
( Text )
import Network.HTTP.Client
Expand Down Expand Up @@ -72,6 +72,19 @@ data RequestException

instance Exception RequestException

-- | The payload of the request
data Payload
= Json Aeson.Value
| NonJson ByteString
| Empty

-- | The headers of the request
data Headers
= Headers RequestHeaders
| Default
| None
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sweet ❤️


-- | Makes a request to the API and decodes the response.
request
:: forall a m.
( FromJSON a
Expand All @@ -82,9 +95,9 @@ request
=> Context
-> (Method, Text)
-- ^ HTTP method and request path
-> Maybe RequestHeaders
-> Headers
-- ^ Request headers
-> Maybe Aeson.Value
-> Payload
-- ^ Request body
-> m (HTTP.Status, Either RequestException a)
request (Context _ (base, manager)) (verb, path) reqHeaders body = do
Expand All @@ -94,15 +107,21 @@ request (Context _ (base, manager)) (verb, path) reqHeaders body = do
prepareReq :: HTTP.Request -> HTTP.Request
prepareReq req = req
{ method = verb
, requestBody = maybe mempty (RequestBodyLBS . Aeson.encode) body
, requestHeaders = fromMaybe defaultHeaders reqHeaders
, requestBody = payload
, requestHeaders = headers
}
where
headers = case reqHeaders of
Headers x -> x
Default -> [ ("Content-Type", "application/json")
, ("Accept", "application/json")
]
None -> mempty

defaultHeaders :: RequestHeaders
defaultHeaders =
[ ("Content-Type", "application/json")
, ("Accept", "application/json")
]
payload = case body of
Json x -> (RequestBodyLBS . Aeson.encode) x
NonJson x -> RequestBodyLBS x
Empty -> mempty

handleResponse res = case responseStatus res of
s | s < status500 -> maybe
Expand All @@ -125,8 +144,8 @@ unsafeRequest
)
=> Context
-> (Method, Text)
-> Maybe Aeson.Value
-> Payload
-> m (HTTP.Status, a)
unsafeRequest ctx req body = do
(s, res) <- request ctx req Nothing body
(s, res) <- request ctx req Default body
either throwM (pure . (s,)) res