Summary

Update the PMD code, docs, configuration, and tests for the latest changes.

Review Request #11530 — Created March 16, 2021 and submitted March 25, 2021, 1:52 a.m.

Information

Owner

chipx86

Repository

ReviewBot

Branch

release-3.0.x

Bugs

Depends On

Reviewers

Groups

reviewbot

People

Description

PMD has been updated to use the renamed BaseTool class and to take

advantage of the new dependency management, to simplify code.
As part of this, configuration has become standardized, allowing the

pmd tool path to be located on the fileystem (if in $PATH) or

configured in the worker's exe_paths setting. This has the additional

small benefit of caching the pmd binary path, so it doesn't have to be

looked up in $PATH at execution time.
The old pmd_path setting has been deprecated. It will be transitioned

over when loading the configuration. Documentation has been updated to

discuss this.
The list of file extensions are now more forgiving. Extra commas, spaces,

and leading . for file extensions are handled correctly.
The documentation has been fleshed out to go over the fields present

during tool configuration.
Unit tests have been added for handle_file(), to give us a base for

future work and to ensure that the cached pmd path is being used.

Testing Done

Unit tests pass.

Tested dependency checking in the worker, with pmd in the $PATH
and with an explicit path provided in exe_paths.

Built the docs. Checked for build errors, spelling errors, and bad links.

Commits

Summary	ID
Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	eeb5b24cf4fadf0961a3b4b5b513f0f82d3c7cc7

Summary

Update the PMD code, docs, configuration, and tests for the latest changes.

PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.

eeb5b24cf4fadf0961a3b4b5b513f0f82d3c7cc7

Issues

Description	From	Last Updated
F401 'reviewbot.config.config' imported but unused	reviewbot	March 16, 2021, 11:27 p.m.
F811 redefinition of unused 'config' from line 9	reviewbot	March 16, 2021, 11:28 p.m.
F811 redefinition of unused 'config' from line 9	reviewbot	March 16, 2021, 11:28 p.m.
F841 local variable 'review' is assigned to but never used	reviewbot	March 16, 2021, 11:28 p.m.
F841 local variable 'review' is assigned to but never used	reviewbot	March 16, 2021, 11:28 p.m.
F811 redefinition of unused 'config' from line 9	reviewbot	March 16, 2021, 11:28 p.m.

flake8 failed.

JSHint passed.

flake8

bot/reviewbot/tools/tests/test_pmd.py (Diff revision 1)
Show all issues
```
F401 'reviewbot.config.config' imported but unused
```
bot/reviewbot/tools/tests/test_pmd.py (Diff revision 1)
Show all issues
```
F811 redefinition of unused 'config' from line 9
```
bot/reviewbot/tools/tests/test_pmd.py (Diff revision 1)
Show all issues
```
F811 redefinition of unused 'config' from line 9
```
bot/reviewbot/tools/tests/test_pmd.py (Diff revision 1)
Show all issues
```
F841 local variable 'review' is assigned to but never used
```
bot/reviewbot/tools/tests/test_pmd.py (Diff revision 1)
Show all issues
```
F841 local variable 'review' is assigned to but never used
```
bot/reviewbot/tools/tests/test_pmd.py (Diff revision 1)
Show all issues
```
F811 redefinition of unused 'config' from line 9
```

Change Summary:

Removed unused imports and variables in test_pmd.py.

Commits:

	Summary	ID
	Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	25503f21661aa2ff863044d220892c6dd3b5272a
	Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	4dc0827bf96d95d3521d5ce73b48b858cfae88ad

Diff:

Revision 2 (+732 -56)

Show changes

	bot/reviewbot/config.py
	bot/reviewbot/tests/test_config.py
	bot/reviewbot/tools/pmd.py
	bot/reviewbot/tools/tests/test_pmd.py
	docs/reviewbot/upgrading.rst
	docs/reviewbot/tools/pmd.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Updated the file extension handling support to set the new file_patterns.

Description:

		PMD has been updated to use the renamed `BaseTool` class and to take
		advantage of the new dependency management, to simplify code.

		As part of this, configuration has become standardized, allowing the
		`pmd` tool path to be located on the fileystem (if in `$PATH`) or
		configured in the worker's `exe_paths` setting. This has the additional
		small benefit of caching the `pmd` binary path, so it doesn't have to be
		looked up in `$PATH` at execution time.

		The old `pmd_path` setting has been deprecated. It will be transitioned
		over when loading the configuration. Documentation has been updated to
		discuss this.

	+	The list of file extensions are now more forgiving. Extra commas, spaces,
	+	and leading `.` for file extensions are handled correctly.
	+
		The documentation has been fleshed out to go over the fields present
		during tool configuration.

		Unit tests have been added for `handle_file()`, to give us a base for
		future work and to ensure that the cached `pmd` path is being used.

Commits:

	Summary	ID
	Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	4dc0827bf96d95d3521d5ce73b48b858cfae88ad
	Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	995e0bebb540edd92329bcb69ff466738cf0150d

Diff:

Revision 3 (+762 -72)

Show changes

	bot/reviewbot/config.py
	bot/reviewbot/tests/test_config.py
	bot/reviewbot/tools/pmd.py
	bot/reviewbot/tools/tests/test_pmd.py
	docs/reviewbot/upgrading.rst
	docs/reviewbot/tools/pmd.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Failed to publish the complete new change last time. This actually updates to the new file_patterns.

Commits:

	Summary	ID
	Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	995e0bebb540edd92329bcb69ff466738cf0150d
	Update the PMD code, docs, configuration, and tests for the latest changes. PMD has been updated to use the renamed `BaseTool` class and to take advantage of the new dependency management, to simplify code. As part of this, configuration has become standardized, allowing the `pmd` tool path to be located on the fileystem (if in `$PATH`) or configured in the worker's `exe_paths` setting. This has the additional small benefit of caching the `pmd` binary path, so it doesn't have to be looked up in `$PATH` at execution time. The documentation has been fleshed out to go over the fields present during tool configuration. Unit tests have been added for `handle_file()`, to give us a base for future work and to ensure that the cached `pmd` path is being used.	eeb5b24cf4fadf0961a3b4b5b513f0f82d3c7cc7

Diff:

Revision 4 (+778 -72)

Show changes

	bot/reviewbot/config.py
	bot/reviewbot/tests/test_config.py
	bot/reviewbot/tools/pmd.py
	bot/reviewbot/tools/tests/test_pmd.py
	docs/reviewbot/upgrading.rst
	docs/reviewbot/tools/pmd.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (23f8c44)