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	ID
Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
Rename run_on_all_review_request_changes to always_run	47ea3783f7df75e13577ccce65e2fae5383206d1
Make tool offer a suggestion on a better wrapping.	aa64609da7f66bf0c2d43e27369bce878837092c
Add a test and some other polish.	84e7aaef77f8a1347b19ba273b1100fd34bc34ad
Fix linting issues.	f4c0f8b03c239fdb2aa82354f2186906bc53fb2c

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	ID
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121

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	ID
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
	Rename run_on_all_review_request_changes to always_run	47ea3783f7df75e13577ccce65e2fae5383206d1

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	ID
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
	Rename run_on_all_review_request_changes to always_run	47ea3783f7df75e13577ccce65e2fae5383206d1
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
	Rename run_on_all_review_request_changes to always_run	47ea3783f7df75e13577ccce65e2fae5383206d1
	Make tool offer a suggestion on a better wrapping.	aa64609da7f66bf0c2d43e27369bce878837092c
	Add a test and some other polish.	84e7aaef77f8a1347b19ba273b1100fd34bc34ad

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	ID
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
	Rename run_on_all_review_request_changes to always_run	47ea3783f7df75e13577ccce65e2fae5383206d1
	Make tool offer a suggestion on a better wrapping.	aa64609da7f66bf0c2d43e27369bce878837092c
	Add a test and some other polish.	84e7aaef77f8a1347b19ba273b1100fd34bc34ad
	Make it possible to create Tools that run on every review request update.	a9a72c80d098db1cc1629604b68d3629aabcf189
	First stab at a review request line length formatter tool thing.	868a4307b7b94a820072cbafa5f3b9ef8f338e65
	Linting and documentation fixes	0014db2779e4e12a4a381980c3617c1530e42121
	Rename run_on_all_review_request_changes to always_run	47ea3783f7df75e13577ccce65e2fae5383206d1
	Make tool offer a suggestion on a better wrapping.	aa64609da7f66bf0c2d43e27369bce878837092c
	Add a test and some other polish.	84e7aaef77f8a1347b19ba273b1100fd34bc34ad
	Fix linting issues.	f4c0f8b03c239fdb2aa82354f2186906bc53fb2c

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