Software Engineering

Group

Phase

Due Date

Deliverables

Deliverables

1. Source code with JavaDoc comments (each relevant field should be filled)
2. JavaDoc HTML output
3. JUnit Test cases & their JavaDoc (Test Cases should have 95% Statement Coverage and 100% Method Coverage; Submit Coverage Reports)
4. Printout of your Bug reports from Bugzilla (Bug reports should have description of Bug and the test case attachment that was used to detect it)

Deliverables

1. VORD templates 
2. Viewpoint hierarchy

Deliverables

1. Get scenarios from customer via interviews
2. 100 Scenarios. The structure of each scenario is [initial software state, event sequence, final software state]. 

Deliverables

1. Source Code.
2. Build and execute scripts (plain-text files).
3. Plain-text README file describing how to build and execute the software on any platform.

GRADING POLICY: This submission is worth 300 points. The source code submission should include only SOURCE files. Code archives (e.g., .jar) should not be submitted. The build scripts should be able to install the software on a new computer, which has only the OS installed. The grader will first delete all archives and derived files (e.g., .jar, .exe, .class files) from your submission; if any are found, you will lose 100 points. The grader will then read your README file (a plain-text file) and use it to build your application. The build script should return a meaningful error and instructions if additional system software (such as a compiler) needs to be installed. If the script does not return a meaningful message, then the grader will abandon the installation; you will lose all points for this submission. You are not allowed to require the installation of any third-party tools and/or libraries. A successful build is not worth any points. The grader will repeat this process on three platforms -- Mac OS X, Windows XP, and Linux. The final message from the build script (after a successful build) should give detailed instructions on how to execute your application. An "execute script" should be generated/provided that automatically executes the application. Without this script, the grader will not run your application.

Deliverables (Choose 300 methods in the code for this phase)

1. JUnit Test cases & their JavaDoc (Test Cases should have 95% Statement Coverage and 100% Method Coverage); each method should have at least one unit test case. Also submit code faults, i.e., comments in the method's code of the form /*FAULT::   ....*/ that, if substituted for the current line, will cause the method's test case to fail. Provide one script to run all unit test cases fully automatically on the code. Provide a script to automatically insert the code faults, and run the test cases showing that all the test cases failed. Use doccheck to check the completeness of your JavaDoc. Provide a script to instrument the code and execute JUnit test cases automatically on the instrumented code. You can use any instrumenter. Once the JUnit test cases have been executed on the instrumented code, the script should generate a coverage report that summarizes the "cumulative" coverage of all covered methods (as one number) and per method.
2. Printout of at least 100 bug reports from Bugzilla (Bug reports should have description of Bug and the test case attachment that was used to detect it). If the software does not have 100 bugs, then mention this "claim" in your submission. However, in this case, if the grader finds unreported bugs while executing the software, you will lose points.

GRADING POLICY:

1. JUnit test cases per method: ((Number of test cases)/(Total number of methods)) * 20. Maximum points = 20.
2. Coverage of test cases: (((Number of Statements Covered)/(Total Number of Statements)*100) / 95) * 20. Maximum points = 20.
3. JavaDoc per test case: Formula based on "Executive Summary" output of doccheck. Maximum points = 20.
4. JavaDoc manual checking: 20 instances of JavaDoc will be selected and evaluated for completeness, consistency and correctness. Maximum points = 20.
5. Code faults per test case: ((Number of failed test cases due to code faults)/(Total number of methods)) * 30. Maximum points = 30.
6. Bug reports. ((Number of bug reports submitted)/100) * 20. Maximum points = 20.
7. Scripts: You are expected to submit three scripts to: (1) run the JUnit test cases on your code, (2) insert code faults, and run test cases on the fault-inserted code, and (3) instrument the code, run JUnit test cases on the instrumented code and generate a "cumulative" and "per method" coverage report. The above evaluation points will be awarded only if the grader can execute the JUnit test cases, etc. using your scripts. Debugging a problematic script or running individual test cases is left to the discretion of the grader.

Deliverables (Use the same (as above) 300 methods in the code for this phase)

1. Source code with JavaDoc comments (each relevant field should be filled). Use doccheck to check the completeness of your JavaDoc.
2. Code for the getIcon() method. Please get the requirements from the TerpManager group. (Informally, the method should take a file-name (of your application type) as a parameter and return a jpeg or gif image as an output. The image should be a thumbnail of the file, generated dynamically, showing a miniature image (icon size) of the file. Please get the exact requirements from the TerpManager group.)

GRADING POLICY:

1. JavaDoc per test case: Formula based on  "Executive Summary" output of doccheck. Maximum points 20.
2. JavaDoc manual checking: 20 instances of JavaDoc will be selected and evaluated for completeness, consistency and correctness. Maximum points 20.
3. Working version of getIcon(). Maximum points 30 (no partial points for this step).

GRADING POLICY:

WEB-SITE: [This submission is worth 200 points; bonus points will be given for creativity] The web-site should be submitted on a CD. It should have only one root folder at the top-level, called any one of: TerpManager, TerpWord, TerpPaint, TerpSpreadSheet, TerpCalc, TerpPresent. I will copy the root folder to the www.cs.umd.edu web server. Please don't hardcode any links, i.e., all links should be relative to your root folder.  Also, don't make any assumptions about the web-server (Note that cgi and other server scripts are not allowed; directory browsing is also not allowed). The root folder should contain a file called index.html that points to the "first page" (or Home) of your site. The contents of your entire site should be accessible (directly or indirectly) from this page. Provide at least the following pages: (1) "About Us" that lists your names, (2) "Contact Us" that points to your Terp????@cs.umd.edu contact e-mail address, (3) "Report a Bug" that points to all bugs related to your version of Terp???? on bugs.cs.umd.edu (yes, if you have reported bugs elsewhere, please migrate them to bugs.cs.umd.edu), (4) "FAQs" that contain answers to some commonly asked questions about your software/installer/developers; you may get some questions from the TA or your instructor, (5) "Install" that provides instructions (and a link to an archive containing only SOURCE files and install scripts) on how to install your application, (6) "Site Map" that shows the structure of your site as a tree, and (7) "Downloads" that allows users to download any (or all) document(s) and code submitted during this semester; provide mechanisms to let the user first select the needed files and then download them using one button-click. Each page should contain links to all these pages and Home. (Feel free to get feedback on partially created web-sites before the submission date. I strongly encourage that all groups work together to produce the web-sites; also, it would be nice to have one TerpOffice Version 4.0 page that links to all Terp???? applications in version 4.0)

USER-MANUAL: [This submission is worth 100 points; bonus points will be given for creativity] Submit ONE pdf file that is the user guide, and all the source files. The sources should produce one document identical to the submitted pdf file. The user guide should contain the following sections: Cover page, Table of contents, Introduction (overview of the software, platform restrictions, etc.), Installation guide, Working with Terp???? (features of your software, How-to use-cases submitted in an earlier phase).

GRADING POLICY: This submission is worth 300 points. The grader will use the "Install" page of your web-site to download and build your application. If the download/build script/process fails, then the grader will abandon the installation; you will lose all points for this submission. You are not allowed to require the installation of any third-party tools and/or libraries. A successful build is not worth any points. The grader will repeat this process on three client platforms -- Mac OS X, Windows XP, and Linux. The final message from the build script (after a successful build) should give detailed instructions on how to execute your application. An "execute script" should be generated/provided that automatically executes the application. Without this script, the grader will not run your application.