Add dependency checks for TFS.

Review Request #12554 — Created Aug. 19, 2022 and submitted — Latest diff uploaded

Information

RBTools
release-4.x

Reviewers

This updates TFSClient to add formal support for dependency checks.
Unlike most other SCM updates, this one's a bit more complicated due to
the three wrapper classes that can be chosen.

The wrapper classes now all inherit from a base class, which defines the
interface for wrappers. They then override their own
check_dependencies(), performing the checks that used to be done in
TFSClient.

TFSClient has been updated to check each wrapper in order, selecting
one that passes dependency checks, or failing with a hopefully helpful
error listing broad dependencies.

That has the added benefit of now allowing a fallback to TEE when the TF
Helper is installed but Java is not.

The tf_wrapper attribute is now a property, which enforces a
dependency check, emitting a warning if dependencies haven't already
been checked via setup() or has_dependencies(). All methods on
TFSClient go through this already, ensuring this is used.

There weren't any TFS unit tests before. This change adds the first
ones, which are all focused on the variety of dependency checks.

Unit tests pass on Python 3.7-3.11.

Diff Revision 3 (Latest)

orig
1
2
3

Commits

First Last Summary ID Author
Add dependency checks for TFS.
This updates `TFSClient` to add formal support for dependency checks. Unlike most other SCM updates, this one's a bit more complicated due to the three wrapper classes that can be chosen. The wrapper classes now all inherit from a base class, which defines the interface for wrappers. They then override their own `check_dependencies()`, performing the checks that used to be done in `TFSClient`. `TFSClient` has been updated to check each wrapper in order, selecting one that passes dependency checks, or failing with a hopefully helpful error listing broad dependencies. That has the added benefit of now allowing a fallback to TEE when the TF Helper is installed but Java is not. The `tf_wrapper` attribute is now a property, which enforces a dependency check, emitting a warning if dependencies haven't already been checked via `setup()` or `has_dependencies()`. All methods on `TFSClient` go through this already, ensuring this is used. There weren't any TFS unit tests before. This change adds the first ones, which are all focused on the variety of dependency checks.
a1f884cab7f306b5c6029f9d283eaf2600fd5c06 Christian Hammond
rbtools/clients/tfs.py
rbtools/clients/tests/test_tfs.py
Loading...