PHPSpec Reporting Gets A Needed Boost

PHPSpec is closing in on its first stable release, so the time had finally come to spruce up its output! No more the simple reporting of failed specs - now you get a few more details in a readable format, exceptions and errors even come with traces. In addition, I've implemented specdoc output as an option (using "-s") so you can get a list of specs in their plain text form.

I've pasted in a copy of the output from a real PHPSpec run and added a few issues to show how they are output. I've been writing some experimental source code for a possible Mock Object framework in PHP (see last blog entry), so I used PHPSpec to apply Behaviour-Driven Development in its development. You can read the actual spec files over at http://phpmock.googlecode.com/svn/branches/padraic/specs/.

PHPSpec development snapshots have been updated on http://dev.phpspec.org, which also hosts the manual being written (HTML).

$ phpspec -rs



EE..................................................P..



Finished in 0.334152936935 seconds



p h p mock method expectations

  -should expect each method exactly once unless otherwise specified (ERROR)

  -should throw default exception if method call count is unexpected (EXCEPTION)

  -should expect number of methods in times term

  -should return self from times term invocation

  -should set return value in terms and default to returning value for all calls

  -should return values in order of setting but return last value remaining on other calls

  -should return self from return term invocation

  -should set expected args using with term

  -should return self from with term invocation

  -should allow no calls for zeroormoretimes term

  -should allow one call with once term

  -should throw exception if less than once using once tern

  -should throw exception if greater than once using once term

  -should return self instance from once term

  -should allow two calls with twice term

  -should throw exception if less than twice using twice term

  -should throw exception if greater than twice using twice term

  -should return self instance from twice term

  -should allow no calls with never term

  -should throw exception if any call after never term

  -should return self instance from never term

  -should allow any calls for zeroormoretimes term

  -should allow zero calls for zeroormoretimes term

  -should return self instance from zeroormoretimes term

  -should set times minimum with once using atleast term

  -should set times minimum with times using atleast term

  -should throw exception if less than minimum using atleast term

  -should return self instance from atleast term

  -should set times maximum with once using atmost term

  -should set times maximum with times using atmost term

  -should throw exception if more than twice using twice term

  -should return self instance from atmost term

  -should allow any args using withanyargs term

  -should return self instance from withanyargs term

  -should disallow args using withnoargs term

  -should return self instance from withnoargs term

  -should obey ordering via sequence of ordered term calls

  -should disallow method calling if method has specified order

  -should allow method calling of unordered expectations in any order

  -should return self instance from ordered term

  -should throw specified exception using andthrow term

  -should throw specified exception with message using andthrow term

  -should throw exception if class passed to andthrow term not an exception

  -should return self instance from andthrow term

p h p mock

  -should create mock inheriting class type from original

  -should create mock inheriting type if original an interface

  -should create mock with specified name

  -should create stub from an array of methods and return values

  -should throw exception if class is final

  -should throw exception if class does not exist

  -should not throw class not exists exception if an interface

  -should mock all allowed public methods which do nothing since mocked

  -should mock public static methods which do nothing since mocked (PENDING)

  -should retain method parameter definitions in mocks

  -should return true on validation by default if no expectations set





55 examples, 0 failures, 1 error, 1 exception, 1 pending

Errors:



1)

'p h p mock method expectations should expect each method exactly once unless otherwise specified' ERROR

exception 'PHPSpec_Runner_ErrorException' with message 'more bad stuff happenin'' in /user/opt/projects/phpmock/specs/PHPMockMethodExpectationsSpec.php:19

Stack trace:

#0 [internal function]: PHPSpec_ErrorHandler(1024, 'more bad stuff ...', '/user/opt/...', 19, Array)

#1 /user/opt/projects/phpmock/specs/PHPMockMethodExpectationsSpec.php(19): trigger_error('more bad stuff ...')

#2 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Example.php(81): DescribePHPMockMethodExpectations->itShouldExpectEachMethodExactlyOnceUnlessOtherwiseSpecified()

#3 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Collection.php(73): PHPSpec_Runner_Example->execute()

#4 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Base.php(51): PHPSpec_Runner_Collection->execute(Object(PHPSpec_Runner_Result))

#5 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Base.php(44): PHPSpec_Runner_Base->executeExamples()

#6 /user/opt/projects/phpspec/trunk/src/PHPSpec/Console/Command.php(82): PHPSpec_Runner_Base::execute(Object(PHPSpec_Runner_Collection), Object(PHPSpec_Ru

nner_Result))

#7 /user/opt/projects/phpspec/trunk/src/PHPSpec/Console/Command.php(125): PHPSpec_Console_Command::main()

#8 {main}



Exceptions:



1)

'p h p mock method expectations should throw default exception if method call count is unexpected' EXCEPTION

exception 'PHPSpec_Exception' with message 'no specification object created yet' in /user/opt/projects/phpspec/trunk/src/PHPSpec/Context.php:92

Stack trace:

#0 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Example.php(89): PHPSpec_Context->getCurrentSpecification()

#1 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Collection.php(73): PHPSpec_Runner_Example->execute()

#2 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Base.php(51): PHPSp

ec_Runner_Collection->execute(Object(PHPSpec_Runner_Result))

#3 /user/opt/projects/phpspec/trunk/src/PHPSpec/Runner/Base.php(44): PHPSpec_Runner_Base->executeExamples()

#4 /user/opt/projects/phpspec/trunk/src/PHPSpec/Console/Command.php(82): PHPSpec_Runner_Base::execute(Object(PHPSpec_Runner_Collection), Object(PHPSpec_Runner_Result))

#5 /user/opt/projects/phpspec/trunk/src/PHPSpec/Console/Command.php(125): PHPSpec_Console_Command::main()

#6 {main}



Pending:



1)

'p h p mock should mock public static methods which do nothing since mocked' PENDING

Static methods will need static handling

Posted by Pádraic Brady on Wednesday, November 14. 2007 at 14:27 in PHP General, PHP Security

Defined tags for this entry: bdd, behaviour-driven development, mock objects, php general, php security, phpmock, phpspec, tdd, unit testing

View as PDF: This entry | This month | Full blog
View as PDF: This entry | This month | Full blog

Trackbacks

Trackback specific URI for this entry

Pádraic Brady's Blog: PHPSpec Reporting Gets A Needed Boost
Pádraic Brady has made a few updates to the PHPSpec software ...

Weblog: PHPDeveloper.org
Tracked: Nov 14, 16:07

Comments

Display comments as (Linear | Threaded)

Chritopher Thompson says,

Wednesday, November 14. 2007 at 22:33 (Reply)

Hey Pádraic,

I looked through the docs, but I don't see how to run the specs with a the Runner rather than from the command line. I recall you saying that you were going to make it so you could just point it at a directory and it would run everything.

Christopher

PS - I may have a project to run PHPSpec throught its paces

Pádraic Brady says,

Wednesday, November 14. 2007 at 23:24 (Link) (Reply)

Hi Christopher,

I haven't gotten around to adding a file runner just yet. If you check the test coverage, the specific area of running tests is largely uncovered (it wasn't a major concern until the framework became useful). I'll likely refactor/rewrite the running system during tomorrow so you can have a file based runner (http) and command line runner (cli) which both share possible Reporters (current only plain text).

I think after that it's down to adding a few more matchers, and looking into better Exception expectations via the DSL, and it's ready for final review to an alpha or beta release of 0.2.0.

Any observations from a real project are immensely valuable - I started using it over the weekend for PHPMock (need Mock support in PHPSpec, in an independent form since it will likely be usable from PHPT and PHPUnit at a minimum). Any development since the weekend is now needs based - get any final badly needed functionality defined and implemented outside the usual XP process we're using.

Christopher Thompson says,

Thursday, November 15. 2007 at 21:42 (Reply)

Pádraic,

I am in the process of trying to resurrect a PHP5 version of the Skeleton framework. Given the disenchantment with Zend and other frameworks I figured I would bring back that code, which I had abandoned. The plan is lighter weight than the current frameworks and compatible so it is designed to use external components (e.g. Swift, Doctrine, Zend, etc.).

The frame had light SimpleTest coverage, but in the upgrade I tossed out a lot of the tests rather than try to upgrade. Which leaves me open to new ideas, but I do need a runner.

Also, have you given any thought to either a test scaffolding builder or something that would automate creating tests for existing classes? Could I help the project in any of these areas -- scaffolding, automation, runners?

Christopher

Pádraic Brady says,

Sunday, November 18. 2007 at 01:49 (Link) (Reply)

A few days behind my comment approval - sorry for the delay in approving and responding!

>I am in the process of trying to resurrect a PHP5 version of the
>Skeleton framework. Given the disenchantment with Zend and other
>frameworks I figured I would bring back that code, which I had
>abandoned. The plan is lighter weight than the current
>frameworks and compatible so it is designed to use external
>components (e.g. Swift, Doctrine, Zend, etc.).

I noticed an upsurge in ap3 posts to my SF lists folder

.

>The frame had light SimpleTest coverage, but in the upgrade I tossed out a
>lot of the tests rather than try to upgrade. Which leaves me open to new
>ideas, but I do need a runner.

As previously, it's upcoming. PHPSpec has a long list of goals and user stories with assigned weightings - the wall in front of me only has 7 post-its on PHPSpec so it's just a few days from implementation.

>Also, have you given any thought to either a test scaffolding builder or
>something that would automate creating tests for existing classes? Could I
>help the project in any of these areas -- scaffolding, automation,
>runners?

Scaffolding is something I want soon - but it bears discussion on what to implement for scaffolding. For example, I use post-its here to record user stories, which lead to plain text specifications stored in a local DB. So I need scaffolding to take in newline delimited output of specs in an agreed format, and generate base Specs which are all marked pending. On the otherside, having a class based scaffolder is likewise useful - a bit limited in that BDD is spec related, over method related.

If you want to contribute along these lines, even just what you need personally, you should post the proposal to the main mailing list so Travis has a chance to offer any comments. 0.2.0 will likely see an alpha release by end of November so there is room for some needs-based contributions to give PHPSpec a nice round sense of purpose for those considering using it.
http://groups.google.com/group/phpspec-dev

Note, any help is truly appreciated

. I'm not big on code ownership as the local tin god.

Christopher Thompson says,

Monday, November 19. 2007 at 16:07 (Reply)

Pádraic, I PM'd you as well. Let me know if I can help with the web based test runner. If you have a basic direction you want to go, I can run with that. As I said, I am looking for a system where you can create a index.php file that contains a few lines of PHPSpec code, put it in the top level of your tests directory, and it just works. I think if it was just dead simple it would be a major draw for PHPSpec.

Also, something that would create specs from existing classes just for coverage. I know it is backwards from you BDD intent, but again it would be a draw to get existing projects to use the tool.

Let me know ... feel free to email me directly.

Add Comment

Pádraic Brady about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Tue, 22.07.2008 13:55
I'll never deny an influence f rom rspec

- only the accusa tion that I'm motivated to re- implement Ruby because i [...]

Federico about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Tue, 22.07.2008 10:11
Looking at your example, the f irst thing that comes to my mi nd is RSpec: [geshi lang=ru by] # bowling_spec.rb [...]

Pádraic Brady about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Mon, 21.07.2008 11:15
The only change you made thoug h was to use a lamdba - it sti ll suffers from the same probl ems of being verbose, no [...]

Lars Strojny about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Sun, 20.07.2008 10:56
I'm not convinced if a DSL is the way to go. What about a re ally base class for BDD storie s. [geshi lang=php] [...]

Pádraic Brady about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Sat, 19.07.2008 00:21
Final clarification - the exte rnal DSL is not based on any e xisting language. Man, I will never mention Ruby in a [...]

Dougal Matthews about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Fri, 18.07.2008 23:50
If your going to change langua ge. Go for Python, I find it f ar superior to Ruby. By the way, I don't think decr [...]

Pádraic Brady about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Fri, 18.07.2008 20:44
And I misread you

. Sorry. The DSL is for BDD which pla ces an emphasis on intuitive p rediction - "equals" is [...]

Pádraic Brady about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Fri, 18.07.2008 20:17
PHP and Ruby are both general programming languages. The Zen d Framework and Ruby On Rails are both frameworks. I c [...]

Pádraic Brady about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Fri, 18.07.2008 20:04
Hi Vincent - == is the PHP equ ality comparison, just as === is for making an identical che ck. Plain old = is just [...]

Les about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Fri, 18.07.2008 19:10
Never been one to argue with y ou but you've just gone and co mpared PHP to Ruby which is a very load no no... Th [...]

Vincent about A Domain Specific Language for Behaviour Driven Development (BDD) in PHP
Fri, 18.07.2008 18:58
Hmm, why are you using "==" in stead of "equal"?

Justin about Google roll out OAuth Authorisation to all Google Data APIs
Wed, 16.07.2008 01:00
Crazy release time hasn't let me check it out again - but th anks for addressing those conc erns. It looks like tha [...]

Pádraic Brady about Google roll out OAuth Authorisation to all Google Data APIs
Tue, 01.07.2008 12:15
Hi Justin, Zend_Crypt_Hmac is available from the ZF Incub ator repository as it is not y et within Core. It does [...]

Justin about Google roll out OAuth Authorisation to all Google Data APIs
Tue, 01.07.2008 01:41
Hey, I'm trying to test out ba sed on the code you linked - b ut it looks like the Zend_Cryp t_Hmac package is not av [...]

Pádraic Brady about MIA from Planet PHP
Wed, 25.06.2008 17:21
Yes, I noticed. I haven't re-s ubmitted a request yet though. So they are still aggregating the posts I was refused [...]

PHPSpec Reporting Gets A Needed Boost

Maugrim The Reaper's Blog

License

Powered by

Syndicate This Blog

Planet PHP

Statistics

Calendar

Quicksearch

Comments

Categories

Archives

Top Referrers

Show tagged entries

PHPSpec Reporting Gets A Needed Boost

	July '08
Mo	Tu	We	Th	Fr	Sa	Su
	1	2	3	4	5	6
7	8	9	10	11	12	13
14	15	16	17	18	19	20
21	22	23	24	25	26	27
28	29	30	31