-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathensure_internal_distribution.py
More file actions
416 lines (367 loc) · 17.3 KB
/
Copy pathensure_internal_distribution.py
File metadata and controls
416 lines (367 loc) · 17.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
#!/usr/bin/env python3
"""Ensure internal TestFlight/Firebase builds are actually visible to testers."""
from __future__ import annotations
import argparse
import os
import sys
from pathlib import Path
from typing import Any
from urllib.parse import quote
_SCRIPTS_DIR = str(Path(__file__).resolve().parent)
_ASC_DIR = str(Path(__file__).resolve().parent / "asc")
for _p in (_SCRIPTS_DIR, _ASC_DIR):
if _p not in sys.path:
sys.path.insert(0, _p)
from asc_client import ASCClient, AscClientError
from pem_env import load_google_play_service_account_dict
from repo_dotenv import load_repo_dotenv
load_repo_dotenv(Path(__file__).resolve().parent.parent)
IOS_BUNDLE_ID = "com.igorganapolsky.randomtimer"
FIREBASE_SCOPE = ("https://www.googleapis.com/auth/cloud-platform",)
def _csv(raw: str) -> list[str]:
return [item.strip() for item in raw.split(",") if item.strip()]
def _error(details: str) -> dict[str, Any]:
return {"passed": False, "status": "ERROR", "details": details}
class TestFlightInternalDistributor:
def __init__(self, bundle_id: str = IOS_BUNDLE_ID, client: ASCClient | None = None):
self.bundle_id = bundle_id
self.client = client or ASCClient.from_env()
def _get_app_id(self) -> str:
apps = self.client.get("/apps", params={"filter[bundleId]": self.bundle_id}).get("data", [])
if not apps:
raise RuntimeError(f"No App Store Connect app found for bundle id '{self.bundle_id}'")
return apps[0]["id"]
def _groups_for_app(self, app_id: str) -> dict[str, dict[str, Any]]:
groups = self.client.get_all(f"/apps/{app_id}/betaGroups", params={"limit": "200"})
return {group["attributes"]["name"]: group for group in groups}
def _latest_build_for_version(self, app_id: str, marketing_version: str) -> dict[str, Any]:
payload = self.client.get(
"/builds",
params={
"filter[app]": app_id,
"include": "preReleaseVersion",
"sort": "-uploadedDate",
"limit": 50,
"fields[builds]": "version,processingState,uploadedDate,preReleaseVersion",
"fields[preReleaseVersions]": "version",
},
)
pre_release_versions = {
item["id"]: item.get("attributes", {}).get("version")
for item in payload.get("included", [])
if item.get("type") == "preReleaseVersions"
}
for build in payload.get("data", []):
pre_rel = (
build.get("relationships", {})
.get("preReleaseVersion", {})
.get("data")
)
pre_rel_id = pre_rel.get("id") if isinstance(pre_rel, dict) else None
if pre_release_versions.get(pre_rel_id) == marketing_version:
return build
raise RuntimeError(f"No TestFlight build found for marketing version {marketing_version}")
def _ensure_build_in_group(self, group_id: str, build_id: str) -> None:
try:
self.client.request(
"POST",
f"/betaGroups/{group_id}/relationships/builds",
payload={"data": [{"type": "builds", "id": build_id}]},
)
except AscClientError as exc:
if "HTTP 409" not in str(exc):
raise
def _group_build_ids(self, group_id: str) -> set[str]:
builds = self.client.get_all(f"/betaGroups/{group_id}/builds", params={"limit": "200"})
return {build["id"] for build in builds}
def _group_tester_emails(self, group_id: str) -> set[str]:
testers = self.client.get_all(f"/betaGroups/{group_id}/betaTesters", params={"limit": "200"})
return {
(tester.get("attributes", {}).get("email") or "").strip().lower()
for tester in testers
if tester.get("attributes", {}).get("email")
}
def ensure(self, *, marketing_version: str, groups: list[str], required_testers: list[str]) -> dict[str, Any]:
try:
app_id = self._get_app_id()
build = self._latest_build_for_version(app_id, marketing_version)
build_id = build["id"]
attrs = build.get("attributes", {})
build_number = str(attrs.get("version", "?"))
processing_state = attrs.get("processingState", "UNKNOWN")
app_groups = self._groups_for_app(app_id)
missing_groups: list[str] = []
missing_tester_details: list[str] = []
verified_groups: list[str] = []
for group_name in groups:
group = app_groups.get(group_name)
if not group:
missing_groups.append(group_name)
continue
group_id = group["id"]
is_internal_group = bool(group.get("attributes", {}).get("isInternalGroup"))
if not is_internal_group:
self._ensure_build_in_group(group_id, build_id)
if build_id not in self._group_build_ids(group_id):
return _error(
f"Build {build_number} for {marketing_version} is missing from TestFlight group '{group_name}'"
)
testers = self._group_tester_emails(group_id)
missing = [email for email in required_testers if email.lower() not in testers]
if missing:
missing_tester_details.append(f"{group_name}: {', '.join(missing)}")
verified_groups.append(group_name)
if missing_groups:
return _error("Missing TestFlight groups: " + ", ".join(missing_groups))
if missing_tester_details:
return _error(
"Required internal TestFlight testers missing from group membership: "
+ "; ".join(missing_tester_details)
)
if processing_state != "VALID":
return _error(
f"Latest TestFlight build {build_number} for {marketing_version} is not VALID (processingState={processing_state})"
)
return {
"passed": True,
"status": "VISIBLE",
"details": (
f"TestFlight {marketing_version} build {build_number} is attached to groups "
f"{', '.join(verified_groups)} and required tester membership is present."
),
}
except Exception as exc:
return _error(f"TestFlight internal distribution check failed: {exc}")
class FirebaseInternalDistributor:
def __init__(
self,
*,
app_id: str,
service_account_key: str | None = None,
requests_module: Any | None = None,
):
self.app_id = app_id
self.project_number = self._project_number_from_app_id(app_id)
self._service_account_key = (
service_account_key
or os.environ.get("FIREBASE_SERVICE_ACCOUNT_JSON", "")
or os.environ.get("GOOGLE_PLAY_JSON_KEY", "")
)
self._requests = requests_module
self._token: str | None = None
@staticmethod
def _project_number_from_app_id(app_id: str) -> str:
parts = app_id.split(":")
if len(parts) < 2 or not parts[1].isdigit():
raise RuntimeError(f"Could not parse project number from Firebase app id '{app_id}'")
return parts[1]
def _get_token(self) -> str:
if self._token:
return self._token
try:
from google.auth.transport.requests import Request
from google.oauth2 import service_account
except ImportError as exc:
raise RuntimeError(
"Missing google-auth dependencies. Install: pip install google-auth requests"
) from exc
info = load_google_play_service_account_dict(self._service_account_key)
credentials = service_account.Credentials.from_service_account_info(
info,
scopes=list(FIREBASE_SCOPE),
)
credentials.refresh(Request())
self._token = credentials.token
return self._token
def _request(
self,
method: str,
path: str,
*,
params: dict[str, Any] | None = None,
payload: dict[str, Any] | None = None,
) -> dict[str, Any]:
requests_module = self._requests
if requests_module is None:
try:
import requests as requests_module # type: ignore
except ImportError as exc:
raise RuntimeError("Missing requests. Install: pip install requests") from exc
response = requests_module.request(
method.upper(),
f"https://firebaseappdistribution.googleapis.com{path}",
headers={
"Authorization": f"Bearer {self._get_token()}",
"Content-Type": "application/json",
},
params=params or {},
json=payload,
timeout=30,
)
if response.status_code >= 400:
raise RuntimeError(f"{method.upper()} {path} failed: HTTP {response.status_code} {response.text[:1000]}")
return response.json() if getattr(response, "text", "") else {}
def _list_releases(self) -> list[dict[str, Any]]:
payload = self._request(
"GET",
f"/v1/projects/{self.project_number}/apps/{quote(self.app_id, safe=':')}/releases",
params={"pageSize": 50},
)
return payload.get("releases", [])
def _find_release(self, *, build_version: str | None, display_version: str | None) -> dict[str, Any]:
releases = self._list_releases()
if build_version:
releases = [release for release in releases if str(release.get("buildVersion", "")) == str(build_version)]
if display_version:
releases = [release for release in releases if str(release.get("displayVersion", "")) == str(display_version)]
if not releases:
raise RuntimeError(
f"No Firebase release found for app {self.app_id}"
+ (f" buildVersion={build_version}" if build_version else "")
+ (f" displayVersion={display_version}" if display_version else "")
)
return max(releases, key=lambda release: release.get("createTime", ""))
def _distribute_release(self, release_name: str, *, tester_emails: list[str], group_aliases: list[str]) -> None:
if not tester_emails and not group_aliases:
return
self._request(
"POST",
f"/v1/{quote(release_name, safe='/:')}:distribute",
payload={"testerEmails": tester_emails, "groupAliases": group_aliases},
)
def _list_testers(self) -> list[dict[str, Any]]:
payload = self._request(
"GET",
f"/v1/projects/{self.project_number}/testers",
params={"pageSize": 200},
)
return payload.get("testers", [])
def _get_group(self, alias: str) -> dict[str, Any]:
return self._request("GET", f"/v1/projects/{self.project_number}/groups/{quote(alias, safe='')}")
def ensure(
self,
*,
build_version: str | None,
display_version: str | None,
group_aliases: list[str],
tester_emails: list[str],
required_testers: list[str],
) -> dict[str, Any]:
try:
release = self._find_release(build_version=build_version, display_version=display_version)
if not tester_emails and not group_aliases:
return _error(
"Firebase release found, but no tester emails or group aliases were provided for visibility verification"
)
direct_tester_emails = {email.strip().lower() for email in tester_emails if email.strip()}
self._distribute_release(
release["name"],
tester_emails=tester_emails,
group_aliases=group_aliases,
)
project_testers = {
(tester.get("email") or "").strip().lower()
for tester in self._list_testers()
if tester.get("email")
}
missing_project_testers = [email for email in required_testers if email.lower() not in project_testers]
missing_undistributed_testers = [
email
for email in missing_project_testers
if email.lower() not in direct_tester_emails
]
if missing_undistributed_testers:
return _error(
"Required Firebase testers are missing from the project tester list "
f"and were not included in direct distribution (count={len(missing_undistributed_testers)})"
)
group_summaries: list[str] = []
group_warnings: list[str] = []
for alias in group_aliases:
group = self._get_group(alias)
tester_count = int(group.get("testerCount", 0))
release_count = int(group.get("releaseCount", 0))
if tester_count <= 0:
message = f"Firebase group '{alias}' has no testers"
if direct_tester_emails:
group_warnings.append(message)
continue
return _error(message)
if release_count <= 0:
message = f"Firebase group '{alias}' has no accessible releases"
if direct_tester_emails:
group_warnings.append(message)
continue
return _error(message)
group_summaries.append(f"{alias}(testers={tester_count}, releases={release_count})")
direct_summary = (
f"direct tester distribution accepted for {len(direct_tester_emails)} tester(s)"
if direct_tester_emails
else "no direct tester emails requested"
)
propagation_summary = (
f"; project tester list pending for {len(missing_project_testers)} required tester(s)"
if missing_project_testers
else ""
)
return {
"passed": True,
"status": "VISIBLE",
"details": (
f"Firebase release {release.get('displayVersion', '?')} ({release.get('buildVersion', '?')}) "
f"is distributed. Firebase distribute API accepted the release; {direct_summary}. "
f"Groups verified: {', '.join(group_summaries) if group_summaries else 'none'}"
f"{'; group warnings: ' + '; '.join(group_warnings) if group_warnings else ''}"
f"{propagation_summary}."
),
}
except Exception as exc:
return _error(f"Firebase internal distribution check failed: {exc}")
def _parse_args() -> argparse.Namespace:
parser = argparse.ArgumentParser(description="Ensure internal TestFlight/Firebase visibility before signoff.")
parser.add_argument("--platform", choices=["ios", "firebase", "both"], required=True)
parser.add_argument("--ios-version", default="")
parser.add_argument("--ios-groups", default="")
parser.add_argument("--ios-required-testers", default="")
parser.add_argument("--firebase-app-id", default=os.environ.get("FIREBASE_ANDROID_APP_ID", ""))
parser.add_argument("--firebase-build-version", default="")
parser.add_argument("--firebase-display-version", default="")
parser.add_argument("--firebase-group-aliases", default="")
parser.add_argument("--firebase-tester-emails", default="")
parser.add_argument("--firebase-required-testers", default="")
return parser.parse_args()
def main() -> int:
args = _parse_args()
results: list[dict[str, Any]] = []
if args.platform in {"ios", "both"}:
if not args.ios_version:
print("❌ --ios-version is required for iOS checks", file=sys.stderr)
return 2
results.append(
{"platform": "iOS", **TestFlightInternalDistributor().ensure(
marketing_version=args.ios_version,
groups=_csv(args.ios_groups),
required_testers=[email.lower() for email in _csv(args.ios_required_testers)],
)}
)
if args.platform in {"firebase", "both"}:
if not args.firebase_app_id:
print("❌ --firebase-app-id is required for Firebase checks", file=sys.stderr)
return 2
results.append(
{"platform": "Firebase", **FirebaseInternalDistributor(app_id=args.firebase_app_id).ensure(
build_version=args.firebase_build_version or None,
display_version=args.firebase_display_version or None,
group_aliases=_csv(args.firebase_group_aliases),
tester_emails=[email.lower() for email in _csv(args.firebase_tester_emails)],
required_testers=[email.lower() for email in _csv(args.firebase_required_testers or args.firebase_tester_emails)],
)}
)
all_passed = True
for result in results:
icon = "✅" if result["passed"] else "❌"
print(f"{icon} {result['platform']}: {result['status']} — {result['details']}")
all_passed = all_passed and result["passed"]
return 0 if all_passed else 1
if __name__ == "__main__":
raise SystemExit(main())