|
@@ -34,17 +34,17 @@ The figure shows the SZZ Unleashed workflow, i.e., running three Python scripts
|
|
|
To get issues one needs a bug tracking system. As an example the project Jenkins uses [JIRA](https://issues.jenkins-ci.org).
|
|
|
From here it is possible to fetch issues that we then can link to bug fixing commits.
|
|
|
|
|
|
-We have provided an example script that can be used to fetch issues from Jenkins issues. In the directory fetch_jira_bugs, one can find the **fetch.py** script. The script has a jql string which is used as a filter to get certain issues. JIRA provides a neat way to test these jql strings directly in the [web page](https://issues.jenkins-ci.org/browse/JENKINS-41020?jql=). Change to the advanced view and then enter the search creiterias. Notice that the jql string is generated in the browsers url bar once enter is hit.
|
|
|
+We have provided an example script that can be used to fetch issues from Jenkins issues (see 1) in the figure). In the directory fetch_jira_bugs, one can find the **fetch.py** script. The script has a jql string which is used as a filter to get certain issues. JIRA provides a neat way to test these jql strings directly in the [web page](https://issues.jenkins-ci.org/browse/JENKINS-41020?jql=). Change to the advanced view and then enter the search creiterias. Notice that the jql string is generated in the browsers url bar once enter is hit.
|
|
|
|
|
|
To fetch issues from Jenkins JIRA, just run:
|
|
|
```python
|
|
|
python fetch.py
|
|
|
```
|
|
|
-It creates a directory with issues. These issues will later on be used by the `find_bug_fixes.py` script. Second we need to convert the `git log` output to something that can be processed. That requires a local copy of the repository that we aim to analyze, [Jenkins Core Repository](https://github.com/jenkinsci/jenkins). Onced cloned, one can now run the **git_log_to_array.py** script. The script requires an absolute path to the cloned repository and optionally a SHA-1 for an initial commit.
|
|
|
+It creates a directory with issues (see issues folder in the figure). These issues will later on be used by the `find_bug_fixes.py` script. Second we need to convert the `git log` output to something that can be processed. That requires a local copy of the repository that we aim to analyze, [Jenkins Core Repository](https://github.com/jenkinsci/jenkins). Onced cloned, one can now run the **git_log_to_array.py** script (see 2) in the figure). The script requires an absolute path to the cloned repository and optionally a SHA-1 for an initial commit.
|
|
|
```python
|
|
|
python git_log_to_array.py --repo-path <path_to_local_repo>
|
|
|
```
|
|
|
-Once executed, this creates a file `gitlog.json` that can be used together with issues that we created with `fetch.py` script. Now using the `find_bug_fixes.py` and this file, we can get a json file
|
|
|
+Once executed, this creates a file `gitlog.json` that can be used together with issues that we created with `fetch.py` script. Now using the `find_bug_fixes.py` (see 3) in the figure) and this file, we can get a json file
|
|
|
that contains the Issue and its corresponding commit SHA-1, the commit date, the creation date and the resolution date. Just run:
|
|
|
```python
|
|
|
python find_bug_fixes.py --gitlog <path_to_gitlog_file> --issue-list <path_to_issues_directory>
|
|
@@ -69,11 +69,10 @@ Or if the algorithm should be runned without building a jar:
|
|
|
gradle build && gradle runJar
|
|
|
```
|
|
|
|
|
|
-The algorithm tries to use as many cores as possible during runtime. The more
|
|
|
-the merrier so to speak.
|
|
|
+The algorithm tries to use as many cores as possible during runtime.
|
|
|
|
|
|
To get the bug introducing commits from a repository using the file produced
|
|
|
-by the previous issue to bug fix commit step, run:
|
|
|
+by the previous issue to bug fix commit step, run (see 4) in the figure):
|
|
|
|
|
|
```shell
|
|
|
java -jar szz_find_bug_introducers-<version_number>.jar -i <path_to_issue_list.json> -r <path_to_local_repo>
|
|
@@ -81,7 +80,7 @@ java -jar szz_find_bug_introducers-<version_number>.jar -i <path_to_issue_list.j
|
|
|
|
|
|
## Output
|
|
|
|
|
|
-The output can be seen in three different files commits.json,
|
|
|
+As shown in the figure, the output consists of three different files: commits.json,
|
|
|
annotations.json and fix\_and\_bug\_introducing\_pairs.json.
|
|
|
|
|
|
The commits.json file includes all commits that have been blamed to be bug
|
|
@@ -102,7 +101,7 @@ fixes.
|
|
|
|
|
|
## Use Docker to generate fix_and_bug_introducing_pairs.json. <a name="szz_docker"></a>
|
|
|
|
|
|
-There exist a *Dockerfile* in the repository. It contains all the steps in chronological order that is needed to generate the **fix\_and\_bug\_introducing\_pairs.json**. Simply run this command in the directory where the Dockerfile is located:
|
|
|
+There exists a *Dockerfile* in the repository. It contains all the steps in chronological order that is needed to generate the **fix\_and\_bug\_introducing\_pairs.json**. Simply run this command in the directory where the Dockerfile is located:
|
|
|
|
|
|
```bash
|
|
|
docker build -t ssz .
|