Shulou(Shulou.com)06/02 Report--

This article mainly introduces what ReviewBoard refers to, has a certain reference value, interested friends can refer to, I hope you can learn a lot after reading this article, the following let the editor take you to understand it.

1 background

Recently, I have participated in the project implementation of a larger team, with tens of millions of dollars and nearly a hundred people. However, after the implementation of the project, the following problems were exposed:

(1) the quality is poor, the level of team members is uneven, and the consistency of software external quality and internal quality is poor.

(2) the demand is uncertain, the time is very tight, the code is modified frequently, it becomes uglier and uglier, and the efficiency becomes lower.

In order to ensure that the project is delivered on time and quality, quality improvement Brooks no delay. Therefore, in the early and middle stages of the project, three things were done:

(1) formulate a unified interface specification, formulate a unified reference example, and train and review the interface specification regularly for all members.

(2) formulate a unified code specification, formulate the PPT of "Review Culture Construction" and "Code ugliness", cultivate the team's quality culture and review culture, and implement the review.

(3) introduce the management tool ReviewBoard.

The project unifies the construction of standards and specifications, which effectively ensures the consistency of the interface, but the improvement of code quality is not so simple. Here, I will not share the situation of the project for the time being. In the future, I will introduce the importance of standards and standardized software development methods to the project through more detailed articles.

2 introduction to ReviewBoard

This leads to an excellent tool, ReviewBoard. This tool is easy to use and powerful. It is very effective to implement code review through it. Code review is divided into two ways: pre-submission review (Pre-Review) and post-submission review (Post-Review). Pre-submission review, that is, developers need to submit to ReviewBoard after code changes, and then submit to SVN source server after review. If they do not pass the review, the code submission will fail and not a single line can be submitted; post-submission review, that is, developers submit the code first, and then submit the changes to ReviewBoard. If the review fails, modify the code and update the review until it is passed. These two approaches have their own advantages and disadvantages, and we use the latter, which does not block developers from submitting code and cannot control all quality at 100%, but it can reach more than 80%.

ReviewBoard was designed to support Pre-Review, so there are the following problems: (1) after being submitted and passed, Review cannot automatically change its status to closed and will be mixed with all ReviewRequest that have passed the review; (2) it is impossible to see that the request that failed the review is updated again, because if it is updated again, it means a second review. During the management process, it will query which requests fail the review and send notifications to the developers on a regular basis.

Therefore, I decided to customize ReviewBoard to support the above features. However, ReviewBoard is based on the Python language and Django framework development, I have never learned Python, let alone Django, so how to fix it? So I started to do research on ReviewBoard. The ReviewBoard*** version can only run on non-Windows, and I installed and deployed on Ubuntu 14.04 while using the MySQL database. So I started to try to make changes.

3 try to modify ReviewBoard

3.1 explore * step: database

First of all, I studied the database and was surprised to find that the design of the database was so neat that I didn't need to check any documents to know the meaning of the tables and fields of the data library. I found several key tables, namely reviews_reviewrequest, look at its fields, almost consistent with the interface display, immediately understand what to think, along the meaning of the field, found the other two key tables diffviewer_diffsethistory, diffviewer_diffset. By querying the data of these tables, I can easily solve * problems. The ReviewRequest that passed the review can be turned off with a SQL statement, so that there is no need to see these review requests.

3.2 learn Python and modify the code

The next second question, the need to modify the code, I spent 3 hours learning Python, through online English help, directly in the console to do experiments, learning basic syntax structure, learning classes and object programming, learning Python module and compilation, after a preliminary familiarity with Python, I decided to start to modify the code.

Therefore, I first query all the files through the similar column "Submitter", and quickly find the two files columns.py and grids.py through it. After looking at the code, I found that the review request of ReviewBoard is realized through these two files, and the name of the query again did not find the associated file. From these two files, you can see that columns.py is used to define all the columns to display, and grids.py combines and displays the columns. Then you can simply imitate and add a column. The column is defined as Diffs.

one

two

three

four

five

six

seven

eight

nine

ten

eleven

twelve

thirteen

fourteen

fifteen

sixteen

seventeen

eighteen

nineteen

twenty

twenty-one

twenty-two

twenty-three

twenty-four

twenty-five

twenty-six

twenty-seven

twenty-eight

twenty-nine

Class DiffSetCountColumn (Column):

"Shows the diff set count of published reviews for a review request."

Def _ _ init__ (self, * args, * * kwargs):

Super (DiffSetCountColumn, self). _ init__ (

Label=_ ('Diffs')

Detailed_label=_ ('Number of Diffs')

Shrink=True

Sortable=True

Link=False

* kwargs, * * kwargs)

Def render_data (self, state, review_request):

If review_request.mydiffsetcount > 1:

Return (''

'!% s'

''

% review_request.mydiffsetcount)

Else:

Return''

Def augment_queryset (self, state, queryset):

Return queryset.extra (select= {

"mydiffsetcount':"

SELECT COUNT (*)

FROM diffviewer_diffset

WHERE diffviewer_diffset.history_id =

Reviews_reviewrequest.diffset_history_id

"

})

To be brief, I define the DiffSetCountColumn class, which inherits from the Column class, and the class initialization method _ _ init__, is equivalent to a constructor. Self here is the this that was often used in the past, defining two methods, one is augment_queryset, which is used to display the data in the current column, the definition name is mydiffsetcount, and another method render_data is defined, that is, to display the data in the table. Other column definitions are referenced here.

Next, declare the use of this column in grids.py, which is very simple.

25 new lines:

DiffSetCountColumn

Line 99 adds:

Diffset_count = DiffSetCountColumn ()

Then restart the Apache server and you can simply test it and be surprised to find that it works.

3.3 further add features

With this attempt, I would like to customize it further. At present, each group is submitted to a different SVN address, and the submission of each group can be distinguished by SVN. However, ReviewBoard does not filter for SVN addresses.

First modify the columns.py and modify the Repository column.

one

two

three

four

five

six

seven

eight

nine

ten

eleven

twelve

thirteen

fourteen

fifteen

sixteen

seventeen

eighteen

nineteen

twenty

twenty-one

twenty-two

twenty-three

twenty-four

Class RepositoryColumn (Column):

"Shows the name of the repository the review request's change is on."

Def _ _ init__ (self, * args, * * kwargs):

Super (RepositoryColumn, self). _ init__ (

Label=_ ('Repository')

Db_field='repository__name'

Shrink=True

Sortable=True

Link=True

Link_func=self.link_to_object

Css_class='repository-column'

* args, * * kwargs)

Def augment_queryset (self, state, queryset):

Return queryset.select_related ('repository')

Def render_data (self, state, obj):

Return super (RepositoryColumn, self). Render_data (state, obj) or'

Def link_to_object (self, state, obj, value):

Import urllib

Return local_site_reverse ('all-review-requests'

Request=state.datagrid.request) +'?'+

Urllib.urlencode ({'repository':obj.repository_id})

Change the column to support Link here, and then define the link_to_object function. After looking for a period of time, it is found that local_site_reverse can be used to obtain the required url, and then combined with url. Without using urlencode at the beginning, it cannot be rendered normally. Since I had used urlencode in ASP.NET, I knew there was a hole in it, so I inquired about Python's urlencode on the Internet, and then solved it and found that it was ready to work. However, the next question comes, that is, how to filter after the link? Found here its "show closed" filtering function, through the code query, know how to work in grids.py, then, add filtering is not difficult. As follows.

Line 116 of grids.py

Self.repository_query =''

Line 133 of grids.py

Self.repository_query = self.request.GET.get ('repository',')

If len (self.repository_query) > 0:

Self.queryset = self.queryset.filter (repository_id=int (self.repository_query))

4 ReviewBoard astonishingly excellent code gene

After the smooth modification, I was shocked and amazed at the excellent software ReviewBoard. Why is it possible to learn from Python to modify a completely black box of software in one day? The answer is that ReviewBoard has very neat code. In other words, ReviewBoard has excellent internal and external quality.

Database design, simple and clear, very clear structure, strong readability, do not need any database documents at all. The document is superfluous!

The style of the code is very consistent, and we find that there are very few comments in ReviewBoard. Uncle Bob's "Code cleanliness" emphasizes that comments are a supplement to the failure of the code's intention. The naming of ReviewBoard is very consistent from front to back, with uniform rules for case, underscore, class name and method name, accurate naming, no unprofessional naming, no unprofessional abbreviations. ReviewBoard classes are very simple, in the columns.py file, you can find that each Column is basically less than 50 lines, each method is also very simple. ReviewBoard is very committed to a single responsibility, telling me clearly what tasks can be done through which classes, which methods, and what code to write. The ReviewBoard code style is excellent, with no ugly tightening, no ugly crowding, spaces when there should be spaces, blank lines when there should be blank lines, tightening when they should be tightened. Here, I don't see any smell of code corruption. With this kind of excellent software, it is very difficult for me to write the code for business trip.

In the small matter of writing code, many people may only see things such as architecture and framework, but in fact, many programmers who have worked for many years, the code is still shit, there is no standard style, no good coding habits. Many people can finish a job, but it is not beautiful. Unconsciously, over time, you just do more ugly things. From my coding experience, I can sum up a programmer's current situation, 1-3 years of developers, in a state of confusion, they can complete the function is good. Developers for 3 ~ 5 years have some abstract consciousness, but one is to go to hackers, and only they and God can understand the abstract code, and the other is to become professional and tend to write code that can be understood by the rest of the team. another is to maintain the status quo. Five years later, there are three types of developers, one to management, one to higher technical routes, such as architects or experts, and the other is to become waste, and over time, they have less and less space and less and less value. Generally speaking, through training, the younger people are, the faster they grow and the more promising they are. to improve their level, code review is the most effective way to let them know what is beautiful and what is ugly through review and training. what is good, what is inferior.

Thank you for reading this article carefully. I hope the article "what does ReviewBoard mean" shared by the editor will be helpful to everyone? at the same time, I also hope that you will support us and pay attention to the industry information channel. More related knowledge is waiting for you to learn!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.