gundeck: integration test docs (#2754)

* services/gundeck: move appName closer to where it's used * services/gundeck: document SNS Platform Application requirements
wireapp · Oct 10, 2022 · 1db0a1a · 1db0a1a
1 parent 9d1847c
commit 1db0a1a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/changelog.d/gundeck-integration-test-docs b/changelog.d/gundeck-integration-test-docs
@@ -0,0 +1 @@
+Documentation on what SNS platform applications the gundeck integration test expects was added.
diff --git a/services/gundeck/test/integration/API.hs b/services/gundeck/test/integration/API.hs
@@ -68,9 +68,6 @@ import Util (runRedisProxy, withSettingsOverrides)
 import Wire.API.Internal.Notification
 import qualified Prelude
 
-appName :: AppName
-appName = AppName "test"
-
 tests :: IO TestSetup -> TestTree
 tests s =
   testGroup
@@ -736,6 +733,10 @@ testUnregisterClient = do
 
 -----------------------------------------------------------------------------
 -- Native push token registration
+-- This expects the following SNS Platform applications to be present in AWS:
+
+-- ${env}-test (FCM), ${env}-test (APNS_SANDBOX), ${env}-com.wire.ent (APNS_SANDBOX),
+-- with ${env} normally being integration.
 
 testRegisterPushToken :: TestM ()
 testRegisterPushToken = do
@@ -1121,6 +1122,9 @@ buildPush sdr rcps pload =
   where
     rcpt u c = recipient u RouteAny & recipientClients .~ c
 
+appName :: AppName
+appName = AppName "test"
+
 data TokenSpec = TokenSpec {trans :: Transport, tSize :: Int, tName :: AppName}
 
 gcmToken :: TokenSpec
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Documentation on what SNS platform applications the gundeck integration test expects was added.