Summary

Add dependency checks for Bazaar.

Review Request #12544 — Created Aug. 18, 2022 and submitted Aug. 23, 2022, 6:33 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This updates BazaarClient to add formal support for dependency checks.
BazaarClient.check_dependencies() now determines if Breezy or Bazaar
is installed, and sets appropriate flags for the tool to use.

The bzr and is_breezy attributes have become properties, which will
trigger a dependency check if one is not performed. Similarly,
get_local_path() will also perform a dependency check if needed. This
is all in case of legacy usage where these are accessed before calling
setup() or has_dependencies(). In RBTools 5, these will instead
raise an exception.

Unit tests have been updated to include new dependency-related tests.
They also now leverage the dependency checks, rather than duplicating
checks or working around the different names of the tool. Tests that
require a working client will be skipped if missing a dependency.

Testing Done

Unit tests pass on Python 3.7 through 3.11.

Tested with Breezy installed, with Bazaar installed, and with neither
installed.

Commits

Summary	ID
Add dependency checks for Bazaar. This updates `BazaarClient` to add formal support for dependency checks. `BazaarClient.check_dependencies()` now determines if Breezy or Bazaar is installed, and sets appropriate flags for the tool to use. The `bzr` and `is_breezy` attributes have become properties, which will trigger a dependency check if one is not performed. Similarly, `get_local_path()` will also perform a dependency check if needed. This is all in case of legacy usage where these are accessed before calling `setup()` or `has_dependencies()`. In RBTools 5, these will instead raise an exception. Unit tests have been updated to include new dependency-related tests. They also now leverage the dependency checks, rather than duplicating checks or working around the different names of the tool. Tests that require a working client will be skipped if missing a dependency.	51cbcffc36de098dd18395ab5c80e8353d92a9e8

Summary

Add dependency checks for Bazaar.

This updates `BazaarClient` to add formal support for dependency checks. `BazaarClient.check_dependencies()` now determines if Breezy or Bazaar is installed, and sets appropriate flags for the tool to use. The `bzr` and `is_breezy` attributes have become properties, which will trigger a dependency check if one is not performed. Similarly, `get_local_path()` will also perform a dependency check if needed. This is all in case of legacy usage where these are accessed before calling `setup()` or `has_dependencies()`. In RBTools 5, these will instead raise an exception. Unit tests have been updated to include new dependency-related tests. They also now leverage the dependency checks, rather than duplicating checks or working around the different names of the tool. Tests that require a working client will be skipped if missing a dependency.

51cbcffc36de098dd18395ab5c80e8353d92a9e8

Issues

Description	From	Last Updated
Want to add str while you're in here?	david	Aug. 19, 2022, 4:13 p.m.
Docs don't match up with type annotations and implementation.	david	Aug. 19, 2022, 4:14 p.m.

flake8 passed.

JSHint passed.

rbtools/clients/bazaar.py (Diff revision 1)

The issue has been resolved. Show all issues

Want to add str while you're in here?

chipx86 Aug. 19, 2022, 4:14 p.m.

Yeah I'll do that. It's apparently inferred if assigned to a string initially, but better to be explicit.

rbtools/clients/bazaar.py (Diff revision 1)

The issue has been resolved. Show all issues

Docs don't match up with type annotations and implementation.

chipx86 Aug. 19, 2022, 4:14 p.m.
```
Oof yep.
```

Change Summary:

Fixed type annotations for the bzr property and the wrapped attribute.

Commits:

	Summary	ID
	Add dependency checks for Bazaar. This updates `BazaarClient` to add formal support for dependency checks. `BazaarClient.check_dependencies()` now determines if Breezy or Bazaar is installed, and sets appropriate flags for the tool to use. The `bzr` and `is_breezy` attributes have become properties, which will trigger a dependency check if one is not performed. Similarly, `get_local_path()` will also perform a dependency check if needed. This is all in case of legacy usage where these are accessed before calling `setup()` or `has_dependencies()`. In RBTools 5, these will instead raise an exception. Unit tests have been updated to include new dependency-related tests. They also now leverage the dependency checks, rather than duplicating checks or working around the different names of the tool. Tests that require a working client will be skipped if missing a dependency.	7aed3d0345245e678734514ddf6fdb7ff08cc60c
	Add dependency checks for Bazaar. This updates `BazaarClient` to add formal support for dependency checks. `BazaarClient.check_dependencies()` now determines if Breezy or Bazaar is installed, and sets appropriate flags for the tool to use. The `bzr` and `is_breezy` attributes have become properties, which will trigger a dependency check if one is not performed. Similarly, `get_local_path()` will also perform a dependency check if needed. This is all in case of legacy usage where these are accessed before calling `setup()` or `has_dependencies()`. In RBTools 5, these will instead raise an exception. Unit tests have been updated to include new dependency-related tests. They also now leverage the dependency checks, rather than duplicating checks or working around the different names of the tool. Tests that require a working client will be skipped if missing a dependency.	51cbcffc36de098dd18395ab5c80e8353d92a9e8

Diff:

Revision 2 (+782 -106)

Show changes

	rbtools/clients/bazaar.py
	rbtools/clients/base/scmclient.py
	rbtools/clients/tests/test_bzr.py
	rbtools/clients/tests/testdata/homedir/.gitignore

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-4.x (8931f0e)