This change has been marked as completed.

Describe the completed change (optional):

Pushed to release-5.x (8ff4f39)

Summary

Fix issues when running rbt commands outside of a repository with TREES.

Review Request #14396 — Created April 4, 2025 and submitted 1 day, 16 hours ago

Information

Owner

david*

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description*

When running some rbt commands outside of a repository (such as
rbt api-get or rbt patch --print) and using the TREES
configuration to define the server URL, rbtools would exit with a
message about being unable to find a repository. This was a regression
caused by the previous fix in 5.2 to allow these commands to use TREES.

This fix plumbs through the tool_required flag to
scan_usable_client, making it so we don't exit if we don't find a tool
at all.

Testing Done


Ran unit tests.
Was able to successfully use rbt patch --print, rbt patch --write,

  and rbt api-get outside of any source tree when using TREES to

  define the server URL.
Verified that TREES still worked as expected.

Commits

Summary	ID
Fix issues when running rbt commands outside of a repository with TREES. When running some rbt commands outside of a repository (such as `rbt api-get` or `rbt patch --print`) and using the `TREES` configuration to define the server URL, rbtools would exit with a message about being unable to find a repository. This was a regression caused by the previous fix in 5.2 to allow these commands to use TREES. This fix plumbs through the `tool_required` flag to `scan_usable_client`, making it so we don't exit if we don't find a tool at all. Testing Done: - Ran unit tests. - Was able to successfully use `rbt patch --print`, `rbt patch --write`, and `rbt api-get` outside of any source tree when using `TREES` to define the server URL. - Verified that `TREES` still worked as expected.	d9e58384a399fab76e63108e1f971d336ac0065f

Summary

Fix issues when running rbt commands outside of a repository with TREES.

When running some rbt commands outside of a repository (such as `rbt api-get` or `rbt patch --print`) and using the `TREES` configuration to define the server URL, rbtools would exit with a message about being unable to find a repository. This was a regression caused by the previous fix in 5.2 to allow these commands to use TREES. This fix plumbs through the `tool_required` flag to `scan_usable_client`, making it so we don't exit if we don't find a tool at all. Testing Done: - Ran unit tests. - Was able to successfully use `rbt patch --print`, `rbt patch --write`, and `rbt api-get` outside of any source tree when using `TREES` to define the server URL. - Verified that `TREES` still worked as expected.

d9e58384a399fab76e63108e1f971d336ac0065f

Issues

Description	From	Last Updated
Can you verify in testing that TREES otherwise is working as expected for other uses?	chipx86	3 days, 16 hours ago
This should be :rbtconfig:	chipx86	3 days, 16 hours ago
We can probably skip the last sentence. The summary states we fix it already.	chipx86	3 days, 16 hours ago
There are no open issues

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

The issue has been resolved. Show all issues

Can you verify in testing that TREES otherwise is working as expected for other uses?

david 3 days, 16 hours ago
```
Yep, all good.
```

docs/releasenotes/5.2.1.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
This should be :rbtconfig:
```
docs/releasenotes/5.2.1.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
We can probably skip the last sentence. The summary states we fix it already.
```

Testing Done:

~		Was able to successfully use `rbt patch --print`, `rbt patch --write`,
~		and `rbt api-get` outside of any source tree when using `TREES` to
~		define the server URL.
	~	Ran unit tests.
	~	Was able to successfully use `rbt patch --print`, `rbt patch --write`, and `rbt api-get` outside of any source tree when using `TREES` to define the server URL.
	~	Verified that `TREES` still worked as expected.

Commits:

	Summary	ID
	Fix issues when running rbt commands outside of a repository with TREES. When running some rbt commands outside of a repository (such as `rbt api-get` or `rbt patch --print`) and using the `TREES` configuration to define the server URL, rbtools would exit with a message about being unable to find a repository. This was a regression caused by the previous fix in 5.2 to allow these commands to use TREES. This fix plumbs through the `tool_required` flag to `scan_usable_client`, making it so we don't exit if we don't find a tool at all. Testing Done: Was able to successfully use `rbt patch --print`, `rbt patch --write`, and `rbt api-get` outside of any source tree when using `TREES` to define the server URL.	726c8436e87bab21bca1966ed9a1e527f578e9fb
	Fix issues when running rbt commands outside of a repository with TREES. When running some rbt commands outside of a repository (such as `rbt api-get` or `rbt patch --print`) and using the `TREES` configuration to define the server URL, rbtools would exit with a message about being unable to find a repository. This was a regression caused by the previous fix in 5.2 to allow these commands to use TREES. This fix plumbs through the `tool_required` flag to `scan_usable_client`, making it so we don't exit if we don't find a tool at all. Testing Done: - Ran unit tests. - Was able to successfully use `rbt patch --print`, `rbt patch --write`, and `rbt api-get` outside of any source tree when using `TREES` to define the server URL. - Verified that `TREES` still worked as expected.	d9e58384a399fab76e63108e1f971d336ac0065f

Diff:

Revision 2 (+120 -4)

Show changes

	docs/releasenotes/5.2.1.rst
	docs/releasenotes/index.rst
	rbtools/clients/__init__.py
	rbtools/commands/base/commands.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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

docs/releasenotes/5.2.1.rst (Diff revision 1)

docs/releasenotes/5.2.1.rst (Diff revision 1)