Summary

Add a registry for managing and looking up diff tools.

Review Request #12601 — Created Sept. 14, 2022 and submitted Sept. 28, 2022, 12:50 a.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-4.x

Bugs

Depends On

~~12600~~

Blocks

12602

Reviewers

Groups

rbtools

People

Description

This implements DiffToolsRegistry, which tracks all available diff
tools. It can be used to look up registered tool classes and instantiate
available tool instances (which will be cached for reuse).

New tools can also be registered dynamically, though this isn't
something that will be useful outside of very specialized custom code.

When looking up available tools, it will instantiate each tool, set it
up and check for availability on the system, and then cache it.

If an available tool can't be found, a MissingDiffToolError will be
raised. This will contain a list of all tools tried, and any
instructions that candidate tools may provide.

Testing Done

Unit tests pass.

Used this with in-progress changes to SCMClients.

Commits

Summary	ID
Add a registry for managing and looking up diff tools. This implements `DiffToolsRegistry`, which tracks all available diff tools. It can be used to look up registered tool classes and instantiate available tool instances (which will be cached for reuse). New tools can also be registered dynamically, though this isn't something that will be useful outside of very specialized custom code. When looking up available tools, it will instantiate each tool, set it up and check for availability on the system, and then cache it. If an available tool can't be found, a `MissingDiffToolError` will be raised. This will contain a list of all tools tried, and any instructions that candidate tools may provide.	0fa88510199d1665b9da93b763520f5c92575728

Summary

Add a registry for managing and looking up diff tools.

This implements `DiffToolsRegistry`, which tracks all available diff tools. It can be used to look up registered tool classes and instantiate available tool instances (which will be cached for reuse). New tools can also be registered dynamically, though this isn't something that will be useful outside of very specialized custom code. When looking up available tools, it will instantiate each tool, set it up and check for availability on the system, and then cache it. If an available tool can't be found, a `MissingDiffToolError` will be raised. This will contain a list of all tools tried, and any instructions that candidate tools may provide.

0fa88510199d1665b9da93b763520f5c92575728

Issues

Description	From	Last Updated
Add a Version Added:.	maubin	Sept. 20, 2022, 11:34 a.m.
Add a Version Added:.	maubin	Sept. 21, 2022, 7:19 p.m.

flake8 passed.

JSHint passed.

rbtools/diffs/tests/test_diff_tools_registry.py (Diff revision 1)
The issue has been dropped. Show all issues
```
Add a Version Added:.
```
1. david Sept. 20, 2022, 8:54 a.m.
  We usually don't put this for test case classes because it's not really API in the same way as other stuff.
2. maubin Sept. 20, 2022, 11:34 a.m.
  Ah ok.
rbtools/diffs/tests/test_diff_tools_registry.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Add a Version Added:.
```

Ship it!

```
Ship It!
```

Change Summary:

Added a missing Version Added.

Commits:

	Summary	ID
	Add a registry for managing and looking up diff tools. This implements `DiffToolsRegistry`, which tracks all available diff tools. It can be used to look up registered tool classes and instantiate available tool instances (which will be cached for reuse). New tools can also be registered dynamically, though this isn't something that will be useful outside of very specialized custom code. When looking up available tools, it will instantiate each tool, set it up and check for availability on the system, and then cache it. If an available tool can't be found, a `MissingDiffToolError` will be raised. This will contain a list of all tools tried, and any instructions that candidate tools may provide.	a828e3f125d14db2800edcd3354e7a21620ddacf
	Add a registry for managing and looking up diff tools. This implements `DiffToolsRegistry`, which tracks all available diff tools. It can be used to look up registered tool classes and instantiate available tool instances (which will be cached for reuse). New tools can also be registered dynamically, though this isn't something that will be useful outside of very specialized custom code. When looking up available tools, it will instantiate each tool, set it up and check for availability on the system, and then cache it. If an available tool can't be found, a `MissingDiffToolError` will be raised. This will contain a list of all tools tried, and any instructions that candidate tools may provide.	0fa88510199d1665b9da93b763520f5c92575728

Diff:

Revision 2 (+1022)

Show changes

	docs/rbtools/api/coderef/index.rst
	rbtools/diffs/tests/test_diff_tools_registry.py
	rbtools/diffs/tools/errors.py
	rbtools/diffs/tools/registry.py
	rbtools/diffs/tools/base/diff_tool.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

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