Welcome to klara’s documentation!

Note

Klara is still in early experimental stage, notable missing features are loop, comprehension, module import, exceptions and many more. See limitation for full list. It probably will not run on real world projects, so it’s best to cherry-pick a few interesting functions to generate the corresponding test case.

Klara is a static analysis tools to automatically generate test cases, based on an SMT solver (z3), with a powerful AST level inference system. Klara will take a python file as input and generate a corresponding test file in pytest format, that attempts to cover all return values of the input file’s functions. For example, the following function in file test.py:

def triangle(x: int, y: int, z: int) -> str:
    if x == y == z:
        return "Equilateral triangle"
    elif x == y or y == z or x == z:
        return "Isosceles triangle"
    else:
        return "Scalene triangle"

will generate:

import test


def test_triangle_0():
    assert test.triangle(0, 0, 0) == 'Equilateral triangle'
    assert test.triangle(0, 0, 1) == 'Isosceles triangle'
    assert test.triangle(2, 0, 1) == 'Scalene triangle'

The User Guide

The sections here will explain how to install and use Klara, and include steps for extending Klara.

• Klara
  • Installing
  • Usage
  • Why Klara?
  • Contributing
  • Acknowledgements
  • License
• Quick Start
• Inference
  • Inference Result
  • Supported features
• Extending Klara
  • Node transformation
  • Extending Inference
  • Inserting as a plugin
• Extending Inference with User defined type
  • Defining the wrapper
  • Define inferring point
  • Define python operation
  • Using it
• Customize Coverage Strategy
• Plugins
• Limitation
  • Python Syntax
  • Uninferable

The Contributor Guide

The sections here will explain the internals workings of Klara

• How Does It Work?
  • Test case generation
  • Z3 solver Integration
• Python ast transformation
  • 1.1. Introduction
  • 1.2. Basic blocks
  • 1.3. Revisiting SSA
  • 1.4. Minimal SSA
  • 1.5. Creating a test
  • 1.6. Live Variable Analysis
  • 1.7. Insertion of φ-function
  • 1.8. Renaming of SSA
  • 1.9. References

The API

Documentations for modules, classes and functions.

• API

Indices and tables

• Index

• Module Index

• Search Page