King Saud University College of Computer and Information Sciences Information Technology Department

Transcription

1 King Saud University College of Computer and Information Sciences Information Technology Department GUIDE FOR WRITING A S OFTWARE T ESTING DOCUMENT DOCU MENT PR EP AR ED FOR IT 323: SW ENGINEER ING P ROJECT S - PA RT 4 Version: 1 Date: December 2009 Prepared by: Maha Al-Yahya and Latifa AlAbdulkarim

2 INTRODUCTION The purpose of this document is to describe the standards and procedures to follow during the software testing phases.this standard describes a set of basic test approaches that are associated with the dynamic aspects of software testing (i.e. during the execution of procedures and code). [1] STYLE CONVENTIONS FORMAT The SOFTWARE TESTING document should be typed. All text, Figures and Tables should appear on only one side of each sheet of paper. All pages other than the cover sheet should have page numbers that begin with 1 on the first page after the title page, and should continue through the last page of the reference page, but not the appendices. The right-hand margin should be 1.5 cm and the upper and lower margins cm. The left-hand margin must be 4 cm on each page of the document because of the binding. The margin instructions should be followed in the appendices as well. The font size in the text should be in 12, in subsections 12 and in the main headings 14. The main headings are to be written in capitals and placed at the beginning of a new page. All headings are to be in bold letters. Leave two empty lines under the main heading, two empty lines above the subsection and one empty line under it. The headings should not have more than three numbers. A line spacing of 1.5 should be used in the text, 1 on the title page and in the abstract. The font to be used is Times New Roman. The page number is placed in the lower right corner. The text should not be indented and both margins on the page should be justified. When a paragraph continues on the next page, at least two lines of the paragraph should be left on the upper or lower end of the page. The paragraphs are separated from each other and from the headings with one empty line. A new chapter is started on a new page. One empty line is needed to separate two paragraphs. TEXT The text of the report should be written in complete sentences. The style should be formal. Formal style means to avoid slang, clichés, abbreviations that are common in spoken English or advertising. It is convention that formal reports are written in the third person. FIGURES AND TABLES All Figures and Tables should have a number and a caption. If a figure or table is extracted from a source, the source should be cited in the references. Page 2

3 SOFTWARE TESTING REPORT CONTENTS A template for the project software testing report is attached. A project testing report should include the following components: The title page should include: TITLE PAGE University, College, and Department centered University logo on right hand side Project logo just above the title Project title: The title should be a stand-alone statement that can fully describe the project by summarizing the main idea of the project. The title is supremely important. A successful title will attract readers while an unsuccessful one will discourage readers. Compose trial versions of the title as early as you can. Student names in alphabetical order, along with the IDs. Supervisor name Year and semester in HIjrii and Gregorian TABLE OF CONTENTS A table of contents should list each of the main sections of the software testing report, and the beginning page numbers for each section. 1.0 INTRODUCTION The introduction should provide an overview of the entire software testing document STD as follow: Describe the purpose of this document (why do we need this document?) Describe this document's intended audience.(skills required and assumptions) Provide a complete list of all the applicable, referenced and any other pertinent documents such as: o Documents which provide background and/or context for this document o Documents that result from this document (e.g. a test plan or a development plan) Summarize (or give an abstract for) the contents of this document. "Describe what the rest of the STD contains and explain how the STD is organized. Constraints - Briefly describe any restrictions, limitations or constraints that impact the testing of the Software."[3] Page 3

4 2.0 TEST ITEMS This section describes the software testing items, i.e. for each component described in section Detailed system design in the software design document you will show the following: 1.0 Component Definition Responsibilities' Reference The ID of the related requirement(s) from the SRS document. Testing Items Define the test items based on the requirement, i.e. what are the different tests that you are going to apply for this component. Numbered in the following format T1.1,T1.2 T1.3.where the first number is the component number. Pseudocode The complete pseudocode of this component, as shown in the detailed system design of the SDD. 3.0 UNIT TESTING The goal of the unit component testing is to assure that all functions and features of a single compliable unit of code perform as specified in the Design Specification. This can be done by performing the following test: 3.1 Partition Testing[2] This section should show all the equivalence partitions in rectangle shape which must be handled by the pseudocode of each component. Then for each partition, define a set of test cases that covers the boundaries and midpoint of the partition as shown in table1 below: Test Case Test Data Expected Output Result Pass/Fail -Table INTEGRATION AND SYSTEM TESTING This section should cover the testing of the interaction between the system components. I.e. Once the unit testing has been completed for all units contained in each component, the testers will perform the integration testing for the system units by doing the following: 1- Create an integration test plan, by showing the order of the integration between the components. I.e. what are the first components that are going to be combined, and so on. 2- Combine each group of components, then apply the unit testing of these components and show the results of each integration process. Page 4

5 3- Draw a diagram that shows the system integration process. REFERENCES Always give complete citations for material on other sources. A proper reference involves two components: the citation in the text and the complete bibliographic entry in the References section. Use the Institute of Electrical and Electronics Engineers (IEEE) style for referencing. For more information see APPENDICES An appendix is included at the end of the report. It contains information referred to in the report that's too large to fit in the body of the report. Provide any appendices you have in this section. Appendices include the material needed for the report but which is unnecessary to include in the text itself (sample agreement form with client, graphs, and interview forms). The appendices must be referred to in the text and they must have all the necessary information needed for interpretation. Appendices are situated at the end of the thesis and numbered consecutively. The written form for reference to appendices within the text is: Appendix 1, Appendix 2, etc. In the References it is: APPENDIX 1, APPENDIX 2, etc. REFERENCES FOR THIS GUIDE [1] IEEE (1998) IEEE Standard for Software Test Documentation. IEEE Std (Revision of IEEE Std )The Institute of Electrical and Electronics Engineers, Inc [2]Sommerville, I. (2001)Software Engineering.6th ed. England: Pearson.ISBN: x [3] CMSC 421 Staff(2003) "System Design Document Template". Page 5