|
| 1 | +# PushAdmin createApnsBroadcast Tests |
| 2 | + |
| 3 | +Spec points: `RSH1`, `RSH1d` |
| 4 | + |
| 5 | +## Test Type |
| 6 | +Unit test with mocked HTTP client |
| 7 | + |
| 8 | +## Mock HTTP Infrastructure |
| 9 | + |
| 10 | +See `uts/test/rest/unit/helpers/mock_http.md` for the full Mock HTTP Infrastructure specification. |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +## RSH1d — createApnsBroadcast sends POST to /push/apnsBroadcastChannels |
| 15 | + |
| 16 | +**Test ID**: `rest/unit/RSH1d/create-apns-broadcast-post-0` |
| 17 | + |
| 18 | +**Spec requirement:** RSH1d — `createApnsBroadcast(options)` issues a `POST` request to `/push/apnsBroadcastChannels`. |
| 19 | + |
| 20 | +Tests that `push.admin.createApnsBroadcast()` sends a POST to the correct path. |
| 21 | + |
| 22 | +### Setup |
| 23 | +```pseudo |
| 24 | +captured_requests = [] |
| 25 | +
|
| 26 | +mock_http = MockHttpClient( |
| 27 | + onConnectionAttempt: (conn) => conn.respond_with_success(), |
| 28 | + onRequest: (req) => { |
| 29 | + captured_requests.append(req) |
| 30 | + req.respond_with(201, { "id": "broadcast-1", "apnsChannelId": "apns-1" }) |
| 31 | + } |
| 32 | +) |
| 33 | +install_mock(mock_http) |
| 34 | +
|
| 35 | +client = Rest(options: ClientOptions(key: "appId.keyId:keySecret")) |
| 36 | +``` |
| 37 | + |
| 38 | +### Test Steps |
| 39 | +```pseudo |
| 40 | +AWAIT client.push.admin.createApnsBroadcast( |
| 41 | + options: { "messageStoragePolicy": 1 } |
| 42 | +) |
| 43 | +``` |
| 44 | + |
| 45 | +### Assertions |
| 46 | +```pseudo |
| 47 | +ASSERT captured_requests.length == 1 |
| 48 | +
|
| 49 | +request = captured_requests[0] |
| 50 | +ASSERT request.method == "POST" |
| 51 | +ASSERT request.url.path == "/push/apnsBroadcastChannels" |
| 52 | +``` |
| 53 | + |
| 54 | +--- |
| 55 | + |
| 56 | +## RSH1d — createApnsBroadcast body contains messageStoragePolicy |
| 57 | + |
| 58 | +**Test ID**: `rest/unit/RSH1d/message-storage-policy-1` |
| 59 | + |
| 60 | +**Spec requirement:** RSH1d — the request body contains the `messageStoragePolicy`. |
| 61 | + |
| 62 | +Tests that the supplied `messageStoragePolicy` is serialized into the request body. |
| 63 | + |
| 64 | +### Setup |
| 65 | +```pseudo |
| 66 | +captured_requests = [] |
| 67 | +
|
| 68 | +mock_http = MockHttpClient( |
| 69 | + onConnectionAttempt: (conn) => conn.respond_with_success(), |
| 70 | + onRequest: (req) => { |
| 71 | + captured_requests.append(req) |
| 72 | + req.respond_with(201, { "id": "broadcast-1", "apnsChannelId": "apns-1" }) |
| 73 | + } |
| 74 | +) |
| 75 | +install_mock(mock_http) |
| 76 | +
|
| 77 | +client = Rest(options: ClientOptions(key: "appId.keyId:keySecret")) |
| 78 | +``` |
| 79 | + |
| 80 | +### Test Steps |
| 81 | +```pseudo |
| 82 | +AWAIT client.push.admin.createApnsBroadcast( |
| 83 | + options: { "messageStoragePolicy": 0 } |
| 84 | +) |
| 85 | +``` |
| 86 | + |
| 87 | +### Assertions |
| 88 | +```pseudo |
| 89 | +ASSERT captured_requests.length == 1 |
| 90 | +
|
| 91 | +body = parse_json(captured_requests[0].body) |
| 92 | +ASSERT body["messageStoragePolicy"] == 0 |
| 93 | +``` |
| 94 | + |
| 95 | +--- |
| 96 | + |
| 97 | +## RSH1d — createApnsBroadcast returns id and apnsChannelId |
| 98 | + |
| 99 | +**Test ID**: `rest/unit/RSH1d/returns-ids-2` |
| 100 | + |
| 101 | +**Spec requirement:** RSH1d — returns the created broadcast as `{ id, apnsChannelId }`. |
| 102 | + |
| 103 | +Tests that the `id` and `apnsChannelId` are parsed from the response body and returned. |
| 104 | + |
| 105 | +### Setup |
| 106 | +```pseudo |
| 107 | +mock_http = MockHttpClient( |
| 108 | + onConnectionAttempt: (conn) => conn.respond_with_success(), |
| 109 | + onRequest: (req) => req.respond_with(201, { |
| 110 | + "id": "broadcast-xyz", |
| 111 | + "apnsChannelId": "apple-channel-abc" |
| 112 | + }) |
| 113 | +) |
| 114 | +install_mock(mock_http) |
| 115 | +
|
| 116 | +client = Rest(options: ClientOptions(key: "appId.keyId:keySecret")) |
| 117 | +``` |
| 118 | + |
| 119 | +### Test Steps |
| 120 | +```pseudo |
| 121 | +result = AWAIT client.push.admin.createApnsBroadcast( |
| 122 | + options: { "messageStoragePolicy": 1 } |
| 123 | +) |
| 124 | +``` |
| 125 | + |
| 126 | +### Assertions |
| 127 | +```pseudo |
| 128 | +ASSERT result.id == "broadcast-xyz" |
| 129 | +ASSERT result.apnsChannelId == "apple-channel-abc" |
| 130 | +``` |
| 131 | + |
| 132 | +--- |
| 133 | + |
| 134 | +## RSH1d — createApnsBroadcast request includes an auth header |
| 135 | + |
| 136 | +**Test ID**: `rest/unit/RSH1d/auth-header-3` |
| 137 | + |
| 138 | +**Spec requirement:** RSH1d — the request is authenticated. |
| 139 | + |
| 140 | +Tests that the request carries a Basic authorization header derived from the API key. |
| 141 | + |
| 142 | +### Setup |
| 143 | +```pseudo |
| 144 | +captured_requests = [] |
| 145 | +
|
| 146 | +mock_http = MockHttpClient( |
| 147 | + onConnectionAttempt: (conn) => conn.respond_with_success(), |
| 148 | + onRequest: (req) => { |
| 149 | + captured_requests.append(req) |
| 150 | + req.respond_with(201, { "id": "broadcast-1", "apnsChannelId": "apns-1" }) |
| 151 | + } |
| 152 | +) |
| 153 | +install_mock(mock_http) |
| 154 | +
|
| 155 | +client = Rest(options: ClientOptions(key: "appId.keyId:keySecret")) |
| 156 | +``` |
| 157 | + |
| 158 | +### Test Steps |
| 159 | +```pseudo |
| 160 | +AWAIT client.push.admin.createApnsBroadcast( |
| 161 | + options: { "messageStoragePolicy": 1 } |
| 162 | +) |
| 163 | +``` |
| 164 | + |
| 165 | +### Assertions |
| 166 | +```pseudo |
| 167 | +ASSERT captured_requests.length == 1 |
| 168 | +ASSERT captured_requests[0].headers["Authorization"] STARTS_WITH "Basic " |
| 169 | +``` |
| 170 | + |
| 171 | +--- |
| 172 | + |
| 173 | +## RSH1d — createApnsBroadcast propagates server error |
| 174 | + |
| 175 | +**Test ID**: `rest/unit/RSH1d/server-error-4` |
| 176 | + |
| 177 | +**Spec requirement:** RSH1d — a server error response is propagated to the caller. |
| 178 | + |
| 179 | +Tests that an error response from the server is surfaced to the caller. |
| 180 | + |
| 181 | +### Setup |
| 182 | +```pseudo |
| 183 | +mock_http = MockHttpClient( |
| 184 | + onConnectionAttempt: (conn) => conn.respond_with_success(), |
| 185 | + onRequest: (req) => req.respond_with(400, { |
| 186 | + "error": { |
| 187 | + "code": 40000, |
| 188 | + "statusCode": 400, |
| 189 | + "message": "Invalid request" |
| 190 | + } |
| 191 | + }) |
| 192 | +) |
| 193 | +install_mock(mock_http) |
| 194 | +
|
| 195 | +client = Rest(options: ClientOptions(key: "appId.keyId:keySecret")) |
| 196 | +``` |
| 197 | + |
| 198 | +### Test Steps and Assertions |
| 199 | +```pseudo |
| 200 | +AWAIT client.push.admin.createApnsBroadcast( |
| 201 | + options: { "messageStoragePolicy": 1 } |
| 202 | +) FAILS WITH error |
| 203 | +ASSERT error.code == 40000 |
| 204 | +``` |
0 commit comments