diff --git a/INSTALL.md b/INSTALL.md index 3dd27bd..f2fb15d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -22,23 +22,29 @@ Once the virtual machine is imported, it will appear in your VirtualBox Manager VirtualBox Manager -Once the virtual machine loads, Eclipse will open -- this process may take a few minutes. Once Eclipse opens, there will be 7 files opens labeled *Defect 0- Defect 6*. At the bottom of the window, the Tasks View is open with a list of TODOs. Each TODO is attached to the failing test for each defect. For example, **TODO: Test 00 (Training)** is associated with *Defect_0_Training*. +Once the virtual machine loads, Eclipse will open -- this process may take a few minutes. Once Eclipse opens, there will be 7 projects in the Project Explorer labeled *Defect 0- Defect 6*. +At the bottom of the window, the Tasks View is open with a list of TODOs. Each TODO is attached to the failing test for each defect. For example, **TODO: Test 00 (Training)** is attached to the failing test *test_toBoolean_String()* which exposes *Defect 0* in the *toBoolean()* method. ## Running Holmes To see Holmes output for each defect: 1. Double-click a TODO in the Tasks View to get to the failing test. - * *Defect 0* runs the test generation portion of Holmes (which does not include execution traces, as this was not automated in the user study version of Holmes). - * *Defects 1-6* show the pre-processed output that participants saw during the user study. +Eclipse TODOs -2. Highlight the method that takes the input being tested. Each TODO is followed by comments that specify what we asked participants to do and the method to highlight. +2. Highlight the method that takes the input being tested, as shown below. Each TODO is followed by comments that specify what we asked participants to do and the method to highlight. + +Highlighting target method 3. Right-click the highlighted method and click **"Run Holmes"** in the pop-up menu. +*Defect 0* runs the test generation portion of Holmes (which does not include execution traces, as this was not automated in the user study version of Holmes). + +*Defects 1-6* show the pre-processed output that participants saw during the user study. + If you are running Holmes on *Defect 0*, the editor will automatically go to the top of the file as Holmes generates and executes tests. This process will take a minute or two; eventually the Holmes View will open with results of the execution. If you are running Holmes on *Defects 1-6*, after a few seconds, the Holmes View will open with the pre-processed results used in our user study. For each of these defects, the output includes the original failing test, generated passing tests, and generated faiing tests. You can access the execution trace for each test by clicking the "See Execution Trace" button under the test of interest.