COEN 286: Code Inspection Exercise

Software Testing and Quality Assurance -- winter, 2008

Prof. John Noll

Santa Clara University

$Id: inspection-ex.body,v 1.23 2006/11/01 03:12:27 jnoll Exp $
Due February 28, at the beginning of class. The header file xmlfunc.h has been added to the code listing, so you have the typedefs as well.

1. Introduction

We discussed various kinds of review techniques in class: inspections, reviews, walkthroughs, etc. This exercise investigates formal inspections. We will again use the PEOS web interface as an example.

2. Instructions

This exercise consists of two parts. The first part is the preparation for the second part, which is an in-class inspection exercise.

2.1 Preparation

As we discussed in class, formal inspections require individual preparation:

  1. Obtain the source code listing for process_table.[ch] (please use this numbered listing so we all refer to the same line numbers).
  2. Review the code for save_process_table() and the functions it calls; use the checklist as a guide. Note any defects found by type and line number, and also record the total amount of time you spent reviewing the code.
  3. Prepare an Inspection Preparation Log, documenting
    1. Your name and student id.
    2. The total amount of time you spent preparing. This is not graded, so please be honest.
    3. Possible defects found, identified by line number, defect category, and brief description.
  4. Make a copy for yourself, for use in class during the actual inspection.

2.2 Inspection

On February 28, at the beginning of class, we will conduct a formal review of the code.

3. Deliverables

Submit a copy of your completed Inspection Preparation Log (keep a copy to use during the meeting), listing defects organized by line number, identified by checklist category and including a description.

Also, report the total amount of time spent on the preparation. Use the following format: 

                 COEN 286 Inspection Preparation Log

Name: Ed Student
Id: 123456
Module: process_table.c
Total Time: 6.5 hours.

Potential Defects:
line 6  DA: array element at this location may not be initialized.
line 8  ...

The final document is due February 28, at the beginning of class.

Generated Sat Mar 15 11:22:21 2008