Polish the crap out of SimpleTest module [#212351]

If we want to use this as a required tool for the D7 release cycle (which I think we ought to), then we need the code in both the module and the tests themselves clean enough that you could eat off of them. Our goal should be nothing less than core-worthy code (even though obviously we don't want to make this module part of core ;)).

This is going to be my #1 priority for the next while: coding standards compliance, bountiful comments, consistency, and so on. I want to make it as simple as possible for a new developer who's never heard of SimpleTest to dig in and start being productive.

I apologize in advance for the forthcoming pedantic patches that will be coming, which include:

It's "SimpleTest," not "Simpletest" or "simpletest".
We need clearer, more detailed, and corrected/updated documentation pretty much everywhere.
Coding standards compliance for both SimpleTest module and all tests.

Comment	File	Size	Author
#4	simpletest_code_style.patch	216.94 KB	cwgordon7
#4

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

Rok Žlender CreditAttribution: Rok Žlender commented 28 January 2008 at 08:34

+10 :) you will have to watch me, my eyes usually don't notice the diff between "". or "" . and stuff like that. Can we even tweak coder module to scan .test files.

Comment #2

vladimir.dolgopolov CreditAttribution: vladimir.dolgopolov commented 5 March 2008 at 11:55

My 10 cents for new deweloper's sake:

I suggest to add more helper methods in SimpleTest for common uses cases.

I suggest add a parameter to this (and existed) methods to avoid a lots of asserts' output messages. If I test only page creation I wish to hide messages of sucessful user login and so on.

PS. SimpleTest is awesome

Comment #3

cwgordon7 CreditAttribution: cwgordon7 commented 6 March 2008 at 19:24

+11 :) Perhaps run the whole thing through coder format?

Comment #4

cwgordon7 CreditAttribution: cwgordon7 commented 7 March 2008 at 16:54

File	Size
simpletest_code_style.patch	216.94 KB

Initial code style patch

Comment #5

KentBye CreditAttribution: KentBye commented 7 March 2008 at 19:41

Boombatower and I were looking at this during the code sprint, and created a sub-issue related to this for finding a consistent naming convention for the *.test files: http://drupal.org/node/231348

Comment #6

catch

he/him

English

CreditAttribution: catch commented 9 March 2008 at 23:26

Status:

Active

» Needs review

Comment #7

boombatower CreditAttribution: boombatower commented 10 March 2008 at 00:31

Do we want comment blocks for the file that contain test description and author?

Comment #8

cwgordon7 CreditAttribution: cwgordon7 commented 10 March 2008 at 01:20

I just removed them to standardize things. But I also think it is not good practice to credit yourself after you write a simpletest.

Comment #9

catch

he/him

English

CreditAttribution: catch commented 10 March 2008 at 12:34

We should see tests being created as patches to core soon, so credits will probably happen via the commit log. Nice to have a description of the test somewhere though.

Comment #10

boombatower CreditAttribution: boombatower commented 14 March 2008 at 23:37

After reviewing community ideas and talking with chx and Rok Žlender we have agreed upon the last convention and I have written a script to correctly name the tests.

I started a discussion about coding standards and group convention.