Summary

Ease restrictions on installing into non-empty site directories.

Review Request #12997 — Created April 30, 2023 and updated May 22, 2023, 9:39 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

rb-site install will now permit installing into a site directory that
contains only a venv folder. This is to enable deployments where a
virtual environment is first set up in the destination sitedir, and then
the installed rb-site is used to populate the sitedir.

There's also a --allow-non-empty-sitedir option for advanced use,
which bypasses the empty sitedir check.

Testing Done

Tested installing into a populated sitedir. It gave me the expected error.

Tested installing into a new location. Installation was allowed.

Tested installing into a directory containing just a venv directory.
Installation was allowed.

Tested installing into an empty directory. Installation was allowed.

Tested installing into a populated sitedir and using
--allow-non-empty-sitedir. Installation was allowed.

Commits

Summary	ID
Ease restrictions on installing into non-empty site directories. `rb-site install` will now permit installing into a site directory that contains only a `venv` folder. This is to enable deployments where a virtual environment is first set up in the destination sitedir, and then the installed `rb-site` is used to populate the sitedir. There's also a `--allow-non-empty-sitedir` option for advanced use, which bypasses the empty sitedir check.	250004ff338b8ff4146c06cba12e4ce04dfa4726

Summary

Ease restrictions on installing into non-empty site directories.

`rb-site install` will now permit installing into a site directory that contains only a `venv` folder. This is to enable deployments where a virtual environment is first set up in the destination sitedir, and then the installed `rb-site` is used to populate the sitedir. There's also a `--allow-non-empty-sitedir` option for advanced use, which bypasses the empty sitedir check.

250004ff338b8ff4146c06cba12e4ce04dfa4726

Issues

Description	From	Last Updated
I think it's somewhat confusing to have the conditional be in the assignment to site_contents. How about we do: site_contents …	david	May 19, 2023, 4:34 p.m.

flake8 passed.

JSHint passed.

Testing Done:

	+	Tested installing into a populated sitedir. It gave me the expected error.
	+
	+	Tested installing into a new location. Installation was allowed.
	+
	+	Tested installing into a directory containing just a `venv` directory.
	+	Installation was allowed.
	+
	+	Tested installing into an empty directory. Installation was allowed.
	+
	+	Tested installing into a populated sitedir and using
	+	`--allow-non-empty-sitedir`. Installation was allowed.

reviewboard/cmdline/rbsite.py (Diff revision 1)

The issue has been resolved. Show all issues

I think it's somewhat confusing to have the conditional be in the assignment to site_contents. How about we do:

site_contents = os.listdir(install_dir)

if (site_contents and
    site contents != ['venv'] and
    not options.allow_non_empty_sitedir):
    ...

chipx86 May 3, 2023, 10:25 p.m.

I was just aiming to avoid an unncessary os.listdir(), but that's probably not worth optimizing for.

Change Summary:

Simplified the logic for determining whether a directory can be installed into.

Commits:

	Summary	ID
	Ease restrictions on installing into non-empty site directories. `rb-site install` will now permit installing into a site directory that contains only a `venv` folder. This is to enable deployments where a virtual environment is first set up in the destination sitedir, and then the installed `rb-site` is used to populate the sitedir. There's also a `--allow-non-empty-sitedir` option for advanced use, which bypasses the empty sitedir check.	3fc1ba7366fdcc779a7180267883d9c1341f8d83
	Ease restrictions on installing into non-empty site directories. `rb-site install` will now permit installing into a site directory that contains only a `venv` folder. This is to enable deployments where a virtual environment is first set up in the destination sitedir, and then the installed `rb-site` is used to populate the sitedir. There's also a `--allow-non-empty-sitedir` option for advanced use, which bypasses the empty sitedir check.	250004ff338b8ff4146c06cba12e4ce04dfa4726

Diff:

Revision 2 (+42 -6)

Show changes

reviewboard/cmdline/rbsite.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```