pyspec

New Post: tearDown example

gorshing — Sat, 30 Aug 2008 01:58:55 GMT

You have done a pretty good job at showing some basic examples to get people's feet wet. But I think you need to show the @spec_finalize and possibly @class_finalize in either the Usage or Tutorial pages as this will be their first impression and I would assume this will be one of their first questions is how to tear down.

Just a thought.

Source code checked in

shibu — Tue, 11 Mar 2008 17:16:39 GMT

bug fix * error when wxpython was not installed * error when specs were ran on PyScripter

UPDATED WIKI: Home

JerrySeutter — Wed, 05 Mar 2008 04:56:53 GMT

Japanese

Description

PySpec is a Behavior Driven Development Framework for Python. If this means nothing to you, see this uninteresting explanation of Behavior Driven Development.

PySpec has some notable features which include:

Many tools to help verify results
Concise, informative error messages
Uses decorators to define specifications
Data driven tests: test(@data_provider)
Includes Mock Object functionality
CLI & GUI spec runners (wxPython)
Support for running pyunit test cases within PySpec's specs

Wiki Contents

Core documentation

Experimental documentation

Other documentation

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

UPDATED WIKI: Home

JerrySeutter — Wed, 05 Mar 2008 04:54:11 GMT

Japanese

Description

Many tools to help verify results.
Concise, informative error messages.
Uses decorators to define specifications
Data driven tests: test(@data_provider).
Includes Mock Object functionality.
CLI & GUI spec runners (wxPython)
Support for running pyunit test cases within PySpec's specs

Wiki Contents

Fundamental

Experimental

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

UPDATED WIKI: Home

JerrySeutter — Wed, 05 Mar 2008 04:51:40 GMT

Japanese

Project Description

Many tools to help verify results.
Concise, informative error messages.
Uses decorators to define specifications
Data driven tests: test(@data_provider).
Includes Mock Object functionality.
CLI & GUI spec runners (wxPython)
Support for running pyunit test cases within PySpec's specs

Wiki Contents

Fundamental

Experimental

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

UPDATED WIKI: Home

JerrySeutter — Wed, 05 Mar 2008 04:48:13 GMT

Japanese

Project Description

PySpec is a Behavior Driven Development Framework for Python. If this means nothing to you, see this uninteresting explanation of Behavior Driven Development.

PySpec has following specialty.

Many kind of verification methods.
More concrete error messages.
Use decorators to define spec.
Data driven test(@data_provider).
Mock Objects included.
CUI & GUI spec runner(wxPython)
Support running pyunit test cases with PySpec's specs

Wiki Contents

Fundamental

Experimental

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

UPDATED WIKI: Home

JerrySeutter — Wed, 05 Mar 2008 04:45:31 GMT

Japanese

Project Description

PySpec is a Behavior Driven Development Framework for Python. If this means nothing to you, check out this very uninteresting http://behaviour-driven.org/ explanation of Behaviour Driven Development.

PySpec has following specialty.

Many kind of verification methods.
More concrete error messages.
Use decorators to define spec.
Data driven test(@data_provider).
Mock Objects included.
CUI & GUI spec runner(wxPython)
Support running pyunit test cases with PySpec's specs

Wiki Contents

Fundamental

Experimental

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

Source code checked in

shibu — Thu, 28 Feb 2008 15:44:50 GMT

* Fix CUI Runner ** Fix --encode ** Fix --version * Add localization support(English and Japanese) You can change error messages. $ python behavior_some.py --language ja --encode ShiftJIS If you want to add your own language, see pyspec/embedded/languages folder

UPDATED RELEASE: PySpec 0.54

Sat, 23 Feb 2008 08:17:19 GMT

! Version 0.54(2008/03/12)

* Support for doctest on PySpec
* Error message localization
* Fix GUI runner
** Support legacy testing
** Fix many part of the code

UPDATED WIKI: Home_jp

shibu — Fri, 22 Feb 2008 12:25:33 GMT

プロジェクト概要

PySpecはPython用のビヘイビア(振る舞い)駆動開発フレームワークです。

PySpecは以下のような特徴があります。

豊富な検証メソッド
わかりやすいエラーメッセージ
デコレータを使用した仕様の宣言
データ駆動のテスト(@data_provider)
モックオブジェクトを搭載
CUI & GUIのテストランナープログラム(wxPythonを利用)
pyunitのテストケースも実行可能

Wikiの目次

基本機能

実験的な機能

その他

なぜPySpecはこんなにファイルサイズが大きいの？(英語)

サンプルコード

def add2(input):
  """2を足します"""
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    """add2関数に3を渡す"""
    self.result = add2(3)
 
  @spec
  def should_return_5(self):
    """返り値は5になる"""
    About(self.result).should_equal(5)

この仕様を実行すると以下のように出力されます:

add2関数に3を渡す
  - 返り値は5になる - OK

UPDATED WIKI: Home_jp

shibu — Fri, 22 Feb 2008 12:24:43 GMT

プロジェクト概要

PySpecはPython用のビヘイビア(振る舞い)駆動開発フレームワークです。

PySpecは以下のような特徴があります。

豊富な検証メソッド
わかりやすいエラーメッセージ
デコレータを使用した仕様の宣言
データ駆動のテスト(@data_provider)
モックオブジェクトを搭載
CUI & GUIのテストランナープログラム(wxPythonを利用)
pyunitのテストケースも実行可能

Wikiの目次

基本機能

実験的な機能

その他

なぜPySpecはこんなにファイルサイズが大きいの？(英語)

サンプルコード

def add2(input):
  """2を足します"""
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    """add2関数に3を渡す"""
    self.result = add2(3)
 
  @spec
  def should_return_5(self):
    """返り値は5になる"""
    About(self.result).should_equal(5)

この仕様を実行すると以下のように出力されます:

add2関数に3を渡す
  - 返り値は5になる - OK

CREATED RELEASE: PySpec 0.54

Fri, 22 Feb 2008 12:08:15 GMT

! Version 0.54(2008/03/12)

* Support for doctest on PySpec
* Fix GUI runner
** Support legacy testing
** Fix many part of the code

UPDATED RELEASE: PySpec 0.53 (2 22, 2008)

Fri, 22 Feb 2008 12:01:19 GMT

! Version 0.53

* Support for writing specs of legacy code.
** {{About().should_not_be_changed()}}
** {{pyspec.legacy_code.test_proxy()}}

These functions helps you to write specs of existing systems that have no tests.
These functions record the objects behavior. Exist program become specs.

* Support function for finding bugs.
** dprint()

This function is used for finding bugs. It's args format is similar to print() of Python3000.
It shows the file name and the expression and the value.

Source code checked in

shibu — Fri, 22 Feb 2008 12:00:20 GMT

0.53 released.

UPDATED WIKI: Legacy Code Testing

shibu — Fri, 22 Feb 2008 11:54:00 GMT

PySpec Legacy Code Test Guide

Author	Shibukawa Yoshiki
Contact	yoshiki at shibu.jp
Copyright	This document has been placed in the public domain.

Reference

About('actual value').should_not_be_changed()
test_proxy()

Usage

Reset History
Show History

Sample Code

Story
1st Step
2nd Step
3rd Step
4th Step

This feature is experimental.

This sample file is pyspec/sample/sample_dbc.py.

Reference

About('actual value').should_not_be_changed()

This method is used for assertion not to change the value.
When you would run tests at first, PySpec would record the
value and the spec's result would become 'ignored'.
After that, the recorded value will be used for checking
the value.

sample:

from pyspec.embedded import *
from pyspec.embedded.dbc import DbCobject, DbC
 
class Behavior_CARDatabase():
    @spec
    def You_should_be_able_to_see_power(self):
        G37 = CARDatabase.get("G37")
        # if change the result, this spec will fail
        About(G37.get_power()).should_not_be_changed()

If you change the module name or the class name or the spec name or
the expression in About() , PySpec can't find the recorded values.
So the spec always become 'ignored' and records the value whenever
you change these names/expressions.

Option	Description
reset=False	If this parameter is True, PySpec reset the record.

test_proxy()

This function is defined at pyspec.legacy_code .

This function creates proxy object and wraps the target object in the proxy.
At first you call the function of the target object through this proxy,
a history of function calls would be recorded and the spec would be 'ignored'
(neither success nor fail). Next time you run spec, PySpec verifies the
function calls.

This function is useful for checking the source code is not broken during
refactoring/enhancing activities.

Option	Description
target_object	The object you want to
hook_methods=[]	The method name list you want to record(default=all methods)
runtime_option=None	This is backdoor for testing PySpec itself(see behavior_pyspec_legacy_code.py )
check_return=True	This flag controls that PySpec verifies return values or doesn't
check_args=True	This flag controls that PySpec verifies method arguments or doesn't

sample:

@spec
def check_log_value():
    log = StringIO.StringIO()
    log = test_proxy(log) # create log proxy
    write_log(log)
 
def write_log(log):
    log.write(name())   # recording/verifying ``write()`` method call
    log.write(score())  # recording/verifying ``write()`` method call

Usage

You can control these features in command line. It's important to use them.

Option	Description
-r, --reset-legacy-data	Reset the all recorded values.
--show-legacy-data	Show the function call history in reST format.

Reset History

After big refactoring, the behavior of your code wouldn't match the record.
In this case, these specs would be failed every time. If your other specs have
passed, you should reset the history. The new behavior after the refactoring
becomes new code navigator.

Show History

The history record of your code is good information to analyze it.
You can see the history whenever you want.

Sample Code

There is a sample of legacy support function. See sample/rst2codeplex .
If you want to run this sample, you need to install docutils .

Story

Create new program from existing source code. New program generates
CodePlex wiki format from reStructuredText. To create it, you use
the docutils/writer/html4css1 module.

Actually, docutils is well tested product. But in this sample,
it was treated as legacy product (that had no tests).

1st Step

At first, you need to find entry point. It's important step.
If there is no entry point, you have to create or modify it.
Docutils has useful function publish_string() .
This sample uses the function.

If you create it, DI or some technology help you.
Actually, you should create the entry point after running
the first spec and fail (It's basic rule of TDD).

2nd Step

You would write two specs. One is a basic style spec. And another spec uses
the legacy code support method. Of course you can put together these methods.
But you shouldn't do that. These methods have there own roles.

spec:

class Behavior_rst2codeplex(object):
    source_title = """
==========
Test Title
==========
"""
 
    @context(group=1)
    def Title_source(self):
        self.result = publish_string(self.source_title, writer_name="codeplex",
                writer=Writer(translator=CodePlexTranslator))
 
    @spec(group=1)
    def can_convert_to_wiki1(self):
        About(self.result).should_include("! Test Title")
 
    @context(group=2)
    def Method_calls_in_createing_title(self):
        def TranslatorWithProxy(document):
            translator = CodePlexTranslator(document)
            return test_proxy(translator, check_return=False)
        self.writer = Writer(translator=TranslatorWithProxy)
 
    @spec(group=2)
    def should_not_changed_for_title(self):
        print publish_string(self.source_title, writer_name="codeplex",
                writer=self.writer)

3rd Step

If you run this spec, the result would become fail. Copy
docutils/writer/html4css1 into your workspace and rename it.

Before	After
__init__.py	rst2codeplex.py
HTMLTranslator	CodePlexTranslator

After initialize steps, you can run these specs again.
If errors become failures, you can see the function call history record:

$ python behavior_rst2codeplex.py --show-legacy-data
 
method: method_call_should_not_changed_for_title
================================================
 
dispatch_visit(<document ids="test-title" names="test\ title" source="<string>" title="Test Title"><title>Test Title</title></document>)
dispatch_visit(<title>Test Title</title>)
dispatch_visit(Test Title)
dispatch_departure(Test Title)
dispatch_departure(<title>Test Title</title>)
dispatch_departure(<document ids="test-title" names="test\ title" source="<string>" title="Test Title"><title>Test Title</title></document>)
astext()

From this information and the source code, you can understand the function
visit_title() creates the title string. After modifying the part of
the method, the first spec would pass and second spec would fail.
This legacy support refers old code behavior. So if the behavior is changed
after refactoring or modification, this spec may be fail.

rst2codeplex.py :

elif isinstance(node.parent, nodes.document):
    self.body.append('! ')
    self.context.append('\n\n')
    self.in_document_title = len(self.body)

4th Step

Now, you watched the first spec was passed.
You reset the old function call history record:

$ python behavior_rst2codeplex.py --reset-legacy-data

The second spec refers new behavior. This spec can detect unexpected part
of the code base was broken or not. It is one of insurance.
If you repeat 2nd step-4th step, you will have many normal style specs and
you can throw these insurance into a trash box.

UPDATED WIKI: Home

shibu — Fri, 22 Feb 2008 11:46:30 GMT

Japanese

Project Description

PySpec is the Behavior Driven Development Framework for Python.

PySpec has following specialty.

Many kind of verification methods.
More concrete error messages.
Use decorators to define spec.
Data driven test(@data_provider).
Mock Objects included.
CUI & GUI spec runner(wxPython)
Support running pyunit test cases with PySpec's specs

Wiki Contents

Fundamental

Experimental

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

UPDATED WIKI: Home_jp

shibu — Thu, 21 Feb 2008 22:39:08 GMT

プロジェクト概要

PySpecはPython用のビヘイビア(振る舞い)駆動開発フレームワークです。

PySpecは以下のような特徴があります。

豊富な検証メソッド
わかりやすいエラーメッセージ
デコレータを使用した仕様の宣言
データ駆動のテスト(@data_provider)
モックオブジェクトを搭載
CUI & GUIのテストランナープログラム(wxPythonを利用)
pyunitのテストケースも実行可能

Wikiの目次

基本機能

実験的な機能

Design by Contract(英語)

その他

なぜPySpecはこんなにファイルサイズが大きいの？(英語)

サンプルコード

def add2(input):
  """2を足します"""
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    """add2関数に3を渡す"""
    self.result = add2(3)
 
  @spec
  def should_return_5(self):
    """返り値は5になる"""
    About(self.result).should_equal(5)

この仕様を実行すると以下のように出力されます:

add2関数に3を渡す
  - 返り値は5になる - OK

UPDATED WIKI: Home

shibu — Thu, 21 Feb 2008 22:29:54 GMT

Japanese

Project Description

PySpec is the Behavior Driven Development Framework for Python.

PySpec has following specialty.

Many kind of verification methods.
More concrete error messages.
Use decorators to define spec.
Data driven test(@data_provider).
Mock Objects included.
CUI & GUI spec runner(wxPython)
Support running pyunit test cases with PySpec's specs

Wiki Contents

Fundamental

Experimental

Design by Contract

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.

CREATED RELEASE: PySpec 0.53

Thu, 21 Feb 2008 22:22:58 GMT

UPDATED WIKI: Home

shibu — Thu, 21 Feb 2008 17:13:00 GMT

Project Description
Behavior Driven Development Framework for Python.

PySpec has following specialty.

* Many kind of verification methods.
* More concrete error messages.
* Use decorators to define spec.
* Data driven test(@data_provider).
* Mock Objects included.
* CUI & GUI spec runner(wxPython)

Wiki Contents

Fundamental

Experimental

Design by Contract

Other

Why is PySpec so Fat?

Sample Code

def add2(input):
  return input + 2
 
class add2_Behavior(object):
  @context
  def Function_add2_whose_input_is_3(self):
    self.result = add_2(3)
 
  @spec
  def should_return_5(self):
    About(self.result).should_equal(5)

Then, if you run test, you would get the following result:

Function add2 whose input is 3
  - should return 5 - OK

I am not a native english speaker. Please give me more suitable word than About.