DOI: 10.5281/zenodo.1253317
title: Spanichella/Testsmelldescriber-Replicationpackage Testsmelldescriber-Replicationpackage-V1.1

description: # TestSmellDescriber-ReplicationPackage

1) "1_Emails-Sent-To-Participants" contains:

    1. Email-WS1.docx and Email-WS1.pdf  <br>
    2. Email-WS2.docx and Email-WS2.pdf<br>
    <br>
     As explained in the paper the experiment was conducted offline, i.e., <br>
     we have send via email to the participants the required experimental material <br>
     with instructions about the tasks to perform. During the tasks the participants were guided via<br>
     Google Forms (shared in the above e-mail), this also to collect information about the performed activities. <br>
     As reported in the emails we send to each participant  an experiment package composed by (i) a <br>
     pre-questionnaire (to collect information about the profile and experience of each participant), <br>
     (ii) surveys with instructions and materials to perform the tasks, and (iii) a post-questionnaire. <br>
     Before the  study, we explained to the participants the expected tasks:  <br>
     two maintenance and evolution tasks, each involving two pairs of Java and test classes. 

<br>
2) "2_Information-about-smells-and-refactoring-operations" contains, <br>
    as reported in the paper, to facilitate the two tasks "we provided <br>
    the document &lt;"Test Smells & Refactorings.pdf"&gt; describing the notion of a test/code smells, the types<br>
     of smells potentially affecting test cases and the recommended refactoring operations to remove them.

3) "3_Information-about-the-smells-detected" contains:<br>
   (a) "Summary for apache-ofbiz-16.11.04" contains name of all the smelly classes and name of the smell(s) each Java/test<br>
       class has.<br>
   (b) "Summary for at method level apache-ofbiz-16.11.04" contains name of the classes with name of the smelly <br>
        methods    and name of the smell<br>
        each method is suffering with.<br>
    <br>
4) "4_Surveys-Sent-To-Participants" contains<br>
    the 4 surveys (in pdf format) performed by the participants.

        1. Pre-Task TSD survey.pdf includes Brief Introduction of this experiment and question related to basic information of participants.<br>
        2. Task 1 TSD survey.pdf includes testing task 1, additional information to perform the task 1 and questions related to the task 1.<br>
        3. Task 2 TSD Survey.pdf includes testing task 2, additional information to perform the task 2 and questions related to the task 2.<br>
        4. Post-Task TSD survey.pdf includes questions regarding the TestSmellDescriber tools performance and usefulness, provides opportunity<br>
        to suggest modifications and questions related to consiceness, completness and precision of the whole survey and tasks.<br>
    <br>
5) "5_Templates-defined-and-used-to-generate-the-summaries".<br>
    As reported in the paper, "by leveraging the SWUM model TestSmellDescriber generates descriptions at <br>
    different levels of abstraction, as reported in Figure 1 of the paper:<br>
    - a short and long method description, <br>
    - a short and long refactoring description, <br>
    - and a quantitative description of the smell in the context of the whole project. <br>
    The descriptions are generated, as done in previous work, with natural "language templates" that are <br>
    augmented by the information that is gathered from the smell detection process. 

6) "6_Working-Dataset" contains the two workspaces we gave to the participants for executing the tasks.<br>
   <br>
    a) “Workspace1-Sent-To-Participants” contains the java projects we selected for our experiment;<br>
        in this case, we have selected 2 target classes, needs to be smell free, one class without <br>
        summaries and another with summaries<br>
      b)  “Workspace2-Sent-To-Participants” contains the java projects we selected for our experiment;<br>
         in this case, we have selected 2 target classes, needs to be smell free, one class without <br>
         summaries and another with summaries<br>
    c) It is important to mention the test/Java classes used in the study are are located in the <br>
        workspaces in the following relative paths:<br>
        1) ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\string\test\FlexibleStringExpanderTests.java<br>
        2) ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\test\TimeDurationTests.java<br>
        3)  ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\string\FlexibleStringExpander.java<br>
        4)  ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\TimeDuration.java<br>
        5) ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\collections\test\FlexibleMapAccessorTests.java<br>
        6) ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\cache\test\UtilCacheTests.java<br>
        7)...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\collections\FlexibleStringExpander.java<br>
        8) ...\src\framework\base\src\main\java\org\apache\ofbiz\base\util\cache\UtilCache.java<br>
       

7) "7_Results-of-the-questionnaires" contains a folder "data-analysis" containing<br>
   - "data" folder which contains: <br>
               - in "figs" several  figures about the main results achieved (some of them used in the paper).<br>
               - the file "full_results-testsmelldescriber-anonymized.csv" reporting all results<br>
                 of the involved study participants. It was used to compute the statistics reported in the paper by using the <br>
                 R script which is in the folder "R-script" (explained later in the readme file).<br>
   - "R-script"  folder which contains<br>
               - "analysis.R" the script files used to computed all statistics explained in section study<br>
                 and reported in the papers. The script automatically generates the figures in the folder <br>
                 "data/figs". <br>
   - "summary - Post-Task TSD Survey.pdf" - It reports the summary of results of the post-experiment questionnaires<br>
   - "summary - Pre-Experiment TSD Survey.pdf" -  It reports the summary of results of the pre-experiment questionnaires<br>
   - "summary---Task1-Survey.pdf" - It reports the summary of results of the  of the post-task questionnaire<br>
   - "summary---Task2-Survey.pdf" - It reports the summary of results of the post-task questionnaire<br>
   - "tasks-participants" contains the information the participants provided us about the performed changes.

8) "8_TestSmellDescriber-research-prototype" contains the<br>
   prototypical version of TestSmellDescriber we used to generate the summaries <br>
   evaluated for the experiments. We provide information on how to use and run the tool<br>
   on the provided data.