From 78280dc2672edac8551c5447d78203543ca0e0d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20Deest?= Date: Tue, 19 Apr 2022 10:46:39 +0200 Subject: [PATCH] Disable hspec colored output in servant-swagger doctests Colored output is the default since hspec 2.9.5. This causes CI failures due to terminal escaping characters when running the doctests on GitHub Actions. --- servant-swagger/src/Servant/Swagger.hs | 2 ++ servant-swagger/src/Servant/Swagger/Internal/Test.hs | 2 ++ 2 files changed, 4 insertions(+) diff --git a/servant-swagger/src/Servant/Swagger.hs b/servant-swagger/src/Servant/Swagger.hs index 0ceea5bc..9d44b69c 100644 --- a/servant-swagger/src/Servant/Swagger.hs +++ b/servant-swagger/src/Servant/Swagger.hs @@ -55,6 +55,7 @@ import Servant.Swagger.Internal.Orphans () -- >>> import Data.Typeable -- >>> import GHC.Generics -- >>> import Servant.API +-- >>> import System.Environment -- >>> import Test.Hspec -- >>> import Test.QuickCheck -- >>> import qualified Data.ByteString.Lazy.Char8 as BSL8 @@ -64,6 +65,7 @@ import Servant.Swagger.Internal.Orphans () -- >>> :set -XGeneralizedNewtypeDeriving -- >>> :set -XOverloadedStrings -- >>> :set -XTypeOperators +-- >>> setEnv "HSPEC_COLOR" "no" -- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable) -- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON) -- >>> instance ToJSON User diff --git a/servant-swagger/src/Servant/Swagger/Internal/Test.hs b/servant-swagger/src/Servant/Swagger/Internal/Test.hs index e1e32766..93e9d08e 100644 --- a/servant-swagger/src/Servant/Swagger/Internal/Test.hs +++ b/servant-swagger/src/Servant/Swagger/Internal/Test.hs @@ -29,10 +29,12 @@ import Servant.Swagger.Internal.TypeLevel -- >>> import Control.Applicative -- >>> import GHC.Generics -- >>> import Test.QuickCheck +-- >>> import System.Environment (setEnv) -- >>> :set -XDeriveGeneric -- >>> :set -XGeneralizedNewtypeDeriving -- >>> :set -XDataKinds -- >>> :set -XTypeOperators +-- >>> setEnv "HSPEC_COLOR" "no" -- | Verify that every type used with @'JSON'@ content type in a servant API -- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSON'@.