test(spec): inline config into test suite

Previously, information about each test-suite was repeated in 3 separate
places:
- as a label and as implicit knowledge in the test-suite itself,
- as a comment in Main.hs, and
- as a configuration in SpecHelper.hs.

With this change, there will be a single source of truth in the test
suite itself. This will allow a single test-suite to easily test
multiple different configurations.

test/spec/Feature/OpenApi/DisabledOpenApiSpec.hs

@@ -1,16 +1,18 @@
 module Feature.OpenApi.DisabledOpenApiSpec where
 
 import Network.HTTP.Types
-import Network.Wai        (Application)
 
 import Test.Hspec
 import Test.Hspec.Wai
 import Test.Hspec.Wai.JSON
 
-import Protolude
+import PostgREST.Config (AppConfig (..), OpenAPIMode (..))
 
-spec :: SpecWith ((), Application)
-spec =
+import Protolude
+import SpecHelper
+
+spec :: SpecWithConfig
+spec withConfig = withConfig (baseCfg { configOpenApiMode = OADisabled }) $
   describe "Disabled OpenApi" $ do
     it "responds with 404" $
       request methodGet "/"

test/spec/Feature/OpenApi/IgnorePrivOpenApiSpec.hs

@@ -4,19 +4,26 @@ import Control.Lens ((^?))
 
 import Data.Aeson.Lens
 import Data.Aeson.QQ
+import Data.List.NonEmpty (fromList)
 
 import Network.HTTP.Types
-import Network.Wai        (Application)
 import Network.Wai.Test   (SResponse (..))
 
 import Test.Hspec     hiding (pendingWith)
 import Test.Hspec.Wai
 
+import PostgREST.Config (AppConfig (..), OpenAPIMode (..))
+
 import Protolude  hiding (get)
 import SpecHelper
 
-spec :: SpecWith ((), Application)
-spec = describe "OpenAPI Ignore Privileges" $ do
+spec :: SpecWithConfig
+spec withConfig = withConfig (
+    baseCfg {
+      configOpenApiMode = OAIgnorePriv
+    , configDbSchemas = fromList ["test", "v1"]
+    }
+  ) $ describe "OpenAPI Ignore Privileges" $ do
   it "root path returns a valid openapi spec" $ do
     validateOpenApiResponse [("Accept", "application/openapi+json")]
     request methodHead "/"

test/spec/Feature/OpenApi/OpenApiSpec.hs

@@ -2,7 +2,6 @@ module Feature.OpenApi.OpenApiSpec where
 
 import Control.Lens     ((^?))
 import Data.Aeson.Types (Value (..))
-import Network.Wai      (Application)
 import Network.Wai.Test (SResponse (..))
 
 import Data.Aeson.Lens
@@ -15,8 +14,8 @@ import PostgREST.Version (docsVersion)
 import Protolude         hiding (get)
 import SpecHelper
 
-spec :: SpecWith ((), Application)
-spec = describe "OpenAPI" $ do
+spec :: SpecWithConfig
+spec withConfig = withConfig baseCfg $ describe "OpenAPI" $ do
   it "root path returns a valid openapi spec" $ do
     validateOpenApiResponse [("Accept", "application/openapi+json")]
     request methodHead "/"

test/spec/Feature/OpenApi/ProxySpec.hs

@@ -1,13 +1,14 @@
 module Feature.OpenApi.ProxySpec where
 
-import Network.Wai (Application)
-import Test.Hspec  hiding (pendingWith)
+import Test.Hspec hiding (pendingWith)
+
+import PostgREST.Config (AppConfig (..))
 
 import Protolude
 import SpecHelper
 
-spec :: SpecWith ((), Application)
-spec =
+spec :: SpecWithConfig
+spec withConfig = withConfig (baseCfg { configOpenApiServerProxyUri = Just "https://postgrest.com/openapi.json" }) $
   describe "GET / with proxy" $
     it "returns a valid openapi spec with proxy" $
       validateOpenApiResponse [("Accept", "application/openapi+json")]

test/spec/Feature/OpenApi/RootSpec.hs

@@ -1,16 +1,19 @@
 module Feature.OpenApi.RootSpec where
 
 import Network.HTTP.Types
-import Network.Wai        (Application)
 
 import Test.Hspec          hiding (pendingWith)
 import Test.Hspec.Wai
 import Test.Hspec.Wai.JSON
 
-import Protolude hiding (get)
+import PostgREST.Config                  (AppConfig (..))
+import PostgREST.SchemaCache.Identifiers (QualifiedIdentifier (..))
 
-spec :: SpecWith ((), Application)
-spec =
+import Protolude  hiding (get)
+import SpecHelper
+
+spec :: SpecWithConfig
+spec withConfig = withConfig (baseCfg { configDbRootSpec = Just $ QualifiedIdentifier mempty "root" }) $
   describe "root spec function" $ do
     it "accepts application/openapi+json" $ do
       request methodGet "/"

test/spec/Feature/OpenApi/SecurityOpenApiSpec.hs

@@ -5,16 +5,18 @@ import Control.Lens ((^?))
 import Data.Aeson.Lens
 import Data.Aeson.QQ
 
-import Network.Wai      (Application)
 import Network.Wai.Test (SResponse (..))
 
 import Test.Hspec     hiding (pendingWith)
 import Test.Hspec.Wai
 
-import Protolude hiding (get)
+import PostgREST.Config (AppConfig (..))
 
-spec :: SpecWith ((), Application)
-spec =
+import Protolude  hiding (get)
+import SpecHelper
+
+spec :: SpecWithConfig
+spec withConfig = withConfig (baseCfg { configOpenApiSecurityActive = True }) $
   describe "Security active" $
     it "includes security and security definitions" $ do
       r <- simpleBody <$> get "/"