summary refs log tree commit diff
path: root/scripts-dev/check_locked_deps_have_sdists.py
diff options
context:
space:
mode:
authorreivilibre <oliverw@matrix.org>2023-02-13 18:15:38 +0000
committerGitHub <noreply@github.com>2023-02-13 18:15:38 +0000
commitc0bf4c3cb43abb90945591f5c3edb6ac45be2afd (patch)
tree406c00b2f7d45b1dc2051a9c7bf768f0baf184d2 /scripts-dev/check_locked_deps_have_sdists.py
parentTweak comment on `_is_local_room_accessible` as part of room visibility in `/... (diff)
downloadsynapse-c0bf4c3cb43abb90945591f5c3edb6ac45be2afd.tar.xz
Add check to ensure locked dependencies have source distributions available. (#14742)
Diffstat (limited to 'scripts-dev/check_locked_deps_have_sdists.py')
-rwxr-xr-xscripts-dev/check_locked_deps_have_sdists.py58
1 files changed, 58 insertions, 0 deletions
diff --git a/scripts-dev/check_locked_deps_have_sdists.py b/scripts-dev/check_locked_deps_have_sdists.py
new file mode 100755
index 0000000000..63ad99280a
--- /dev/null
+++ b/scripts-dev/check_locked_deps_have_sdists.py
@@ -0,0 +1,58 @@
+#! /usr/bin/env python
+# Copyright 2022 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import sys
+from pathlib import Path
+from typing import Dict, List
+
+import tomli
+
+
+def main() -> None:
+    lockfile_path = Path(__file__).parent.parent.joinpath("poetry.lock")
+    with open(lockfile_path, "rb") as lockfile:
+        lockfile_content = tomli.load(lockfile)
+
+    # Poetry 1.3+ lockfile format:
+    # There's a `files` inline table in each [[package]]
+    packages_to_assets: Dict[str, List[Dict[str, str]]] = {
+        package["name"]: package["files"] for package in lockfile_content["package"]
+    }
+
+    success = True
+
+    for package_name, assets in packages_to_assets.items():
+        has_sdist = any(asset["file"].endswith(".tar.gz") for asset in assets)
+        if not has_sdist:
+            success = False
+            print(
+                f"Locked package {package_name!r} does not have a source distribution!",
+                file=sys.stderr,
+            )
+
+    if not success:
+        print(
+            "\nThere were some problems with the Poetry lockfile (poetry.lock).",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+    print(
+        f"Poetry lockfile OK. {len(packages_to_assets)} locked packages checked.",
+        file=sys.stderr,
+    )
+
+
+if __name__ == "__main__":
+    main()