Analyze the quality of source code folders based on various metrics.
Click Source Code > Browse Code.
The Browse Code page enables you to browse the repository's folder structure and display key metrics regarding the folders and files.
To ensure full functionality, make sure that the most recent version of the ALI plugin is installed on the build server. For details, see Set up Hudson/Jenkins for ALI and HPE ALI Hudson/Jenkins plugin configuration.
If the plugin is not configured correctly, the following folder and file data will not be available: Lines of Code, Relative Code Churn, Defect Density.
What do you want to do?
The boxes on the heatmap represent folders that share the same parent folder.
The box sizes and colors represent the folders' values in one of the following parameters:
|Lines of Code (LOC)||The total amount of lines of code included in an SCM folder.|
The amount of added or changed lines of code in an SCM folder, between a baseline version and the current version of the files. The baseline version is taken at the start date of the specified time period.
|Relative Code Churn||The code churn in an SCM folder, as a ratio of the folder's LOC.|
|Unit Tests||The success rate of unit tests run on an SCM folder.|
|Coverage||The percentage of code in an SCM folder covered by unit tests.|
|Defect Density||The number of defects associated with the code in an SCM folder, as a ratio of the folder's LOC.|
To use the heatmap:
- Set a Time period. The time period determines the range of data that is analyzed for the heatmap.
- Select parameters from the Size and Color drop down lists.
- Click a box to drill down to its child folders, or click a folder name in the grid below the heatmap.
- Use the Path breadcrumbs under the heatmap to navigate to higher levels in the folder structure.
The table below the heatmap displays the same folders as the heatmap. It also lists the files included in the same parent folder.
The following properties are displayed for each folder and file:
|Unit Tests||The success rate of unit tests run on an SCM folder or file.|
|Defect Density||The number of defects associated with the code in an SCM folder or file, as a ratio of the folder or file's LOC.|
|Code Churn||The share of code changes in the folder or file associated with user stories, defects, or neither.|
- Click a folder to drill down to its child folders and files.
- Click a file name to display its contents in a separate tab.
- Click [Diff] under a file name to compare the current contents of the file with an earlier revision.
Select Online browsing above the heat map to toggle between online and offline mode.
- When in online mode, the folder and file structure is loaded directly from the SCM branch.
- When in offline mode, the folder and file structure is based on the result of code parsing in the database.
Offline mode does not affect the metrics displayed: these are always loaded from the database.
When does Agile Manager switch to offline mode?
Code browsing will automatically enter offline mode in cases similar to the following scenarios:
- ALI DevBridge is down
- SCM repository is down
- Authentication error when connecting to SCM repository
- Network problem
When should I manually switch to offline mode?
We recommend offline browsing if you have a slow connection to the SCM repository, or if you have a large folder structure that requires loading a larger amount of data.