Patent Application
20170097823
Technical Field
The present invention relates to code tagging and, more particularly, to identifying source code that corresponds to particular functionality or features.
Description of the Related Art
Code tagging provides an explicit association between a given function or feature of a program and the specific source code that implements the feature. Code tagging thereby aids in debugging, as a problem with a particular feature can rapidly be localized to specific regions of code, as well as future development, as new features or improvements can be more readily introduced if one can quickly find the appropriate point in the source code to add them.
Existing code tagging techniques are relatively limited in scope, focusing only on specific types of information to determine code tagging. For example, dynamic tagging uses natural language queries, feature-relevant scenarios, and feature-irrelevant scenarios with the source code and execution traces to identify frequent code portions in traces of feature-specific scenarios. The dynamic tagging approach has a high overhead and produces false negatives. Static tagging, meanwhile, is based on natural language queries to find program dependencies, concern graphs, and structural information. Static tagging produces false positives.
A method for tagging code includes building a code structure based description unit association model (CDAM) that associates code units with respective description units and organizes the code units in a hierarchical structure. The CDAM is filtered to remove un-meaningful description units through cross-validation between code units. Feature tags are generated, using a processor, based on a weighted sum of term frequencies in the description units of the CDAM to associate features with respective code units.
A feature tagging system includes a CDAM generation module configured to build a CDAM that associates code units with respective description units and organizes the code units in a hierarchical structure. A CDAM refinement module is configured to filter the CDAM to remove un-meaningful description units through cross-validation between code units. A feature tag module includes a processor configured to generate feature tags based on a weighted sum of term frequencies in the description units of the CDAM to associate features with respective code units.
These and other features and advantages will become apparent from the following detailed description of illustrative embodiments thereof, which is to be read in connection with the accompanying drawings.
The disclosure will provide details in the following description of preferred embodiments with reference to the following figures wherein:
Embodiments of the present invention automatically tag source code relating to specific features based on information from multiple different sources at different levels of granularity. Toward this end, the present embodiments build a Code structure based Description unit Association Model (CDAM) to provide cross-validation among different information sources. The present embodiments thereby provide an association between “business level features” that are human recognizable to “code level components” that form the inner workings of the program.
The CDAM uses a multi-layer code structure for annotation. In this structure, a code unit A is said to “contain” a code unit B if B is a part of A. The CDAM also includes description units. A description unit C is said to be “associated” with a code unit C if a description unit C is used to describe the code unit A. Description units may represent, for example, comments in the source code or other forms of documentation. Each description unit may have a weight value to indicate its relevance to its associated code unit.
Code unit types can be flexibly adjusted based on specific projects under analysis. For example, code units may have the type, “Organization,” “Project,” “Class Unit,” “Method Unit,” or “Callee Method Unit.” Each type represents a level in a code hierarchy. Multiple types of description unit are associated with their relevant code units. Description unit types can be flexibly adjusted and extended based on specific projects under analysis (e.g., by the availability of information sources in each project). Description units may have, for example, the type, “code information,” “code comment,” “commit log,” “work item description,” “use case,” “project description,” and others. A “work item” in this context refers to, e.g., a specific piece of development work. For example, work items may include adding a new feature, fixing a defect, etc. A work item can be associated with one or more code commits.
Based on the relationships between code units and description units, the layered CDAM generates feature tags for each code unit based on cross-validation (e.g., among its associated description units) and on the impact of the code units neighbors (e.g., a code unit from a higher or lower layer).
Referring now to
For example, a method unit 108 may have a set of different types of description units, including code info, code comments, commit logs, workitem descriptions, and other description information. Each level of code unit may have different applicable types of description unit. For example, at the organization 102 or project 104 levels, there may not be actual code information, code comments, or commit logs.
As noted above, each description unit may be weighted, with an exemplary default weight of 1.0. These weights may then be updated based on user feedback, tuning the contributions of different types of description units. In different projects, the quality of specific description sources may vary. In this case, weights are set for each different type of description source. If a type of description source (e.g., commit logs) are known to have low quality in the project in question, the weight for that type of description source may be set to a lower weight.
Referring now to
This feedback is obtained from users regarding which code units are correct and fulfill their needs. Based on such feedback, the weights of the different sources of description units are recalculated. For example, if a first source of description units contributes more meaningful concepts for helping the identification of the correct code units, block 204 can increase the weights of description units from that source. Based on the updated weights, block 204 executes CDAM refinement again to improve the effectiveness of the CDAM.
Referring now to
Concept-based association block 205 then computes, for description units that don't have explicit links to code units, a relevancy between each such description unit and each code unit in block 310. This may include an average value of similarity values between each description unit and each already-associated description unit of each code unit. Thus, if an un-associated description unit has certain keywords in common with an already-associated description unit (or is by any other metric highly similar to the already-associated description unit), then the un-associated description unit may be associated with the same code unit as is associated with the highly similar description unit in block 312.
As a result of each of blocks 203 and 205, as many description units are associated with code units as possible. Not all of the associations will be particularly relevant, which necessitates some form of trimming or refinement, as discussed below. For those description units that are not explicitly associated in block 203, block 205 attempts to tie their information to a code unit.
Referring now to
Block 408 filters out unmeaningful description units. To accomplish this, block 408 looks for description units that include at least one level-relevant concept. For example, if a code unit in question is a class unit 106, block 408 looks for description units that have at least one class-level concept. All description units that lack a level-relevant concept are filtered out, leaving only the meaningful description units in block 410. In this context, a “concept” is a descriptive word or phrase for a code unit defined by its description units. Meaningful concepts are words or phrases which can specifically present one characteristic of code. For example, some common words or jargon will not be meaningful concepts. Class-level concepts usually come from class-level description units.
Referring now to
Neighbor-based concept prioritization in block 504 uses concepts from adjacent levels to adjust a given concept ranking. For example, if a method unit 108 is being analyzed, concepts from the class unit 106 above it and any callee method units 110 below it are also considered. This may include promoting concepts that are present in lower neighbors and degrading concepts that are present in higher neighbors to produce a finalized, prioritized set of concepts for the code unit in question. Alternatively, concepts from lower neighbors may be degraded and concepts from upper neighbors may be enhanced. Promotion is usually performed when, e.g., all of the children units of a given code unit have the same concept, and that concept is promoted from the children to the parent. Degradation, meanwhile, is usually performed when some of the child code units have the same concept as the parent concept, such that the concept is degraded from the parent code unit to these children code units.
For each code unit, block 506 finds its top N prioritized concepts and generates action-entity pairs, where “actions” are action concepts and usually are verbs and “entities” are entity concepts and usually are nouns. To generate an action-entity pair, the action concept is identified and then its subject entity concept is located in a sentence, which shows that the two are semantically relevant. For each pair, it is determined whether each element of the pair occurs in a single sentence among the description units associated with the code unit. If so, and if the action and the entity are semantically relevant, block 506 computes the semantic relevance using semantic analysis and computes a ranking score as, for example, relevancy multiplied by the description unit's weight. Block 506 then selects the top N action-entity pairs based on their ranking scores and assigns them as feature tags of the code unit.
The present invention may be a system, a method, and/or a computer program product. The computer program product may include a computer readable storage medium (or media) having computer readable program instructions thereon for causing a processor to carry out aspects of the present invention.
The computer readable storage medium can be a tangible device that can retain and store instructions for use by an instruction execution device. The computer readable storage medium may be, for example, but is not limited to, an electronic storage device, a magnetic storage device, an optical storage device, an electromagnetic storage device, a semiconductor storage device, or any suitable combination of the foregoing. A non-exhaustive list of more specific examples of the computer readable storage medium includes the following: a portable computer diskette, a hard disk, a random access memory (RAM), a read-only memory (ROM), an erasable programmable read-only memory (EPROM or Flash memory), a static random access memory (SRAM), a portable compact disc read-only memory (CD-ROM), a digital versatile disk (DVD), a memory stick, a floppy disk, a mechanically encoded device such as punch-cards or raised structures in a groove having instructions recorded thereon, and any suitable combination of the foregoing. A computer readable storage medium, as used herein, is not to be construed as being transitory signals per se, such as radio waves or other freely propagating electromagnetic waves, electromagnetic waves propagating through a waveguide or other transmission media (e.g., light pulses passing through a fiber-optic cable), or electrical signals transmitted through a wire.
Computer readable program instructions described herein can be downloaded to respective computing/processing devices from a computer readable storage medium or to an external computer or external storage device via a network, for example, the Internet, a local area network, a wide area network and/or a wireless network. The network may comprise copper transmission cables, optical transmission fibers, wireless transmission, routers, firewalls, switches, gateway computers and/or edge servers. A network adapter card or network interface in each computing/processing device receives computer readable program instructions from the network and forwards the computer readable program instructions for storage in a computer readable storage medium within the respective computing/processing device.
Computer readable program instructions for carrying out operations of the present invention may be assembler instructions, instruction-set-architecture (ISA) instructions, machine instructions, machine dependent instructions, microcode, firmware instructions, state-setting data, or either source code or object code written in any combination of one or more programming languages, including an object oriented programming language such as Smalltalk, C++ or the like, and conventional procedural programming languages, such as the “C” programming language or similar programming languages. The computer readable program instructions may execute entirely on the user's computer, partly on the user's computer, as a stand-alone software package, partly on the user's computer and partly on a remote computer or entirely on the remote computer or server. In the latter scenario, the remote computer may be connected to the user's computer through any type of network, including a local area network (LAN) or a wide area network (WAN), or the connection may be made to an external computer (for example, through the Internet using an Internet Service Provider). In some embodiments, electronic circuitry including, for example, programmable logic circuitry, field-programmable gate arrays (FPGA), or programmable logic arrays (PLA) may execute the computer readable program instructions by utilizing state information of the computer readable program instructions to personalize the electronic circuitry, in order to perform aspects of the present invention.
Aspects of the present invention are described herein with reference to flowchart illustrations and/or block diagrams of methods, apparatus (systems), and computer program products according to embodiments of the invention. It will be understood that each block of the flowchart illustrations and/or block diagrams, and combinations of blocks in the flowchart illustrations and/or block diagrams, can be implemented by computer readable program instructions.
These computer readable program instructions may be provided to a processor of a general purpose computer, special purpose computer, or other programmable data processing apparatus to produce a machine, such that the instructions, which execute via the processor of the computer or other programmable data processing apparatus, create means for implementing the functions/acts specified in the flowchart and/or block diagram block or blocks. These computer readable program instructions may also be stored in a computer readable storage medium that can direct a computer, a programmable data processing apparatus, and/or other devices to function in a particular manner, such that the computer readable storage medium having instructions stored therein comprises an article of manufacture including instructions which implement aspects of the function/act specified in the flowchart and/or block diagram block or blocks.
The computer readable program instructions may also be loaded onto a computer, other programmable data processing apparatus, or other device to cause a series of operational steps to be performed on the computer, other programmable apparatus or other device to produce a computer implemented process, such that the instructions which execute on the computer, other programmable apparatus, or other device implement the functions/acts specified in the flowchart and/or block diagram block or blocks.
The flowchart and block diagrams in the Figures illustrate the architecture, functionality, and operation of possible implementations of systems, methods, and computer program products according to various embodiments of the present invention. In this regard, each block in the flowchart or block diagrams may represent a module, segment, or portion of instructions, which comprises one or more executable instructions for implementing the specified logical function(s). In some alternative implementations, the functions noted in the block may occur out of the order noted in the figures. For example, two blocks shown in succession may, in fact, be executed substantially concurrently, or the blocks may sometimes be executed in the reverse order, depending upon the functionality involved. It will also be noted that each block of the block diagrams and/or flowchart illustration, and combinations of blocks in the block diagrams and/or flowchart illustration, can be implemented by special purpose hardware-based systems that perform the specified functions or acts or carry out combinations of special purpose hardware and computer instructions.
Reference in the specification to “one embodiment” or “an embodiment” of the present principles, as well as other variations thereof, means that a particular feature, structure, characteristic, and so forth described in connection with the embodiment is included in at least one embodiment of the present principles. Thus, the appearances of the phrase “in one embodiment” or “in an embodiment”, as well any other variations, appearing in various places throughout the specification are not necessarily all referring to the same embodiment.
It is to be appreciated that the use of any of the following “/”, “and/or”, and “at least one of”, for example, in the cases of “A/B”, “A and/or B” and “at least one of A and B”, is intended to encompass the selection of the first listed option (A) only, or the selection of the second listed option (B) only, or the selection of both options (A and B). As a further example, in the cases of “A, B, and/or C” and “at least one of A, B, and C”, such phrasing is intended to encompass the selection of the first listed option (A) only, or the selection of the second listed option (B) only, or the selection of the third listed option (C) only, or the selection of the first and the second listed options (A and B) only, or the selection of the first and third listed options (A and C) only, or the selection of the second and third listed options (B and C) only, or the selection of all three options (A and B and C). This may be extended, as readily apparent by one of ordinary skill in this and related arts, for as many items listed.
Referring now to
Having described preferred embodiments of cross-validation based feature tagging (which are intended to be illustrative and not limiting), it is noted that modifications and variations can be made by persons skilled in the art in light of the above teachings. It is therefore to be understood that changes may be made in the particular embodiments disclosed which are within the scope of the invention as outlined by the appended claims. Having thus described aspects of the invention, with the details and particularity required by the patent laws, what is claimed and desired protected by Letters Patent is set forth in the appended claims.
