Merge branch 'moneymeets:master' into master

yunojuno · Sep 8, 2023 · 3103c2d · 3103c2d
2 parents c2b3c2a + 22a02ea
commit 3103c2d
Show file tree

Hide file tree

Showing 20 changed files with 75 additions and 28 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -17,3 +17,13 @@ jobs:
           shellcheck -P SCRIPTDIR -x test/utils test/test-*
 
       - run: ./run_tests.sh
+
+  test-macos:
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    runs-on: macos-latest
+    timeout-minutes: 5
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - run: ./run_tests.sh
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ heroku buildpacks:add https://github.com/moneymeets/python-poetry-buildpack.git
 heroku buildpacks:add heroku/python
 ```
 
-**Note:** this buildpack is _only_ for generating `requirements.txt` and `runtime.txt` for subsequent use by the official `heroku/python` buildpack. Do not depend on the installed Poetry's location, or its venv remaining functional at app runtime. If you need Poetry for other purposes (for example CI checks), make your own separate Poetry installation accordingly.
+**Note:** this buildpack is _only_ for generating `requirements.txt` and `runtime.txt` for subsequent use by the official `heroku/python` buildpack. Do not depend on the installed Poetry's location, or its virtual environment remaining functional at app runtime. If you need Poetry for other purposes (for example CI checks), make your own separate Poetry installation accordingly.
 
 ## Configuration
 
@@ -26,16 +26,28 @@ Python version can be forced by setting the `PYTHON_RUNTIME_VERSION` variable. O
 heroku config:set PYTHON_RUNTIME_VERSION=3.9.1
 ```
 
+### `runtime.txt`
+
+Generation of the `runtime.txt` can be skipped by setting `DISABLE_POETRY_CREATE_RUNTIME_FILE` to `1`:
+
+```
+heroku config:set DISABLE_POETRY_CREATE_RUNTIME_FILE=1
+```
+
+If `DISABLE_POETRY_CREATE_RUNTIME_FILE` is set, the required Python version can be specified in `runtime.txt`. Otherwise, if `runtime.txt` is present in the repository, the buildpack will prevent the app from being deployed in order to avoid possible ambiguities.
+
 ### Poetry
 
-Poetry version can be specified by setting `POETRY_VERSION` in Heroku config vars. Otherwise, it will default to a hardcoded version.
+Poetry version can be specified by setting `POETRY_VERSION` in Heroku config vars. Otherwise, it will attempt to be inferred from `poetry.lock` or default to the latest version.
 
 ```
 heroku config:set POETRY_VERSION=1.1.13
 ```
 
 Generally all variables starting with `POETRY_` are passed on to Poetry by this buildpack; see the corresponding [Poetry documentation](https://python-poetry.org/docs/configuration/#using-environment-variables) section for possible uses.
 
+### `requirements.txt`
+
 Exporting of development dependencies (e.g. to run tests in CI pipelines) can be optionally enabled by setting `POETRY_EXPORT_DEV_REQUIREMENTS` to `1`:
 
 ```
@@ -48,16 +60,6 @@ If you want to override the default export parameters (`--without-hashes --with-
 heroku config:set POETRY_EXPORT_PARAMS=--with-hashes
 ```
 
-### runtime.txt
-
-Generation of the `runtime.txt` can be skipped by setting `DISABLE_POETRY_CREATE_RUNTIME_FILE` to `1`:
-
-```
-heroku config:set DISABLE_POETRY_CREATE_RUNTIME_FILE=1
-```
-
-If `DISABLE_POETRY_CREATE_RUNTIME_FILE` is set, the required Python version can be specified in `runtime.txt`. Otherwise, if `runtime.txt` is present in the repository, the buildpack will prevent the app from being deployed in order to avoid possible ambiguities.
-
 ## Contributing
 
 To test your changes locally run the (TAP-compatible) test suite:

diff --git a/bin/compile b/bin/compile
@@ -25,9 +25,18 @@ for env_file in $BUILDPACK_VARIABLES ; do
     [ -f "$ENV_DIR/$env_file" ] && export "$(basename "$env_file")=$(cat "$ENV_DIR/$env_file" 2>/dev/null)"
 done
 
-if [ -z "${POETRY_VERSION:-}" ] ; then
-    export POETRY_VERSION=1.5.1
-    log "No Poetry version specified in POETRY_VERSION config var. Defaulting to $POETRY_VERSION."
+POETRY_VERSION="${POETRY_VERSION:-}"
+
+if [ -z "$POETRY_VERSION" ] ; then
+    if [ -f "$BUILD_DIR/poetry.lock" ] ; then
+        POETRY_VERSION=$(head --lines=1 "$BUILD_DIR/poetry.lock" | grep --only-matching '[0-9]\+\.[0-9]\+\.[0-9]\+' || true)
+    fi
+    if [ -n "$POETRY_VERSION" ] ; then
+        export POETRY_VERSION
+        log "Read Poetry version $POETRY_VERSION from poetry.lock"
+    else
+        log "No Poetry version specified in POETRY_VERSION config var. Defaulting to latest."
+    fi
 else
     log "Using Poetry version from POETRY_VERSION config var: $POETRY_VERSION"
 fi
@@ -88,7 +97,7 @@ fi
 
 if [ -z "${PYTHON_RUNTIME_VERSION:-}" ] ; then
     log "Read Python version from poetry.lock"
-    PYTHON_RUNTIME_VERSION="$(sed -n -e '/^\[metadata\]/,/^\[/p' poetry.lock | sed -n -e 's/^python-versions\s*=\s*//p' | tr -d \"'[:space:]'\')"
+    PYTHON_RUNTIME_VERSION="$(sed -n -e '/^\[metadata\]/,/^\[/p' poetry.lock | sed -n -e 's/^python-versions[[:space:]]*=[[:space:]]*//p' | tr -d \"'[:space:]'\')"
 else
     log "Force Python version to $PYTHON_RUNTIME_VERSION, because PYTHON_RUNTIME_VERSION is set!"
 fi

diff --git a/test/fixtures/compile-exact_version_specifier.stdout.txt b/test/fixtures/compile-exact_version_specifier.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-export_dev.stdout.txt b/test/fixtures/compile-export_dev.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-export_params-0.stdout.txt b/test/fixtures/compile-export_params-0.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-export_params-1.stdout.txt b/test/fixtures/compile-export_params-1.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-force_python_version.stdout.txt b/test/fixtures/compile-force_python_version.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-invalid_python_version.stdout.txt b/test/fixtures/compile-invalid_python_version.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-no_vars_success.stdout.txt b/test/fixtures/compile-no_vars_success.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-poetry_version_comment.stderr.txt b/test/fixtures/compile-poetry_version_comment.stderr.txt
diff --git a/test/fixtures/compile-poetry_version_comment.stdout.txt b/test/fixtures/compile-poetry_version_comment.stdout.txt
@@ -0,0 +1,10 @@
+-----> Read Poetry version 1.5.1 from poetry.lock
+-----> Generate requirements.txt with Poetry
+-----> Install Poetry
+       >>> mocked curl call <<<
+-----> Add Poetry to the PATH
+-----> Export requirements.txt from Poetry
+       >>> mocked poetry call <<<
+-----> Export Python version from Poetry to Heroku runtime.txt file
+-----> Read Python version from poetry.lock
+-----> Write 3.8.3 into runtime.txt
diff --git a/test/fixtures/compile-skip_runtime_error.stdout.txt b/test/fixtures/compile-skip_runtime_error.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-skip_runtime_success.stdout.txt b/test/fixtures/compile-skip_runtime_success.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/compile-trailing_space.stdout.txt b/test/fixtures/compile-trailing_space.stdout.txt
@@ -1,4 +1,4 @@
------> No Poetry version specified in POETRY_VERSION config var. Defaulting to 1.5.1.
+-----> No Poetry version specified in POETRY_VERSION config var. Defaulting to latest.
 -----> Generate requirements.txt with Poetry
 -----> Install Poetry
        >>> mocked curl call <<<

diff --git a/test/fixtures/poetry.lock-invalid b/test/fixtures/poetry.lock-invalid
diff --git a/test/fixtures/poetry.lock-valid b/test/fixtures/poetry.lock-valid
diff --git a/test/fixtures/poetry.lock-valid_exact_version_specifier b/test/fixtures/poetry.lock-valid_exact_version_specifier
diff --git a/test/fixtures/poetry.lock-valid_version_comment b/test/fixtures/poetry.lock-valid_version_comment
diff --git a/test/test-compile b/test/test-compile
@@ -9,12 +9,14 @@ run_test sanity-2 compile BUILD_DIR CACHE_DIR
 cp fixtures/poetry.lock-valid "$INPUT_DIR"/poetry.lock
 run_test no_vars_success compile "$INPUT_DIR" CACHE_DIR fixtures/env_dir
 
+cp fixtures/poetry.lock-valid_version_comment "$INPUT_DIR"/poetry.lock
+run_test poetry_version_comment compile "$INPUT_DIR" CACHE_DIR fixtures/env_dir
+
 cp fixtures/poetry.lock-valid_exact_version_specifier "$INPUT_DIR"/poetry.lock
 run_test exact_version_specifier compile "$INPUT_DIR" CACHE_DIR fixtures/env_dir
 
-cp fixtures/poetry.lock-valid "$INPUT_DIR"/poetry.lock
 # add trailing space to python-versions to test if it will be removed
-sed -i 's/^python-versions.*/& /g' "$INPUT_DIR"/poetry.lock
+sed -e 's/^python-versions.*/& /g' fixtures/poetry.lock-valid > "$INPUT_DIR"/poetry.lock
 run_test trailing_space compile "$INPUT_DIR" CACHE_DIR fixtures/env_dir
 
 cp fixtures/poetry.lock-valid "$INPUT_DIR"/poetry.lock