Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "JaCoCo/Proposal"

(New page: = Draft proposal = This is a draft proposal, feel free to contribute to it! == Introduction == JaCoCo is a free code coverage library for Java, which is currently developed by the EclEmm...)
 
Line 10: Line 10:
 
== Background and Goal ==
 
== Background and Goal ==
  
TODO
+
There are several open source coverage technologies for Java available. While implementing the Eclipse plug-in EclEmma (http://www.eclemma.org/) the observation was that none of them are really designed for integration. Most of them are specifically fit to a particular tool (Ant tasks, command line, IDE plug-in) and do not offer a documented API that allows embedding in different contexts. One of the best and widely used available open source tools is EMMA (http://emma.sourceforge.net/). While EclEmma is based on it the EMMA library is not actively maintained any more by the original author. Due to the lack of regression tests maintenance and feature additions will become very difficult.
 +
 
 +
JaCoCo should become the standard backend technology for code coverage analysis in Java VM based environments. The focus is providing a lightweight, flexible and well documented library for integration with various build and development tools. Ant tasks are provided as reference usage scenarios. Other tools like a ready to use Eclipse plug-in (future version of EclEmma) or a Maven plug-in might follow.
  
 
== Architecture and Extensibility ==
 
== Architecture and Extensibility ==

Revision as of 03:30, 3 April 2011

Draft proposal

This is a draft proposal, feel free to contribute to it!

Introduction

JaCoCo is a free code coverage library for Java, which is currently developed by the EclEmma team based on the lessons learned from using and integration existing libraries over the last three years.

JaCoCo is proposed as an open source project under the Eclipse Technology Project (http://www.eclipse.org/technology/). This proposal is still in the Project Proposal Phase, and is being made in order to call for more community participation. You are invited to comment on and/or join the project. Please send all feedback to the http://www.eclipse.org/newsportal/thread.php?group=eclipse.technology.jacocoa newsgroup.

Background and Goal

There are several open source coverage technologies for Java available. While implementing the Eclipse plug-in EclEmma (http://www.eclemma.org/) the observation was that none of them are really designed for integration. Most of them are specifically fit to a particular tool (Ant tasks, command line, IDE plug-in) and do not offer a documented API that allows embedding in different contexts. One of the best and widely used available open source tools is EMMA (http://emma.sourceforge.net/). While EclEmma is based on it the EMMA library is not actively maintained any more by the original author. Due to the lack of regression tests maintenance and feature additions will become very difficult.

JaCoCo should become the standard backend technology for code coverage analysis in Java VM based environments. The focus is providing a lightweight, flexible and well documented library for integration with various build and development tools. Ant tasks are provided as reference usage scenarios. Other tools like a ready to use Eclipse plug-in (future version of EclEmma) or a Maven plug-in might follow.

Architecture and Extensibility

TODO

Project Scope

TODO

Future Roadmap

The immediate priorities for JaCoCo in order of importance are:

TODO

Concerns

TODO

Packaging and Deployment

JaCoCo currently ships in the form of an Eclipse update site, and also an independent .zip/.tgz download. It would continue to ship in these forms.

Organization

Mentors

  • Chris Aniszczyk
  • TODO

Initial committers

  • Marc R. Hoffmann

Interested parties

  • Chris Aniszczyk
  • Dave Carver

Back to the top