Javadoc in sca/itest

[Brian Murray <br...@gmail.com>]

 I'd like to take a crack at expanding the Javadoc in the sca itests, and
I'd like some feedback on the benefit and conventions of doing so.

I've noticed that the Javadoc in the sca/itests could be enhanced (or in
many cases is absent altogether). Javadoc seems to me a great way to
document the intent of the test cases.  Including the package.html and
overview.html files will allow a single source of documentation.  This will
allow us to more easily assess test coverage of concepts (rather than merely
API's).

As for javadoc conventions:

I'd like to add javadoc to the src/test subdirectories.  This is where we
would document the scenario being tested.  (e.g. Attempt to locate a service
with an invalid name.)

I'd like to add javadoc to the src/main subdirectories to describe the
requirements on the services (e.g.  This must be a composite within a
composite....) for the test case scenario to be achieved.

Please let me know if you'd like me to add or subtract from the above.

Re: Javadoc in sca/itest

[haleh mahbod <hm...@gmail.com>]

Hi,
Javadoc for iTests will help clearify what is there or missing and help the
reader to better understand the tests.  I went through itests once to try to
figure out what is missing and how I can potentially contribute. I did not
get too far.

Venu, your idea of 'how to create & configure a new itest module or what are
itests' are things that can be covered in the development guide. There is
already a 'test' section in this guide that seems to be a bit out dated. [1]

http://incubator.apache.org/tuscany/sca-java-development-guide.html#SCAJavaDevelopmentGuide-Testing

Just a suggestion..

Haleh

On 8/16/07, venu reddy <ve...@gmail.com> wrote:
>
> Hi Brian,
> That will be a boon to developers who want's to get started with
> integration
> tests. In addition  we can also have brief documentation about itests
> itself
> or FAQ about itest.  Few things those can be included are What are
> itests?,
> How to create &configure a new itest module? so that surefire plugin can
> execute the tests successfully.
> Thanks,
> Venu.
>
>
>
> On 8/16/07, Brian Murray <br...@gmail.com> wrote:
> >
> > I'd like to take a crack at expanding the Javadoc in the sca itests, and
> > I'd like some feedback on the benefit and conventions of doing so.
> >
> > I've noticed that the Javadoc in the sca/itests could be enhanced (or in
> > many cases is absent altogether). Javadoc seems to me a great way to
> > document the intent of the test cases.  Including the package.html and
> > overview.html files will allow a single source of documentation.  This
> > will
> > allow us to more easily assess test coverage of concepts (rather than
> > merely
> > API's).
> >
> > As for javadoc conventions:
> >
> > I'd like to add javadoc to the src/test subdirectories.  This is where
> we
> > would document the scenario being tested.  (e.g. Attempt to locate a
> > service
> > with an invalid name.)
> >
> > I'd like to add javadoc to the src/main subdirectories to describe the
> > requirements on the services (e.g.  This must be a composite within a
> > composite....) for the test case scenario to be achieved.
> >
> > Please let me know if you'd like me to add or subtract from the above.
> >
>
>
>
> --
>
> -----------------------------------------------------------------------------------------------------
> A 'wish' changes nothing. A 'decision' changes everything! ---- Anon
> Even if you're on the right track, you'll get run over if you just sit
> there.---- Will Rogers
>

Re: Javadoc in sca/itest

[venu reddy <ve...@gmail.com>]

Hi Brian,
That will be a boon to developers who want's to get started with integration
tests. In addition  we can also have brief documentation about itests itself
or FAQ about itest.  Few things those can be included are What are itests?,
How to create &configure a new itest module? so that surefire plugin can
execute the tests successfully.
Thanks,
Venu.



On 8/16/07, Brian Murray <br...@gmail.com> wrote:
>
> I'd like to take a crack at expanding the Javadoc in the sca itests, and
> I'd like some feedback on the benefit and conventions of doing so.
>
> I've noticed that the Javadoc in the sca/itests could be enhanced (or in
> many cases is absent altogether). Javadoc seems to me a great way to
> document the intent of the test cases.  Including the package.html and
> overview.html files will allow a single source of documentation.  This
> will
> allow us to more easily assess test coverage of concepts (rather than
> merely
> API's).
>
> As for javadoc conventions:
>
> I'd like to add javadoc to the src/test subdirectories.  This is where we
> would document the scenario being tested.  (e.g. Attempt to locate a
> service
> with an invalid name.)
>
> I'd like to add javadoc to the src/main subdirectories to describe the
> requirements on the services (e.g.  This must be a composite within a
> composite....) for the test case scenario to be achieved.
>
> Please let me know if you'd like me to add or subtract from the above.
>



-- 
-----------------------------------------------------------------------------------------------------
A 'wish' changes nothing. A 'decision' changes everything! ---- Anon
Even if you're on the right track, you'll get run over if you just sit
there.---- Will Rogers