Summary

Allow repositories and servers to be defined in separate JSON files.

Review Request #12100 — Created March 4, 2022 and submitted March 14, 2022, 1:54 p.m.

Information

Owner

chipx86

Repository

ReviewBot

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewbot

People

Description

This introduces two new settings: reviewboard_servers_config_path and
repositories_config_path. These are used to point to user-defined JSON
files for Review Board servers and repositories, respectively.

The primary reason for these files is to allow the upcoming Docker
images to point to volume mounts for these configuration files,
separating the configuration in the images (for executable paths and
other settings) from any user-specified lists of servers and
repositories.

The configuration loader will parse these files and append the results
to the reviewboard_servers and repositories lists. This means that
the repository support doesn't have to know anything about these files.
It's purely contained in the configuration loader.

Documentation has been updated to cover these new options and to provide
examples.

Unit tests have also been added to test validation and loading of these
files.

Testing Done

Unit tests passed.

Tested these settings in the upcoming Docker images.

Built the docs and checked that the results appeared correct.

Commits

Summary	ID
Allow repositories and servers to be defined in separate JSON files. This introduces two new settings: `reviewboard_servers_config_path` and `repositories_config_path`. These are used to point to user-defined JSON files for Review Board servers and repositories, respectively. The primary reason for these files is to allow the upcoming Docker images to point to volume mounts for these configuration files, separating the configuration in the images (for executable paths and other settings) from any user-specified lists of servers and repositories. The configuration loader will parse these files and append the results to the `reviewboard_servers` and `repositories` lists. This means that the repository support doesn't have to know anything about these files. It's purely contained in the configuration loader. Documentation has been updated to cover these new options and to provide examples. Unit tests have also been added to test validation and loading of these files.	c96093cd16ca42440f7ccdfa421187a8fb56d766

Summary

Allow repositories and servers to be defined in separate JSON files.

This introduces two new settings: `reviewboard_servers_config_path` and `repositories_config_path`. These are used to point to user-defined JSON files for Review Board servers and repositories, respectively. The primary reason for these files is to allow the upcoming Docker images to point to volume mounts for these configuration files, separating the configuration in the images (for executable paths and other settings) from any user-specified lists of servers and repositories. The configuration loader will parse these files and append the results to the `reviewboard_servers` and `repositories` lists. This means that the repository support doesn't have to know anything about these files. It's purely contained in the configuration loader. Documentation has been updated to cover these new options and to provide examples. Unit tests have also been added to test validation and loading of these files.

c96093cd16ca42440f7ccdfa421187a8fb56d766

Issues

Description	From	Last Updated
E501 line too long (84 > 79 characters)	reviewbot	March 6, 2022, 5:38 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:38 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:38 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:38 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.
F841 local variable 'config_file' is assigned to but never used	reviewbot	March 6, 2022, 5:39 p.m.

flake8 failed.

JSHint passed.

flake8

bot/reviewbot/config.py (Diff revision 1)
Show all issues
```
E501 line too long (84 > 79 characters)
```

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

bot/reviewbot/tests/test_config.py (Diff revision 1)

Show all issues

F841 local variable 'config_file' is assigned to but never used

Change Summary:


Fixed a line length error from a search-and-replace.
Removed unused variables in configuration loading in unit tests.

Commits:

	Summary	ID
	Allow repositories and servers to be defined in separate JSON files. This introduces two new settings: `reviewboard_servers_config_path` and `repositories_config_path`. These are used to point to user-defined JSON files for Review Board servers and repositories, respectively. The primary reason for these files is to allow the upcoming Docker images to point to volume mounts for these configuration files, separating the configuration in the images (for executable paths and other settings) from any user-specified lists of servers and repositories. The configuration loader will parse these files and append the results to the `reviewboard_servers` and `repositories` lists. This means that the repository support doesn't have to know anything about these files. It's purely contained in the configuration loader. Documentation has been updated to cover these new options and to provide examples. Unit tests have also been added to test validation and loading of these files.	f322decbcbfb14e093f87f57515442c5105eee8b
	Allow repositories and servers to be defined in separate JSON files. This introduces two new settings: `reviewboard_servers_config_path` and `repositories_config_path`. These are used to point to user-defined JSON files for Review Board servers and repositories, respectively. The primary reason for these files is to allow the upcoming Docker images to point to volume mounts for these configuration files, separating the configuration in the images (for executable paths and other settings) from any user-specified lists of servers and repositories. The configuration loader will parse these files and append the results to the `reviewboard_servers` and `repositories` lists. This means that the repository support doesn't have to know anything about these files. It's purely contained in the configuration loader. Documentation has been updated to cover these new options and to provide examples. Unit tests have also been added to test validation and loading of these files.	c96093cd16ca42440f7ccdfa421187a8fb56d766

Diff:

Revision 2 (+1164 -66)

Show changes

	bot/reviewbot/config.py
	bot/reviewbot/tests/test_config.py
	docs/reviewbot/configuration.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (4b4574d)