Summary

Reimplement the TREES config option.

Review Request #14219 — Created Oct. 31, 2024 and submitted Nov. 6, 2024, 8:27 a.m.

Information

Owner

david

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

Older versions of RBTools had an undocumented config option called
TREES, which allowed people to set the REVIEWBOARD_URL for multiple
remote repository paths from a single .reviewboardrc file in their home
directory. After a deprecation cycle, we removed this, but it turns out
that some people were using it and had just skipped all the intermediate
versions of RBTools and went straight from 1 to 5, missing the
deprecation warnings.

This change implements a new version of TREES which is much more full
featured. This allows using either the remote repository path or local
directory name as the keys, and the value dictionaries now support the
full RBTools configuration.

The way this works is that we go through the basic initialization
routine to the point where we've initialized the repository. After that,
we'll look to see if there's a matching TREES configuration. If there
is, we merge that into the base config, remove TREES entirely from the
loaded config, and then rerun all initialization.

Testing Done


Set up TREES in my own .reviewboardrc file and verified that things

  worked as expected.
Added some new tests that cover the three main codepaths for command

  initialization--no configured server URL, a single server URL, and a

  server URL that gets overridden inside of TREES.
Ran all unit tests.

Commits

Summary	ID
Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	d01e2525ee243c91ee09baaa876bab26d66f47fd

Summary

Reimplement the TREES config option.

Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.

d01e2525ee243c91ee09baaa876bab26d66f47fd

Issues

Description	From	Last Updated
continuation line over-indented for visual indent Column: 21 Error code: E127	reviewbot	Oct. 31, 2024, 10:10 a.m.
We should use :file: for .reviewboardrc	chipx86	Nov. 1, 2024, 8:18 a.m.
The upcoming release is 5.1.	chipx86	Nov. 1, 2024, 8:22 a.m.
For this, we want to be explicit and use: ... code-block:: python TREES = { ...	chipx86	Nov. 1, 2024, 8:20 a.m.
This needs a Version Added.	chipx86	Nov. 1, 2024, 8:20 a.m.
Missing a Version Added. Same with the classes below.	chipx86	Nov. 1, 2024, 8:20 a.m.
Missing Returns.	chipx86	Nov. 1, 2024, 8:21 a.m.
No trailing period here or in the ones below for test docstrings.	chipx86	Nov. 1, 2024, 8:21 a.m.
Should be 5.1, assuming it's coming to the upcoming release.	chipx86	Nov. 1, 2024, 8:22 a.m.
Should we add a Raises section to the method docs for this and the NeedsReinitialize error?	maubin	Nov. 5, 2024, 3:21 p.m.
We should maybe use https in the example here, so this doesn't look stale.	chipx86	Nov. 6, 2024, 8:25 a.m.

flake8 failed.

JSHint passed.

flake8

rbtools/commands/tests/test_command_initialization.py (Diff revision 1)
The issue has been dropped. Show all issues
```
continuation line over-indented for visual indent

Column: 21
Error code: E127
```

Commits:

	Summary	ID
	Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	564217e85ecdb0f89b989c354efcc1a313f698bc
	Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	35fcbcbd8eeb36ce7701bad4b61e1bfb1060da20

Diff:

Revision 2 (+544 -172)

Show changes

	docs/rbtools/rbt/configuration/users.rst
	rbtools/commands/base/commands.py
	rbtools/commands/base/errors.py
	rbtools/commands/tests/test_alias.py
	rbtools/commands/tests/test_command_initialization.py
	rbtools/commands/tests/test_post.py
	rbtools/config/__init__.py
	rbtools/config/config.py
	1 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

```
Code looks good. Just a few docs nits.
```
docs/rbtools/rbt/configuration/users.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
We should use :file: for .reviewboardrc
```

docs/rbtools/rbt/configuration/users.rst (Diff revision 2)

The issue has been resolved. Show all issues

For this, we want to be explicit and use:

... code-block:: python

    TREES = { ...

rbtools/commands/base/errors.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This needs a Version Added.
```
rbtools/commands/tests/test_command_initialization.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing a Version Added. Same with the classes below.
```

rbtools/commands/tests/test_command_initialization.py (Diff revision 2)

The issue has been resolved. Show all issues

Missing Returns.

rbtools/commands/tests/test_command_initialization.py (Diff revision 2)
The issue has been resolved. Show all issues
```
No trailing period here or in the ones below for test docstrings.
```

docs/rbtools/rbt/configuration/users.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
The upcoming release is 5.1.
```
rbtools/config/config.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Should be 5.1, assuming it's coming to the upcoming release.
```

Commits:

	Summary	ID
	Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	35fcbcbd8eeb36ce7701bad4b61e1bfb1060da20
	Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	795e13f51ca7096d18132913ed978679cfaf55a3

Diff:

Revision 3 (+584 -172)

Show changes

	docs/rbtools/rbt/configuration/users.rst
	rbtools/commands/base/commands.py
	rbtools/commands/base/errors.py
	rbtools/commands/tests/test_alias.py
	rbtools/commands/tests/test_command_initialization.py
	rbtools/commands/tests/test_post.py
	rbtools/config/__init__.py
	rbtools/config/config.py
	1 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/commands/base/commands.py (Diff revision 3)

The issue has been resolved. Show all issues

Should we add a Raises section to the method docs for this and the NeedsReinitialize error?

Commits:

	Summary	ID
	Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	795e13f51ca7096d18132913ed978679cfaf55a3
	Reimplement the TREES config option. Older versions of RBTools had an undocumented config option called `TREES`, which allowed people to set the `REVIEWBOARD_URL` for multiple remote repository paths from a single .reviewboardrc file in their home directory. After a deprecation cycle, we removed this, but it turns out that some people were using it and had just skipped all the intermediate versions of RBTools and went straight from 1 to 5, missing the deprecation warnings. This change implements a new version of `TREES` which is much more full featured. This allows using either the remote repository path or local directory name as the keys, and the value dictionaries now support the full RBTools configuration. The way this works is that we go through the basic initialization routine to the point where we've initialized the repository. After that, we'll look to see if there's a matching TREES configuration. If there is, we merge that into the base config, remove TREES entirely from the loaded config, and then rerun all initialization. Testing Done: - Set up TREES in my own .reviewboardrc file and verified that things worked as expected. - Added some new tests that cover the three main codepaths for command initialization--no configured server URL, a single server URL, and a server URL that gets overridden inside of TREES. - Ran all unit tests.	d01e2525ee243c91ee09baaa876bab26d66f47fd

Diff:

Revision 4 (+600 -172)

Show changes

	docs/rbtools/rbt/configuration/users.rst
	rbtools/commands/base/commands.py
	rbtools/commands/base/errors.py
	rbtools/commands/tests/test_alias.py
	rbtools/commands/tests/test_command_initialization.py
	rbtools/commands/tests/test_post.py
	rbtools/config/__init__.py
	rbtools/config/config.py
	1 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

docs/rbtools/rbt/configuration/users.rst (Diff revision 4)
The issue has been resolved. Show all issues
```
We should maybe use https in the example here, so this doesn't look stale.
```

Status:: Completed
Change Summary:: Pushed to release-5.x (d93ff87)