Diagnoser

Script to run AutoFixer Diagnoser task

Dependencies

---

Overview

Autofixer depends on two projects shown below:

1. Injector: Used to inject suggested annotations to source code. It receives a path to json file where all the suggested fixes are written as an argument. The default location is /tmp/NullAwayFix/fixes.json
2. Customized NullAway: A special version of NullAway with suggested fixes capability. It needs to be on autofix branch to have all the fix suggestions features available.

Installation

AutoFixer is provided via a jar file where all dependenceis related to Injector are already handled. To install the customized version of NullAway in maven local repository, please follow the instructions below:

git clone https://github.com/nimakarimipour/NullAway
cd NullAway
git checkout autofixer
./gradlew Install

Or simply run the dependecies.sh script provided.

The customized version of NullAway will be installed at the following location in maven local repository:

edu.ucr.cs.riple:nullaway:0.7.12-SNAPSHOT

Build Jar

The jar file in jars directory can be rebuilt by the following commands:

git clone git@github.com:nimakarimipour/Injector.git
cd Injector
./gradlew install
cd ..
git clone git@github.com:nimakarimipour/NullAwayAutoFixer.git
cd NullAwayAutoFixer
./gradlew fatJar

Requirements for Target Project

---

The only requirement for a target project to run autofixer on is that it needs to work with the customized version of NullAway mentioned in Dependencies/Installation rather than the original version. After that the original version of the NullAway is replaced by the customized version, the following flag must be sent to NullAway to activate the autofix features.

-XepOpt:NullAway:AutoFix=true

Please find a sample project setup below:

dependencies {
    //Here we pass the customized verion of NullAway
    annotationProcessor "edu.ucr.cs.riple:nullaway:0.7.12-SNAPSHOT"
    compileOnly "com.google.code.findbugs:jsr305:3.0.2"
    errorprone "com.google.errorprone:error_prone_core:2.3.2"
    errorproneJavac "com.google.errorprone:javac:9+181-r4173-1"
}

tasks.withType(JavaCompile) {
    if (!name.toLowerCase().contains("test")) {
        options.errorprone.errorproneArgs += ["-XepDisableAllChecks",
                                              "-Xep:NullAway:ERROR",
                                              "-XepOpt:NullAway:AnnotatedPackages=",
                                              //Autofix flag must be set to true
                                              "-XepOpt:NullAway:AutoFix=true"]
    }
}

Config

---

Configurations are written inside the config.json file. Please find a sample below:

{
    "PROJECT_PATH": "/Projects/MPAndroidChart",
    "BUILD_COMMAND": "./gradlew build -x test",
    "ANNOTATION":{
        "INITIALIZE": "com.github.Initializer",
        "NONNULL": "javax.annotation.NonNull",
        "NULLABLE": "javax.annotation.Nullable"
    },
    "FORMAT": "",
    "DEPTH": 4
}

Below is the description of each setting:

1. PROJECT_PATH: The path to the project directory (if a subproject needs to be analyzied, this path needs to point to the subproject not the root project)
2. BUILD_COMMAND: The command to execute NullAway for the project at the path given in PROJECT_PATH. The script will use the command, cd PROJECT_PATH && BUILD_COMMAND to execute NullAway.
3. INITIALIZE: Fully qualified name of the Initializer annotation to inject on detected initializer methods.
4. NONNULL: Fully qualified name of the Nonnull annotation.
5. NULLABLE: Fully qualified name of the Nullable annotation.
6. FORMAT: Task which automatically reformats the code. This command should be executed at the directory where BUILD_COMMAND is executed. Since some projects have checkstyle tasks, reformat task will be executed to pass checkstyles in consecutive builds.
7. DEPTH: The depth of deep analysis.

Run

---

Before running, please make sure that all the changes in the Requirements for Target Project section has been applied to the target project.

The script is written in python3 in the file run.py. It needs the NullAwayAutoFixer.jar file to execute at the relative path: ./jars/NulAwayAutoFixer.jar just like the structure in this repo. To run the script a command must be passed to the script. A command must be one of the followings:

1. diagnose: It will make diagnose_report.json file which is the result of analyizing all fixes comming from NullAway
2. pre: It will perform a preprocessing phase which adds @Initialize annotation to all initializer methods detected by NullAway.
3. apply: It will apply all the effective fixes reported in diagnose_report.json which reduces the number or errors.
4. clean: It will clean all genereted files.
5. loop: It will run diagnose/apply in iterations, until no further new fix is suggested.

python3 run.py pre
python3 run.py diagnose
python3 run.py apply
python3 run.py clean
python3 run.py loop

Output

All outputs will be stored at /tmp/NullAwayFix/ directory. To delete all outputs, Please run python run.py clean.

If AutoFix flag is set to true, anytime NullAway (can be via the build command) is executed on a project, a fixes.json file will be generetaed which includes all the suggested fixes.

Please find a sample fixes.json below:

{
    "fixes": [
        {
            "annotation": "javax.annotation.Nullable",
            "reason": "FIELD_NO_INIT",
            "method": "",
            "param": "mVelocityTracker",
            "location": "CLASS_FIELD",
            "class": "com.github.CustomGestureDetector",
            "pkg": "com.github",
            "uri": "file:AbsolutePathTo/CustomGestureDetector.java",
            "inject": "true"
        },
    ]
}

After the diagnose task is finished, diagnose_report.json will be created which holds the information regarding the effectiveness of each fix written in fixes.json. Please find a sample below:

Here jump refers to the difference in number of errors.

{
    "reports": [
        {
            "annotation": "javax.annotation.Nullable",
            "reason": "FIELD_NO_INIT",
            "method": "",
            "param": "mVelocityTracker",
            "location": "CLASS_FIELD",
            "class": "com.github.CustomGestureDetector",
            "pkg": "com.github",
            "inject": "true",
            "uri": "file:AbsolutePathTo/CustomGestureDetector.java",
            "errors": [],
            "jump": -3
        }
    ]
}