Summary

Quick fix for refreshing changes for tools

Review Request #11207 — Created Oct. 1, 2020 and updated Oct. 27, 2020, 10:22 p.m.

Information

Owner

jblazusi

Repository

ReviewBot

Branch

master

Bugs

Depends On

Commit

4bba6ed...

Reviewers

Groups

reviewbot, students

People

ceciliawei, jace

Description

Updated the ReviewBot ToolResource.
Previously the ToolResource would not correctly update changes made to any
ReviewBot Tools. The previous behavior would allow a ReviewBot tool to be
updated only if there is a change in name/version. However, during
development this can be frustrating, since options are being frequently
revised. To fix this problem, I have changed resource to update the
instance of the tool in the database. This is done regardless of a change
in versioning. This makes the process of creating tools easier, since tool
settings made in the tool are updated each time that the ToolResource
create method is called.

Testing Done

This is difficult to do since there is no test framework setup for
ReviewBot. No real tests were done, only manual testing and a quick
visual inspection.

Issues

Description	From	Last Updated
Looks like the description is wrapping a bit too early. Can you target ~70 (upwards of 75) characters for the …	ceciliawei	Oct. 2, 2020, 3:33 p.m.
To pick up the change, do I need to do anything other than setup.py develop? I downloaded the patch and …	ceciliawei	Oct. 27, 2020, 10:11 p.m.

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

I'll try to get that framework done ASAP. But the change looks good!

Looks like the description is wrapping a bit too early. Can you target ~70 (upwards of 75) characters for the wrap point? Helps keep it from appearing really short.

The issue has been resolved. Show all issues



Looks like the description is wrapping a bit too early. Can you target ~70 (upwards of 75) characters for the wrap point? Helps keep it from appearing really short.


Just to clarify on the visual inspection, did you mean manual testing?

jblazusi Oct. 1, 2020, 9:08 p.m.

Good catch, Thank you
I updated the wrapping to be closer to 70-75 characters per line.
Yes, in this case I did a manual test and visually checked it.

Description:: ~
Updated the ReviewBot ToolResource.
~ Previously the ToolResource would not correctly update changes
~ made to any ReviewBot Tools. The previous behavior would allow
~ a ReviewBot tool to be updated only if there is a change in
~ name/version. However, during development this can be frustrating,
~ since options are being frequently revised.
~ To fix this problem, I have changed resource to update the instance
~ of the tool in the database. This is done regardless of a change
~ in versioning. This makes the process of creating tools easier,
~ since tool settings made in the tool are updated each time that
~
Updated the ReviewBot ToolResource.
~ Previously the ToolResource would not correctly update changes made to any
~ ReviewBot Tools. The previous behavior would allow a ReviewBot tool to be
~ updated only if there is a change in name/version. However, during
~ development this can be frustrating, since options are being frequently
~ revised. To fix this problem, I have changed resource to update the
~ instance of the tool in the database. This is done regardless of a change
~ in versioning. This makes the process of creating tools easier, since tool
~ settings made in the tool are updated each time that the ToolResource
~ create method is called.
- the ToolResource create method is called.
Testing Done:: ~
This is difficult to do since there is no test framework setup
~ for ReviewBot. No real tests were done, only visual inspection.
~
This is difficult to do since there is no test framework setup for
~ ReviewBot. No real tests were done, only manual testing and a quick
+ visual inspection.

Fix it!

An issue was opened. Show all issues

To pick up the change, do I need to do anything other than setup.py develop? I downloaded the patch and was working on the shellcheck tool. To update the options, I still had to load the configure page and reinstalling the tool. Did I miss anything?

jblazusi Oct. 27, 2020, 10:17 p.m.

This change would still require you to load the configure page and refresh the review bot. But you should not have to reinstall the tool. I am not sure why you are experiencing this behavior.

ceciliawei Oct. 27, 2020, 10:22 p.m.

Okay that makes sense. By reinstalling the tool I meant I had to go to the add integration page to check the latest option field. But I guess with your change, this could have done by editing the existing tool. I'll try that next time.

~		Updated the ReviewBot `ToolResource`.
~		Previously the `ToolResource` would not correctly update changes
~		made to any ReviewBot Tools. The previous behavior would allow
~		a ReviewBot tool to be updated only if there is a change in
~		name/version. However, during development this can be frustrating,
~		since options are being frequently revised.
~		To fix this problem, I have changed resource to update the instance
~		of the tool in the database. This is done regardless of a change
~		in versioning. This makes the process of creating tools easier,
~		since tool settings made in the tool are updated each time that
	~	Updated the ReviewBot ToolResource.
	~	Previously the ToolResource would not correctly update changes made to any
	~	ReviewBot Tools. The previous behavior would allow a ReviewBot tool to be
	~	updated only if there is a change in name/version. However, during
	~	development this can be frustrating, since options are being frequently
	~	revised. To fix this problem, I have changed resource to update the
	~	instance of the tool in the database. This is done regardless of a change
	~	in versioning. This makes the process of creating tools easier, since tool
	~	settings made in the tool are updated each time that the ToolResource
	~	create method is called.
-		the `ToolResource` create method is called.

~		This is difficult to do since there is no test framework setup
~		for ReviewBot. No real tests were done, only visual inspection.
	~	This is difficult to do since there is no test framework setup for
	~	ReviewBot. No real tests were done, only manual testing and a quick
	+	visual inspection.