Merge pull request #1324 from jleroy/bugfix/venv-activation

Fix venv activation not working when using a custom VENV_NAME

.changelog/cbeaa629126c4d7bbb6f8b59e76b8835.md

@@ -0,0 +1,4 @@
+---
+type: none
+---
+Fix venv activation not working when using a custom VENV_NAME

.git_hooks_pre-commit

@@ -1,13 +1,14 @@
-#!/bin/sh
+#!/bin/bash
 
-set -e
+# Scripts path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )/script"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
-HOOKS=$(dirname "$0")
-GIT=$(dirname "$HOOKS")
-ROOT=$(dirname "$GIT")
-
-. "$ROOT/env/bin/activate"
-"$ROOT/script/changelog" check
-"$ROOT/script/lint"
-"$ROOT/script/format" --check --quiet || (echo "Formatting check failed, run ./script/format" && exit 1)
-"$ROOT/script/coverage"
+./script/changelog check
+./script/lint
+./script/format --check --quiet || (
+    echo "Formatting check failed, run ./script/format" &&
+    exit 1
+)
+./script/coverage

.github/workflows/changelog.yml

@@ -15,10 +15,10 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
-      - name: Install dependencies
+      - name: Setup Environment
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt -r requirements-dev.txt
+          ./script/bootstrap
       - name: Changelog Check
         run: |
           ./script/changelog check

script/changelog

@@ -1,16 +1,8 @@
-#!/bin/sh
-set -e
+#!/bin/bash
 
-cd "$(dirname "$0")/.."
-ROOT=$(pwd)
-
-if [ -z "$VENV_NAME" ]; then
-    VENV_NAME="env"
-fi
-
-ACTIVATE="$VENV_NAME/bin/activate"
-if [ -f "$ACTIVATE" ]; then
-    . "$ACTIVATE"
-fi
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 changelet "$@"

script/common.sh

@@ -0,0 +1,27 @@
+# This script contains Python's venv management features common to all shell
+# scripts located in this directory and to the repository pre-commit hook.
+# This script is *not* meant to be run directly.
+
+# Exit on any error
+set -e
+
+# Path to OctoDNS base directory
+OCTODNS_PATH="$( dirname -- "${SCRIPT_PATH}"; )"
+
+# Change to path OctoDNS base directory
+cd "${OCTODNS_PATH}"
+
+# If no venv name is set, set it to "env"
+if [ -z "${VENV_NAME}" ]; then
+    VENV_NAME="${OCTODNS_PATH}/env"
+fi
+
+ACTIVATE="${VENV_NAME}/bin/activate"
+# Check that [venv_directory]/bin/activate exists.
+if [ ! -f "${ACTIVATE}" ]; then
+    echo "${ACTIVATE} does not exist. Run ./script/bootstrap" >&2
+    exit 1
+fi
+
+# Activate OctoDNS venv.
+source "${ACTIVATE}"

script/coverage

@@ -1,18 +1,9 @@
-#!/bin/sh
-set -e
+#!/bin/bash
 
-cd "$(dirname "$0")/.."
-
-if [ -z "$VENV_NAME" ]; then
-    VENV_NAME="env"
-fi
-
-ACTIVATE="$VENV_NAME/bin/activate"
-if [ ! -f "$ACTIVATE" ]; then
-    echo "$ACTIVATE does not exist, run ./script/bootstrap" >&2
-    exit 1
-fi
-. "$ACTIVATE"
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 # Just to be sure/safe
 export AWS_ACCESS_KEY_ID=

script/format

@@ -1,10 +1,11 @@
 #!/bin/bash
 
-set -e
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 SOURCES="$(find *.py octodns tests docs -name '*.py') $(grep --files-with-matches '^#!.*python' script/*)"
 
-. env/bin/activate
-
 isort "$@" $SOURCES
 black "$@" $SOURCES

script/generate-docs

@@ -1,19 +1,9 @@
-#!/bin/sh
-set -e
+#!/bin/bash
 
-cd "$(dirname "$0")/.."
-ROOT=$(pwd)
-
-if [ -z "$VENV_NAME" ]; then
-    VENV_NAME="env"
-fi
-
-ACTIVATE="$VENV_NAME/bin/activate"
-if [ ! -f "$ACTIVATE" ]; then
-    echo "$ACTIVATE does not exist, run ./script/bootstrap" >&2
-    exit 1
-fi
-. "$ACTIVATE"
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 cd docs
 

script/lint

@@ -1,19 +1,9 @@
-#!/bin/sh
-set -e
+#!/bin/bash
 
-cd "$(dirname "$0")/.."
-ROOT=$(pwd)
-
-if [ -z "$VENV_NAME" ]; then
-    VENV_NAME="env"
-fi
-
-ACTIVATE="$VENV_NAME/bin/activate"
-if [ ! -f "$ACTIVATE" ]; then
-    echo "$ACTIVATE does not exist, run ./script/bootstrap" >&2
-    exit 1
-fi
-. "$ACTIVATE"
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 SOURCES="$(find *.py octodns tests docs -name '*.py') $(grep --files-with-matches '^#!.*python' script/*)"
 

script/release

@@ -1,13 +1,9 @@
 #!/bin/bash
 
-set -e
-
-cd "$(dirname "$0")"/..
-ROOT=$(pwd)
-
-if [ -z "$VENV_NAME" ]; then
-    VENV_NAME="env"
-fi
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 PYPYRC="$HOME/.pypirc"
 if [ ! -e "$PYPYRC" ]; then
@@ -22,13 +18,6 @@ EndOfMessage
     exit 1
 fi
 
-ACTIVATE="$VENV_NAME/bin/activate"
-if [ ! -f "$ACTIVATE" ]; then
-    echo "$ACTIVATE does not exist, run ./script/bootstrap" >&2
-    exit 1
-fi
-. "$ACTIVATE"
-
 # Set so that setup.py will create a public release style version number
 export OCTODNS_RELEASE=1
 

script/test

@@ -1,18 +1,9 @@
-#!/bin/sh
-set -e
+#!/bin/bash
 
-cd "$(dirname "$0")/.."
-
-if [ -z "$VENV_NAME" ]; then
-    VENV_NAME="env"
-fi
-
-ACTIVATE="$VENV_NAME/bin/activate"
-if [ ! -f "$ACTIVATE" ]; then
-    echo "$ACTIVATE does not exist, run ./script/bootstrap" >&2
-    exit 1
-fi
-. "$ACTIVATE"
+# Get current script path
+SCRIPT_PATH="$( dirname -- "$( readlink -f -- "${0}"; )"; )"
+# Activate OctoDNS Python venv
+source "${SCRIPT_PATH}/common.sh"
 
 # Just to be sure/safe
 export AWS_ACCESS_KEY_ID=