Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mehralsnix/assumptions

Assumptions can be used to skip tests when common preconditions, like the PHP Version or installed extensions, are not met.
https://github.com/mehralsnix/assumptions

phpunit testing

Last synced: 2 months ago
JSON representation

Assumptions can be used to skip tests when common preconditions, like the PHP Version or installed extensions, are not met.

Host: GitHub
URL: https://github.com/mehralsnix/assumptions
Owner: MehrAlsNix
License: mit
Created: 2015-05-14T14:59:24.000Z (over 9 years ago)
Default Branch: develop
Last Pushed: 2018-02-12T22:10:15.000Z (almost 7 years ago)
Last Synced: 2024-11-15T19:07:20.514Z (2 months ago)
Topics: phpunit, testing
Language: PHP
Homepage: http://mehralsnix.github.io/Assumptions
Size: 111 KB
Stars: 2
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Assumptions (not only) for PHPUnit.

[![Build Status](https://travis-ci.org/MehrAlsNix/Assumptions.svg?branch=develop)](https://travis-ci.org/MehrAlsNix/Assumptions) [![Code Climate](https://codeclimate.com/github/MehrAlsNix/Assumptions/badges/gpa.svg)](https://codeclimate.com/github/MehrAlsNix/Assumptions) [![Test Coverage](https://codeclimate.com/github/MehrAlsNix/Assumptions/badges/coverage.svg)](https://codeclimate.com/github/MehrAlsNix/Assumptions/coverage) [![Dependency Status](https://www.versioneye.com/user/projects/5558aa6eb2ff6d2ecc000368/badge.svg?style=flat)](https://www.versioneye.com/user/projects/5558aa6eb2ff6d2ecc000368)

[![Latest Stable Version](https://poser.pugx.org/mehr-als-nix/assumptions/v/stable)](https://packagist.org/packages/mehr-als-nix/assumptions) [![Latest Unstable Version](https://poser.pugx.org/mehr-als-nix/assumptions/v/unstable)](https://packagist.org/packages/mehr-als-nix/assumptions) [![License](https://poser.pugx.org/mehr-als-nix/assumptions/license)](https://packagist.org/packages/mehr-als-nix/assumptions) [![Total Downloads](https://poser.pugx.org/mehr-als-nix/assumptions/downloads)](https://packagist.org/packages/mehr-als-nix/assumptions)

[![Build status](https://ci.appveyor.com/api/projects/status/xqcdrl8b62d6qrle/branch/develop?svg=true)](https://ci.appveyor.com/project/siad007/assumptions/branch/develop)

## Introduction

Assumptions can be used to skip tests when common preconditions, like the PHP Version or installed extensions, are not met.

The default PHPUnit runner treats tests with failing assumptions as skipped. Custom runners may behave differently.

We have included several assumptions like `assumeTrue`, `assumeExtensionLoaded`,... by default. All of those functions are subsumed in assumeThat, with the appropriate `Hamcrest` matcher.

A failing assumption in a `@before` or `@beforeClass` method will have the same effect as a failing assumption in each `@test` method of the class.

***

The concept behind **Assumptions for PHPUnit** is based on the adequate junit feature, which is documented on their [wiki - Assumptions with assume](https://github.com/junit-team/junit/wiki/Assumptions-with-assume)

## Note

There is a similar feature in PHPUnit called [@requires](https://phpunit.de/manual/current/en/appendixes.annotations.html#appendixes.annotations.requires)!

If you are familiar in using `@requires` annotation to dedicate that a given [requirement](https://phpunit.de/manual/current/en/incomplete-and-skipped-tests.html#incomplete-and-skipped-tests.requires.tables.api) would be given and you are happy about, then you just do not need the use of **Assumption for PHPUnit**.

But if you want to have

- code completion

- better readability

- finer control

- more requirement abilities

then you should give **Assumption for PHPUnit** a try.



## Requirements

- PHP >= 7.1

if you are looking for a version which supports PHP < 7.0.7 just use the v2.0.0

## Installation

[see wiki:installation](https://github.com/MehrAlsNix/Assumptions/wiki/1.-Installation)

## Assumptions

[see wiki:assumptions](https://github.com/MehrAlsNix/Assumptions/wiki/2.-Assumptions)

## Examples

[see wiki:examples](https://github.com/MehrAlsNix/Assumptions/wiki/3.-Examples)

## ResultPrinter

[see wiki:result-printer](https://github.com/MehrAlsNix/Assumptions/wiki/4.-ResultPrinter)