EiffelStudio: an EiffelSoftware project - User contributions [en]

CddBranch

2008-12-12T13:11:40Z

Aleitner: /* Related Publications */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Publications ==

Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", in Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf pdf] [http://se.ethz.ch/people/leitner/publications/ESEC_FSE2007.bib.txt bibtex]

Leitner, A., Pretschner A., Mori S., Meyer B., Oriol M., "On the Effectiveness of Test Extraction without Overhead", under submission

== News ==
14.May 2008: Added patch for Windows and Linux that fixes a bug that can cause a crash during extraction.

10.April 2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

08.April 2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

02.April 2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the '$ISE_EIFFEL/studio/spec/linux-x86/bin/ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec.exe and replace it with the '$ISE_EIFFEL/studio/spec/windows/bin/ec.exe' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-12-12T13:10:29Z

Aleitner:

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Publications ==

Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", in Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf pdf] [http://se.ethz.ch/people/leitner/publications/ESEC_FSE2007.bib.txt bibtex]

Leitner, A., Pretschner A., Mori S., Meyer B., Oriol M., "On the Effectiveness of Test Extraction without Overhead", under submission

== News ==
14.May 2008: Added patch for Windows and Linux that fixes a bug that can cause a crash during extraction.

10.April 2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

08.April 2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

02.April 2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the '$ISE_EIFFEL/studio/spec/linux-x86/bin/ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec.exe and replace it with the '$ISE_EIFFEL/studio/spec/windows/bin/ec.exe' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-05-14T13:56:38Z

Aleitner: /* Windows Patch */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
14.May 2008: Added patch for Windows and Linux that fixes a bug that can cause a crash during extraction.

10.April 2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

08.April 2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

02.April 2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the '$ISE_EIFFEL/studio/spec/linux-x86/bin/ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec.exe and replace it with the '$ISE_EIFFEL/studio/spec/windows/bin/ec.exe' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-05-14T13:55:31Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
14.May 2008: Added patch for Windows and Linux that fixes a bug that can cause a crash during extraction.

10.April 2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

08.April 2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

02.April 2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the '$ISE_EIFFEL/studio/spec/linux-x86/bin/ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Final 7(or final 7, fixes bug that causes crash under uncommon circumstances): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows_patch_01.zip
* does NOT work for official EiffelStudio 6.1 installation (or pre-final 5 versions of CDD Edition)!
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-05-14T12:47:44Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
14.May 2008: Added patch for Windows and Linux that fixes a bug that can cause a crash during extraction.
10.April 2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

08.April 2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

02.April 2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the '$ISE_EIFFEL/studio/spec/linux-x86/bin/ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (or final 7, fixes bug that causes crash under uncommon circumstances): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows_patch_01.zip
* does NOT work for official EiffelStudio 6.1 installation (or pre-final 5 versions of CDD Edition)!
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-28T13:31:09Z

Aleitner: /* Linux Patch */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
10.April.2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

8.April.2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the '$ISE_EIFFEL/studio/spec/linux-x86/bin/ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-28T13:30:32Z

Aleitner: /* Linux */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
10.April.2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

8.April.2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Linux Patch ===
* Patch for CDD EiffelStudio Final 7: Download http://se.ethz.ch/people/leitner/cdd/ec and replace it with the 'ec' from Final 7. This patch fixes a crash that sometimes occurs during extraction of test cases. You may need to delete the precompile and EIFGENs of your project after applying the patch.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-22T16:45:31Z

Aleitner: /* Linux */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
10.April.2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

8.April.2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Full Linux version (for Debian stable): http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7_debian_stable.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CDD Common Problems

2008-04-18T07:52:32Z

Aleitner:

[[Category:CDD]]

Problem: ''''Something doesn't work and I get no feedback. What can I do?''''
* There is a CDD specific output tool, it is called ''''CDD Output''''. If you don't see this window, you can make it visible via ''''"View -> Tools -> CDD Output"''''

Problem: ''''My system suddenly has the wrong root class / doesn't compile anymore because it doesn't find the strange wrong root class''''
* This issue arises if EiffelStudio crashes / is killed during the (foreground) debugging of a test case (via the corresponding button in the testing tool). On Windows, crashes should no happen, but there is an issue on Linux with the foreground debugging of test cases we haven't been able to solve. If you are debugging a test case that passes, OR you are debugging a test case that fails, but you press "Continue" after the exception occured (instead of "Stop", to end the execution immediately), EiffelStudio will crash.
* Solution: You have to manually set the root class of the system back to the correct class (via Project Settings, or by directly editing the .ecf file)
* Prevention: On Linux, use test case debugging ONLY for FAILING test cases, and after exception occured, STOP the execution (with the "Stop" button)!

Problem: ''''My test cases time out''''
* CDD automatically aborts test cases that run longer than a given period of time. The default value (which is a few seconds) can be changed by setting the environment variable ''''CDD_TESTER_TIMEOUT''''. On Linux ''''"export CDD_TESTER_TIMEOUT=120"'''' sets the timeout to 120 seconds. On Windows the same thing is acomplished with ''''"set CDD_TESTER_TIMEOUT=120"''''.

Problem: '''Installing EiffelStudio reports error codes like '2908' and '2909' '''
* This seems to be a rare problem. The following might help
<blockquote>
<<
I finally found the solution. Have a look at the following URLs:
- http://tinyurl.com/2rj93p
- http://tinyurl.com/3ey6fe

I believe you should have the same issue. In my case, I think it is because
I
had just installed the .NET 3.0 runtime which is part of the Windows Update.

If you rename the `Components' registry key, assuming that like me you only
have one child key, the installation should progress fine.
>>

This often happens when uninstalling and then reinstalling EiffelStudio
although it is clearly not a bug in our installer.

</blockquote>

Problem: ''''I cannot see the testing window.''''
* Make it visible via ''''View -> Tools -> CDD Output''''

Problem: ''''I am getting a duplicate class error'''' or ''''I am trying to use CDD on an existing project but it doesn't work''''
* If you have a look at the ''''CDD output'''' window you will probably find the error message:

<pre>
Error code: VSCN
Configuration error: cluster has two classes with the same name.
What to do: if both classes are needed, change name of one of them.

Cluster name: erl_g_tests
First class: CDD_INTERPRETER
First file: "/home/aleitner/src/erl_g/src/erl_g/cdd_tests/erl_g/cdd_interpreter.e"
Second class: CDD_INTERPRETER
Second file: "/home/aleitner/src/erl_g/library/cdd_tests/erl_g_library/cdd_interpreter.e"
</pre>

To fix this go to the project settings, to your active target, '''Groups -> Clusters''' and then select your root cluster. Open the '''Advanced''' tree-item and click on the value part of the '''Exclude Rules'''. Now add rule ''''/cdd_tests$'''' and click ''''OK''''.

Alternatively you can open your ecf file with a text editor. You will find a stance that looks like this:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
</file_rule>
</pre>

Edit edit to make it looks like the following:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
<exclude>/cdd_tests$</exclude>
</file_rule>
</pre>

Problem: ''''I have written or extracted a test case. How can I execute it?''''
* All tests are executed in the background right after compiling automatically. You can choose to enable or disable background testing via the ''''Enable/Disable automatic background execution of tests''''.

[[Image:enable_testing.png|center]]

Problem: ''''The environment is unstable when using the .Net backend.''''
Solution: CDD does currently not support the .Net backend. Please use the C backend.

Problem: ''''How to disable the CDD extension in EiffelStudio''''
Solution: Make sure the push-buttons for Extraction and Execution are not pressed. The buttons are shown in the below picture.
[[Image:enable_exec_and_extract.png|center]]

Problem: ''''My extracted test cases get overwritten in the SVN Repository, because my colleagues commit their extracted test cases which have the same name.''''
* Solution: Define a new environment variable "CDD_TESTER_ID". The value of the variable will be used as suffix for all extracted test class names. So if all members of the project define a unique "CDD_TESTER_ID", the individually extracted test cases can be commited to the svn without collisions.
* ATTENTION: The value of CDD_TESTER_ID has to conform to a valid Eiffel class name, e.g. it has to consist of (uppercase) letters and '_' only!
* EXAMPLE: You define CDD_TESTER_ID and set it to value "MARKUS". Each time a new test case gets exracted for a class ROOT_CLASS, the generated class name for the test case will be CDD_TEST_ROOT_CLASS_xyz_MARKUS. Likewise it will get stored in a file called cdd_test_root_class_xyz_markus.e

CddBranch

2008-04-10T13:01:23Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
10.April.2008: If installation exits with cryptic error codes, please have a look at the [[CDD Common Problems|Common Problems]] page.

8.April.2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-10T13:01:03Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
10.April.2008: If installation exits with cryptic error codes, please have a look at the common problems page.

8.April.2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CDD Common Problems

2008-04-10T13:00:07Z

Aleitner:

[[Category:CDD]]

Problem: ''''My test cases time out''''
* CDD automatically aborts test cases that run longer than a given period of time. The default value (which is a few seconds) can be changed by setting the environment variable ''''CDD_TESTER_TIMEOUT''''. On Linux ''''"export CDD_TESTER_TIMEOUT=120"'''' sets the timeout to 120 seconds. On Windows the same thing is acomplished with ''''"set CDD_TESTER_TIMEOUT=120"''''.

Problem: '''Installing EiffelStudio reports error codes like '2908' and '2909' '''
* This seems to be a rare problem. The following might help
<blockquote>
<<
I finally found the solution. Have a look at the following URLs:
- http://tinyurl.com/2rj93p
- http://tinyurl.com/3ey6fe

I believe you should have the same issue. In my case, I think it is because
I
had just installed the .NET 3.0 runtime which is part of the Windows Update.

If you rename the `Components' registry key, assuming that like me you only
have one child key, the installation should progress fine.
>>

This often happens when uninstalling and then reinstalling EiffelStudio
although it is clearly not a bug in our installer.

</blockquote>

Problem: ''''I cannot see the testing window.''''
* Make it visible via ''''View -> Tools -> CDD Output''''

Problem: ''''Is there some kind of CDD log window?''''
* Yes there is it is called ''''CDD Output''''. If you don't see this window, you can make it visible via ''''"View -> Tools -> CDD Output"''''

Problem: ''''I am getting a duplicate class error'''' or ''''I am trying to use CDD on an existing project but it doesn't work''''
* If you have a look at the ''''CDD output'''' window you will probably find the error message:

<pre>
Error code: VSCN
Configuration error: cluster has two classes with the same name.
What to do: if both classes are needed, change name of one of them.

Cluster name: erl_g_tests
First class: CDD_INTERPRETER
First file: "/home/aleitner/src/erl_g/src/erl_g/cdd_tests/erl_g/cdd_interpreter.e"
Second class: CDD_INTERPRETER
Second file: "/home/aleitner/src/erl_g/library/cdd_tests/erl_g_library/cdd_interpreter.e"
</pre>

To fix this go to the project settings, to your active target, '''Groups -> Clusters''' and then select your root cluster. Open the '''Advanced''' tree-item and click on the value part of the '''Exclude Rules'''. Now add rule ''''/cdd_tests$'''' and click ''''OK''''.

Alternatively you can open your ecf file with a text editor. You will find a stance that looks like this:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
</file_rule>
</pre>

Edit edit to make it looks like the following:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
<exclude>/cdd_tests$</exclude>
</file_rule>
</pre>

Problem: ''''I have written or extracted a test case. How can I execute it?''''
* All tests are executed in the background right after compiling automatically. You can choose to enable or disable background testing via the ''''Enable/Disable automatic background execution of tests''''.

[[Image:enable_testing.png|center]]

Problem: ''''The environment is unstable when using the .Net backend.''''
Solution: CDD does currently not support the .Net backend. Please use the C backend.

Problem: ''''How to disable the CDD extension in EiffelStudio''''
Solution: Make sure the push-buttons for Extraction and Execution are not pressed. The buttons are shown in the below picture.
[[Image:enable_exec_and_extract.png|center]]

Problem: ''''My extracted test cases get overwritten in the SVN Repository, because my colleagues commit their extracted test cases which have the same name.''''
* Solution: Define a new environment variable "CDD_TESTER_ID". The value of the variable will be used as suffix for all extracted test class names. So if all members of the project define a unique "CDD_TESTER_ID", the individually extracted test cases can be commited to the svn without collisions.
* ATTENTION: The value of CDD_TESTER_ID has to conform to a valid Eiffel class name, e.g. it has to consist of (uppercase) letters and '_' only!
* EXAMPLE: You define CDD_TESTER_ID and set it to value "MARKUS". Each time a new test case gets exracted for a class ROOT_CLASS, the generated class name for the test case will be CDD_TEST_ROOT_CLASS_xyz_MARKUS. Likewise it will get stored in a file called cdd_test_root_class_xyz_markus.e

CDD Common Problems

2008-04-10T12:59:39Z

Aleitner:

[[Category:CDD]]

Problem: ''''My test cases time out''''
* CDD automatically aborts test cases that run longer than a given period of time. The default value (which is a few seconds) can be changed by setting the environment variable ''''CDD_TESTER_TIMEOUT''''. On Linux ''''"export CDD_TESTER_TIMEOUT=120"'''' sets the timeout to 120 seconds. On Windows the same thing is acomplished with ''''"set CDD_TESTER_TIMEOUT=120"''''.

Problem: ''''Installing EiffelStudio reports error codes like '2908' and '2909' ''''
* This seems to be a rare problem. The following might help
<blockquote>
<<
I finally found the solution. Have a look at the following URLs:
- http://tinyurl.com/2rj93p
- http://tinyurl.com/3ey6fe

I believe you should have the same issue. In my case, I think it is because
I
had just installed the .NET 3.0 runtime which is part of the Windows Update.

If you rename the `Components' registry key, assuming that like me you only
have one child key, the installation should progress fine.
>>

This often happens when uninstalling and then reinstalling EiffelStudio
although it is clearly not a bug in our installer.

</blockquote>

Problem: ''''I cannot see the testing window.''''
* Make it visible via ''''View -> Tools -> CDD Output''''

Problem: ''''Is there some kind of CDD log window?''''
* Yes there is it is called ''''CDD Output''''. If you don't see this window, you can make it visible via ''''"View -> Tools -> CDD Output"''''

Problem: ''''I am getting a duplicate class error'''' or ''''I am trying to use CDD on an existing project but it doesn't work''''
* If you have a look at the ''''CDD output'''' window you will probably find the error message:

<pre>
Error code: VSCN
Configuration error: cluster has two classes with the same name.
What to do: if both classes are needed, change name of one of them.

Cluster name: erl_g_tests
First class: CDD_INTERPRETER
First file: "/home/aleitner/src/erl_g/src/erl_g/cdd_tests/erl_g/cdd_interpreter.e"
Second class: CDD_INTERPRETER
Second file: "/home/aleitner/src/erl_g/library/cdd_tests/erl_g_library/cdd_interpreter.e"
</pre>

To fix this go to the project settings, to your active target, '''Groups -> Clusters''' and then select your root cluster. Open the '''Advanced''' tree-item and click on the value part of the '''Exclude Rules'''. Now add rule ''''/cdd_tests$'''' and click ''''OK''''.

Alternatively you can open your ecf file with a text editor. You will find a stance that looks like this:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
</file_rule>
</pre>

Edit edit to make it looks like the following:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
<exclude>/cdd_tests$</exclude>
</file_rule>
</pre>

Problem: ''''I have written or extracted a test case. How can I execute it?''''
* All tests are executed in the background right after compiling automatically. You can choose to enable or disable background testing via the ''''Enable/Disable automatic background execution of tests''''.

[[Image:enable_testing.png|center]]

Problem: ''''The environment is unstable when using the .Net backend.''''
Solution: CDD does currently not support the .Net backend. Please use the C backend.

Problem: ''''How to disable the CDD extension in EiffelStudio''''
Solution: Make sure the push-buttons for Extraction and Execution are not pressed. The buttons are shown in the below picture.
[[Image:enable_exec_and_extract.png|center]]

Problem: ''''My extracted test cases get overwritten in the SVN Repository, because my colleagues commit their extracted test cases which have the same name.''''
* Solution: Define a new environment variable "CDD_TESTER_ID". The value of the variable will be used as suffix for all extracted test class names. So if all members of the project define a unique "CDD_TESTER_ID", the individually extracted test cases can be commited to the svn without collisions.
* ATTENTION: The value of CDD_TESTER_ID has to conform to a valid Eiffel class name, e.g. it has to consist of (uppercase) letters and '_' only!
* EXAMPLE: You define CDD_TESTER_ID and set it to value "MARKUS". Each time a new test case gets exracted for a class ROOT_CLASS, the generated class name for the test case will be CDD_TEST_ROOT_CLASS_xyz_MARKUS. Likewise it will get stored in a file called cdd_test_root_class_xyz_markus.e

CDD Common Problems

2008-04-10T12:58:29Z

Aleitner:

[[Category:CDD]]

Problem: ''''My test cases time out''''
* CDD automatically aborts test cases that run longer than a given period of time. The default value (which is a few seconds) can be changed by setting the environment variable ''''CDD_TESTER_TIMEOUT''''. On Linux ''''"export CDD_TESTER_TIMEOUT=120"'''' sets the timeout to 120 seconds. On Windows the same thing is acomplished with ''''"set CDD_TESTER_TIMEOUT=120"''''.

Problem: ''''Installing EiffelStudio reports error codes like '2908' and '2909' ''''
* This seems to be a rare problem. The following might help
<quote>
<<
I finally found the solution. Have a look at the following URLs:
- http://tinyurl.com/2rj93p
- http://tinyurl.com/3ey6fe

I believe you should have the same issue. In my case, I think it is because
I
had just installed the .NET 3.0 runtime which is part of the Windows Update.

If you rename the `Components' registry key, assuming that like me you only
have one child key, the installation should progress fine.
>>

This often happens when uninstalling and then reinstalling EiffelStudio
although it is clearly not a bug in our installer.

</quote>

Problem: ''''I cannot see the testing window.''''
* Make it visible via ''''View -> Tools -> CDD Output''''

Problem: ''''Is there some kind of CDD log window?''''
* Yes there is it is called ''''CDD Output''''. If you don't see this window, you can make it visible via ''''"View -> Tools -> CDD Output"''''

Problem: ''''I am getting a duplicate class error'''' or ''''I am trying to use CDD on an existing project but it doesn't work''''
* If you have a look at the ''''CDD output'''' window you will probably find the error message:

<pre>
Error code: VSCN
Configuration error: cluster has two classes with the same name.
What to do: if both classes are needed, change name of one of them.

Cluster name: erl_g_tests
First class: CDD_INTERPRETER
First file: "/home/aleitner/src/erl_g/src/erl_g/cdd_tests/erl_g/cdd_interpreter.e"
Second class: CDD_INTERPRETER
Second file: "/home/aleitner/src/erl_g/library/cdd_tests/erl_g_library/cdd_interpreter.e"
</pre>

To fix this go to the project settings, to your active target, '''Groups -> Clusters''' and then select your root cluster. Open the '''Advanced''' tree-item and click on the value part of the '''Exclude Rules'''. Now add rule ''''/cdd_tests$'''' and click ''''OK''''.

Alternatively you can open your ecf file with a text editor. You will find a stance that looks like this:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
</file_rule>
</pre>

Edit edit to make it looks like the following:

<pre>
<file_rule>
<exclude>/.svn$</exclude>
<exclude>/EIFGENs$</exclude>
<exclude>/cdd_tests$</exclude>
</file_rule>
</pre>

Problem: ''''I have written or extracted a test case. How can I execute it?''''
* All tests are executed in the background right after compiling automatically. You can choose to enable or disable background testing via the ''''Enable/Disable automatic background execution of tests''''.

[[Image:enable_testing.png|center]]

Problem: ''''The environment is unstable when using the .Net backend.''''
Solution: CDD does currently not support the .Net backend. Please use the C backend.

Problem: ''''How to disable the CDD extension in EiffelStudio''''
Solution: Make sure the push-buttons for Extraction and Execution are not pressed. The buttons are shown in the below picture.
[[Image:enable_exec_and_extract.png|center]]

Problem: ''''My extracted test cases get overwritten in the SVN Repository, because my colleagues commit their extracted test cases which have the same name.''''
* Solution: Define a new environment variable "CDD_TESTER_ID". The value of the variable will be used as suffix for all extracted test class names. So if all members of the project define a unique "CDD_TESTER_ID", the individually extracted test cases can be commited to the svn without collisions.
* ATTENTION: The value of CDD_TESTER_ID has to conform to a valid Eiffel class name, e.g. it has to consist of (uppercase) letters and '_' only!
* EXAMPLE: You define CDD_TESTER_ID and set it to value "MARKUS". Each time a new test case gets exracted for a class ROOT_CLASS, the generated class name for the test case will be CDD_TEST_ROOT_CLASS_xyz_MARKUS. Likewise it will get stored in a file called cdd_test_root_class_xyz_markus.e

CddBranch

2008-04-08T13:26:39Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
8.April.2008: CDD EiffelStudio final 7 available
* Important bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-08T12:22:18Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==
8.April.2008: CDD EiffelStudio final 7 available
* Important Bug fix: EiffelStudio no longer freezes when opening projects with many test cases

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 or Final 6 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_7-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-07T16:47:22Z

Aleitner: /* Download CDD */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_7.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-07T16:32:30Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual Studio or the Windows SDK:
*** Visual Studio (up to Visual Studio 2005, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-07T16:31:53Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual C++ or the Windows SDK:
*** Visual C++ (up to 6.0, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler_6.1_and_older to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CDDHowtoRollARelease

2008-04-07T16:10:41Z

Aleitner: /* List of CDD specific files */

[[Category:CDD]]
== Update version number ==
* geant -b $EIFFEL_SRC/Src/scripts/build.eant set_ec_version
* geant -b $EIFFEL_SRC/Src/scripts/build.eant set_esbuilder_version

== List of CDD specific files ==
The following files have to be overwritten or added to a stock EiffelStudio release:
* ec(.exe) -> $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/bin
* Src/library/base/ise/support/cdd -> $ISE_EIFFEL/library/base/ise/support/cdd
* Src/examples/cdd -> $ISE_EIFFEL/examples/cdd
* Delivery/studio/help/defaults -> $ISE_EIFFEL/studio/help/defaults
* Delivery/studio/bitmaps/png/16x16.png -> $ISE_EIFFEL/studio/bitmaps/png/16x16.png
* Delivery/studio/bitmaps/png/splash_shadow.png -> $ISE_EIFFEL/studio/bitmaps/png/splash_shadow.png
* Delivery/studio/bitmaps/png/splash.png -> $ISE_EIFFEL/studio/bitmaps/png/splash.png
* [For Windows Only] estudio.exe -> $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/bin
RUNTIME patch
* eif_except.h, eif_types.h: Src/C/run-time -> $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/include/
* Windows: finalized.lib, mtfinalized.lib, mtwkbench.lib, wkbench.lib: Src/C/run-time/LIB -> $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/lib(/msc)/
* Linux: libfinalized.a, libmtfinalized.a, libmtwkbench.a, libwkbench.a: Src/C/run-time/ -> $ISE_EIFFEL/studio/spec/$ISE_PLATFORM/lib/
(NOTE: the libs mentioned above can be build with the geant script, geant -b %EIFFEL_SRC%/build.eant prepare)

== How to roll a release on Windows ==
* prepare some directory <INSTALL_DIR> like this:
** create 3 subdirectories <INSTALL_DIR>/EiffelStudio, <INSTALL_DIR>/gcc, <INSTALL_DIR>/releases. Fill them according to the following description
*** [<INSTALL_DIR>/EiffelStudio] has to contain a complete delivery without the ec.exe binaries. Without a working delivery script, this can be achieved by "patching" an official installation:
**** copy the contents of the installation directory of a fresh offcial installation into <INSTALL_DIR>/EiffelStudio (fresh = NO EIFGENs produced. To be sure, uninstall the official version if alrady existing, manually delete the remains in the installation directory, and reinstall it WITHOUT building any precompilations)
**** Remove the ec.exe from <INSTALL_DIR>/EiffelStudio/studio/spec/windows/bin
**** Replace/Add the cdd specific files (see list above). Watch out for the proper place to add/replace them (the above list is svn-specific)
*** [<INSTALL_DIR>/gcc] needs to contain content of <svn-eiffel-branch>/free_add_ons/gcc
*** [<INSTALL_DIR>/releases] needs to contain the ec.exe binaries (the cdd versions of course)
**** <INSTALL_DIR>/releases/gpl_version/ needs to contain ec.exe
**** <INSTALL_DIR>/releases/enterprise_version/ needs to contain ec.exe (take the same ec.exe, it's a dummy for using the scripts later on)

* let env variable %INSTALL_DIR% point to the <INSTALL_DIR>
* let env variable %INIT_DIR% point to the <svn-eiffel-branch>/Delivery/scripts/windows folder
* finalize the "hallow" tool (<svn-eiffel-branch>/Src/tools/hallow/hallow.ecf)
* create if not exists directory %INIT_DIR%/install/bin
* copy content of <svn-eiffel-branch>/Src/tools/hallow/EIFGENs/hallow/F_code to INIT_DIR/install/bin
* create if not exists directory %INIT_DIR%/install/binaries/x86
* get a proper setup.dll (from manus probably, or build yourself, instructions for this will be added soon) and put it into %INIT_DIR%/install/binaries/x86/
* start command line, go to %INIT_DIR%/install/content/eiffelstudio and run:
** nmake /nologo clean
** nmake /nologo
** nmake /nologo gpl_x86
* wait some minutes .... and pray :-)

CddBranch

2008-04-07T16:03:00Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Which C compiler to install?
** Use the Microsoft C compiler either from Visual C++ or the Windows SDK:
*** Visual C++ (up to 8.0, but no later, and only the non-express version)
*** Windows SDK (up to version 6.0, but no later)
** Do not use the gcc/mingw.
** Do not use the .NET compiler backend.

Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler to learn how to install either Visual C++ or the Windows SDK for use with EiffelStudio.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-07T13:43:29Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://dev.eiffel.com/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddMeeting 13 02 2008

2008-04-07T13:42:08Z

Aleitner: /* Stefan */

[[Category:CDD]]
=CDD Meeting, Wednesday, 14.02.2008, 10:00=

== Next Meeting ==
* 15.02.2008; 14:15

== Tasks ==

===Andreas===
* Forumulate Experiment Hypothesis (Andreas)
* Fix AutoTest for courses
** New release
* Write documentation and videos tutorials (together with final release)
* Finish tuple_002 test case
* [delayed] Retest if test cases with errors are properly ignored (after 6.1 port)
* [done] Add timeout judgement
* Build releasable delivery for Linux (after each Beta I guess...)

===Arno===

====Bug Fixing====
* [ON WINDOWS NO CRASH OCCURS] Check why EiffelStudio quits after debugging a test routine and ignoring violations (ask Jocelyn)

===Ilinca===

* Integrate variable declarations into AutoTest trunk (by 8.2.2008)

===Stefan===
* [RECURRENT] Build releasable delivery on Windows
* [RECURRENT, currently valid]Check log for XML validity

* Opening Geneaology solution makes CDD ES freeze.
* FG Debugging Crash
** Wenn ich im CDD Eiffel den Debug the selected test case button drücke und dann während dem debuggen eine assertion violation auftritt, crasht das ganze Eiffel Studio. Das ist mit der CDD Version die ich am Samstag frisch vom SVN server gebaut habe.
* When detecting if compilation succeeded, inlude "corrupted" as keyword when parsing output message (as in the "project corrupted. cannot continue message)

* Make newly extracted test cases show up "expanded" in GUI treeview
* Only execute unresolved test cases once. Disable them afterwards. (Needs discussion)
* Make general encoding/decoding routines for special feature names
** e.g. infix "+" (ES) <=> infix_plus (CDD)
* Cache debug values when extracting several test cases.
* Allow for test case extraction of passing routine invocations (with Jocelyn)
* Rebuilding manual test suite through extraction and synthesizing
* Find performance bottleneck of test case extraction and propose extraction method for second chance
* [LOW PRIORITY since inv prob solved] When runtime of interpreter is severly damaged a popup box shows up on Windows. Popup can be ignored and goes away. This popup does not come up when we shoot down interpreter, but when a faulty instruction is executed. (E.g. the inv bug can trigger this dialog)
* [LOW PRIORITY since unlikely situation] Test cases with a 'False' (not satisfieable) invariant makes interpreter hang and ES crash. Add test case and fix it.

====Bugs/Things to look at====

* For big projects (like ES itself) background compilation of the interpreter leads to completely unresponsive ES
* [NO EASY SOLUTION POSSIBLE] Crash upon closing of EiffelStudio (feature call on void target in breakpoint tool)

===Manu===
* Install CDD in student labs (Manu)
* Devise questionnaires
** Initial (due next meeting after Manu's vacation)
** Midterm
** Final
* Analyze questionnaires
* Rework example profiles
* Assis will use CDD to get a feel for it and create a test suite for the students to start with

=== Bernd ===
* Define Project for SoftEng
** Find test suite for us to test students code
** Find project with pure functional part

===Unassigned===

====Beta Tester Feedback====
(Please put your name so we can get back to you in the case of questions)
* (Jocelyn) It should be possible to set the location of the cdd_tests directory (what if location of .ecf file is not readable?) [delayed]
** home directory? application_data directory? [Jocelyn]
* (Jocelyn) There should be UI support for deletion of Test Case [difficult for test routines, possible for classes. documentation added.]
* (Jocelyn) [BUG] the manual test case creation dialog should check if class with chosen name is already in the system [delayed]
* (Jocelyn) It would be nice if there was a way to configure the timeout for the interpreter [Stefan will ask Jocelyn for concrete example]

== Questionnaires ==

* Use ELBA

== Software Engineering Project ==

* Task 1: Implement VCard API
* Task 2: Implement Mime API
* Task 3: Write test cases to reveal faults in foreign VCard implementations
* Task 4: Write test cases to reveal faults in foreign Mime implementations

* Group A:
** Task 1, Manual Tests
** Task 2, Extracted Tests
** Task 3, Manual Tests
** Task 4, Extracted Tests
* Group B:
** Task 1, Extracted Tests
** Task 2, Manual Tests
** Task 3, Extracted Tests
** Task 4, Manual Tests

* One large project, but divided into testable subcomponents
* Students required to write test cases
* Fixed API to make things uniformly testable
* Public/Secret test cases (similar to Zeller course)
* Competitions:
** Group A test cases applied to Group A project
** Group A test cases applied to Groupt B project

* Idea how to cancel out bias while allowing fair grading:
** Subtasks 1 and 2, Students divided into groups A and B
** First both groups do 1, A is allowed to use tool, B not
** Then both groups do 2, B is allowed to use tool, A not
** Bias cancelation:
*** Project complexity
*** Experience of students
*** Experience gained in first subtask, when developing second
*** Risk: One task might be better suited for the tool than the other

== Data to harvest ==
* IDE Time with CDD(extraction) enabled / IDE Time with CDD(extraction) disabled
* Test Case Source (just final version, or all versions?)
** Use Profiler to get coverage approximation
* TC Meta Data (with timestamps -> Evolution of Test Case)
** TC Added/Removed/Changed
** TC Outcome (transitions from FAIL/PASS/UNRESOLVED[bad_communication <-> does_not_compile <-> bad_input])
** TC execution time
** Modificiations to a testcase (compiler needs to recompile)
* Development Session Data
** IDE Startup
** File save
* Questionnairs
** Initial
** Final

== Logging ==

* "Meta" log entries
** Project opened (easy)
** CDD enable/disable (easy)
** general EiffelStudio action log entries for Developer Behaviour (harder... what do we need??)

* CDD actions log entries
** Compilation of interpreter (start, end, duration)
** Execution of test cases (start, end, do we need individual duration of each test cases that gets executed?)
** Extraction of new test case (extraction time)

* Test Suite Status
** Test suite: after each refresh log list of all test cases (class level, needed because it's not possible to know when manual test cases get added...)
** Test class: (do we need info on this level)
** Test routine: status (basically as you see it in the tool)

==Experiment Hypotheses==

===Comparisons===

{| class="wikitable"
|-
!
! contracts
! man. tests
! playing
! extr.
! synth.
|-
|
| A
| B
| A B
|
|
|-
|
| A B
|
| A
| B
|
|-
|
| A B
| A
|
|
|
|-
| experiment
| A B
| A
| A B
| A
|
|-
|
|
| A
| B
|
|
|-
|
|
| A
|
| B
|
|-
|
| A B
|
|
| A
| B
|-
|
|
|
|
| A
| B
|-
| ISSTA
| A B
| A
|
|
| B
|-
|
|
| A
|
|
| B
|}

===How reliably can we extract test cases that reproduce the original failure?===
* Log original exception and exception received from first test execution

===Are the extracted tests useful for debugging?===
* Ask developers, using CDD

===What is the (time and memory) overhead of enabling extraction?===

===What is the size of the extracted test cases?===

===Are we able to reproduce bugs from industry?===
Take bug repository (say EiffelStudio, Gobo, eposix, ...). Use buggy version, try to reproduce bug, see if extracted test case is good.

===Does it make a difference in the quality of the code, whether one tests manually or extracts them?===
* Compare projects using extracted tests and manual tests to ref test suite

===Do contracts replace traditional testing oracles?===
* Original API without contracts
* Run failing test cases (the ones we get from second part) with reference API with contracts
* How many times does the contract replace the testing oracle?

CddMeeting 13 02 2008

2008-04-07T11:39:26Z

Aleitner: /* Stefan */

[[Category:CDD]]
=CDD Meeting, Wednesday, 14.02.2008, 10:00=

== Next Meeting ==
* 15.02.2008; 14:15

== Tasks ==

===Andreas===
* Forumulate Experiment Hypothesis (Andreas)
* Fix AutoTest for courses
** New release
* Write documentation and videos tutorials (together with final release)
* Finish tuple_002 test case
* [delayed] Retest if test cases with errors are properly ignored (after 6.1 port)
* [done] Add timeout judgement
* Build releasable delivery for Linux (after each Beta I guess...)

===Arno===

====Bug Fixing====
* [ON WINDOWS NO CRASH OCCURS] Check why EiffelStudio quits after debugging a test routine and ignoring violations (ask Jocelyn)

===Ilinca===

* Integrate variable declarations into AutoTest trunk (by 8.2.2008)

===Stefan===
* [RECURRENT] Build releasable delivery on Windows
* [RECURRENT, currently valid]Check log for XML validity

* FG Debugging Crash
** Wenn ich im CDD Eiffel den Debug the selected test case button drücke und dann während dem debuggen eine assertion violation auftritt, crasht das ganze Eiffel Studio. Das ist mit der CDD Version die ich am Samstag frisch vom SVN server gebaut habe.
* When detecting if compilation succeeded, inlude "corrupted" as keyword when parsing output message (as in the "project corrupted. cannot continue message)

* Make newly extracted test cases show up "expanded" in GUI treeview
* Only execute unresolved test cases once. Disable them afterwards. (Needs discussion)
* Make general encoding/decoding routines for special feature names
** e.g. infix "+" (ES) <=> infix_plus (CDD)
* Cache debug values when extracting several test cases.
* Allow for test case extraction of passing routine invocations (with Jocelyn)
* Rebuilding manual test suite through extraction and synthesizing
* Find performance bottleneck of test case extraction and propose extraction method for second chance
* [LOW PRIORITY since inv prob solved] When runtime of interpreter is severly damaged a popup box shows up on Windows. Popup can be ignored and goes away. This popup does not come up when we shoot down interpreter, but when a faulty instruction is executed. (E.g. the inv bug can trigger this dialog)
* [LOW PRIORITY since unlikely situation] Test cases with a 'False' (not satisfieable) invariant makes interpreter hang and ES crash. Add test case and fix it.

====Bugs/Things to look at====

* For big projects (like ES itself) background compilation of the interpreter leads to completely unresponsive ES
* [NO EASY SOLUTION POSSIBLE] Crash upon closing of EiffelStudio (feature call on void target in breakpoint tool)

===Manu===
* Install CDD in student labs (Manu)
* Devise questionnaires
** Initial (due next meeting after Manu's vacation)
** Midterm
** Final
* Analyze questionnaires
* Rework example profiles
* Assis will use CDD to get a feel for it and create a test suite for the students to start with

=== Bernd ===
* Define Project for SoftEng
** Find test suite for us to test students code
** Find project with pure functional part

===Unassigned===

====Beta Tester Feedback====
(Please put your name so we can get back to you in the case of questions)
* (Jocelyn) It should be possible to set the location of the cdd_tests directory (what if location of .ecf file is not readable?) [delayed]
** home directory? application_data directory? [Jocelyn]
* (Jocelyn) There should be UI support for deletion of Test Case [difficult for test routines, possible for classes. documentation added.]
* (Jocelyn) [BUG] the manual test case creation dialog should check if class with chosen name is already in the system [delayed]
* (Jocelyn) It would be nice if there was a way to configure the timeout for the interpreter [Stefan will ask Jocelyn for concrete example]

== Questionnaires ==

* Use ELBA

== Software Engineering Project ==

* Task 1: Implement VCard API
* Task 2: Implement Mime API
* Task 3: Write test cases to reveal faults in foreign VCard implementations
* Task 4: Write test cases to reveal faults in foreign Mime implementations

* Group A:
** Task 1, Manual Tests
** Task 2, Extracted Tests
** Task 3, Manual Tests
** Task 4, Extracted Tests
* Group B:
** Task 1, Extracted Tests
** Task 2, Manual Tests
** Task 3, Extracted Tests
** Task 4, Manual Tests

* One large project, but divided into testable subcomponents
* Students required to write test cases
* Fixed API to make things uniformly testable
* Public/Secret test cases (similar to Zeller course)
* Competitions:
** Group A test cases applied to Group A project
** Group A test cases applied to Groupt B project

* Idea how to cancel out bias while allowing fair grading:
** Subtasks 1 and 2, Students divided into groups A and B
** First both groups do 1, A is allowed to use tool, B not
** Then both groups do 2, B is allowed to use tool, A not
** Bias cancelation:
*** Project complexity
*** Experience of students
*** Experience gained in first subtask, when developing second
*** Risk: One task might be better suited for the tool than the other

== Data to harvest ==
* IDE Time with CDD(extraction) enabled / IDE Time with CDD(extraction) disabled
* Test Case Source (just final version, or all versions?)
** Use Profiler to get coverage approximation
* TC Meta Data (with timestamps -> Evolution of Test Case)
** TC Added/Removed/Changed
** TC Outcome (transitions from FAIL/PASS/UNRESOLVED[bad_communication <-> does_not_compile <-> bad_input])
** TC execution time
** Modificiations to a testcase (compiler needs to recompile)
* Development Session Data
** IDE Startup
** File save
* Questionnairs
** Initial
** Final

== Logging ==

* "Meta" log entries
** Project opened (easy)
** CDD enable/disable (easy)
** general EiffelStudio action log entries for Developer Behaviour (harder... what do we need??)

* CDD actions log entries
** Compilation of interpreter (start, end, duration)
** Execution of test cases (start, end, do we need individual duration of each test cases that gets executed?)
** Extraction of new test case (extraction time)

* Test Suite Status
** Test suite: after each refresh log list of all test cases (class level, needed because it's not possible to know when manual test cases get added...)
** Test class: (do we need info on this level)
** Test routine: status (basically as you see it in the tool)

==Experiment Hypotheses==

===Comparisons===

{| class="wikitable"
|-
!
! contracts
! man. tests
! playing
! extr.
! synth.
|-
|
| A
| B
| A B
|
|
|-
|
| A B
|
| A
| B
|
|-
|
| A B
| A
|
|
|
|-
| experiment
| A B
| A
| A B
| A
|
|-
|
|
| A
| B
|
|
|-
|
|
| A
|
| B
|
|-
|
| A B
|
|
| A
| B
|-
|
|
|
|
| A
| B
|-
| ISSTA
| A B
| A
|
|
| B
|-
|
|
| A
|
|
| B
|}

===How reliably can we extract test cases that reproduce the original failure?===
* Log original exception and exception received from first test execution

===Are the extracted tests useful for debugging?===
* Ask developers, using CDD

===What is the (time and memory) overhead of enabling extraction?===

===What is the size of the extracted test cases?===

===Are we able to reproduce bugs from industry?===
Take bug repository (say EiffelStudio, Gobo, eposix, ...). Use buggy version, try to reproduce bug, see if extracted test case is good.

===Does it make a difference in the quality of the code, whether one tests manually or extracts them?===
* Compare projects using extracted tests and manual tests to ref test suite

===Do contracts replace traditional testing oracles?===
* Original API without contracts
* Run failing test cases (the ones we get from second part) with reference API with contracts
* How many times does the contract replace the testing oracle?

CddMeeting 13 02 2008

2008-04-07T11:39:02Z

Aleitner: /* Stefan */

[[Category:CDD]]
=CDD Meeting, Wednesday, 14.02.2008, 10:00=

== Next Meeting ==
* 15.02.2008; 14:15

== Tasks ==

===Andreas===
* Forumulate Experiment Hypothesis (Andreas)
* Fix AutoTest for courses
** New release
* Write documentation and videos tutorials (together with final release)
* Finish tuple_002 test case
* [delayed] Retest if test cases with errors are properly ignored (after 6.1 port)
* [done] Add timeout judgement
* Build releasable delivery for Linux (after each Beta I guess...)

===Arno===

====Bug Fixing====
* [ON WINDOWS NO CRASH OCCURS] Check why EiffelStudio quits after debugging a test routine and ignoring violations (ask Jocelyn)

===Ilinca===

* Integrate variable declarations into AutoTest trunk (by 8.2.2008)

===Stefan===
* [RECURRENT] Build releasable delivery on Windows
* [RECURRENT, currently valid]Check log for XML validity

* FG Debugging Crash
** Wenn ich im CDD Eiffel den Debug the selected test case button drücke
und dann während dem debuggen eine assertion violation auftritt, crasht
das ganze Eiffel Studio. Das ist mit der CDD Version die ich am Samstag
frisch vom SVN server gebaut habe.
* When detecting if compilation succeeded, inlude "corrupted" as keyword when parsing output message (as in the "project corrupted. cannot continue message)

* Make newly extracted test cases show up "expanded" in GUI treeview
* Only execute unresolved test cases once. Disable them afterwards. (Needs discussion)
* Make general encoding/decoding routines for special feature names
** e.g. infix "+" (ES) <=> infix_plus (CDD)
* Cache debug values when extracting several test cases.
* Allow for test case extraction of passing routine invocations (with Jocelyn)
* Rebuilding manual test suite through extraction and synthesizing
* Find performance bottleneck of test case extraction and propose extraction method for second chance
* [LOW PRIORITY since inv prob solved] When runtime of interpreter is severly damaged a popup box shows up on Windows. Popup can be ignored and goes away. This popup does not come up when we shoot down interpreter, but when a faulty instruction is executed. (E.g. the inv bug can trigger this dialog)
* [LOW PRIORITY since unlikely situation] Test cases with a 'False' (not satisfieable) invariant makes interpreter hang and ES crash. Add test case and fix it.

====Bugs/Things to look at====

* For big projects (like ES itself) background compilation of the interpreter leads to completely unresponsive ES
* [NO EASY SOLUTION POSSIBLE] Crash upon closing of EiffelStudio (feature call on void target in breakpoint tool)

===Manu===
* Install CDD in student labs (Manu)
* Devise questionnaires
** Initial (due next meeting after Manu's vacation)
** Midterm
** Final
* Analyze questionnaires
* Rework example profiles
* Assis will use CDD to get a feel for it and create a test suite for the students to start with

=== Bernd ===
* Define Project for SoftEng
** Find test suite for us to test students code
** Find project with pure functional part

===Unassigned===

====Beta Tester Feedback====
(Please put your name so we can get back to you in the case of questions)
* (Jocelyn) It should be possible to set the location of the cdd_tests directory (what if location of .ecf file is not readable?) [delayed]
** home directory? application_data directory? [Jocelyn]
* (Jocelyn) There should be UI support for deletion of Test Case [difficult for test routines, possible for classes. documentation added.]
* (Jocelyn) [BUG] the manual test case creation dialog should check if class with chosen name is already in the system [delayed]
* (Jocelyn) It would be nice if there was a way to configure the timeout for the interpreter [Stefan will ask Jocelyn for concrete example]

== Questionnaires ==

* Use ELBA

== Software Engineering Project ==

* Task 1: Implement VCard API
* Task 2: Implement Mime API
* Task 3: Write test cases to reveal faults in foreign VCard implementations
* Task 4: Write test cases to reveal faults in foreign Mime implementations

* Group A:
** Task 1, Manual Tests
** Task 2, Extracted Tests
** Task 3, Manual Tests
** Task 4, Extracted Tests
* Group B:
** Task 1, Extracted Tests
** Task 2, Manual Tests
** Task 3, Extracted Tests
** Task 4, Manual Tests

* One large project, but divided into testable subcomponents
* Students required to write test cases
* Fixed API to make things uniformly testable
* Public/Secret test cases (similar to Zeller course)
* Competitions:
** Group A test cases applied to Group A project
** Group A test cases applied to Groupt B project

* Idea how to cancel out bias while allowing fair grading:
** Subtasks 1 and 2, Students divided into groups A and B
** First both groups do 1, A is allowed to use tool, B not
** Then both groups do 2, B is allowed to use tool, A not
** Bias cancelation:
*** Project complexity
*** Experience of students
*** Experience gained in first subtask, when developing second
*** Risk: One task might be better suited for the tool than the other

== Data to harvest ==
* IDE Time with CDD(extraction) enabled / IDE Time with CDD(extraction) disabled
* Test Case Source (just final version, or all versions?)
** Use Profiler to get coverage approximation
* TC Meta Data (with timestamps -> Evolution of Test Case)
** TC Added/Removed/Changed
** TC Outcome (transitions from FAIL/PASS/UNRESOLVED[bad_communication <-> does_not_compile <-> bad_input])
** TC execution time
** Modificiations to a testcase (compiler needs to recompile)
* Development Session Data
** IDE Startup
** File save
* Questionnairs
** Initial
** Final

== Logging ==

* "Meta" log entries
** Project opened (easy)
** CDD enable/disable (easy)
** general EiffelStudio action log entries for Developer Behaviour (harder... what do we need??)

* CDD actions log entries
** Compilation of interpreter (start, end, duration)
** Execution of test cases (start, end, do we need individual duration of each test cases that gets executed?)
** Extraction of new test case (extraction time)

* Test Suite Status
** Test suite: after each refresh log list of all test cases (class level, needed because it's not possible to know when manual test cases get added...)
** Test class: (do we need info on this level)
** Test routine: status (basically as you see it in the tool)

==Experiment Hypotheses==

===Comparisons===

{| class="wikitable"
|-
!
! contracts
! man. tests
! playing
! extr.
! synth.
|-
|
| A
| B
| A B
|
|
|-
|
| A B
|
| A
| B
|
|-
|
| A B
| A
|
|
|
|-
| experiment
| A B
| A
| A B
| A
|
|-
|
|
| A
| B
|
|
|-
|
|
| A
|
| B
|
|-
|
| A B
|
|
| A
| B
|-
|
|
|
|
| A
| B
|-
| ISSTA
| A B
| A
|
|
| B
|-
|
|
| A
|
|
| B
|}

===How reliably can we extract test cases that reproduce the original failure?===
* Log original exception and exception received from first test execution

===Are the extracted tests useful for debugging?===
* Ask developers, using CDD

===What is the (time and memory) overhead of enabling extraction?===

===What is the size of the extracted test cases?===

===Are we able to reproduce bugs from industry?===
Take bug repository (say EiffelStudio, Gobo, eposix, ...). Use buggy version, try to reproduce bug, see if extracted test case is good.

===Does it make a difference in the quality of the code, whether one tests manually or extracts them?===
* Compare projects using extracted tests and manual tests to ref test suite

===Do contracts replace traditional testing oracles?===
* Original API without contracts
* Run failing test cases (the ones we get from second part) with reference API with contracts
* How many times does the contract replace the testing oracle?

CddBranch

2008-04-04T11:16:21Z

Aleitner: /* Create new manual test class */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

Redefine routine `set_up' or `tear_down' if you want something to be executed before resp. after every test routine of a class.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T09:32:06Z

Aleitner: /* Linux */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are '''upgrading''' from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T09:31:57Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are upgrading from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are '''upgrading''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T09:31:48Z

Aleitner: /* Windows */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are upgrading from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are ''''upgrading'''' from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T09:31:17Z

Aleitner: /* Download CDD */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html
Notes:
* If you are upgrading from a previous version, make sure you delete the old version first (rm -rf)

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
Notes:
* Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* If you are upgrading from a previous version, you first have to uninstall the old version then delete the existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/) and then install the new version.
* Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:12:05Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
* Less mess: Redundant or duplicate test cases are no longer extracted
* Smoother upgrade: Cleaning a project will automatically clean the test suite
* Fixed bug in invarant checking
* Fixed bug that caused EiffelStudio to freeze in some situations
* Improved logging
* Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:11:53Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

2.April.2008: CDD EiffelStudio Final 6 available
** Less mess: Redundant or duplicate test cases are no longer extracted
** Smoother upgrade: Cleaning a project will automatically clean the test suite
** Fixed bug in invarant checking
** Fixed bug that caused EiffelStudio to freeze in some situations
** Improved logging
** Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:11:38Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

==== 2.April.2008: CDD EiffelStudio Final 6 available ====
** Less mess: Redundant or duplicate test cases are no longer extracted
** Smoother upgrade: Cleaning a project will automatically clean the test suite
** Fixed bug in invarant checking
** Fixed bug that caused EiffelStudio to freeze in some situations
** Improved logging
** Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:11:29Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

=== 2.April.2008: CDD EiffelStudio Final 6 available ===
** Less mess: Redundant or duplicate test cases are no longer extracted
** Smoother upgrade: Cleaning a project will automatically clean the test suite
** Fixed bug in invarant checking
** Fixed bug that caused EiffelStudio to freeze in some situations
** Improved logging
** Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:11:17Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

* 2.April.2008: CDD EiffelStudio Final 6 available
** Less mess: Redundant or duplicate test cases are no longer extracted
** Smoother upgrade: Cleaning a project will automatically clean the test suite
** Fixed bug in invarant checking
** Fixed bug that caused EiffelStudio to freeze in some situations
** Improved logging
** Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:02:56Z

Aleitner: /* News */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

* CDD EiffelStudio Final 6 available
** Less mess: Redundant or duplicate test cases are no longer extracted
** Smoother upgrade: Cleaning a project will automatically clean the test suite
** Fixed bug in invarant checking
** Fixed bug that caused EiffelStudio to freeze in some situations
** Improved logging
** Installer ''might'' work with mingw on Windows now. (Not yet tested, reports welcome)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-02T08:02:38Z

Aleitner: /* What is the CDD EiffelStudio? */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== News ==

* CDD EiffelStudio Final 6 available
** Less mess: Redundant or duplicate test cases are no longer extracted
** Smoother upgrade: Cleaning a project will automatically clean the test suite
** Fixed bug in invarant checking
** Fixed bug that caused EiffelStudio to freeze in some situations
** Improved logging
** Installer ''might'' work with mingw on Windows now. (Not yet tested)

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

==== Windows Patch ====

* Patch version for existing EiffelStudio CDD Edition Final 5 installation (does NOT work for official EiffelStudio 6.1 installation!): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_6-windows.zip
* Replace <INSTALL_DIRECTORY>/studio/spec/windows/bin/ec.exe with ec.exe contained in archive
* Delete existing precompilations (= delete EIFGENs in subdirectories of <INSTALL_DIRECTORY>/precomp/spec/windows/)
* Recompile existing projects from scratch (use the "clean" option in the project load screen)

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-04-01T17:31:47Z

Aleitner: /* Linux */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_6.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddMeeting 13 02 2008

2008-03-26T15:30:25Z

Aleitner: /* Stefan */

[[Category:CDD]]
=CDD Meeting, Wednesday, 14.02.2008, 10:00=

== Next Meeting ==
* 15.02.2008; 14:15

== Tasks ==

===Andreas===
* Forumulate Experiment Hypothesis (Andreas)
* Fix AutoTest for courses
** New release
* Write documentation and videos tutorials (together with final release)
* Finish tuple_002 test case
* [delayed] Retest if test cases with errors are properly ignored (after 6.1 port)
* [done] Add timeout judgement
* Build releasable delivery for Linux (after each Beta I guess...)

===Arno===

====Bug Fixing====
* [ON WINDOWS NO CRASH OCCURS] Check why EiffelStudio quits after debugging a test routine and ignoring violations (ask Jocelyn)

===Ilinca===

* Integrate variable declarations into AutoTest trunk (by 8.2.2008)

===Stefan===
* [RECURRENT] Build releasable delivery on Windows
* [RECURRENT, currently valid]Check log for XML validity

* [DONE] Don't store test case if exactly the same one exists already.
* [DONE] Look at test case from Manu that doesn't compile (ARRAY is printed instead of ARRAY[STRING]
* [DONE] Add link to "common problems" website in context window for test cases that time out

* Invariant violations occurring before routine invocation make a test case fail. It should be invalid. How to reproduce: Launch bank account example with final 2. Implement `BANK_ACCOUNT.withdraw' correctly. Replace postcondition with "withdrawn: balance = old balance + an_amount". Launch app, try to withdraw 700. You will get a test case that fails. It should be invalid though.

* Inspect cannot read file problem that occured in lecture. I can reproduce it also on my Linux box now.
* When detecting if compilation succeeded, inlude "corrupted" as keyword when parsing output message (as in the "project corrupted. cannot continue message)
* Log:
** Playing around (duration and number of times)
** FG-test case execution (duration, number of times, exception thrown, which test case, outcome)
* Clean cdd target when main target is cleaned too.

* Make newly extracted test cases show up "expanded" in GUI treeview
* Only execute unresolved test cases once. Disable them afterwards. (Needs discussion)
* Make general encoding/decoding routines for special feature names
** e.g. infix "+" (ES) <=> infix_plus (CDD)
* Cache debug values when extracting several test cases.
* Allow for test case extraction of passing routine invocations (with Jocelyn)
* Rebuilding manual test suite through extraction and synthesizing
* Find performance bottleneck of test case extraction and propose extraction method for second chance
* [LOW PRIORITY since inv prob solved] When runtime of interpreter is severly damaged a popup box shows up on Windows. Popup can be ignored and goes away. This popup does not come up when we shoot down interpreter, but when a faulty instruction is executed. (E.g. the inv bug can trigger this dialog)
* [LOW PRIORITY since unlikely situation] Test cases with a 'False' (not satisfieable) invariant makes interpreter hang and ES crash. Add test case and fix it.

====Bugs/Things to look at====

* For big projects (like ES itself) background compilation of the interpreter leads to completely unresponsive ES
* [NO EASY SOLUTION POSSIBLE] Crash upon closing of EiffelStudio (feature call on void target in breakpoint tool)

===Manu===
* Install CDD in student labs (Manu)
* Devise questionnaires
** Initial (due next meeting after Manu's vacation)
** Midterm
** Final
* Analyze questionnaires
* Rework example profiles
* Assis will use CDD to get a feel for it and create a test suite for the students to start with

=== Bernd ===
* Define Project for SoftEng
** Find test suite for us to test students code
** Find project with pure functional part

===Unassigned===

====Beta Tester Feedback====
(Please put your name so we can get back to you in the case of questions)
* (Jocelyn) It should be possible to set the location of the cdd_tests directory (what if location of .ecf file is not readable?) [delayed]
** home directory? application_data directory? [Jocelyn]
* (Jocelyn) There should be UI support for deletion of Test Case [difficult for test routines, possible for classes. documentation added.]
* (Jocelyn) [BUG] the manual test case creation dialog should check if class with chosen name is already in the system [delayed]
* (Jocelyn) It would be nice if there was a way to configure the timeout for the interpreter [Stefan will ask Jocelyn for concrete example]

== Questionnaires ==

* Use ELBA

== Software Engineering Project ==

* Task 1: Implement VCard API
* Task 2: Implement Mime API
* Task 3: Write test cases to reveal faults in foreign VCard implementations
* Task 4: Write test cases to reveal faults in foreign Mime implementations

* Group A:
** Task 1, Manual Tests
** Task 2, Extracted Tests
** Task 3, Manual Tests
** Task 4, Extracted Tests
* Group B:
** Task 1, Extracted Tests
** Task 2, Manual Tests
** Task 3, Extracted Tests
** Task 4, Manual Tests

* One large project, but divided into testable subcomponents
* Students required to write test cases
* Fixed API to make things uniformly testable
* Public/Secret test cases (similar to Zeller course)
* Competitions:
** Group A test cases applied to Group A project
** Group A test cases applied to Groupt B project

* Idea how to cancel out bias while allowing fair grading:
** Subtasks 1 and 2, Students divided into groups A and B
** First both groups do 1, A is allowed to use tool, B not
** Then both groups do 2, B is allowed to use tool, A not
** Bias cancelation:
*** Project complexity
*** Experience of students
*** Experience gained in first subtask, when developing second
*** Risk: One task might be better suited for the tool than the other

== Data to harvest ==
* IDE Time with CDD(extraction) enabled / IDE Time with CDD(extraction) disabled
* Test Case Source (just final version, or all versions?)
** Use Profiler to get coverage approximation
* TC Meta Data (with timestamps -> Evolution of Test Case)
** TC Added/Removed/Changed
** TC Outcome (transitions from FAIL/PASS/UNRESOLVED[bad_communication <-> does_not_compile <-> bad_input])
** TC execution time
** Modificiations to a testcase (compiler needs to recompile)
* Development Session Data
** IDE Startup
** File save
* Questionnairs
** Initial
** Final

== Logging ==

* "Meta" log entries
** Project opened (easy)
** CDD enable/disable (easy)
** general EiffelStudio action log entries for Developer Behaviour (harder... what do we need??)

* CDD actions log entries
** Compilation of interpreter (start, end, duration)
** Execution of test cases (start, end, do we need individual duration of each test cases that gets executed?)
** Extraction of new test case (extraction time)

* Test Suite Status
** Test suite: after each refresh log list of all test cases (class level, needed because it's not possible to know when manual test cases get added...)
** Test class: (do we need info on this level)
** Test routine: status (basically as you see it in the tool)

==Experiment Hypotheses==

===Comparisons===

{| class="wikitable"
|-
!
! contracts
! man. tests
! playing
! extr.
! synth.
|-
|
| A
| B
| A B
|
|
|-
|
| A B
|
| A
| B
|
|-
|
| A B
| A
|
|
|
|-
| experiment
| A B
| A
| A B
| A
|
|-
|
|
| A
| B
|
|
|-
|
|
| A
|
| B
|
|-
|
| A B
|
|
| A
| B
|-
|
|
|
|
| A
| B
|-
| ISSTA
| A B
| A
|
|
| B
|-
|
|
| A
|
|
| B
|}

===How reliably can we extract test cases that reproduce the original failure?===
* Log original exception and exception received from first test execution

===Are the extracted tests useful for debugging?===
* Ask developers, using CDD

===What is the (time and memory) overhead of enabling extraction?===

===What is the size of the extracted test cases?===

===Are we able to reproduce bugs from industry?===
Take bug repository (say EiffelStudio, Gobo, eposix, ...). Use buggy version, try to reproduce bug, see if extracted test case is good.

===Does it make a difference in the quality of the code, whether one tests manually or extracts them?===
* Compare projects using extracted tests and manual tests to ref test suite

===Do contracts replace traditional testing oracles?===
* Original API without contracts
* Run failing test cases (the ones we get from second part) with reference API with contracts
* How many times does the contract replace the testing oracle?

CddBranch

2008-03-19T11:52:18Z

Aleitner: /* What is the CDD EiffelStudio? */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''Play CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-19T11:51:56Z

Aleitner: /* What is the CDD EiffelStudio? */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ '''CDD Video''', click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* '''Automatically extract test cases'''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-19T10:39:11Z

Aleitner: /* What is the CDD EiffelStudio? */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
<center>
[http://se.ethz.ch/people/leitner/cdd/video/ CDD Video, click here]
</center>
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-19T10:38:19Z

Aleitner: /* What is the CDD EiffelStudio? */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
[center]
[http://se.ethz.ch/people/leitner/cdd/video/ CDD Video, click here]
[/center]
CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-19T10:38:05Z

Aleitner: /* What is the CDD EiffelStudio? */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]
[http://se.ethz.ch/people/leitner/cdd/video/ CDD Video, click here]

CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled no test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

Update: To remove duplicate test cases (until the next cdd update), please use the command-line tool from the [http://clean-cdd.origo.ethz.ch/ clean-cdd project].

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddMeeting 13 02 2008

2008-03-19T08:38:19Z

Aleitner: /* Stefan */

[[Category:CDD]]
=CDD Meeting, Wednesday, 14.02.2008, 10:00=

== Next Meeting ==
* 15.02.2008; 14:15

== Tasks ==

===Andreas===
* Forumulate Experiment Hypothesis (Andreas)
* Fix AutoTest for courses
** New release
* Write documentation and videos tutorials (together with final release)
* Finish tuple_002 test case
* [delayed] Retest if test cases with errors are properly ignored (after 6.1 port)
* [done] Add timeout judgement
* Build releasable delivery for Linux (after each Beta I guess...)

===Arno===

====Bug Fixing====
* [ON WINDOWS NO CRASH OCCURS] Check why EiffelStudio quits after debugging a test routine and ignoring violations (ask Jocelyn)
* [DONE!] CDD Output Tool window display is not saved (on initial start after installation it is there. But after closing and reopening it is gone)

===Ilinca===

* Integrate variable declarations into AutoTest trunk (by 8.2.2008)

===Stefan===
* [RECURRENT] Build releasable delivery on Windows
* [RECURRENT, currently valid]Check log for XML validity

* Invariant violations occurring before routine invocation make a test case fail. It should be invalid. How to reproduce: Launch bank account example with final 2. Implement `BANK_ACCOUNT.withdraw' correctly. Replace postcondition with "withdrawn: balance = old balance + an_amount". Launch app, try to withdraw 700. You will get a test case that fails. It should be invalid though.

* Add link to "common problems" website in context window for test cases that time out
* Inspect cannot read file problem that occured in lecture. I can reproduce it also on my Linux box now.
* When detecting if compilation succeeded, inlude "corrupted" as keyword when parsing output message (as in the "project corrupted. cannot continue message)
* Don't store test case if exactly the same one exists already.
* Look at test case from Manu that doesn't compile (ARRAY is printed instead of ARRAY[STRING]
* Log:
** Playing around (duration and number of times)
** FG-test case execution (duration, number of times, exception thrown, which test case, outcome)

* Make newly extracted test cases show up "expanded" in GUI treeview
* Only execute unresolved test cases once. Disable them afterwards. (Needs discussion)
* Make general encoding/decoding routines for special feature names
** e.g. infix "+" (ES) <=> infix_plus (CDD)
* Cache debug values when extracting several test cases.
* Allow for test case extraction of passing routine invocations (with Jocelyn)
* Rebuilding manual test suite through extraction and synthesizing
* Find performance bottleneck of test case extraction and propose extraction method for second chance
* [LOW PRIORITY since inv prob solved] When runtime of interpreter is severly damaged a popup box shows up on Windows. Popup can be ignored and goes away. This popup does not come up when we shoot down interpreter, but when a faulty instruction is executed. (E.g. the inv bug can trigger this dialog)
* [LOW PRIORITY since unlikely situation] Test cases with a 'False' (not satisfieable) invariant makes interpreter hang and ES crash. Add test case and fix it.

====Bugs/Things to look at====

* For big projects (like ES itself) background compilation of the interpreter leads to completely unresponsive ES
* [NO EASY SOLUTION POSSIBLE] Crash upon closing of EiffelStudio (feature call on void target in breakpoint tool)

===Manu===
* Install CDD in student labs (Manu)
* Devise questionnaires
** Initial (due next meeting after Manu's vacation)
** Midterm
** Final
* Analyze questionnaires
* Rework example profiles
* Assis will use CDD to get a feel for it and create a test suite for the students to start with

=== Bernd ===
* Define Project for SoftEng
** Find test suite for us to test students code
** Find project with pure functional part

===Unassigned===

====Beta Tester Feedback====
(Please put your name so we can get back to you in the case of questions)
* (Jocelyn) It should be possible to set the location of the cdd_tests directory (what if location of .ecf file is not readable?) [delayed]
** home directory? application_data directory? [Jocelyn]
* (Jocelyn) There should be UI support for deletion of Test Case [difficult for test routines, possible for classes. documentation added.]
* (Jocelyn) [BUG] the manual test case creation dialog should check if class with chosen name is already in the system [delayed]
* (Jocelyn) It would be nice if there was a way to configure the timeout for the interpreter [Stefan will ask Jocelyn for concrete example]

== Questionnaires ==

* Use ELBA

== Software Engineering Project ==

* Task 1: Implement VCard API
* Task 2: Implement Mime API
* Task 3: Write test cases to reveal faults in foreign VCard implementations
* Task 4: Write test cases to reveal faults in foreign Mime implementations

* Group A:
** Task 1, Manual Tests
** Task 2, Extracted Tests
** Task 3, Manual Tests
** Task 4, Extracted Tests
* Group B:
** Task 1, Extracted Tests
** Task 2, Manual Tests
** Task 3, Extracted Tests
** Task 4, Manual Tests

* One large project, but divided into testable subcomponents
* Students required to write test cases
* Fixed API to make things uniformly testable
* Public/Secret test cases (similar to Zeller course)
* Competitions:
** Group A test cases applied to Group A project
** Group A test cases applied to Groupt B project

* Idea how to cancel out bias while allowing fair grading:
** Subtasks 1 and 2, Students divided into groups A and B
** First both groups do 1, A is allowed to use tool, B not
** Then both groups do 2, B is allowed to use tool, A not
** Bias cancelation:
*** Project complexity
*** Experience of students
*** Experience gained in first subtask, when developing second
*** Risk: One task might be better suited for the tool than the other

== Data to harvest ==
* IDE Time with CDD(extraction) enabled / IDE Time with CDD(extraction) disabled
* Test Case Source (just final version, or all versions?)
** Use Profiler to get coverage approximation
* TC Meta Data (with timestamps -> Evolution of Test Case)
** TC Added/Removed/Changed
** TC Outcome (transitions from FAIL/PASS/UNRESOLVED[bad_communication <-> does_not_compile <-> bad_input])
** TC execution time
** Modificiations to a testcase (compiler needs to recompile)
* Development Session Data
** IDE Startup
** File save
* Questionnairs
** Initial
** Final

== Logging ==

* "Meta" log entries
** Project opened (easy)
** CDD enable/disable (easy)
** general EiffelStudio action log entries for Developer Behaviour (harder... what do we need??)

* CDD actions log entries
** Compilation of interpreter (start, end, duration)
** Execution of test cases (start, end, do we need individual duration of each test cases that gets executed?)
** Extraction of new test case (extraction time)

* Test Suite Status
** Test suite: after each refresh log list of all test cases (class level, needed because it's not possible to know when manual test cases get added...)
** Test class: (do we need info on this level)
** Test routine: status (basically as you see it in the tool)

==Experiment Hypotheses==

===Comparisons===

{| class="wikitable"
|-
!
! contracts
! man. tests
! playing
! extr.
! synth.
|-
|
| A
| B
| A B
|
|
|-
|
| A B
|
| A
| B
|
|-
|
| A B
| A
|
|
|
|-
| experiment
| A B
| A
| A B
| A
|
|-
|
|
| A
| B
|
|
|-
|
|
| A
|
| B
|
|-
|
| A B
|
|
| A
| B
|-
|
|
|
|
| A
| B
|-
| ISSTA
| A B
| A
|
|
| B
|-
|
|
| A
|
|
| B
|}

===How reliably can we extract test cases that reproduce the original failure?===
* Log original exception and exception received from first test execution

===Are the extracted tests useful for debugging?===
* Ask developers, using CDD

===What is the (time and memory) overhead of enabling extraction?===

===What is the size of the extracted test cases?===

===Are we able to reproduce bugs from industry?===
Take bug repository (say EiffelStudio, Gobo, eposix, ...). Use buggy version, try to reproduce bug, see if extracted test case is good.

===Does it make a difference in the quality of the code, whether one tests manually or extracts them?===
* Compare projects using extracted tests and manual tests to ref test suite

===Do contracts replace traditional testing oracles?===
* Original API without contracts
* Run failing test cases (the ones we get from second part) with reference API with contracts
* How many times does the contract replace the testing oracle?

CddBranch

2008-03-18T16:33:20Z

Aleitner: /* Test outcomes */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]

CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled not test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-18T16:32:40Z

Aleitner: /* Create new manual test class */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]

CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons. Please see the CddBranch web page for details.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled not test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases. This is how a manually written test case can look like:

<eiffel>
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
test_deposit
local
ba: BANK_ACCOUNT
do
create ba.make_with_balance (0)
ba.deposit (100)
check
money_depisited: ba.balance = 100
end
end
end
</eiffel>

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-18T16:29:38Z

Aleitner: /* Change test case view */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]

CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons. Please see the CddBranch web page for details.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled not test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

Select one of several predefined test case views. For example you can group test cases by their outcome to quickly see only failing test cases.

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-18T16:29:00Z

Aleitner: /* Restrict execution of test cases */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]

CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons. Please see the CddBranch web page for details.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled not test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

Once you have many test cases, you will run into situation where you don't want to execute all of them. The restrict button will help you to achieve this. As long as the "Restrict" button is pushed test cases that don't show up in the test case view will not be tested. Execution is restricted to those test cases that do show up.

=== Change test case view ===

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]

CddBranch

2008-03-18T16:25:12Z

Aleitner: /* Search for tags */

[[Category:Testing]]
[[Category:EiffelDebugger]]
[[Category:CDD]]

== What is the CDD EiffelStudio? ==

[[Image:cdd_logo.png|center]]

CDD (short for Contract Driven Development) is a project developed at [http://se.ethz.ch ETH Zurich]. It adds advanced support for unit testing to EiffelStudio. With CDD EiffelStudio you can

* Write test cases
* Manage test cases (using tags)
* Run test cases
* View test outcomes
* ''''Automatically extract test cases''''

If you have questions, feedback, or would like to report a bug please visit the [http://eiffelstudio.origo.ethz.ch/forum/20 CDD forum].

CDD EiffelStudio adds the following panel to regular EiffelStudio:

[[Image:cdd_panel.png|center]]

== Download CDD ==

The following packages contain the full EiffelStudio 6.1 plus the CDD extension. You do not need to have EiffelStudio installed already in order to install below packages. On Windows you do have to have either the Platform SDK or Visual C++ installed. Do not use EiffelStudio with the gcc/mingw or the .Net backend.

=== Linux ===
* Full Linux version: http://se.ethz.ch/people/leitner/cdd/Eiffel61_cdd_final_5.tar.bz2
* Installation instructions: http://docs.eiffel.com/eiffelstudio/installation/studio/060_linux.html

Download the above file and install it just like you would install a EiffelStudio tar ball. Afterwards proceed to section "Using CDD". Make sure you set/update the environment variables PATH, ISE_EIFFEL, and ISE_PLATFORM according to the installation instructions.

=== Windows ===

* Full Windows version (with installer): http://n.ethz.ch/~moris/download/Eiffel61_cdd_final_5-windows.msi
* Note 1: Installation is independent of installations of official EiffelStudio 6.1 (neither overwrites nor invalidates nor is influenced by those)
* Note 2: If you have a previous installation of the CDD Edition of EiffelStudio installed, you need to uninstall it first. If you want to reuse the installation directory, you need to manually delete all EIFGENs in its subdirectories after the uninstall procedure.
* Note 3: Do not use the gcc/mingw or the .NET compiler backend. You will have to use the Microsoft C compiler. You can get it either by installing Visual C++, or via (the freely available) Microsoft Platform SDK.Have a look at http://eiffelsoftware.origo.ethz.ch/Installing_Microsoft_C_compiler to learn how to install either compiler.

== Documentation ==

=== Manually Written Test Cases ===
CDD Eiffelstudio allows you to create a new “empty” test case. These test cases are similar to jUnit test cases. A manually written test class must start with the word “TEST” and all test routines also have to start with the word “test”. It also has to inherit from class CDD_TEST_CASE.

=== Extracted Test Cases ===
CDD EiffelStudio automatically extracts test cases whenever you run your program and an exception is triggered. This feature is novel and not yet part of any other testing environment. You will be the first to try it out.

=== Test outcomes ===
A test case checks whether your program contains a particular bug. A test cases can fail indicating that the bug is present in your program, or pass indicating your program does not contain this bug. Sometimes test cases will be unresolved, in which case the testing framework was unable to find out whether the test case passed or failed. A test case can be unresolved for several reasons. Please see the CddBranch web page for details.

[[Image:cdd_buttons.png|center]]

=== Debug Test Case ===
Select a test case and press this button to run a test case in the debugger.

=== Enable/Disable Execution of Test Cases in Background ===
If enabled, all test cases are retested every time you press compile. If disabled not test cases are executed.

=== Enable/Disable automatic extraction of Test Cases ===
If enabled every time an exception is triggered a set of test cases that try to reproduce this exception is extracted. If disabled no test cases are extracted.

=== Clean up/Delete ===
You can use the “Clean Up/Delete” button in two different ways. By simply pressing it you will delete all unresolved test cases. By pick and dropping a test case to the “Clean up/Delete” button (right click on test case, move mouse to button and right click again) you can delete a test case. By the way, test cases are just regular classes. So you can use all existing tools that apply to classes in EiffelStudio too.

=== Create new manual test class ===
Press this button to create a empty test class. You can then edit the class to add manually written test cases.

[[Image:cdd_buttons_2.png|center]]

=== Search for tags ===
Enter keywords to search for paritcular test cases. Some tags are automatically set for you like the name of the test case. You can also easily add your own tags by adding an indexing item "tag" to your test class or routine:

<eiffel>
indexing
tag: "fixme"
class TEST_BANK_ACCOUNT
inherit CDD_TEST_CASE
feature
...
end
</eiffel>

Tags can be adde to all test routines and classes. Whether they are extracted or manually written does not matter.

=== Restrict execution of test cases ===

=== Change test case view ===

== Further Documentation and Common Problems ==
Please visit [[Using CDD]] for further documentation or look at
[[CDD Common Problems|Common Problems]] if you run into problems.

== Related Publications ==

* Leitner, A., Ciupa, I., Oriol, M., Meyer, B., Fiva, A., "Contract Driven Development = Test Driven Development - Writing Test Cases", Proceedings of ESEC/FSE'07: European Software Engineering Conference and the ACM SIGSOFT Symposium on the Foundations of Software Engineering 2007, (Dubrovnik, Croatia), September 2007 [http://se.ethz.ch/people/leitner/publications/cdd_leitner_esec_fse_2007.pdf (pdf)]
* Sunghun Kim, Shay Artzi, and Michael D. Ernst, "reCrash: Making Crash Reproducible" MIT Computer Science and Artificial Intelligence Laboratory technical report MIT-CSAIL-TR-2007-054, (Cambridge, MA), November 20, 2007. [http://recrash.googlecode.com/files/MIT-CSAIL-TR-2007-054.pdf (pdf)]

== Project Internal Stuff ==

[[CddBranchInternal]]