Summary:

Add a Review Bot tool for looking at Review Request field formatting

Review Request #11815 — Created Sept. 17, 2021 and updated Sept. 18, 2021, 4:14 p.m.

Information
Owner:	mike_conley
Repository:	ReviewBot
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	reviewbot
People:

Description

Adds a tool to Review Bot that checks line lengths on the Description
and Testing Done fields for review requests, and opens general comments
when they exceed a limit (defaulting to 79 characters). Those general
comments include suggested wrapping.

Testing Done

Included an automated test that tests both short and long strings for
the Description and Testing Done fields. I also tested this manually.

Commits

Summary
Make it possible to create Tools that run on every review request update.
First stab at a review request line length formatter tool thing.
Linting and documentation fixes
Rename run_on_all_review_request_changes to always_run
Make tool offer a suggestion on a better wrapping.
Add a test and some other polish.
Fix linting issues.

Screenshots

Issues

Description	From	Last Updated
F401 'six' imported but unused	reviewbot	Sept. 18, 2021, 8:33 a.m.
F401 'reviewbot.config.config' imported but unused	reviewbot	Sept. 18, 2021, 8:33 a.m.
E302 expected 2 blank lines, found 1	reviewbot	Sept. 18, 2021, 8:33 a.m.
E501 line too long (84 > 79 characters)	reviewbot	Sept. 18, 2021, 9:04 a.m.
E501 line too long (85 > 79 characters)	reviewbot	Sept. 18, 2021, 9:05 a.m.
E225 missing whitespace around operator	reviewbot	Sept. 18, 2021, 9:06 a.m.
This mixin is probably unnecessary. Better to just have the tool set these members.	mike_conley	Sept. 18, 2021, 12:45 p.m.
Let's rename this to always_run.	mike_conley	Sept. 18, 2021, 1 p.m.
E501 line too long (91 > 79 characters)	reviewbot	Sept. 18, 2021, 4:09 p.m.
E501 line too long (92 > 79 characters)	reviewbot	Sept. 18, 2021, 4:09 p.m.

flake8 failed.

JSHint passed.

flake8

bot/reviewbot/tools/rbfieldformatter.py (Diff revision 1)
Show all issues
```
F401 'six' imported but unused
```
bot/reviewbot/tools/rbfieldformatter.py (Diff revision 1)
Show all issues
```
F401 'reviewbot.config.config' imported but unused
```
bot/reviewbot/tools/rbfieldformatter.py (Diff revision 1)
Show all issues
```
E302 expected 2 blank lines, found 1
```
bot/reviewbot/tools/rbfieldformatter.py (Diff revision 1)
Show all issues
```
E501 line too long (84 > 79 characters)
```

bot/setup.py (Diff revision 1)

Show all issues

E501 line too long (85 > 79 characters)

extension/reviewbotext/integration.py (Diff revision 1)
Show all issues
```
E225 missing whitespace around operator
```

Commits:

	Summary
-	Make it possible to create Tools that run on every review request update.
-	First stab at a review request line length formatter tool thing.
+	Make it possible to create Tools that run on every review request update.
+	First stab at a review request line length formatter tool thing.
+	Linting and documentation fixes

Diff:

Revision 2 (+267 -49)

Show changes

	bot/setup.py
	bot/reviewbot/tasks.py
	bot/reviewbot/processing/review.py
	bot/reviewbot/tools/rbfieldformatter.py
	bot/reviewbot/tools/base/__init__.py
	bot/reviewbot/tools/base/mixins.py
	bot/reviewbot/tools/base/tool.py
	extension/reviewbotext/integration.py
	4 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

extension/reviewbotext/models.py (Diff revision 2)
Show all issues
```
Let's rename this to always_run.
```

bot/reviewbot/tools/base/mixins.py (Diff revision 2)

Show all issues

This mixin is probably unnecessary. Better to just have the tool set these members.

Commits:

	Summary
-	Make it possible to create Tools that run on every review request update.
-	First stab at a review request line length formatter tool thing.
-	Linting and documentation fixes
+	Make it possible to create Tools that run on every review request update.
+	First stab at a review request line length formatter tool thing.
+	Linting and documentation fixes
+	Rename run_on_all_review_request_changes to always_run

Diff:

Revision 3 (+266 -74)

Show changes

	bot/setup.py
	bot/reviewbot/tasks.py
	bot/reviewbot/processing/review.py
	bot/reviewbot/tools/rbfieldformatter.py
	bot/reviewbot/tools/base/tool.py
	extension/reviewbotext/integration.py
	extension/reviewbotext/models.py
	extension/reviewbotext/resources.py
	2 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	[WIP] Add a ReviewBot tool for looking at Review Request field formatting
+	Add a ReviewBot tool for looking at Review Request field formatting

Description:

~		First stab at a review request line length formatter tool thing.
	~	Adds a tool to Review Bot that checks line lengths on the Description
	+	and Testing Done fields for review requests, and opens general comments
	+	when they exceed a limit (defaulting to 79 characters). Those general
	+	comments include suggested wrapping.

Testing Done:

~		Just manual testing for now. I plan on adding automated testing once
~		the implementation architecture settles.
	~	Included an automated test that tests both short and long strings for
	~	the Description and Testing Done fields. I also tested this manually.

Commits:

	Summary
-	Make it possible to create Tools that run on every review request update.
-	First stab at a review request line length formatter tool thing.
-	Linting and documentation fixes
-	Rename run_on_all_review_request_changes to always_run
+	Make it possible to create Tools that run on every review request update.
+	First stab at a review request line length formatter tool thing.
+	Linting and documentation fixes
+	Rename run_on_all_review_request_changes to always_run
+	Make tool offer a suggestion on a better wrapping.
+	Add a test and some other polish.

Diff:

Revision 4 (+742 -96)

Show changes

	bot/setup.py
	bot/reviewbot/tasks.py
	bot/reviewbot/processing/review.py
	bot/reviewbot/testing/testcases.py
	bot/reviewbot/tools/rbfieldformatter.py
	bot/reviewbot/tools/base/tool.py
	bot/reviewbot/tools/tests/test_rbfieldformatter.py
	extension/reviewbotext/integration.py
	4 more

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

bot/reviewbot/tools/rbfieldformatter.py (Diff revision 4)
Show all issues
```
E501 line too long (91 > 79 characters)
```
bot/reviewbot/tools/rbfieldformatter.py (Diff revision 4)
Show all issues
```
E501 line too long (92 > 79 characters)
```

Commits:

	Summary
-	Make it possible to create Tools that run on every review request update.
-	First stab at a review request line length formatter tool thing.
-	Linting and documentation fixes
-	Rename run_on_all_review_request_changes to always_run
-	Make tool offer a suggestion on a better wrapping.
-	Add a test and some other polish.
+	Make it possible to create Tools that run on every review request update.
+	First stab at a review request line length formatter tool thing.
+	Linting and documentation fixes
+	Rename run_on_all_review_request_changes to always_run
+	Make tool offer a suggestion on a better wrapping.
+	Add a test and some other polish.
+	Fix linting issues.

Diff:

Revision 5 (+756 -98)

Show changes

	bot/setup.py
	bot/reviewbot/tasks.py
	bot/reviewbot/processing/review.py
	bot/reviewbot/testing/testcases.py
	bot/reviewbot/tools/rbfieldformatter.py
	bot/reviewbot/tools/base/tool.py
	bot/reviewbot/tools/tests/test_rbfieldformatter.py
	extension/reviewbotext/integration.py
	4 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Summary:

-	Add a ReviewBot tool for looking at Review Request field formatting
+	Add a Review Bot tool for looking at Review Request field formatting