Home > Articles

  • Print
  • + Share This
This chapter is from the book

Tools and Techniques for Debugging Your Program Code

If you've gotten past all the standard problems people run into with CGI scripts and your script still isn't working properly, you have to start searching for bugs within your code. This can be a much tougher job than dealing with all the common problems mentioned previously.

Basically, errors within programs come in two flavors—syntax errors and runtime errors. Syntax errors crop up when you use your programming language of choice improperly. If you leave out a required semicolon or use elseif instead of elsif, your program will not compile, or if it's an interpreted language, it won't execute all the way through. Runtime errors occur when all the syntax in your program is correct, but your program still doesn't behave as expected.

Runtime errors can cause your programs to exit with an error during execution, or they might execute but produce unexpected results. For example, if you have a mathematical construct in your program that divides a number by 0, most languages will exit and return an error during execution. On the other hand, if your program multiplies a number by 1000 when it should multiply by 100, the program will appear to work correctly but will produce invalid results.

Compiled Versus Interpreted Languages

When we talk about debugging, it's important to contrast two types of languages— compiled languages and interpreted languages. The difference between the two is that there are at least two steps to get from source code to execution with compiled languages; with interpreted languages, there's only one—execution. A scripting language, which is a simple language designed to perform special or limited tasks, is usually interpreted.

Let me talk about an interpreted language first to give you an example. Scripts written in the Bourne shell are interpreted. When a Bourne shell script is executed, the shell reads the program command by command, and executes each command before moving on to the next one. With interpreted languages, even syntax errors are "runtime errors." In other words, if there's a syntax error on the fifth line of a shell script, the first four lines will be executed, and the program will exit with an error when it reaches the fifth line.

On the other hand, when you write a program in a compiled language, the source code must be transformed into machine readable instructions prior to execution. How this is handled differs from language to language. When you program in C, you use a compiler to transform source code into machine readable code. The code is then stored in executable format so that it can be used. When you program in Java, the source code is compiled into an intermediate format called bytecode, and is stored in that format. When you execute a Java program, the Java virtual machine translates the bytecode into machine readable code for the platform it's running on and executes the code.

The other example of a compiled language is Perl, which is a scripting language. Despite the fact that it's a scripting language, it's not an interpreted language. The difference between Perl and other compiled languages is that Perl code isn't stored in an executable format or bytecode after it's compiled. Instead, every time you run a Perl program, the source code is read by the Perl interpreter and compiled, and then executed immediately. So, it's a scripting language in the sense that to the user, compilation and execution are part of the same step, but it's a compiled language because the code is compiled before it is executed.

The difference in debugging the two types of languages is that, with an interpreted language, all debugging occurs at runtime. There is no compilation step during which you can iron out all the syntax errors in your code; instead you have to run the program to find any errors in it. This really becomes a problem when your interpreted program modifies files, or makes any other changes to permanent resources. For example, let's say you've written a shell script that, among other things, submits a credit card transaction for processing. If there's a syntax error in the program after the credit card submission, you'll have to submit a credit card transaction to get to the bug, and then submit another to determine whether the bug is fixed after a change. This can make debugging interpreted programs a real hassle (fortunately, in this case, most credit card verification services provide bogus credit card numbers you can use to test your programs). Generally in these situations you comment out instructions that make permanent changes for debugging.

Running CGI Scripts from the Command Line

When you're debugging your CGI scripts, it's important to remember that they're standard command-line programs. That means that you don't have to always run them through the Web server. In many cases, it's a lot easier to run them from the command line and look at the output there to find bugs.

This is certainly true when your script is returning a 500 Server Error result when requested. As you know, when you run into one of these errors, oftentimes you can find out what caused the error in the server's error log. You should always take a 500 Server Error as an indication that you should test the CGI program at the command line if you can't spot the problem immediately in the error log.

Running your program at the command line will let you know immediately whether there's a syntax error in your program if it's written in a scripting language, or whether there's a runtime error in the code that prevents the program from executing if it's a compiled language. In fact, if you're writing a program in Perl, you can execute it at the command line using the -cw flags to compile the program without executing it, nd to turn on warnings to catch coding mistakes that aren't necessarily syntax errors. For example, to compile (but not execute) the program example.pl with warnings, the following command line is used:

perl -cw example.pl

It's also easy to verify from the command line whether your program produces the proper HTTP header. The first two lines of the program's output should be the content type header and a blank line. This output is processed by the Web browser, so you never see it when you're testing through a server, but it's right there on the screen if you test your program at the command line.

CGI.pm and the Command Line

CGI.pm, the standard Perl tool for creating CGI scripts, is designed to make testing CGI programs from the command line very easy. When you run a program that uses CGI.pm from the command line, you can pass in name and value pairs as arguments, like this:

$ perl archive.pl year=2002 month=5 day=1

or this:

$ perl archive.pl year=2002&month=5&day=1

CGI.pm treats data received through the POST and GET methods the same, so there's no need to distinguish between them when you pass data to a script from the command line.

Using Print Statements for Debugging

One of the most important and time-tested techniques for tracking down logic errors in programs is using print statements to isolate bugs and find out where incorrect values are introduced. After you have your script working well enough to produce output, you can start inserting print statements to track down logic errors.

Many programming languages include debuggers that allow you to step through the execution of your program's statement by statement. You can stop execution at any time, and examine the values of variables that have been set within the program. Unfortunately, many languages used for CGI programming don't have debuggers, and even if they do, it's sometimes easier to just use print statements for debugging.

Generally speaking, print statements are most often used to display the values of variables that are normally used internally by the program. Let me show you how print statements are used for debugging with some examples. One of the most common uses of print statements to debug is to print values as a loop executes. If you're unsure of how many times a loop iterates in a program, you can insert a print statement in the loop so that it prints either a count, or just a marker value every time through.

Another common usage for print statements is to determine where, exactly, an error is occurring. Generally, you place print statements before and after the potentially offending code, and check to see whether the text in both of the print statements gets printed out. You can place these types of "markers" throughout your code to figure out where, exactly, something is failing along the way.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020