Summary

Created evolution to add extra_data field to ChangeDescription model

Review Request #12038 — Created Feb. 4, 2022 and updated April 4, 2022, 8:40 p.m.

Information

Owner

sheenaNg

Repository

Review Board

Branch

master

Bugs

Depends On

Blocks

12051, 12050

Reviewers

Groups

reviewboard

People

Description

Created evolution file to add extra_data JSON field to
ChangeDescription model in order to pass in automate=True flag to
track the originator of the close action when review request is closed
by third-party repo services.

Testing Done

I have run ./manage.py evolve --execute to apply the changes to the
database.

Even though unit test is not required to test for a newly added field,
I did a quick sanity check if the extra_data field is added
successfully to the ChangeDescription model. I have attached the
screenshot to show that.

Commits

Summary	ID	Author
Created evolution to add extra_data field to ChangeDescription model	bdb6a7d48f20b8a37a638ac5fcbaf3f0aaac9a92	sng06
Added module docstring to extra_data evolution file	e7c59310bd103aa5cb4302bba84ace5fdc1a3e41	sng06

Files

Issues

Description	From	Last Updated
You can move the statement about running the evolution into the "testing done" field.	david	March 1, 2022, 9:46 p.m.
Please wrap your description and testing done to 70 columns for easier readability.	david	March 1, 2022, 11:23 p.m.
Let's add a module docstring to this (many old files don't have them, but any new files should have it …	david	March 11, 2022, 8:07 p.m.
Test comment	vilavivida	April 4, 2022, 8:40 p.m.

flake8 passed.

JSHint passed.

Change Summary:

Added screenshot to show the newly added field

Summary:

-	[WIP] Created evolution to add extra_data field to ChangeDescription model
+	Created evolution to add extra_data field to ChangeDescription model

Description:

		Created evolution file to add `extra_data` JSON field to ChangeDescription model in order to pass in automate=True flag to track the originator of the close action when review request is closed by third-party repo services.

~		I have not run `./manage.py evolve --execute` to apply the changes to the database yet as I would like to get this reviewed and confirmed if this change is correct before running the execute command to apply the changes.
	~	I have run `./manage.py evolve --execute` to apply the changes to the database.

Testing Done:

~		I think I am not able to do any testing on the new field before running the execute command to apply the changes to the database. Also, I am not sure if it is required to create unit test to test a newly added field as the existing unit tests are mainly testing the methods inside the model files instead of testing for a newly added field.
	~	Even though unit test is not required to test for a newly added field, I did a quick sanity check if the `extra_data` field is added successfully to the ChangeDescription model. I have attached the screenshot to show that.
-
-		However, Django Evolution documentation suggested to test prior to execution. Please advice if unit test is necessary/ what kind of test I should be doing before applying the changes.

Added Files:

reviewboard/changedescs/models.py (Diff revision 1)
Show all issues
```
Test comment
```
1. sheenaNg Feb. 10, 2022, 4:51 p.m.
  Hi, can you explain further what the issue is that I need to fix?

Show all issues

You can move the statement about running the evolution into the "testing done" field.

Show all issues

Please wrap your description and testing done to 70 columns for easier readability.

reviewboard/changedescs/evolutions/extra_data.py (Diff revision 1)

Show all issues

Let's add a module docstring to this (many old files don't have them, but any new files should have it as the first line).

We also won't be needing unicode_literals on master going forward.

Change Summary:

Added module docstring to evolution file.

Description:

~		Created evolution file to add `extra_data` JSON field to ChangeDescription model in order to pass in automate=True flag to track the originator of the close action when review request is closed by third-party repo services.
~
~		I have run `./manage.py evolve --execute` to apply the changes to the database.
	~	Created evolution file to add `extra_data` JSON field to
	~	ChangeDescription model in order to pass in automate=True flag to
	~	track the originator of the close action when review request is closed
	+	by third-party repo services.

Testing Done:

~		Even though unit test is not required to test for a newly added field, I did a quick sanity check if the `extra_data` field is added successfully to the ChangeDescription model. I have attached the screenshot to show that.
	~	I have run `./manage.py evolve --execute` to apply the changes to the
	+	database.
	+
	+	Even though unit test is not required to test for a newly added field,
	+	I did a quick sanity check if the `extra_data` field is added
	+	successfully to the ChangeDescription model. I have attached the
	+	screenshot to show that.

Commits:

Summary	ID	Author
Created evolution to add extra_data field to ChangeDescription model	aece120422829fd4afaba9d45f4cc8d3f7f29461	sng06
Created evolution to add extra_data field to ChangeDescription model	bdb6a7d48f20b8a37a638ac5fcbaf3f0aaac9a92	sng06
Added module docstring to extra_data evolution file	e7c59310bd103aa5cb4302bba84ace5fdc1a3e41	sng06

Diff:

Revision 2 (+27 -1)

Show changes

	reviewboard/changedescs/models.py
	reviewboard/changedescs/evolutions/__init__.py
	reviewboard/changedescs/evolutions/extra_data.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Looks good to me!
```