Welcome to Regression Tests’ Documentation!

This is a documentation for the regression tests framework. It describes how to write regression tests for RetDec and its tools, and provides an overview of the supported functions and methods.

The documentation is primarily focused on tests for the RetDec decompiler, i.e. for the retdec-decompiler script. You can, however, write tests for arbitrary RetDec-related tools, such as fileinfo or unpacker. This is described in section Tests for Arbitrary Tools. Nevertheless, it is highly recommended to read the whole documentation, even if you plan to write tests only for a single tool.

Table of Contents

• General Overview
  • Basic Directory Structure
  • Outputs from Decompilations
  • Naming Conventions
  • Summary
• Creating a New Test
  • Basics
  • General Structure of test.py Files
  • Example of a test.py File
• Specifying Test Settings
  • Basics
  • Test Cases and Their Creation
  • Classes Having Multiple Settings
  • Arbitrary Parameters for the Decompiler
  • Specifying Input Files From Directory
• Writing Test Methods
  • Basics
  • Automatically Performed Verifications
  • Accessing Decompilation and Outputs
  • Accessing Test Settings
  • Verifying Text Outputs
  • Verifying C Outputs
  • Verifying Configuration Files
  • Compiling and Running C Outputs
  • Running Code Only On Selected Platforms
  • Examples
• Tests for Arbitrary Tools
  • Specifying the Tool
  • Passing Parameters
  • Obtaining Outputs and Writing Tests
  • Testing Success or Failure
  • Tools with Extra Support
  • Examples
• Support and Feedback

Indices

• Index
• Module Index