Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pschanely/CrossHair

An analysis tool for Python that blurs the line between testing and type systems.
https://github.com/pschanely/CrossHair

concolic-execution contracts dynamic-analysis fuzzing hacktoberfest python static-analysis symbolic-execution testing testing-framework type-systems z3

Last synced: about 2 months ago
JSON representation

An analysis tool for Python that blurs the line between testing and type systems.

Host: GitHub
URL: https://github.com/pschanely/CrossHair
Owner: pschanely
License: other
Created: 2017-08-29T13:11:40.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2024-07-25T07:33:43.000Z (about 2 months ago)
Last Synced: 2024-07-26T01:25:15.529Z (about 2 months ago)
Topics: concolic-execution, contracts, dynamic-analysis, fuzzing, hacktoberfest, python, static-analysis, symbolic-execution, testing, testing-framework, type-systems, z3
Language: Python
Homepage:
Size: 4.24 MB
Stars: 983
Watchers: 14
Forks: 47
Open Issues: 55
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-python-testing - CrossHair - An analysis tool for Python that blurs the line between testing and type systems. (Tools)

README

        

# CrossHair

[![Join the chat at https://gitter.im/Cross_Hair/Lobby](https://badges.gitter.im/Cross_Hair/Lobby.svg)](https://gitter.im/Cross_Hair/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Check status](https://github.com/pschanely/CrossHair/workflows/Check/badge.svg)](https://github.com/pschanely/CrossHair/actions?query=workflow%3ACheck)

[![Downloads](https://static.pepy.tech/badge/crosshair-tool/week)](https://pepy.tech/project/crosshair-tool)

An analysis tool for Python that blurs the line between testing and

type systems.

> **_THE LATEST NEWS:_**

Python's most popular property-based testing tool,

[Hypothesis](https://hypothesis.readthedocs.io/en/latest/),

now supports running CrossHair as an

[optional backend](https://hypothesis.readthedocs.io/en/latest/strategies.html#alternative-backends)!

This integration is much more effective at bug-finding than running crosshair

with the `--analysis_kind=hypothesis` option.

If you have a function with

[type annotations](https://www.python.org/dev/peps/pep-0484/) and add a

contract

[in a supported syntax](https://crosshair.readthedocs.io/en/latest/kinds_of_contracts.html),

CrossHair will attempt to find counterexamples for you:

![Animated GIF demonstrating the verification of a python function](doc/source/duplicate_list.gif)

CrossHair works by repeatedly calling your functions with symbolic inputs.

It uses an [SMT solver] (a kind of theorem prover) to explore viable

execution paths and find counterexamples for you.

This is not a new idea; a Python approach was first described in

[this paper].

However, to my knowledge, CrossHair is the most complete implementation:

it can use symbolic reasoning for the built-in types, user-defined classes, and much

of the standard library.

[SMT solver]: https://en.wikipedia.org/wiki/Satisfiability_modulo_theories

[this paper]: https://hoheinzollern.files.wordpress.com/2008/04/seer1.pdf

Try CrossHair right now, in your browser, at [crosshair-web.org]!

CrossHair has [IDE integrations] for [VS Code], [PyCharm], and more.

Finally, CrossHair can do more than check contracts. It can also

[generate unit tests](https://crosshair.readthedocs.io/en/latest/cover.html)

and

[find behavioral differences](https://crosshair.readthedocs.io/en/latest/diff_behavior.html)

between functions.

[IDE integrations]: https://crosshair.readthedocs.io/en/latest/ide_integrations.html

[VS Code]: https://marketplace.visualstudio.com/items?itemName=CrossHair.crosshair

[PyCharm]: https://plugins.jetbrains.com/plugin/16266-crosshair-pycharm

[crosshair-web.org]: https://crosshair-web.org

Want to help?

Sign up for

[email](http://eepurl.com/hGTLRH)

or

[RSS](https://pschanely.github.io/feed.xml)

updates.

Star ⭐️ the repository.

There are

[other ways to help](https://crosshair.readthedocs.io/en/latest/how_can_i_help.html)

too.

## [Documentation](https://crosshair.readthedocs.io/en/latest)

* [Introduction](https://crosshair.readthedocs.io/en/latest/introduction.html)

* [Get Started](https://crosshair.readthedocs.io/en/latest/get_started.html)

* [The Details: Contracts](https://crosshair.readthedocs.io/en/latest/contracts.html)

* [The Details: cover](https://crosshair.readthedocs.io/en/latest/cover.html)

* [The Details: diffbehavior](https://crosshair.readthedocs.io/en/latest/diff_behavior.html)

* [Kinds of Contracts](https://crosshair.readthedocs.io/en/latest/kinds_of_contracts.html)

* [Hints for Your Classes](https://crosshair.readthedocs.io/en/latest/hints_for_your_classes.html)

* [IDE Integrations](https://crosshair.readthedocs.io/en/latest/ide_integrations.html)

* [Case Studies](https://crosshair.readthedocs.io/en/latest/case_studies.html)

* [Limitations](https://crosshair.readthedocs.io/en/latest/limitations.html)

* [Plugins](https://crosshair.readthedocs.io/en/latest/plugins.html)

* [How Does It Work?](https://crosshair.readthedocs.io/en/latest/how_does_it_work.html)

* [How Can I Help?](https://crosshair.readthedocs.io/en/latest/how_can_i_help.html)

* [Related Work](https://crosshair.readthedocs.io/en/latest/related_work.html)

* [Contributing](https://crosshair.readthedocs.io/en/latest/contributing.html)

* [Changelog](https://crosshair.readthedocs.io/en/latest/changelog.html)