Initial commit Got map building and print_heat_map working Added CONTRIBUTING, LICENSE, and README
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..bec372b --- /dev/null +++ b/.gitignore
@@ -0,0 +1,2 @@ +*.swp +__pycache__
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e635be7 --- /dev/null +++ b/CONTRIBUTING.md
@@ -0,0 +1,32 @@ +# How to Contribute + +We would love to accept your patches and contributions to this project. + +## Before you begin + +### Sign our Contributor License Agreement + +Contributions to this project must be accompanied by a +[Contributor License Agreement](https://cla.developers.google.com/about) (CLA). +You (or your employer) retain the copyright to your contribution; this simply +gives us permission to use and redistribute your contributions as part of the +project. + +If you or your current employer have already signed the Google CLA (even if it +was for a different project), you probably don't need to do it again. + +Visit <https://cla.developers.google.com/> to see your current agreements or to +sign a new one. + +### Review our Community Guidelines + +This project follows [Google's Open Source Community +Guidelines](https://opensource.google/conduct/). + +## Contribution process + +### Code Reviews + +All submissions, including submissions by project members, require review. We +use [GitHub pull requests](https://docs.github.com/articles/about-pull-requests) +for this purpose.
diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE
@@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.
diff --git a/README.md b/README.md new file mode 100644 index 0000000..781401e --- /dev/null +++ b/README.md
@@ -0,0 +1,44 @@ +# Kernel Bug Heat Map Builder + +This is a tool that scans git repos, extracts bug fix information from git +commits, and aids in the analysis and visualization of that bug fix information. + +This tool was orginally created for doing analysis on the Linux kernel; however, +this tool can likely be adapted to do analysis on any git repo that includes bug +fix information in commit messages in a sufficiently structured way. + +## How to use this tool + +1. Set your current working directory to the root of the git repo to be + analyzed. +2. Build the file to bug mapping: + ``` + $PATH_TO_BUG_HEAT_MAP_BUILDER/heat_map_builder.py build_map $BUG_MAP_FILE_NAME + ``` + This builds the mapping between bugs and source files that subsequent + analysis will be based on. +3. Analyze the information, and vizualize the results: The `heat_map_builder.py` + supplies additional commands to do analysis on the file to bug mapping. + +## Source Code Headers + +Every file containing source code must include copyright and license +information. This includes any JS/CSS files that you might be serving out to +browsers. (This is to help well-intentioned people avoid accidental copying that +doesn't comply with the license.) + +Apache header: + + Copyright 2022 Google LLC + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License.
diff --git a/git.py b/git.py new file mode 100644 index 0000000..3fe5137 --- /dev/null +++ b/git.py
@@ -0,0 +1,256 @@ +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import hashlib +import os +import re +import shutil +import subprocess +import tempfile +import pathlib +from typing import TextIO, List, Dict, Generator + +from absl import logging + +def _git_long(verb: str, *args, git_flag: str = None, cwd=None, input=None) -> TextIO: + logging.debug('Running\ngit %s %s\n with input: %s', verb, ' '.join(args), input) + command = ['git'] + if git_flag: + command += [git_flag] + command += [verb] + command += list(args) + print(' '.join(command)) + result = subprocess.run(command, + cwd=cwd, input=input, + text=True, + check = True, + stderr=subprocess.STDOUT, + stdout=subprocess.PIPE) + return result.stdout + +def _git(verb: str, *args, git_flag: str = None, cwd=None, input=None) -> str: + result = _git_long(verb, *args, git_flag=git_flag, cwd=cwd, input=input) + stdout = str(result) + logging.info('git %s stdout: %s', verb, stdout) + return stdout + +class CommitMessage(object): + def __init__(self, commit_message: str) -> None: + self.commit_message = commit_message + +class Commit(object): + def __init__(self, raw_commit: str) -> None: + self.raw_commit = raw_commit + +class Git(object): + def __init__(self, git_dir: str) -> None: + self._git_dir = git_dir + + def __call__(self, verb: str, *args) -> str: + return _git(verb, *args, cwd=self._git_dir) + + def clone(self, remote, *args) -> str: + return _git('clone', *args, '--', remote, self._git_dir) + + def am(self, patch_contents: str) -> str: + return _git('am', cwd=self._git_dir, input=patch_contents) + + def push(self, remote_branch: str) -> str: + return _git('push', '-u', 'origin', remote_branch, cwd=self._git_dir) + + def config(self, config: str, option: str) -> str: + return _git('config', '--local', config, option, cwd=self._git_dir) + + def commit(self, *args) -> str: + return _git('commit', *args, cwd=self._git_dir) + + def log(self, *args) -> TextIO: + return _git_long('log', *args, git_flag='--no-pager', cwd=self._git_dir) + + def log_no_page(self, commit_hash: str) -> CommitMessage: + return CommitMessage(_git('log', '-n 1', commit_hash, git_flag='--no-pager', cwd=self._git_dir)) + + def show(self, *args) -> Commit: + return Commit(_git('show', *args, git_flag='--no-pager', cwd=self._git_dir)) + +class BugFixChecker(object): + def bug_fix_log_grep(self) -> str: + pass + + def is_bug_fix(self, commit_message: CommitMessage) -> bool: + pass + +class UpstreamKernelBugFixChecker(BugFixChecker): + def bug_fix_log_grep(self) -> str: + return 'Fixes:' + + def is_bug_fix(self, commit_message: CommitMessage) -> bool: + match = re.search('^\s*Fixes: ([0-9a-fA-F]+) \(', commit_message.commit_message, re.MULTILINE) + return bool(match) + +def find_bug_fixes(git: Git, bug_fix_checker: BugFixChecker) -> Generator[str, None, None]: + git_grep = '--grep=' + bug_fix_checker.bug_fix_log_grep() + for commit_hash in git.log(git_grep, '--pretty=format:%h').splitlines(): + commit_message = git.log_no_page(commit_hash) + if bug_fix_checker.is_bug_fix(commit_message): + print('Found bug: ', commit_hash) + yield commit_hash + +class PathToBugListMap(object): + def __init__(self) -> None: + self._path_to_bug_list_map = {} + + def add_bug_to_path(self, path: str, bug_fix_hash: str) -> None: + self._path_to_bug_list_map.setdefault(path, []).append(bug_fix_hash) + + def add_bug_to_paths(self, path_list: List[str], bug_fix_hash: str) -> None: + for path in path_list: + self.add_bug_to_path(path, bug_fix_hash) + + def serialize(self, file_name) -> None: + with open(file_name, 'w') as file: + for path, bug_fix_hash_list in self._path_to_bug_list_map.items(): + for bug_fix_hash in bug_fix_hash_list: + file.write(' '.join([path, bug_fix_hash, '\n'])) + +def path_to_bug_list_map_from_file(file_name: str) -> PathToBugListMap: + path_to_bug_list_map = PathToBugListMap() + with open(file_name, 'r') as file: + for line in file: + path, bug_fix_hash = line.split() + path_to_bug_list_map.add_bug_to_path(path, bug_fix_hash) + return path_to_bug_list_map + +def find_affected_files_in_commit(commit: Commit) -> List[str]: + results = [] + for match in re.finditer('^diff --git a\/\S+ b\/(\S+)$', commit.raw_commit, re.MULTILINE): + affected_file = match.group(1) + print('Found file: ', affected_file) + if os.path.isfile(affected_file): + results.append(affected_file) + return results + +def build_path_to_bug_list_map(git: Git, bug_fix_checker: BugFixChecker) -> PathToBugListMap: + path_to_bug_lists = PathToBugListMap() + for commit_hash in find_bug_fixes(git, bug_fix_checker): + commit = git.show(commit_hash) + paths = find_affected_files_in_commit(commit) + path_to_bug_lists.add_bug_to_paths(paths, commit_hash) + return path_to_bug_lists + +def generate_path_to_bug_list(git: Git, path_to_bug_list_file: str, bug_fix_checker=UpstreamKernelBugFixChecker()) -> None: + path_to_bug_list_map = build_path_to_bug_list_map(git, bug_fix_checker) + path_to_bug_list_map.serialize(path_to_bug_list_file) + +class BugFixFileTreeNode(object): + def get_bugs_of_children(self) -> List[str]: + pass + + def get_number_of_child_bugs(self) -> int: + return len(self.get_bugs_of_children()) + + def sort(self) -> None: + pass + + def print(self, indent: str = '') -> None: + pass + + def add_path_to_bug_mapping(self, path: pathlib.Path, bug_hash: str) -> None: + pass + +class BugFixFileNode(BugFixFileTreeNode): + def __init__(self, file_name: str, bug_list: List[str] = None) -> None: + self.file_name = file_name + self._bug_list = bug_list or [] + + def get_bugs_of_children(self) -> List[str]: + return self._bug_list + + def add_path_to_bug_mapping(self, path: pathlib.Path, bug_hash: str) -> None: + assert os.path.basename(path) == path and path == self.file_name + self._bug_list.append(bug_hash) + + def sort(self) -> None: + self._bug_list.sort() + + def print(self, indent: str = '') -> None: + print(indent, self.file_name, ': ', str(len(self._bug_list))) + #indent += '\t' + #for bug_hash in self._bug_list: + # print(indent, bug_hash) + +class BugFixDirectoryNode(BugFixFileTreeNode): + def __init__(self, directory_name: str, child_directory_nodes: Dict[str, 'BugFixDirectoryNode'] = None, child_file_nodes: Dict[str, BugFixFileNode] = None) -> None: + self.directory_name = directory_name + self._child_directory_nodes = child_directory_nodes or {} + self._child_file_nodes = child_file_nodes or {} + self._child_nodes_sorted = [] + self._number_of_child_bugs = 0 + + def get_bugs_of_children(self) -> List[str]: + results = [] + for _, child in self._child_directory_nodes: + results += child.get_bugs_of_children + for _, child in self._child_file_nodes: + results += child.get_bugs_of_children + return results + + def get_number_of_child_bugs(self) -> int: + return self._number_of_child_bugs + + def add_path_to_bug_mapping(self, path: pathlib.Path, bug_hash: str) -> None: + child_name = path.parts[0] + if len(path.parts) > 1: + remaining_path = pathlib.Path(*path.parts[1:]) + # print('Adding path: ' + str(path), ', Child name: ', child_name, ', Remaining path: ', remaining_path) + self._child_directory_nodes.setdefault(child_name, BugFixDirectoryNode(child_name)).add_path_to_bug_mapping(remaining_path, bug_hash) + # print(self._child_directory_nodes) + else: + self._child_file_nodes.setdefault(child_name, BugFixFileNode(child_name)).add_path_to_bug_mapping(child_name, bug_hash) + + def sort(self) -> None: + #print('Keys for ', self.directory_name, ':') + #for part in list(self._child_directory_nodes.keys()) + list(self._child_file_nodes.keys()): + # print('\t', part) + self._child_nodes_sorted = [] + list(self._child_directory_nodes.values()) + list(self._child_file_nodes.values()) + self._number_of_child_bugs = 0 + for child in self._child_nodes_sorted: + child.sort() + self._number_of_child_bugs += child.get_number_of_child_bugs() + self._child_nodes_sorted.sort(key=lambda child: child.get_number_of_child_bugs(), reverse=True) + + def print(self, indent: str = '') -> None: + print(indent, self.directory_name, ': ', str(self._number_of_child_bugs)) + indent += '\t' + for child in self._child_nodes_sorted: + child.print(indent) + +class BugFixFileTree(object): + def __init__(self) -> None: + self._root_directory_node = BugFixDirectoryNode('') + + def build_from_path_to_bug_list_map(self, path_to_bug_list_map: PathToBugListMap) -> None: + for path, bug_list in path_to_bug_list_map._path_to_bug_list_map.items(): + for bug_hash in bug_list: + self._root_directory_node.add_path_to_bug_mapping(pathlib.Path(path), bug_hash) + + def print(self) -> None: + self._root_directory_node.sort() + self._root_directory_node.print() + +def print_heat_map(git: Git, path_to_bug_list_file: str) -> None: + path_to_bug_list_map = path_to_bug_list_map_from_file(path_to_bug_list_file) + bug_fix_file_tree = BugFixFileTree() + bug_fix_file_tree.build_from_path_to_bug_list_map(path_to_bug_list_map) + bug_fix_file_tree.print()
diff --git a/heat_map_builder.py b/heat_map_builder.py new file mode 100755 index 0000000..dbafe44 --- /dev/null +++ b/heat_map_builder.py
@@ -0,0 +1,34 @@ +#!/usr/bin/env python3 +# Copyright 2023 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import os.path +import sys + +import git + +def main(argv): + assert os.path.exists('.git') + git_obj = git.Git('.git') + if argv[0] == 'build_map': + assert len(argv) > 1 + git.generate_path_to_bug_list(git_obj, argv[1]) + elif argv[0] == 'print_heat_map': + assert len(argv) > 1 + git.print_heat_map(git_obj, argv[1]) + else: + assert False + +if __name__ == '__main__': + main(sys.argv[1:])