TWI550515B - System and method of source code quality management - Google Patents

Description

Source code quality management system and method

The present invention relates to source code management, and particularly to a source code quality management system and related method for assisting a version control system to verify a modification of a source code.

Version control is an important part of the software development process. It can track, record, and control any changes made to the source code during the development process to ensure that each developer can master the source code changes. And get synchronized. In general, before the developer intends to change the source code, it usually compiles only the content that the user wants to change. After the compilation is successfully completed, the changed part is uploaded to the version control system. However, a software development project often involves a large number of source code. Although the developer may only modify, delete or add a certain part of the original code, there is a certain possibility of conflict with the rest, which leads to the subsequent time-consuming debugging and reduces the efficiency of the development process.

In order to ensure that the source code correction content uploaded by the developer to the version control system can be operated normally, the present invention provides a source code quality management system. The source code quality management system of the present invention implements quality management of the source code by controlling the upload permission. Developers must first verify the original code by adding, deleting, modifying, etc., through the original code quality management system. After verification, the developer can obtain the upload permission, upload the revised content to the version control system, and further to the original. The code is added, deleted, modified, etc., thus ensuring the developer's Modify the reliability and security of the content, and improve the efficiency and quality of the software development process.

An embodiment of the present invention provides a source code quality management system, which is used to verify a modified content generated by a remote device for a source code, and includes: a first verification module, a first Two verification modules and an upload permission control module. The first verification module is configured to compile according to the modified content and at least a portion of the original code, to generate a first verification result and at least one output file. The second verification module includes at least one verification auxiliary hardware, and is configured to write the output file to the verification auxiliary hardware, thereby checking the operation result of the output file on the verification auxiliary hardware to generate a second Validation results. The uploading permission control module is configured to generate an uploading permission, wherein the uploading permission control module determines whether to enable the remote device to obtain the uploading permission according to at least the first verification result and the second verification result. Furthermore, the upload permission is used to allow the source code to be modified based on the modified content.

Another embodiment of the present invention provides a source code quality management method for verifying a modified content generated by a remote device for a source code, the method comprising: according to the modified content and at least a portion of the source code Compiling, and generating a first verification result and at least one output file; writing the at least one output file to the at least one verification auxiliary hardware, and checking at least one of the at least one output file on the at least one verification auxiliary hardware The operation result is used to generate a second verification result; and an upload permission is generated, and according to at least the first verification result and the second verification result, whether the remote device obtains the upload permission is determined; the upload permission is used to allow The source code is modified based on the modification.

10‧‧‧Modifications

20‧‧‧ source code

30‧‧‧Upload permission

40‧‧‧ verification record

100‧‧‧ source code quality management system

110‧‧‧First verification module

114_1~114_N‧‧‧First verification unit

120‧‧‧Second verification module

124_1~124_N‧‧‧Verification auxiliary hardware

130‧‧‧ Third verification module

140‧‧‧Upload License Control Module

142‧‧‧Database

200‧‧‧ Remote device

300‧‧‧ version control system

1 is an architectural diagram of an embodiment of a source code quality management system of the present invention.

Figure 2 is an example of a verification record of the present invention.

FIG. 1 illustrates an embodiment of a source code quality management system of the present invention. As shown in the figure, the source code quality management system 100 includes a first verification module 110, a second verification module 120, and a third verification module 130. Under the quality management mechanism of the present invention, before the developer wants to modify the original code 20 on the version control system 300, the modified content 10 must be uploaded to the source code quality management system 100 through the remote device 200, and the source code is The quality management system 100 performs a series of verification procedures. Upon completion of the verification process, the source code quality management system 100 determines whether the developer is allowed to upload the modified content 10 to the version control system 300 based on the verification result. If so, an upload permission 30 is issued to the developer; if not, the developer is not allowed to upload the modified content 10 to the version control system 300. When the developer obtains the upload license 30, the developer uploads the modified content 10 and the upload license 30 to the version control system 300. If the upload license 30 is verified as valid by the version control system 300, then the version control system will accept the developer's modified content 10 and modify the original code 20 in accordance with the modified content 10. The source code quality management system 100 verifies the modified content 10 of the developer through the first verification module 110, the second verification module 120, and the third verification module 130, and determines the modified content 10. Reliability, security, etc., before deciding whether to issue an upload license 30 to the developer.

The verification items performed by each verification module will be described below. However, it should be noted that in practical applications, the verification items described below may be selectively performed as the quality of the source code 20 is required to varying degrees or other considerations such as time cost. . In other words, not every verification module performs all the verification items described below. Or, not all verification modules need to verify the modified content 10.

When the modified content 10 is uploaded by the developer from the remote device 200 to the original code quality management system 100 for verification, the modified content 10 is first sent to the first verification module 110. First verification mode The group 110 may have a server that is a dispatcher and includes one or more first verification units 114_1~114_N, and the first verification units 114_1~114_N are based on the modified content 10 and at least a part of the original code 20. Conduct a holistic verification. Briefly, although the developer's modified content 10 may only be modified for a portion of the original code 20, in order to avoid conflicts between the modified content 10 and the rest of the original code 20, the source code quality management system 100 is actually While verifying the modified content 10, the original code 20 modified based on the modified content 10 must be verified together. In the best case, the source code quality management system 100 may load all of the source code 20 (including the portion modified by the modified content 10); however, the source code quality management system 100 may not need to be loaded with different considerations. All of the original code 20 is entered, and only the portion modified by the modified content 10 and the portion associated with the modified content are loaded.

The first verification units 114_1~114_N compile the different parts of the original code 20 after adding the modified content 10, and perform verification, thereby generating a first verification result. Among them, with the different software development projects, different parts of the original code 20 may represent different functional applications, or different customer-specific operating systems. For example, source code 20 may be a development project for an embedded system's operating system and developed in response to the hardware environment built by different customers. Therefore, different parts of the original code 20 may represent a complete operating system exclusive to different customers, and must be verified separately by different first verification units 114_1~114_N. The first verification units 114_1~114_N may be identical or may differ depending on the nature of the different portions of the original code 20. After the first verification unit 114_1~114_N compiles different parts of the original code 20 after adding the modified content 10, before generating the first verification result, a plurality of images (images) are necessarily generated (for example, respectively included An executable file of a different customer-specific operating system, or a plurality of executable files representing different applications. In an embodiment, the plurality of image files or a plurality of executable files may be output to the first file. The verification module 120 is configured to enable the second verification module 120 to verify the results of running the files on a particular hardware. In different embodiments of the present invention, the first verification units 114_1~114_N may be before all the verification items have been executed. The generated image file or executable file is provided to the second verification module 120 to speed up the verification process.

In addition to error checking during compilation (for example, syntax error or semantic error), the first verification unit 114_1~114_N may also perform static analysis test and the like on the original code 20 after adding the modified content 10, such as the following content verification. For example, Application interface abuse (API abuse), check whether the modified content 10 has abused the application interface; coding standard (coding standard), check whether the modification content 10 is written in accordance with the predetermined format, for individual The unit performs a unit test, that is, the smallest logical unit in the program, and whether the logic is correct or not. In addition, the first verification units 114_1~114_N can also add additional verification items by means of plugin software. The first verification units 114_1~114_N execute the plug-in software, and test the modified content 10 and the original code 20. When all the verification items are passed, the first verification module 110 generates a first verification result that the verification passes. The above verification procedure may be performed simultaneously with the verification procedure of the second verification module 120.

The second verification module 120 includes one or more verification assistance hardware 124_1~124_N, and the verification assistance hardware provides a hardware environment similar or identical to the environment in which the software developed according to the original code 20 is applied. The verification auxiliary hardware 124_1~124_N respectively includes: at least one storage device for storing an image file or an executable file generated by the first verification module 110; and at least one processor for executing or reading the image included in the image file Files and information, or executable files. The verification auxiliary hardware 124_1~124_N may be identical, may be required for different types of image files or executable files, or may be different depending on the hardware environment constructed by different customers. The second verification module 120 may first command the processor to install the image file to the verification auxiliary hardware 124_1~124_N, and perform specific operations to verify whether the results of these operations are correct. For example, if the source code 20 is the operating system of the television, the verification auxiliary hardware 124_1~124_N may be the motherboard of the television (corresponding to the hardware environment constructed by different customers respectively), and the second verification module 120 may request Verify that the auxiliary hardware 124_1~124_N performs basic power on/off operation after installing the operating system, and the TV channel scanning operation The operation of playing the multimedia file; when these operations can be performed normally, the second verification module 120 will generate a second verification result of the verification pass. It should be noted that the above description is not a limitation of the present invention. In different embodiments of the present invention, the second verification module 120 may include verification assistance hardware of different architectures.

The third verification module 130 provides an operation interface to a reviewer, and the reviewer can obtain the modified content 10 through the interface to the original code quality management system 100, and modify the original code 20 before and after the modified content 10, and determine whether Whether the developer's modified content 10 can satisfy some predetermined principles. Finally, the reviewer inputs a determination as to whether the modified content 10 passes the verification to the third verification module 130, and generates a third verification result through the third verification module 130. Moreover, the reviewer may upload another opinion report on the modified content 10 to the third verification module 130 based on its own knowledge, and the developer may refer to it later. It should be noted that the verification procedure of the third verification module 130 may be earlier or later than the verification procedure performed by other verification modules. Additionally, database 142 may be used to store reviewers' opinion reports. In some cases, the third verification module 130 has a certain importance, for example, for some specific source code that cannot be compiled, or when the compilation of the source code takes a lot of time, the first verification module 110 and the second verification module 120 may be configured not to perform verification, and only perform verification by the third verification module 130.

The first verification result, the second verification result, and the third verification generated by the uploading permission control module 140 according to different verification items of the first verification module 110, the second verification module 120, and the third verification module 130 respectively As a result, it is decided whether or not to issue the upload permission 30 to the developer who modifies the content 10. However, it should be noted that in different applications, not every verification module will verify the modified content 10, therefore, the upload permission control module 140 will only decide whether to issue an upload based on the result of the actual verified item. License 30.

When the modified content 10 is uploaded to the source code quality management system 100, uploading the license control The module 140 will keep a backup of the modified content 10 in the database 142, and log in a corresponding verification record 40 in the database 142, record the developer's identity information, modify the creation time of the content 10, and different verification modes. The verification results produced by the verification project performed by the group. In addition, the source code quality management system 100 also modifies the creation time of the content 10 and the related features of the modified content 10 according to the developer's identity information (for example, the content of the original code added, deleted, and modified by the developer), and An upload permission 30 is generated based on a special encryption algorithm and stored in the database 142. The upload license control module 140 can be configured to publish the upload license 30 to the developer after the modified content 10 has passed a certain number (all or part) of the verification items. In addition, although in the above embodiment, the upload permission control module 140 first writes an upload permission to the database before the verification result is not completely generated, in other embodiments of the present invention, the upload permission may be The upload permission control module 140 knows that the upload code 30 is generated after the source code 20 after the modification content 10 is passed through all the verifications.

When the upload license control module 140 considers that the upload license 30 can be published to the developer, the developer is notified to obtain the upload permission from the database 142 (or directly to the remote device 200 to the developer). After the developer obtains the upload license 30, the remote device 200 can log in to the version control system 300 and upload the modified content 10 and the upload license 30 to the version control system 300. Since the upload permission 30 is calculated by the upload permission control module 140 according to a special encryption algorithm, the version control system 300 also calculates whether the upload permission 30 is valid according to the corresponding decryption algorithm. Since the information carried in the uploading license 30 is related to the creation time of the modified content 10, the developer's identity information, and the content characteristics of the modified content 10, if the developer obtains the upload permission 30, it is changed. Modifying the content 10, the originally generated upload permission 30 will not be accepted by the version control system 300 because it does not meet the time or content characteristics corresponding to the modified content 10 that was changed again. Of course, if the different developers use this upload license 30, it will not be accepted by the version control system 300 because of the discrepancy of the identity information. In another embodiment, the upload permission control module 140 may also encrypt the version number of the target source code 20. In modification Before the content 10 and the upload permission 30 are uploaded to the version control system 300, if the original source code 20 has been changed by other developers, the existing source code 20 is different from the target source code 20 for which the content 10 is originally modified. The version control system 300 does not accept this modification content 10. This embodiment can effectively avoid modification errors caused by multiple developers.

After the version control system 300 calculates that the developer's upload permission 30 is valid, the modified content 10 is accepted, and the original code 20 is modified based on the modified content 10 to complete the entire workflow.

Figure 2 is an example of the above verification record. As shown, the verification record 40 contains all the verification items that the source code quality management system 100 can perform, but since the partial verification item may not be executed, it is marked as "N/A". The verification item of this part is not included in the upload permission control module 140 to consider whether to issue the upload permission 30. In the illustration, since the results of the actual verification items are all passed, a "pass" verification result is finally obtained. Please note that the verification items noted in the drawings should not be construed as limiting the invention. In other embodiments of the present invention, since the source code quality management system 100 can perform different verification items through the plug-in software, verification is performed. The results of the projects recorded in record 40 will also vary. In addition, since the verification record 40 is stored in the database 142, the developer can query the database 142 for the verification result of each item through the remote device 200 to know at which stage of the modification content 10 the verification error occurs, thereby correcting the modification. Content 10.

Please note that the components in the source code quality management system of the present invention, such as the first verification module 110, the second verification module 120, the third verification module 130, and the upload permission control module, may be composed of simple hardware. The circuit is either implemented by a specific software program on a compatible hardware or a combination of the two.

The partial operation of the source code quality management system described above can be further simplified and summarized into a source code quality management process. In one embodiment, the following steps are included: S110: according to a modified content for a source code and Compiling at least a portion of the source code and generating a first verification result and at least one output file; S120: writing the at least one output file to the at least one verification auxiliary hardware, and checking the at least one output file in the Determining at least one operation result on the auxiliary hardware to generate a second verification result; S130: generating an upload permission, determining, according to at least the first verification result and the second verification result, whether to enable the remote device to obtain the Upload license; the upload license is used to allow the source code to be modified based on the modified content.

In addition, in another embodiment of the source code quality management process of the present invention, the method includes the following steps: S210: compiling according to a modified content for a source code and at least a part of the source code, and generating a first Verification result and at least one output file; S220: writing the at least one output file to the at least one verification auxiliary hardware, and checking at least one operation result of the at least one output file on the at least one verification auxiliary hardware to generate a first a verification result; S230: providing an interface for a reviewer to review the modified content and the original code through the interface, and generating a third verification result; S240: generating an upload permission, according to the first verification result, the first And the third verification result determines whether the remote device obtains the upload permission; the upload permission is used to allow the source code to be modified based on the modified content.

The details, principles, and application changes of the various steps in the above processes have been mentioned in the description of the source code quality management system, and therefore will not be repeated here.

The "an embodiment" referred to above means that a particular feature, structure or characteristic described for the embodiment is included in at least one embodiment of the invention. Furthermore, "an embodiment" as used in the different paragraphs herein does not represent the same embodiment. Therefore, while the various structural features or methodological acts are described above, respectively, for the various embodiments, it should be noted that these various features can be implemented in the same particular embodiment.

In summary, the present invention improves the management of the source code by the version control system. It can effectively eliminate the impact of bad modified content on the software development project and improve the quality and efficiency of the software development project.

The above are only the preferred embodiments of the present invention, and all changes and modifications made to the scope of the present invention should be within the scope of the present invention.

10‧‧‧Modifications

20‧‧‧ source code

30‧‧‧Upload permission

40‧‧‧ verification record

100‧‧‧ source code quality management system

110‧‧‧First verification module

114_1~114_N‧‧‧First verification unit

120‧‧‧Second verification module

124_1~124_N‧‧‧Verification auxiliary hardware

130‧‧‧ Third verification module

140‧‧‧Upload License Control Module

142‧‧‧Database

200‧‧‧ Remote device

300‧‧‧ version control system

Claims (24)

A source code quality management system for verifying a modified content generated by a remote device for a source code in a version control system, comprising: a first verification module, configured to use the modified content and the source code Compiling at least a portion and generating a first verification result and at least one output file; and a second verification module comprising at least one verification auxiliary hardware for writing the at least one output file to at least one verification Auxiliary hardware, and checking at least one operation result of the at least one output file on the at least one verification auxiliary hardware to generate a second verification result; and an upload permission control module for generating an upload permission, wherein the The uploading permission control module determines whether to enable the remote device to obtain the uploading permission according to at least the first verification result and the second verification result; the uploading permission is to allow the original code to be modified based on the modified content. The source code quality management system of claim 1, wherein the source code includes a plurality of parts, the first verification module includes a plurality of first verification units, and the plurality of first verification units respectively modify the The content is compiled with a plurality of portions of the source code to produce the at least one output file. The source code quality management system of claim 2, wherein the second verification module includes a plurality of verification assistance hardware, and the second verification module verifies the at least one output file on the verification assistance hardware. The result of the operation is used to generate the second verification result. The source code quality management system of claim 1, further comprising: a third verification module, configured to provide an interface for a reviewer to review the modified content and the source code through the interface, and the third The verification module generates a third verification result according to the review result of the reviewer. The source code quality management system of claim 4, wherein the upload permission control module determines whether to enable the remote device to obtain the upload permission according to the first verification result, the second verification result, and the third verification result. . The source code quality management system of claim 1, further comprising a database for storing the upload permission; wherein the upload permission control module is generated before the first verification result or the second verification result is generated The upload license writes the upload license to the database. The source code quality management system of claim 1, further comprising a database for storing the upload permission; wherein the first verification result and the second verification result are all written to the database, and the uploading The license control module determines whether to enable the remote device to obtain the upload permission based on the first verification result that has been written to the database and the second verification result. The source code quality management system of claim 1, wherein the upload permission comprises at least one of identity information of the developer of the modified content, a time of establishing the modified content, and a content characteristic of the modified content. The source code quality management system of claim 1, wherein the first verification module further performs a content verification according to the modified content and at least a portion of the original code to generate the first verification result. The source code quality management system of claim 9, wherein the content verification comprises a coding standard verification, an application programming interface abuse verification, and a unit test verification static analysis. At least one of the test validations. The source code quality management system of claim 1, wherein the source code is stored in the version control system, and the version control system determines whether to accept the modified content according to the upload permission. The source code quality management system of claim 11, wherein the upload permission further comprises a target source code version number of the source code corresponding to the modified content, and one version number of the source code stored in the version control system The version control system does not accept the modified content when it is different from the target source code version number. A source code quality management method for verifying a modified content generated by a remote device for a source code in a version control system, comprising: compiling according to the modified content and at least a part of the source code, and Generating a first verification result and at least one output file; writing the at least one output file to the at least one verification auxiliary hardware, and checking at least one operation result of the at least one output file on the at least one verification auxiliary hardware to generate Determining, by the second verification result, an upload permission, and determining, according to at least the first verification result and the second verification result, whether the remote device obtains the upload permission; the upload permission is used to allow the source code to be based on the The modified content was modified. The source code quality management method of claim 13, wherein the source code includes a plurality of parts, and the step of generating the at least one output file comprises: simultaneously performing the modified content and the plurality of parts of the original code respectively Compiling to generate the at least one output file. The source code quality management method of claim 14, wherein the step of generating the second verification result The method includes: writing the at least one output file to the plurality of verification assistance hardware, and verifying the operation result of the at least one output file on the verification assistance hardware to generate the second verification result. The source code quality management method of claim 13, further comprising: providing an interface for a reviewer to review the modified content and the source code through the interface, and generate a third verification result. The source code quality management method of claim 16, wherein the determining whether the remote device obtains the upload permission comprises: determining, according to the first verification result, the second verification result, and the third verification result, whether Let the remote device obtain the upload permission. The source code quality management method of claim 13, further comprising: generating the upload permission before the first verification result or the second verification result is generated, and storing the upload permission to a database. The source code quality management method of claim 13, further comprising: storing the upload permission, the first verification result, and the second verification result to a database; and according to the first written to the database A verification result and the second verification result determine whether the remote device obtains the upload permission. The source code quality management method of claim 13, wherein the upload permission comprises at least one of identity information of a developer of the modified content, a time of establishment of the modified content, and a content feature of the modified content. The source code quality management method of claim 13, further comprising: performing a content verification according to the modified content and at least a portion of the original code, to generate the first verification result. The source code quality management method according to claim 21, wherein the content verification comprises a coding standard verification, an application programming interface abuse verification, and a unit test verification static analysis. At least one of the test validations. The source code quality management method of claim 13, wherein the source code is stored in the version control system, and the version control system determines whether to accept the modified content according to the upload permission. The source code quality management method of claim 23, wherein the uploading license further comprises one of the source code version number of the source code corresponding to the modified content, and one version number of the source code stored in the version control system. The version control system does not accept the modified content when it is different from the target source code version number.