https://github.com/prmr/dscribe-plugin

Eclipse plug-in for the DScribe test generator
https://github.com/prmr/dscribe-plugin

Last synced: about 2 months ago
JSON representation

Eclipse plug-in for the DScribe test generator

• Host: GitHub
• URL: https://github.com/prmr/dscribe-plugin
• Owner: prmr
• License: apache-2.0
• Created: 2021-09-17T11:32:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-07T00:19:17.000Z (over 2 years ago)
• Last Synced: 2023-09-17T19:31:34.122Z (over 1 year ago)
• Language: Java
• Size: 11.8 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# The Eclipse Plugin for DScribe

[](https://www.mcgill.ca/)    

[](https://github.com/prmr/DScribe)    

[](https://www.eclipse.org/)

## Overview

* Do you frequently copy-paste exisiting unit tests to test a recurrent specification?

* Do you frequently copy-paste existing documentation fragments to document a recurrent specification?

* Do you find it annoying to update both the corresponding unit tests AND documentation fragments when a specification evolves?

If you answered yes to any of the above questions, then DScribe is the right tool for you!

DScribe allows you to test and document recurring concerns consistently and with ease. You simply define joint templates to capture 

the structure to test and document a specification. Then, you use method-level Java annotations to invoke the templates.

To learn more about DScribe, visit the [DScribe GitHub repository](https://github.com/prmr/DScribe).

## Documentation 

**Creating and Invoking DScribe Templates** 


To learn how to create and invoke your own DScribe templates, visit DScribe's [README](https://github.com/prmr/DScribe#how-dscribe-works).

**Running DScribe in Eclipse** 


To generate unit tests and documentation for a production class(es):

1. Select the target class(es) in Eclipse's ``Project Explorer`` view.

     * To select one class, simply click on it with your mouse.

     * To select multiple classes, hold down the ``Ctrl key`` and click on each class one by one.

2. Perform a ``Right`` click. The Eclipse dropdown menu will appear.

3. Click the ``Run DScribe`` command in the dropdown menu (see [screenshot](https://github.com/prmr/DScribe-plugin/blob/main/DScribeUpdateSite/assets/dscribe-command.png)).

Once DScribe terminates, a message dialog will appear to display the execution results. If DScribe runs successfully, the generated documentation 

and unit tests will be added to the production class and its corresponding test class, respectively.

**Publications**

* Mathieu Nassif, Alexa Hernandez, Ashvitha Sridharan, and Martin P. Robillard. [Generating Unit Tests for Documentation](https://ieeexplore-ieee-org.proxy3.library.mcgill.ca/document/9447988). To appear in IEEE Transactions on Software Engineering, 12 pages, 2021. 

## Download

DScribe is distributed under the terms of the [Apache License v 2.0](https://github.com/prmr/DScribe-plugin/blob/main/LICENSE.txt). To install the DScribe Eclipse plugin, follow the steps below.

**System requirements:** Eclipse 3.4, JavaSE 14. DScribe is currently tested on Windows only.

**To install DScribe:**

1. From the Eclipse menu bar, select ``Help > Install New Software``.

2. Click the ``Add`` button. This Add Repository window will appear.

3. For the name, enter *DScribe*. For the Location, enter *https://www.cs.mcgill.ca/~martin/DScribeUpdateSite*. Click ``Add``.

5. Select the new ``DScribe`` entry in the list and click ``Next`` twice.

6. Select that you accept the terms of the license agreement and click ``Finish``.

7. Restart your workspace.

## Contact 

For any questions, concerns, or suggestions, please free feel to contact [Alexa Hernandez](mailto:[email protected]).