You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by robert burrell donkin <ro...@blueyonder.co.uk> on 2003/09/28 11:57:10 UTC

[digester] add examples build to tests...?

i'm in favour of adding compiling the examples as part of the tests. (it'd 
be even better to have some unit tests for them, maybe as example unit 
tests for newbie developers)

rationale: there's nothing worse when trying to learn a new library than 
mistakes in the examples.

the only downside (that i can think of) is that people may need to convert 
relative to absolute paths in their build.properties file (or we come up 
with something clever...).

comments?

- robert


Re: [digester] add examples build to tests...?

Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
On Sunday, September 28, 2003, at 11:06 AM, Simon Kitching wrote:

> On Sun, 2003-09-28 at 21:57, robert burrell donkin wrote:
>> i'm in favour of adding compiling the examples as part of the tests. (it'
>> d
>> be even better to have some unit tests for them, maybe as example unit
>> tests for newbie developers)
>>
>> rationale: there's nothing worse when trying to learn a new library than
>> mistakes in the examples.
>>
>> the only downside (that i can think of) is that people may need to 
>> convert
>> relative to absolute paths in their build.properties file (or we come up
>> with something clever...).
>>
>> comments?
>
> +1 to compiling the examples as part of the tests.
>
> I think there needs to be a way to compile the examples without
> compiling the tests, though, because many users of Digester won't have
> junit.jar installed, and won't know what all the test output means.

i wasn't proposing to remove the ability to compile the examples, just to 
add the compilation of the examples as a test. the idea would be that if 
the examples failed to compile then the digester test target would fail.

> It would be great to have the tests actually verify that the examples
> work. Not sure how that could be done, though.

i was thinking that maybe it would be useful to have a simple example of a 
unit testing for each example. i often ask digester users and developers 
to submit unit tests. it would be cool to have a couple of simple examples 
of unit tests - with comments - that they can take a look at since the 
digester unit tests are long and complicated.

IIRC you're looking to develop your unit testing skills, this might be a 
good place to start. i'd be glad to point you in the right direction if 
you fancy volunteering.

- robert


Re: [digester] add examples build to tests...?

Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
On Sunday, September 28, 2003, at 11:06 AM, Simon Kitching wrote:

> On Sun, 2003-09-28 at 21:57, robert burrell donkin wrote:
>> i'm in favour of adding compiling the examples as part of the tests. (it'
>> d
>> be even better to have some unit tests for them, maybe as example unit
>> tests for newbie developers)
>>
>> rationale: there's nothing worse when trying to learn a new library than
>> mistakes in the examples.
>>
>> the only downside (that i can think of) is that people may need to 
>> convert
>> relative to absolute paths in their build.properties file (or we come up
>> with something clever...).
>>
>> comments?
>
> +1 to compiling the examples as part of the tests.
>
> I think there needs to be a way to compile the examples without
> compiling the tests, though, because many users of Digester won't have
> junit.jar installed, and won't know what all the test output means.

i wasn't proposing to remove the ability to compile the examples, just to 
add the compilation of the examples as a test. the idea would be that if 
the examples failed to compile then the digester test target would fail.

> It would be great to have the tests actually verify that the examples
> work. Not sure how that could be done, though.

i was thinking that maybe it would be useful to have a simple example of a 
unit testing for each example. i often ask digester users and developers 
to submit unit tests. it would be cool to have a couple of simple examples 
of unit tests - with comments - that they can take a look at since the 
digester unit tests are long and complicated.

IIRC you're looking to develop your unit testing skills, this might be a 
good place to start. i'd be glad to point you in the right direction if 
you fancy volunteering.

- robert


---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Re: [digester] add examples build to tests...?

Posted by Simon Kitching <si...@ecnetwork.co.nz>.
On Sun, 2003-09-28 at 21:57, robert burrell donkin wrote:
> i'm in favour of adding compiling the examples as part of the tests. (it'd 
> be even better to have some unit tests for them, maybe as example unit 
> tests for newbie developers)
> 
> rationale: there's nothing worse when trying to learn a new library than 
> mistakes in the examples.
> 
> the only downside (that i can think of) is that people may need to convert 
> relative to absolute paths in their build.properties file (or we come up 
> with something clever...).
> 
> comments?

+1 to compiling the examples as part of the tests.

I think there needs to be a way to compile the examples without
compiling the tests, though, because many users of Digester won't have
junit.jar installed, and won't know what all the test output means.

It would be great to have the tests actually verify that the examples
work. Not sure how that could be done, though.

Simon


Re: [digester] add examples build to tests...?

Posted by Simon Kitching <si...@ecnetwork.co.nz>.
On Sun, 2003-09-28 at 21:57, robert burrell donkin wrote:
> i'm in favour of adding compiling the examples as part of the tests. (it'd 
> be even better to have some unit tests for them, maybe as example unit 
> tests for newbie developers)
> 
> rationale: there's nothing worse when trying to learn a new library than 
> mistakes in the examples.
> 
> the only downside (that i can think of) is that people may need to convert 
> relative to absolute paths in their build.properties file (or we come up 
> with something clever...).
> 
> comments?

+1 to compiling the examples as part of the tests.

I think there needs to be a way to compile the examples without
compiling the tests, though, because many users of Digester won't have
junit.jar installed, and won't know what all the test output means.

It would be great to have the tests actually verify that the examples
work. Not sure how that could be done, though.

Simon


---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org