1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375,...
-
Upload
eric-montgomery -
Category
Documents
-
view
228 -
download
0
Transcript of 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375,...
![Page 1: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/1.jpg)
1
Defensive Programming and Debugging(Chapters 8 and 23 of Code Complete)
Tori BowmanCSSE 375, Rose-HulmanSeptember 21, 2007
![Page 2: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/2.jpg)
What’s coming up?
What’s due
Defensive Programming and Debugging (this)
Project work
2
![Page 3: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/3.jpg)
What’s due? HW3 due 11:55 PM Monday
Please have read the following by Tuesday: http://www.abanet.org/intelprop/opensource.html http://www.monthlyreview.org/0103perelman.htm http://www.groklaw.net/article.php?
story=20031231092027900 Come to class prepared to discuss your opinion on how
open source software does or does not impact intellectual property. You will be expected to back up your opinion with examples/references from the above 3 articles.
3
![Page 4: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/4.jpg)
4
Defensive Programming
![Page 5: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/5.jpg)
5
What is Defensive Programming?
Like defensive driving
Main goal – protect yourself from bad data or other factors you cannot control
How can it be used in detailed design and implementation?
![Page 6: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/6.jpg)
What to do with garbage?
“Garbage in, garbage out”
(inappropriate for production code)
Check the values of all data from external sources
Check the values of all routine input parameters
Decide how to handle bad inputs
6
![Page 7: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/7.jpg)
7
Defensive Programming Techniques
Assertions Error handling Code insertion for finding bad
data
Note: These techniques can also be used elsewhere besides defensive programming
![Page 8: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/8.jpg)
8
Assertions
Definition: code that’s used during development – usually a routine or macro – that allows a program to check itself as it runs
Assertions are intended to always be silent – only use for conditions that should never occur
Avoid putting executable code into assertions Use to document/verify pre-/post-conditions
![Page 9: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/9.jpg)
Error handling
Return a neutral value
Substitute the next valid data
Return previously valid data
Substitute closest “legal” value
Log a warning Return an error code Call an error-
processing routine/object
Display an error message
Whatever is logical Shutdown
9
**For errors you do expect to occur
![Page 10: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/10.jpg)
10
Code insertion
Use this during development only Can be as simple as an output statement to a file or
screen Advantage: independent of programming environment Preprocessing in C++ can help with this
#define DEBUG
.
.
.
#if defined (DEBUG)
// debugging code
#endif
![Page 11: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/11.jpg)
11
Defensive Programming andProduction Code
Leave in code that Checks for important errors Helps the program crash gracefully
Remove code that Checks for trivial errors Hard crashes as a “signal” to testers
Log errors for technical support Make error messages user-friendly
![Page 12: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/12.jpg)
12
Defensive Programming Checklist
Pages 211-212 of Code Complete Sections
General Example: Protected from bad input data?
Exceptions Example: Did you avoid exceptions in
constructors/destructors? Security Issues
Example: Do error messages avoid providing valuable info that can be used to break the system?
![Page 13: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/13.jpg)
13
Debugging
![Page 14: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/14.jpg)
Comic of the Day
14
![Page 15: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/15.jpg)
15
Definition
Debugging is the process of finding and fixing an error in code that was found through testing.
*testing here is meant to include all forms
![Page 16: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/16.jpg)
16
Benefits of Debugging
Debugging helps in: understanding the program understanding the types of errors you
make (you can form a checklist to help find these errors earlier)
in assessing readability and understandability of code
![Page 17: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/17.jpg)
17
Debugging Process
1. Stabilize the error
2. Locate the source of an error
3. Fix the error
4. Test the fix
5. Look for similar errors
6. *Regression testing
![Page 18: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/18.jpg)
18
Common Debugging Problems
Reading your own code can lead to you making assumptions about the code that you shouldn’t
Sometimes a fix is attempted without looking at the overall effect (regression testing helps here)
Sometimes a fix is attempted as a guess or without determining why the problem really occurred
![Page 19: 1 Defensive Programming and Debugging (Chapters 8 and 23 of Code Complete) Tori Bowman CSSE 375, Rose-Hulman September 21, 2007.](https://reader036.fdocuments.us/reader036/viewer/2022062314/56649e315503460f94b21a77/html5/thumbnails/19.jpg)
19
Debugging Tools
GCC – must include debug options when compilinghttp://gcc.gnu.org/onlinedocs/gcc/Debugging-Options.html
Visual Studio 2005 Debugging Infohttp://msdn2.microsoft.com/en-us/library/sc65sadd.aspx
Note how debugging tools vary widely from application to application
However, debugging techniques do not change