Upgrade script installs venv in wrong directory if pwd-returned directory contains spaces #9902

New Issue

adam · 2025-12-29T21:24:11+01:00

adam commented

2025-12-29 21:24:11 +01:00

Originally created by @prryplatypus on GitHub (Jun 25, 2024).

Originally assigned to: @prryplatypus on GitHub.

Deployment Type

Self-hosted

NetBox Version

v2.9.1

Python Version

3.11

Steps to Reproduce

Clone netbox into a directory with spaces (e.g.: ~/Documents/Some Folder/Repos/netbox)
Follow the installation instructions

Expected Behavior

The upgrade.sh script creates the venv in ~/Documents/Some Folder/Repos/netbox/venv and completes successfully.

Observed Behavior

The upgrade.sh script creates the venv in ~/Documents/Some and the script fails.

Originally created by @prryplatypus on GitHub (Jun 25, 2024). Originally assigned to: @prryplatypus on GitHub. ### Deployment Type Self-hosted ### NetBox Version v2.9.1 ### Python Version 3.11 ### Steps to Reproduce 1. Clone netbox into a directory with spaces (e.g.: `~/Documents/Some Folder/Repos/netbox`) 2. Follow the installation instructions ### Expected Behavior The `upgrade.sh` script creates the venv in `~/Documents/Some Folder/Repos/netbox/venv` and completes successfully. ### Observed Behavior The `upgrade.sh` script creates the venv in `~/Documents/Some` and the script fails.

adam added the type: bug status: accepted severity: low labels 2025-12-29 21:24:11 +01:00

adam closed this issue

2025-12-29 21:24:12 +01:00

adam commented

2025-12-29 21:24:12 +01:00

@prryplatypus commented on GitHub (Jun 25, 2024):

Small snippet that might be useful for escaping spaces: printf "%q/venv\n" "$(pwd -P)"

@prryplatypus commented on GitHub (Jun 25, 2024): Small snippet that might be useful for escaping spaces: `printf "%q/venv\n" "$(pwd -P)"`

adam commented

2025-12-29 21:24:12 +01:00

@RangerRick commented on GitHub (Jun 25, 2024):

it's actually being called in an eval so it needs double-quoting... should be able to quote anywhere eval is called, and then also quote any arguments inside that are dynamic, eg, replace:

# Create a new virtual environment
COMMAND="${PYTHON} -m venv ${VIRTUALENV}"
echo "Creating a new virtual environment at ${VIRTUALENV}..."
eval $COMMAND || {

...with:

# Create a new virtual environment
COMMAND="${PYTHON} -m venv \"${VIRTUALENV}\""
echo "Creating a new virtual environment at ${VIRTUALENV}..."
eval "$COMMAND" || {

Might be worth adding shellcheck to the CI/CD pipeline to catch stuff like this.

@RangerRick commented on GitHub (Jun 25, 2024): it's actually being called in an `eval` so it needs double-quoting... should be able to quote anywhere `eval` is called, and then also quote any arguments inside that are dynamic, eg, replace: ```bash # Create a new virtual environment COMMAND="${PYTHON} -m venv ${VIRTUALENV}" echo "Creating a new virtual environment at ${VIRTUALENV}..." eval $COMMAND || { ``` ...with: ```bash # Create a new virtual environment COMMAND="${PYTHON} -m venv \"${VIRTUALENV}\"" echo "Creating a new virtual environment at ${VIRTUALENV}..." eval "$COMMAND" || { ``` Might be worth adding `shellcheck` to the CI/CD pipeline to catch stuff like this.

adam commented

2025-12-29 21:24:13 +01:00

@prryplatypus commented on GitHub (Jun 26, 2024):

I can open a PR to fix this later today

@prryplatypus commented on GitHub (Jun 26, 2024): I can open a PR to fix this later today

adam commented

2025-12-29 21:24:13 +01:00

@jeremystretch commented on GitHub (Jun 26, 2024):

Thanks @prryplatypus, I've assigned this to you.

@jeremystretch commented on GitHub (Jun 26, 2024): Thanks @prryplatypus, I've assigned this to you.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#9902