Merge pull request #649 from hudayou/proxy-awareness

Add proxy awareness for OpenAPI spec generation

test/Feature/ProxySpec.hs

@@ -0,0 +1,13 @@
+module Feature.ProxySpec where
+
+import Test.Hspec hiding (pendingWith)
+
+import SpecHelper
+
+import Network.Wai (Application)
+
+spec :: SpecWith Application
+spec =
+  describe "GET / with proxy" $
+    it "returns a valid openapi spec with proxy" $
+      validateOpenApiResponse [("Accept", "application/openapi+json")]

test/Feature/StructureSpec.hs

@@ -3,16 +3,12 @@ module Feature.StructureSpec where
 import Test.Hspec hiding (pendingWith)
 import Test.Hspec.Wai
 import Test.Hspec.Wai.JSON
+import Network.HTTP.Types
 
 import SpecHelper
 
-import Network.HTTP.Types
 import Network.Wai (Application)
-import Network.Wai.Test (SResponse(simpleStatus, simpleHeaders, simpleBody))
-
-import Data.Maybe (fromJust)
-import Data.Aeson (decode)
-import qualified Data.JsonSchema.Draft4 as D4
+import Network.Wai.Test (SResponse(simpleHeaders))
 
 spec :: SpecWith Application
 spec = do
@@ -65,27 +61,8 @@ spec = do
         ] |]
         {matchStatus = 200}
 
-    it "returns a valid openapi spec" $ do
-      r <- request methodGet "/" [("Accept", "application/openapi+json")] ""
-      liftIO $
-        let respStatus = simpleStatus r in
-        respStatus `shouldSatisfy`
-          \s -> s == Status { statusCode = 200, statusMessage="OK" }
-      liftIO $
-        let respHeaders = simpleHeaders r in
-        respHeaders `shouldSatisfy`
-          \hs -> ("Content-Type", "application/openapi+json; charset=utf-8") `elem` hs
-      liftIO $
-        let respBody = simpleBody r
-            schema :: D4.Schema
-            schema = D4.emptySchema { D4._schemaRef = Just "openapi.json" }
-            schemaContext :: D4.SchemaWithURI D4.Schema
-            schemaContext = D4.SchemaWithURI
-              { D4._swSchema = schema
-              , D4._swURI    = Just "test/fixtures/openapi.json"
-              }
-           in
-           D4.fetchFilesystemAndValidate schemaContext ((fromJust . decode) respBody) `shouldReturn` Right ()
+    it "returns a valid openapi spec" $
+      validateOpenApiResponse [("Accept", "application/openapi+json")]
 
     it "should respond to openapi request on none root path with 415" $
       request methodGet "/none_root_path"

test/Main.hs

@@ -20,6 +20,7 @@ import qualified Feature.QuerySpec
 import qualified Feature.RangeSpec
 import qualified Feature.StructureSpec
 import qualified Feature.UnicodeSpec
+import qualified Feature.ProxySpec
 
 main :: IO ()
 main = do
@@ -32,6 +33,7 @@ main = do
   let withApp = return $ postgrest testCfg refDbStructure pool
       ltdApp  = return $ postgrest testLtdRowsCfg refDbStructure pool
       unicodeApp = return $ postgrest testUnicodeCfg refDbStructure pool
+      proxyApp = return $ postgrest testProxyCfg refDbStructure pool
 
   hspec $ do
     mapM_ (beforeAll_ resetDb . before withApp) specs
@@ -44,6 +46,10 @@ main = do
     beforeAll_ resetDb . before unicodeApp $
       describe "Feature.UnicodeSpec" Feature.UnicodeSpec.spec
 
+    -- this test runs with a proxy
+    beforeAll_ resetDb . before proxyApp $
+      describe "Feature.ProxySpec" Feature.ProxySpec.spec
+
  where
   specs = map (uncurry describe) [
       ("Feature.AuthSpec"         , Feature.AuthSpec.spec)

test/SpecHelper.hs

@@ -3,8 +3,6 @@ module SpecHelper where
 import Data.String.Conversions (cs)
 import Control.Monad (void)
 
-import Network.HTTP.Types.Header (Header, ByteRange, renderByteRange,
-                                  hRange, hAuthorization, hAccept)
 import Codec.Binary.Base64.String (encode)
 import Data.CaseInsensitive (CI(..))
 import Text.Regex.TDFA ((=~))
@@ -14,20 +12,57 @@ import Web.JWT (secret)
 
 import PostgREST.Config (AppConfig(..))
 
+import Test.Hspec hiding (pendingWith)
+import Test.Hspec.Wai
+
+import Network.HTTP.Types
+import Network.Wai.Test (SResponse(simpleStatus, simpleHeaders, simpleBody))
+
+import Data.Maybe (fromJust)
+import Data.Aeson (decode)
+import qualified Data.JsonSchema.Draft4 as D4
+
+validateOpenApiResponse :: [Header] -> WaiSession ()
+validateOpenApiResponse headers = do
+  r <- request methodGet "/" headers ""
+  liftIO $
+    let respStatus = simpleStatus r in
+    respStatus `shouldSatisfy`
+      \s -> s == Status { statusCode = 200, statusMessage="OK" }
+  liftIO $
+    let respHeaders = simpleHeaders r in
+    respHeaders `shouldSatisfy`
+      \hs -> ("Content-Type", "application/openapi+json; charset=utf-8") `elem` hs
+  liftIO $
+    let respBody = simpleBody r
+        schema :: D4.Schema
+        schema = D4.emptySchema { D4._schemaRef = Just "openapi.json" }
+        schemaContext :: D4.SchemaWithURI D4.Schema
+        schemaContext = D4.SchemaWithURI
+          { D4._swSchema = schema
+          , D4._swURI    = Just "test/fixtures/openapi.json"
+          }
+       in
+       D4.fetchFilesystemAndValidate schemaContext ((fromJust . decode) respBody) `shouldReturn` Right ()
+
 testDbConn :: String
 testDbConn = "postgres://postgrest_test_authenticator@localhost:5432/postgrest_test"
 
 testCfg :: AppConfig
 testCfg =
-  AppConfig testDbConn "postgrest_test_anonymous" "test" "localhost" 3000 (secret "safe") 10 Nothing True
+  AppConfig testDbConn "postgrest_test_anonymous" Nothing "test" "localhost" 3000 (secret "safe") 10 Nothing True
 
 testUnicodeCfg :: AppConfig
 testUnicodeCfg =
-  AppConfig testDbConn "postgrest_test_anonymous" "تست" "localhost" 3000 (secret "safe") 10 Nothing True
+  AppConfig testDbConn "postgrest_test_anonymous" Nothing "تست" "localhost" 3000 (secret "safe") 10 Nothing True
 
 testLtdRowsCfg :: AppConfig
 testLtdRowsCfg =
-  AppConfig testDbConn "postgrest_test_anonymous" "test" "localhost" 3000 (secret "safe") 10 (Just 2) True
+  AppConfig testDbConn "postgrest_test_anonymous" Nothing "test" "localhost" 3000 (secret "safe") 10 (Just 2) True
+
+testProxyCfg :: AppConfig
+testProxyCfg =
+  AppConfig testDbConn "postgrest_test_anonymous" (Just "https://postgrest.com/openapi.json") "test" "localhost" 3000 (secret "safe") 10 Nothing True
 
 setupDb :: IO ()
 setupDb = do