chore: update hatch version and remove hatch-containers (DataDog#10373)

taegyunkim · web-flow · commit ecc5741ff3e7 · 2024-08-26T20:11:06.000-04:00
Initially, started this PR to not use `pip install` to install hatch. hatch [docs](https://hatch.pypa.io/1.8/install/#pip) doesn't recommend installing hatch via `pip`, as it could modify the Python environment in which you choose to install. I addressed some of them but not all. Removing hatch-containers, which was used to build docs on local mac. It can now build docs natively by installing enchant, also running `hatch run docs:build` in `scripts/ddtest` works too. ## Checklist - [x] PR author has checked that all the criteria below are met - The PR description includes an overview of the change - The PR description articulates the motivation for the change - The change includes tests OR the PR description describes a testing strategy - The PR description notes risks associated with the change, if any - Newly-added code is easy to change - The change follows the [library release note guidelines](https://ddtrace.readthedocs.io/en/stable/releasenotes.html) - The change includes or references documentation updates if necessary - Backport labels are set (if [applicable](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)) ## Reviewer Checklist - [x] Reviewer has checked that all the criteria below are met - Title is accurate - All changes are related to the pull request's stated goal - Avoids breaking [API](https://ddtrace.readthedocs.io/en/stable/versioning.html#interfaces) changes - Testing strategy adequately addresses listed risks - Newly-added code is easy to change - Release note makes sense to a user of the library - If necessary, author has acknowledged and discussed the performance implications of this PR as reported in the benchmarks PR comment - Backport labels are set in a manner that is consistent with the [release branch maintenance policy](https://ddtrace.readthedocs.io/en/latest/contributing.html#backporting)
diff --git a/.circleci/config.templ.yml b/.circleci/config.templ.yml
@@ -119,7 +119,12 @@ commands:
   setup_hatch:
     description: "Install hatch"
     steps:
-      - run: pip3 install hatch~=1.8.0 hatch-containers==0.7.0
+      - run:
+          name: "Install hatch"
+          command: |
+            curl -L https://github.com/pypa/hatch/releases/download/hatch-v1.12.0/hatch-x86_64-unknown-linux-gnu.tar.gz | tar zx
+            sudo install -t /usr/local/bin hatch
+            hatch -q
 
   start_docker_services:
     description: "Start Docker services"
@@ -1345,7 +1350,6 @@ jobs:
     # build documentation and store as an artifact
     executor: ddtrace_dev
     steps:
-      - setup_hatch
       - checkout
       - run:
           command: |
diff --git a/.github/workflows/generate-package-versions.yml b/.github/workflows/generate-package-versions.yml
@@ -3,8 +3,7 @@ name: Generate Package Versions
 on:
   workflow_dispatch: # can be triggered manually
   schedule:
-    - cron: '0 0 * * 0' # weekly on Sunday at midnight
-
+    - cron: "0 0 * * 0" # weekly on Sunday at midnight
 
 jobs:
   generate-package-versions:
@@ -32,7 +31,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: "3.10"
-      
+
       - name: Setup Python 3.11
         uses: actions/setup-python@v5
         with:
@@ -57,18 +56,22 @@ jobs:
 
       - name: Start docker service
         run: docker-compose up -d testagent
-      
+
       - name: Install system dependencies
         run: |
           sudo apt-get update
           sudo apt-get install -y libmariadb-dev
-          
+
+      - name: Install hatch
+        uses: pypa/hatch@install
+        with:
+          version: "1.12.0"
+
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
           pip install packaging
           pip install riot==0.19.1
-          pip install hatch~=1.8.0 hatch-containers==0.7.0
 
       - name: Run regenerate-riot-latest
         run: scripts/regenerate-riot-latest.sh
diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml
@@ -38,7 +38,9 @@ jobs:
         run: rustup update stable && rustup default stable && rustup component add rustfmt clippy
 
       - name: Install hatch
-        run: pip install hatch
+        uses: pypa/hatch@install
+        with:
+          version: "1.12.0"
 
       - name: Run tests
         run: hatch run ddtrace_unit_tests:test
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,7 +5,9 @@ build:
     python: "3.10"
   commands:
     - git fetch --unshallow || true
-    - pip install hatch~=1.8.0 hatch-containers==0.7.0
+    - curl -L https://github.com/pypa/hatch/releases/download/hatch-v1.12.0/hatch-x86_64-unknown-linux-gnu.tar.gz | tar zx
+    - install -t /usr/local/bin hatch
+    - hatch -q
     - curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain stable -y
     - echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> "$BASH_ENV"
     - hatch -v run docs:sphinx-build -W -b html docs docs/_build/html
diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -4,7 +4,7 @@
 FROM debian:buster-20221219-slim
 
 ARG TARGETARCH
-ARG HATCH_VERSION=1.8.1
+ARG HATCH_VERSION=1.12.0
 
 # http://bugs.python.org/issue19846
 # > At the moment, setting "LANG=C" on a Linux system *fundamentally breaks Python 3*, and that's not OK.
@@ -76,10 +76,9 @@ RUN git clone --depth 1 --branch v2.4.2 https://github.com/pyenv/pyenv "${PYENV_
   && cd -
 
 RUN if [ "$TARGETARCH" = "amd64" ]; \
-    then curl -L https://github.com/pypa/hatch/releases/download/hatch-v${HATCH_VERSION}/hatch-${HATCH_VERSION}-x86_64-unknown-linux-gnu.tar.gz | tar zx; \
-    else curl -L https://github.com/pypa/hatch/releases/download/hatch-v${HATCH_VERSION}/hatch-${HATCH_VERSION}-aarch64-unknown-linux-gnu.tar.gz | tar zx; \
+    then curl -L https://github.com/pypa/hatch/releases/download/hatch-v${HATCH_VERSION}/hatch-x86_64-unknown-linux-gnu.tar.gz | tar zx; \
+    else curl -L https://github.com/pypa/hatch/releases/download/hatch-v${HATCH_VERSION}/hatch-aarch64-unknown-linux-gnu.tar.gz | tar zx; \
     fi \
-  && mv hatch-${HATCH_VERSION}-* hatch \
   && install -t /usr/local/bin hatch \
   && hatch -q
 
diff --git a/docs/contributing-testing.rst b/docs/contributing-testing.rst
@@ -36,7 +36,8 @@ In addition, you will need `riot <https://ddriot.readthedocs.io/en/latest/>`_ an
 .. code-block:: bash
 
     $ pip install riot==0.19.1
-    $ pip install hatch~=1.8.0 hatch-containers==0.7.0
+
+Refer `hatch install <https://hatch.pypa.io/latest/install/>`_ for installation instructions
 
 Some of our test environments are managed with Riot, others with Hatch.
 
diff --git a/hatch.toml b/hatch.toml
@@ -1,8 +1,3 @@
-[env]
-requires = [
-    "hatch-containers==0.7.0",
-]
-
 [envs.lint]
 detached = true
 python = "3.10"
@@ -114,10 +109,6 @@ build = [
     "scripts/docs/build.sh",
 ]
 
-[envs.docs.overrides]
-# Local MacOS development requires Docker containers
-platform.macos.type = { value = "container" }
-
 [envs.slotscheck]
 template = "slotscheck"
 python = "3.10"
diff --git a/scripts/ddtest b/scripts/ddtest
@@ -12,7 +12,10 @@ fi
 # retry docker pull if fails
 for i in {1..3}; do docker-compose pull -q testrunner && break || sleep 3; done
 
-FULL_CMD="pip install -q --disable-pip-version-check riot==0.19.1 hatch && $CMD"
+# DEV: Removing hatch==1.12.0 from this command results in weird failure
+# in which building dd-trace-py fails as it can't find clang compiler for some
+# venvs using Python 3.11.
+FULL_CMD="pip install -q --disable-pip-version-check riot==0.19.1 hatch==1.12.0 && $CMD"
 
 
 # install and upgrade riot in case testrunner image has not been updated
diff --git a/scripts/docs/build.sh b/scripts/docs/build.sh
@@ -1,6 +1,15 @@
 #!/usr/bin/env bash
 set -eux
 
+# DEV: unless it's built with editable, following sphinx-build fails
+if [ -z ${CIRCLECI+x} ]; then
+  CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) pip install -v -e .
+fi
+
+if [[ "$(uname)" == "Darwin" ]]; then
+  export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib
+fi
+
 reno lint
 sphinx-build -vvv -W -b spelling docs docs/_build/html
 sphinx-build -vvv -W -b html docs docs/_build/html
diff --git a/scripts/docs/install.sh b/scripts/docs/install.sh
@@ -8,10 +8,14 @@ elif [[ "${READTHEDOCS}" = "True" ]]; then
     # We skip here because we do not check spelling in RTD
     echo "Skipping install"
 else
+  if [[ "$(uname)" == "Darwin" ]]; then
+    brew install enchant
+  else
     export DEBIAN_FRONTEND="noninteractive"
     export DEBCONF_NOWARNINGS="yes"
 
     apt-get -qq update
     apt-get -qy install --no-install-recommends libenchant-2-dev >/dev/null ||
         apt-get -qy install --no-install-recommends libenchant-dev >/dev/null
+  fi
 fi
