Make sure integration tests use most recent API version (#2695)

* Avoid qualified Util import

* Use viewGalley everywhere

* Add v2 prefix to all galley requests

* Add v2 prefix to all brig requests

* client tests

* account tests

* auth tests wip

* Fix one more client test

* Add versioned paths to legalhold ACL

* Refactor: factor out test cases

* fix bug: regex routes match too much

* Fix the remaining brig tests

* Use versioned API in cargohold tests

* Always use most recent version in galley tests

* Use latest API version in brig

* Use latest API version in cargohold

* Use v1 API in End2End tests

* Add CHANGELOG entry

Co-authored-by: Stefan Matting <[email protected]>

Author: pcapriotti

changelog.d/5-internal/integration-test-version

@@ -0,0 +1 @@
+Make test API calls point to the most recent version by default

deploy/services-demo/conf/nginz/nginx.conf

@@ -214,7 +214,7 @@ http {
       proxy_pass http://brig;
     }
 
-    location ~* ^/teams/invitations/([^/]*)$ {
+    location ~* ^(/v[0-9]+)?/teams/invitations/([^/]*)$ {
       include common_response_no_zauth.conf;
       proxy_pass http://brig;
     }
@@ -226,7 +226,7 @@ http {
 
     ## brig authenticated endpoints
 
-    location /self {
+    location ~* ^(/v[0-9]+)?/self$ {
       include common_response_with_zauth.conf;
       proxy_pass http://brig;
     }
@@ -261,7 +261,7 @@ http {
       proxy_pass http://brig;
     }
 
-    location /clients {
+    location ~* ^(/v[0-9]+)?/clients$ {
       include common_response_with_zauth.conf;
       proxy_pass http://brig;
     }
@@ -325,7 +325,7 @@ http {
       proxy_pass http://galley;
     }
 
-    location ~* /legalhold/conversations/(.*) {
+    location ~* ^(/v[0-9]+)?/legalhold/conversations/(.*)$ {
       include common_response_with_zauth.conf;
       proxy_pass http://galley;
     }
@@ -454,7 +454,7 @@ http {
       proxy_pass http://gundeck;
     }
 
-    location /notifications {
+    location ~* ^(/v[0-9]+)?/notifications$ {
       include common_response_with_zauth.conf;
       proxy_pass http://gundeck;
     }

libs/wire-api/src/Wire/API/Routes/Version.hs

@@ -73,6 +73,10 @@ instance FromHttpApiData Version where
   parseHeader = first Text.pack . Aeson.eitherDecode . LBS.fromStrict
   parseUrlPiece = parseHeader . Text.encodeUtf8
 
+instance ToHttpApiData Version where
+  toHeader = LBS.toStrict . Aeson.encode
+  toUrlPiece = Text.decodeUtf8 . toHeader
+
 supportedVersions :: [Version]
 supportedVersions = [minBound .. maxBound]
 

services/brig/test/integration/API/Internal.hs

@@ -363,7 +363,7 @@ testAddKeyPackageRef brig = do
 
 getFeatureConfig :: forall cfg m. (MonadIO m, MonadHttp m, HasCallStack, ApiFt.IsFeatureConfig cfg, KnownSymbol (ApiFt.FeatureSymbol cfg)) => (Request -> Request) -> UserId -> m ResponseLBS
 getFeatureConfig galley uid = do
-  get $ galley . paths ["feature-configs", featureNameBS @cfg] . zUser uid
+  get $ apiVersion "v1" . galley . paths ["feature-configs", featureNameBS @cfg] . zUser uid
 
 getAllFeatureConfigs :: (MonadIO m, MonadHttp m, HasCallStack) => (Request -> Request) -> UserId -> m ResponseLBS
 getAllFeatureConfigs galley uid = do

services/brig/test/integration/API/Metrics.hs

@@ -51,8 +51,9 @@ testPrometheusMetrics brig = do
     const (Just "TYPE http_request_duration_seconds histogram") =~= responseBody
 
 testMetricsEndpoint :: Brig -> Http ()
-testMetricsEndpoint brig = do
-  let p1 = "/self"
+testMetricsEndpoint brig0 = do
+  let brig = apiVersion "v1" . brig0
+      p1 = "/self"
       p2 uid = "/users/" <> uid <> "/clients"
       p3 = "/login"
   beforeSelf <- getCount "/self" "GET"
@@ -73,7 +74,7 @@ testMetricsEndpoint brig = do
   liftIO $ assertEqual "/login was called twice" (beforeProperties + 2) countProperties
   where
     getCount endpoint m = do
-      rsp <- responseBody <$> get (brig . path "i/metrics")
+      rsp <- responseBody <$> get (brig0 . path "i/metrics")
       -- is there some responseBodyAsText function used elsewhere?
       let asText = fromMaybe "" (fromByteString' (fromMaybe "" rsp))
       pure $ fromRight 0 (parseOnly (parseCount endpoint m) asText)

services/brig/test/integration/API/Settings.hs

@@ -125,7 +125,7 @@ testUsersEmailVisibleIffExpected opts brig galley viewingUserIs visibilitySettin
           ]
   let newOpts = opts & Opt.optionSettings . Opt.emailVisibility .~ visibilitySetting
   withSettingsOverrides newOpts $ do
-    get (brig . zUser viewerId . path "users" . queryItem "ids" uids) !!! do
+    get (apiVersion "v1" . brig . zUser viewerId . path "users" . queryItem "ids" uids) !!! do
       const 200 === statusCode
       const (Just expected) === result
   where
@@ -155,7 +155,7 @@ testGetUserEmailShowsEmailsIffExpected opts brig galley viewingUserIs visibility
   let newOpts = opts & Opt.optionSettings . Opt.emailVisibility .~ visibilitySetting
   withSettingsOverrides newOpts $ do
     forM_ expectations $ \(uid, expectedEmail) ->
-      get (brig . zUser viewerId . paths ["users", toByteString' uid]) !!! do
+      get (apiVersion "v1" . brig . zUser viewerId . paths ["users", toByteString' uid]) !!! do
         const 200 === statusCode
         const expectedEmail === emailResult
   where

services/brig/test/integration/API/Team.hs

@@ -24,7 +24,7 @@ where
 
 import qualified API.Search.Util as SearchUtil
 import API.Team.Util
-import API.User.Util as Util hiding (listConnections)
+import API.User.Util as Util
 import Bilge hiding (accept, head, timeout)
 import qualified Bilge
 import Bilge.Assert
@@ -218,9 +218,9 @@ testInvitationEmailLookupNginz brig nginz = do
   -- expect an invitation to be found querying with email after invite
   headInvitationByEmail nginz email 200
 
-headInvitationByEmail :: Brig -> Email -> Int -> Http ()
-headInvitationByEmail brig email expectedCode =
-  Bilge.head (brig . path "/teams/invitations/by-email" . contentJson . queryItem "email" (toByteString' email))
+headInvitationByEmail :: (Request -> Request) -> Email -> Int -> Http ()
+headInvitationByEmail service email expectedCode =
+  Bilge.head (service . path "/teams/invitations/by-email" . contentJson . queryItem "email" (toByteString' email))
     !!! const expectedCode === statusCode
 
 testInvitationTooManyPending :: Brig -> TeamSizeLimit -> Http ()
@@ -383,7 +383,9 @@ createAndVerifyInvitation' replacementBrigApp acceptFn invite brig galley = do
   mem <- getTeamMember invitee tid galley
   liftIO $ assertEqual "Member not part of the team" invitee (mem ^. Member.userId)
   liftIO $ assertEqual "Member has no/wrong invitation metadata" invmeta (mem ^. Member.invitation)
-  conns <- listConnections invitee brig
+  conns <-
+    responseJsonError =<< listConnections brig invitee
+      <!! const 200 === statusCode
   liftIO $ assertBool "User should have no connections" (null (clConnections conns) && not (clHasMore conns))
   pure (responseJsonMaybe rsp2, invitation)
 

services/brig/test/integration/API/Team/Util.hs

@@ -38,7 +38,6 @@ import qualified Network.Wai.Utilities.Error as Error
 import Test.Tasty.HUnit
 import Util
 import Web.Cookie (parseSetCookie, setCookieName)
-import Wire.API.Connection
 import Wire.API.Conversation
 import Wire.API.Conversation.Protocol
 import Wire.API.Conversation.Role
@@ -343,15 +342,6 @@ register' e t c brig =
           )
     )
 
-listConnections :: HasCallStack => UserId -> Brig -> (MonadIO m, MonadHttp m, MonadThrow m) => m UserConnectionList
-listConnections u brig = do
-  responseJsonError
-    =<< get
-      ( brig
-          . path "connections"
-          . zUser u
-      )
-
 getInvitation :: Brig -> InvitationCode -> (MonadIO m, MonadHttp m) => m (Maybe Invitation)
 getInvitation brig c = do
   r <-

services/brig/test/integration/API/User/Account.hs

@@ -24,7 +24,7 @@ module API.User.Account
 where
 
 import qualified API.Search.Util as Search
-import API.Team.Util hiding (listConnections)
+import API.Team.Util
 import API.User.Util
 import Bilge hiding (accept, timeout)
 import Bilge.Assert
@@ -589,11 +589,11 @@ testNonExistingUserUnqualified :: Brig -> Http ()
 testNonExistingUserUnqualified brig = do
   findingOne <- liftIO $ Id <$> UUID.nextRandom
   foundOne <- liftIO $ Id <$> UUID.nextRandom
-  get (brig . paths ["users", pack $ show foundOne] . zUser findingOne)
+  get (apiVersion "v1" . brig . paths ["users", pack $ show foundOne] . zUser findingOne)
     !!! do
       const 404 === statusCode
       const (Just "not-found") === fmap Error.label . responseJsonMaybe
-  get (brig . paths ["users", pack $ show foundOne] . zUser foundOne)
+  get (apiVersion "v1" . brig . paths ["users", pack $ show foundOne] . zUser foundOne)
     !!! do
       const 404 === statusCode
       const (Just "not-found") === fmap Error.label . responseJsonMaybe
@@ -605,11 +605,11 @@ testNonExistingUser brig = do
   uid2 <- liftIO $ Id <$> UUID.nextRandom
   let uid = qUnqualified qself
       domain = qDomain qself
-  get (brig . paths ["users", toByteString' domain, toByteString' uid1] . zUser uid)
+  get (apiVersion "v1" . brig . paths ["users", toByteString' domain, toByteString' uid1] . zUser uid)
     !!! do
       const 404 === statusCode
       const (Just "not-found") === fmap Error.label . responseJsonMaybe
-  get (brig . paths ["users", toByteString' domain, toByteString' uid2] . zUser uid)
+  get (apiVersion "v1" . brig . paths ["users", toByteString' domain, toByteString' uid2] . zUser uid)
     !!! do
       const 404 === statusCode
       const (Just "not-found") === fmap Error.label . responseJsonMaybe
@@ -629,7 +629,7 @@ testUserInvalidDomain brig = do
 testExistingUserUnqualified :: Brig -> Http ()
 testExistingUserUnqualified brig = do
   uid <- userId <$> randomUser brig
-  get (brig . paths ["users", pack $ show uid] . zUser uid) !!! do
+  get (apiVersion "v1" . brig . paths ["users", pack $ show uid] . zUser uid) !!! do
     const 200 === statusCode
     const (Just uid)
       === ( \r -> do
@@ -643,7 +643,8 @@ testExistingUser brig = do
   let uid = qUnqualified quser
       domain = qDomain quser
   get
-    ( brig
+    ( apiVersion "v1"
+        . brig
         . zUser uid
         . paths
           [ "users",
@@ -664,7 +665,8 @@ testUserExistsUnqualified brig = do
   qself <- userQualifiedId <$> randomUser brig
   quser <- userQualifiedId <$> randomUser brig
   head
-    ( brig
+    ( apiVersion "v1"
+        . brig
         . paths ["users", toByteString' (qUnqualified quser)]
         . zUser (qUnqualified qself)
     )
@@ -726,7 +728,8 @@ testMultipleUsersUnqualified brig = do
             (Just $ userDisplayName u3, Nothing)
           ]
   get
-    ( brig
+    ( apiVersion "v1"
+        . brig
         . zUser (userId u1)
         . contentJson
         . path "users"
@@ -794,7 +797,7 @@ testCreateUserAnonExpiry b = do
   liftIO $ assertBool "Bob must be in deleted state" (fromMaybe False $ deleted resBob')
   where
     getProfile :: UserId -> UserId -> Http ResponseLBS
-    getProfile zusr uid = get (b . zUser zusr . paths ["users", toByteString' uid]) <!! const 200 === statusCode
+    getProfile zusr uid = get (apiVersion "v1" . b . zUser zusr . paths ["users", toByteString' uid]) <!! const 200 === statusCode
     awaitExpiry :: Int -> UserId -> UserId -> Http ()
     awaitExpiry n zusr uid = do
       -- after expiration, a profile lookup should trigger garbage collection of ephemeral users
@@ -818,7 +821,7 @@ testCreateUserAnonExpiry b = do
     field :: FromJSON a => Text -> Value -> Maybe a
     field f u = u ^? key f >>= maybeFromJSON
 
-testUserUpdate :: Brig -> Cannon -> AWS.Env -> Http ()
+testUserUpdate :: HasCallStack => Brig -> Cannon -> AWS.Env -> Http ()
 testUserUpdate brig cannon aws = do
   aliceUser <- randomUser brig
   liftIO $ Util.assertUserJournalQueue "user create alice" aws (userActivateJournaled aliceUser)
@@ -1749,7 +1752,7 @@ execAndAssertUserDeletion brig cannon u hdl others aws execDelete = do
   Search.refreshIndex brig
   -- Does not appear in search; public profile shows the user as deleted
   forM_ others $ \usr -> do
-    get (brig . paths ["users", toByteString' uid] . zUser usr) !!! assertDeletedProfilePublic
+    get (apiVersion "v1" . brig . paths ["users", toByteString' uid] . zUser usr) !!! assertDeletedProfilePublic
     Search.assertCan'tFind brig usr quid (fromName (userDisplayName u))
     Search.assertCan'tFind brig usr quid (fromHandle hdl)
   -- Email address is available again