https://github.com/gabrielfalcao/unclebob

django tool for running tests organized between unit, functional and integration
https://github.com/gabrielfalcao/unclebob

Last synced: 31 minutes ago
JSON representation

django tool for running tests organized between unit, functional and integration

• Host: GitHub
• URL: https://github.com/gabrielfalcao/unclebob
• Owner: gabrielfalcao
• Created: 2011-04-19T20:18:18.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2021-09-26T10:55:38.000Z (about 3 years ago)
• Last Synced: 2024-11-03T14:49:49.254Z (9 days ago)
• Language: Python
• Homepage:
• Size: 247 KB
• Stars: 55
• Watchers: 5
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# unclebob

> Version 0.4.0

# What

UncleBob is a simple django app that allow you writting per-app tests within these paths:

* `/tests/unit/test*.py` - for unit tests

* `/tests/functional/test*.py` - for functional tests

* `/tests/integration/test*.py` - for integration tests

# installing

## first of all

    pip install unclebob

## add it to your django project

on settings.py

```python

INSTALLED_APPS = (

    ...

    'unclebob',

    ...

)

TEST_RUNNER = 'unclebob.runners.Nose'

import unclebob

unclebob.take_care_of_my_tests()

```

# running

just use the regular **test** command:

    python manage.py test

## running only the unit tests

    python manage.py test --unit

## running only the functional tests

    python manage.py test --functional

## running only the integration tests

    python manage.py test --integration

## running only a specific path

    python manage.py test path/to/app/tests

or

    python manage.py test path/to/app/tests/unit

# warning:

if you run only the `unit` tests, then unclebob is NOT going to setup

the test database. Since

[unit tests](http://en.wikipedia.org/wiki/Unit_testing) are supposed

to be "unwired", what I mean is that unit tests MUST NOT make use of

actual database, filesystem or network at all.

Instead, they must test isolated parts of your code.

For that reason, ma'am/sir, Uncle Bob is gonna break your neck in case you

decide to use those, so called, "external resources" in your unit

tests.

# although you can tell unclebob to never touch the database at all

in your `settings.py`

```python

UNCLEBOB_NO_DATABASE = True

```

# other aspects

## 1. it provides an environment variable, so that you'll know when unclebob is running

When unclebob is running tests, it sets the environment variable

 `UNCLEBOB_RUNNING` to the current working directory.

You can use it, for example, in your codebase fr avoiding logging

during the tests.

# Motivation

[nose](http://code.google.com/p/python-nose/) is such a really nice

tool for writting tests on python.

Instead of using the unittest framework, which is builtin python thou

is less fun to use.

And you know, the most joyable is the writting/running test

experience, more developers will write tests for the project. And as

much tests, better.

# Naming

This project was named after [Uncle Bob Martin](http://en.wikipedia.org/wiki/Robert_Cecil_Martin),

one of the [agile manifesto](http://agilemanifesto.org/) chaps that

brought code cleaness techniques and advices to the rest of us.