About this Book¶

Welcome to "The Debugging Book"! Software has bugs, and finding bugs can involve lots of effort. This book addresses this problem by automating software debugging, specifically by locating errors and their causes automatically. Recent years have seen the development of novel techniques that lead to dramatic improvements in automated software debugging. They now are mature enough to be assembled in a book – even with executable code.

A Textbook for Paper, Screen, and Keyboard¶

You can use this book in four ways:

• You can read chapters in your browser. Check out the list of chapters in the menu above, or start right away with the introduction to debugging or how debuggers work. All code is available for download.

• You can interact with chapters as Jupyter Notebooks (beta). This allows you to edit and extend the code, experimenting live in your browser. Simply select "Resources → Edit as Notebook" at the top of each chapter. Try interacting with the introduction to interactive debuggers.

• You can use the code in your own projects. You can download the code as Python programs; simply select "Resources → Download Code" for one chapter or "Resources → All Code" for all chapters. These code files can be executed, yielding (hopefully) the same results as the notebooks. Once the book is out of beta, you can also install the Python package.

• You can present chapters as slides. This allows for presenting the material in lectures. Just select "Resources → View slides" at the top of each chapter. Try viewing the slides for how debuggers work.

Who this Book is for¶

This work is designed as a textbook for a course in software debugging; as supplementary material in a software testing or software engineering course; and as a resource for software developers. We cover fault localization, program slicing, input reduction, automated repair, and much more, illustrating all techniques with code examples that you can try out yourself.

News¶

This book is work in progress. All chapters planned are out now, but we keep on refining text and code with minor and major releases. To get notified on updates, follow us on Mastodon.

About the Author¶

This book is written by Andreas Zeller, a long-standing expert in automated debugging, software analysis and software testing. Andreas is happy to share his expertise and making it accessible to the public.

Follow Andreas on Mastodon.

Frequently Asked Questions¶

Troubleshooting¶

Why does it take so long to start an interactive notebook?¶

The interactive notebook uses the mybinder.org service, which runs notebooks on their own servers. Starting Jupyter through mybinder.org normally takes about 30 seconds, depending on your Internet connection. If, however, you are the first to invoke binder after a book update, binder recreates its environment, which will take a few minutes. Reload the page occasionally.

The interactive notebook does not work!¶

mybinder.org imposes a limit of 100 concurrent users for a repository. Also, as listed on the mybinder.org status and reliability page,

As mybinder.org is a research pilot project, the main goal for the project is to understand usage patterns and workloads for future project evolution. While we strive for site reliability and availability, we want our users to understand the intent of this service is research and we offer no guarantees of its performance in mission critical uses.

There are alternatives to mybinder.org; see below.

Do I have alternatives to the interactive notebook?¶

If mybinder.org does not work or match your needs, you have a number of alternatives:

1. Download the Python code (using the menu at the top) and edit and run it in your favorite environment. This is easy to do and does not require lots of resources.
2. Download the Jupyter Notebooks (using the menu at the top) and open them in Jupyter. Here's how to install jupyter notebook on your machine.

For details, see our article on Using Debuggingbook Code in your own Programs.

As another alternative, you can also use our Docker images (experimental). Install Docker and then run

    $ docker pull zeller24/debuggingbook
    $ docker run -it --rm -p 8888:8888 zeller24/debuggingbook

and then in your Web browser, open the URL (http://127.0.0.1/... or http://localhost/...) given in the console output. This should give you the same environment as in mybinder.org.

If you want to create your own Docker images, use our Dockerfile as a starting point.

Can I run the code on my Windows machine?¶

We try to keep the code as general as possible, but occasionally, when we interact with the operating system, we assume a Unix-like environment (because that is what Binder provides). To run these examples on your own Windows machine, you can install a Linux VM or a Docker environment.

Can't you run your own dedicated cloud service?¶

Technically, yes; but this would cost money and effort, which we'd rather spend on the book at this point. If you'd like to host a JupyterHub or BinderHub instance for the public, please do so and let us know.

Content¶

Can I use your code in my own programs?¶

Yes! See the installation instructions for details.

Do your techniques apply to Python programs only? How about C code?¶

We use Python to implement our tools and techniques because we can get things done quickly. Building an interactive debugger in Python is less than 100 lines of code and took us 2-3 days; doing the same for C is tens of thousands of lines and a year-long project. Instrumenting code, say for dynamic slicing, gets us savings of similar magnitude. Also, Python code allows us (and you) to focus on the main concepts, rather than implementation details that are out of place in a textbook.

Having said this, many of the techniques in this book can also be applied to C and other code. This is notably true for black-box techniques such as reducing inputs or changes or generalizers; these are all language-agnostic. Tools related to the debugging process such as bug tracking or mining repositories are language-agnostic as well. Finally, in all chapters, we provide pointers to implementations in and for other languages, for instance for assertions or program repair.

What are the latest changes?¶

For changes to individual chapters, see the "Last change" link at the end of a chapter. For the debuggingbook Python package, see the release notes for details.

How do I cite your work?¶

Thanks for referring to our work! Just click on the "cite" button at the bottom of the Web page for each chapter to get a citation entry.

Can you cite my paper? And possibly write a chapter about it?¶

We're always happy to get suggestions! If we missed an important reference, we will of course add it. If you'd like specific material to be covered, the best way is to write a notebook yourself; see our Guide for Authors for instructions on coding and writing. We can then refer to it or even host it.

Teaching and Coursework¶

Can I use your material in my course?¶

Of course! Just respect the license (including attribution and share alike). If you want to use the material for commercial purposes, contact us.

Can I extend or adapt your material?¶

Yes! Again, please see the license for details.

How can I run a course based on the book?¶

We have successfully used the material in various courses.

• Initially, we used the slides and code and did live coding in lectures to illustrate how a technique works.

• Now, the goal of the book is to be completely self-contained; that is, it should work without additional support. Hence, we now give out completed chapters to students in a flipped classroom setting, with the students working on the notebooks at their leisure. We would meet in the classroom (or in Zoom) to discuss experiences with past notebooks and discuss future notebooks.

• We have the students work on exercises from the book or work on larger (automated debugging) projects. We also have students who use the book as a base for their research; indeed, it is very easy to prototype in Python for Python.

When running a course, do not rely on mybinder.org – it will not provide sufficient resources for a larger group of students. Instead, install and run your own hub.

Are there specific subsets I can focus on?¶

We will compile a number of tours through the book for various audiences. Our Sitemap lists the dependencies between the individual chapters.

How can I extend or adapt your slides?¶

Download the Jupyter Notebooks (using the menu at the top) and adapt the notebooks at your leisure (see above), including "Slide Type" settings. Then,

1. Download slides from Jupyter Notebook; or
2. Use the RISE extension (instructions) to present your slides right out of Jupyter notebook.

Do you provide PDFs of your material?¶

Technically, we can produce PDF and print versions from notebooks, but it is low on our priority list as we find the interactive formats to be so much superior. Let us know if you'd like PDF versions.

Other Issues¶

I have a question, comment, or a suggestion. What do I do?¶

You can post to @TheDebuggingBook@mastodon.social on Mastodon, allowing the community of readers to chime in. For bugs you'd like to get fixed, report an issue on the development page.

I have reported an issue two weeks ago. When will it be addressed?¶

We prioritize issues as follows:

1. Bugs in code published on debuggingbook.org
2. Bugs in text published on debuggingbook.org
3. Writing missing chapters
4. Issues in yet unpublished code or text
5. Issues related to development or construction
6. Things marked as "beta"
7. Everything else

How can I solve problems myself?¶

We're glad you ask that. The development page has all sources and some supplementary material. Pull requests that fix issues are very welcome.

How can I contribute?¶

Again, we're glad you're here! We are happy to accept

• Code fixes and improvements. Please place any code under the MIT license such that we can easily include it.
• Additional text, chapters, and notebooks on specialized topics. We plan to set up a special folder for third-party contributions.

See our Guide for Authors for instructions on coding and writing.