[DPE-6042] Make tox commands resilient to white-space paths

[sinclert-canonical]

This PR fixes tox.ini commands when the repository is cloned on a white-space containing path. The proposed approach quotes the paths where they are defined (central place), instead of where they are used (distributed throughout the file). However, we could go with the other approach if preferred.

How to reproduce:

$ mkdir -p "Projects/Canonical/Data Platform/PostgreSQL"
$ cd "Projects/Canonical/Data Platform/PostgreSQL"
$ git clone https://github.com/canonical/postgresql-operator
$ cd postgresql-operator
$ tox run -e format
> ...
> /Users/<USERNAME>/Projects/Canonical/Data:1:1: E902 No such file or directory (os error 2)
> Platform/PostgreSQL/postgresql-operator/src:1:1: E902 No such file or directory (os error 2)
> Platform/PostgreSQL/postgresql-operator/tests:1:1: E902 No such file or directory (os error 2)

Additional considerations

Using the quoted paths to set up the PYTHONPATH does not work. This can be tested by running the unit tests.

References

• Issue, from the tox repository.
• Recommended approach, from the tox repository.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.40%. Comparing base (3f31bbf) to head (c74d66b).
Report is 5 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #678   +/-   ##
=======================================
  Coverage   71.40%   71.40%           
=======================================
  Files          13       13           
  Lines        3189     3189           
  Branches      475      475           
=======================================
  Hits         2277     2277           
  Misses        797      797           
  Partials      115      115           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[marceloneppel]

Great job, @sinclert-canonical! I saw that the unit tox environment still fails because it has another path variable in the following command:

poetry run coverage run --source={[vars]src_path} \
        -m pytest -v --tb native -s {posargs} {[vars]tests_path}/unit

[sinclert-canonical]

I am confused. Both {[vars]src_path} and {[vars]tests_path} parts of the command are quoted already.

Running the unit test command locally, in this branch, works, as well as the CI job associated with this changes (reference). Could you share the CLI entry-point you are executing to that failure?

[marceloneppel]

Sorry, I believe that in one of my tests yesterday I probably forgot to checkout the PR branch again. Now it's working.

[sinclert-canonical]

Thanks folks! Will go ahead and merge it.

Just FYI: I think this tiny fix could be applied to, literally, all the MySQL / PostgreSQL codebases. So, if you agree if the chosen approach, prepare for a myriad of tiny PRs 😄

[dragomirp]

Just FYI: I think this tiny fix could be applied to, literally, all the MySQL / PostgreSQL codebases. So, if you agree if the chosen approach, prepare for a myriad of tiny PRs 😄

Yes, do you have a list of all the repos to tweak?