feat: add a tool to update dependencies

aignas · aignas · commit 3b2b838a14c8 · 2023-07-16T22:28:16.000+09:00
Before this change the updates to the dependencies would happen very
seldomly, with this script, I propose we do it before each minor version
release. Adding a shell script and adding a reminder to the release
process may help with that.
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -8,6 +8,8 @@ Before running through the release it's good to run the build and the tests loca
 also test-drive the commit in an existing Bazel workspace to sanity check functionality.
 
 #### Steps
+1. (Optional) bump the internal dependencies using the script `./tools/print_pip_deps.sh`.
+1. (Optional) bump the coverage dependencies using the script `./tools/update_coverage_deps.py`
 1. [Determine the next semantic version number](#determining-semantic-version)
 1. Create a tag and push, e.g. `git tag 0.5.0 upstream/main && git push upstream --tags`
    NOTE: Pushing the tag will trigger release automation.
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -15,6 +15,7 @@ internal_deps = use_extension("@rules_python//python/extensions/private:internal
 internal_deps.install()
 use_repo(
     internal_deps,
+    # Generated with //tools:print_pip_deps.sh
     "pypi__build",
     "pypi__click",
     "pypi__colorama",
diff --git a/python/pip_install/repositories.bzl b/python/pip_install/repositories.bzl
@@ -20,6 +20,7 @@ load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
 load("//:version.bzl", "MINIMUM_BAZEL_VERSION")
 
 _RULE_DEPS = [
+    # Generated with //tools:print_pip_deps.sh
     (
         "pypi__build",
         "https://files.pythonhosted.org/packages/03/97/f58c723ff036a8d8b4d3115377c0a37ed05c1f68dd9a0d66dab5e82c5c1c/build-0.9.0-py3-none-any.whl",
@@ -35,11 +36,21 @@ _RULE_DEPS = [
         "https://files.pythonhosted.org/packages/d1/d6/3965ed04c63042e047cb6a3e6ed1a63a35087b6a609aa3a15ed8ac56c221/colorama-0.4.6-py2.py3-none-any.whl",
         "4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6",
     ),
+    (
+        "pypi__importlib_metadata",
+        "https://files.pythonhosted.org/packages/d7/31/74dcb59a601b95fce3b0334e8fc9db758f78e43075f22aeb3677dfb19f4c/importlib_metadata-1.4.0-py2.py3-none-any.whl",
+        "bdd9b7c397c273bcc9a11d6629a38487cd07154fa255a467bf704cd2c258e359",
+    ),
     (
         "pypi__installer",
         "https://files.pythonhosted.org/packages/e5/ca/1172b6638d52f2d6caa2dd262ec4c811ba59eee96d54a7701930726bce18/installer-0.7.0-py3-none-any.whl",
         "05d1933f0a5ba7d8d6296bb6d5018e7c94fa473ceb10cf198a92ccea19c27b53",
     ),
+    (
+        "pypi__more_itertools",
+        "https://files.pythonhosted.org/packages/bd/3f/c4b3dbd315e248f84c388bd4a72b131a29f123ecacc37ffb2b3834546e42/more_itertools-8.13.0-py3-none-any.whl",
+        "c5122bffc5f104d37c1626b8615b511f3427aa5389b94d61e5ef8236bfbc3ddb",
+    ),
     (
         "pypi__packaging",
         "https://files.pythonhosted.org/packages/8f/7b/42582927d281d7cb035609cd3a543ffac89b74f3f4ee8e1c50914bcb57eb/packaging-22.0-py3-none-any.whl",
@@ -75,21 +86,11 @@ _RULE_DEPS = [
         "https://files.pythonhosted.org/packages/bd/7c/d38a0b30ce22fc26ed7dbc087c6d00851fb3395e9d0dac40bec1f905030c/wheel-0.38.4-py3-none-any.whl",
         "b60533f3f5d530e971d6737ca6d58681ee434818fab630c83a734bb10c083ce8",
     ),
-    (
-        "pypi__importlib_metadata",
-        "https://files.pythonhosted.org/packages/d7/31/74dcb59a601b95fce3b0334e8fc9db758f78e43075f22aeb3677dfb19f4c/importlib_metadata-1.4.0-py2.py3-none-any.whl",
-        "bdd9b7c397c273bcc9a11d6629a38487cd07154fa255a467bf704cd2c258e359",
-    ),
     (
         "pypi__zipp",
         "https://files.pythonhosted.org/packages/f4/50/cc72c5bcd48f6e98219fc4a88a5227e9e28b81637a99c49feba1d51f4d50/zipp-1.0.0-py2.py3-none-any.whl",
         "8dda78f06bd1674bd8720df8a50bb47b6e1233c503a4eed8e7810686bde37656",
     ),
-    (
-        "pypi__more_itertools",
-        "https://files.pythonhosted.org/packages/bd/3f/c4b3dbd315e248f84c388bd4a72b131a29f123ecacc37ffb2b3834546e42/more_itertools-8.13.0-py3-none-any.whl",
-        "c5122bffc5f104d37c1626b8615b511f3427aa5389b94d61e5ef8236bfbc3ddb",
-    ),
 ]
 
 _GENERIC_WHEEL = """\
diff --git a/tools/print_pip_deps.sh b/tools/print_pip_deps.sh
@@ -0,0 +1,48 @@
+#!/bin/bash
+#
+# A script to manage internal dependencies
+
+internal_deps=(
+    build==0.9
+    click==8.0.1
+    colorama
+    importlib_metadata==1.4.0
+    installer
+    more_itertools==8.13.0
+    packaging==22.0
+    pep517
+    pip==22.3.1
+    pip_tools==6.12.1
+    setuptools==60.10
+    tomli
+    wheel==0.38.4
+    zipp==1.0.0
+)
+echo "Copy the following to //python/pip_install/requirements.bzl"
+echo "    # Generated with //tools:$(basename $0)"
+report=$(python -m pip install --quiet --dry-run --ignore-installed --report - ${internal_deps[@]})
+
+echo "$report" |
+    # FIXME: not sure how to sub `.` with jq as usual escaping with `\` fails.
+    jq -r ".install[] \
+        | [\"pypi__\" + (.metadata.name | sub(\"[_-]+\"; \"_\")), \
+          .download_info.url, \
+          .download_info.archive_info.hashes.sha256] \
+        | @csv" |
+    sort |
+    sed -e "s/.*/(\0,),/g" \
+        -e "s/(/    (\n        /g" \
+        -e "s/\",\"/\",\n        \"/g" \
+        -e "s/,)/,\n    )/g"
+
+echo ""
+echo "====================================="
+echo "  Copy the following to MODULE.bazel"
+echo "====================================="
+echo "    # Generated with //tools:$(basename $0)"
+echo "$report" |
+    jq -r ".install[] \
+        | [\"pypi__\" + (.metadata.name | sub(\"[_-]+\"; \"_\"))] \
+        | @csv" |
+    sort |
+    sed "s/.*/    \0,/g"
