Mailing-List: contact harmony-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: harmony-dev@incubator.apache.org
Received-SPF: pass (asf.osuosl.org: domain of mark.hindess@googlemail.com
 designates 64.233.166.182 as permitted sender)
DomainKey-Signature: a=rsa-sha1; q=dns; c=nofws;
        s=beta; d=googlemail.com;
        h=received:message-id:date:from:to:subject:in-reply-to:mime-version:content-type:content-transfer-encoding:content-disposition:references;
        b=ItVhnSIR8Gr9XeRA7qRgpBLJ8geok95Ynj1XprwJjwf6WvPTl7Lg8D3CC7ZOaga62/J7hSrYBAYfeCQQuq+ftLxdE5ngZoX++FprptUOCMA064kPpepE17VYQlp09UooU/f1Nok0ucv6w5nIdjhGud6xdVLOxSVKoYCaAYjEHTI=
Message-ID: <fcb9f9160603280509m4d1fbfb3hc1817271e876555d@mail.gmail.com>
Date: Tue, 28 Mar 2006 14:09:11 +0100
From: "Mark Hindess" <mark.hindess@googlemail.com>
To: harmony-dev@incubator.apache.org
Subject: Re: Regression tests (was: svn commit: r389475 - in
 /incubator/harmony/enhanced/classlib/trunk/modules/text/src:
 main/java/java/text/SimpleDateFormat.java
 test/java/tests/api/java/text/SimpleDateFormatTest.java)
In-Reply-To: <442929C2.5080109@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline
References: <6e47b64f0603280346u3dc491edp8f06bacdbd04c626@mail.gmail.com>
	 <442929C2.5080109@gmail.com>

I'm not convinced.

Having the JIRA reference for non-contentious tests - such as an API
test that passes on the reference implementation - seems a little
redundant since no one will ever bother to look it up.  If a test was
contentious then I'd rather see a brief summary/explanation with the
code (perhaps referencing the JIRA) than to have only the JIRA
reference.  Having just the JIRA reference seems like a poor shortcut for
the important cases and needless clutter for the rest.

If we really need the information later it is in the svn log anyway?=20
For instance, I just did:

bash$ svn blame \
  modules/text/src/test/java/tests/api/java/text/SimpleDateFormatTest.java|=
 \
  grep test_equals_afterFormat
389475   tellison     public void test_equals_afterFormat() {
bash$ svn log -r 389475
------------------------------------------------------------------------
r389475 | tellison | 2006-03-28 11:56:21 +0100 (Tue, 28 Mar 2006) | 2 lines

Fix for HARMONY-209 (java.text.SimpleDateFormat.equals() behavior is
not compatible with RI)

------------------------------------------------------------------------

Granted it gets a little more difficult over time, but the svn log
doesn't go missing or get deleted accidentally, forgottent, etc.  I
prefer to let
the version control system store this kind of metadata (since that is
what it is intended for) rather than cluttering the code with it.


Regards,
 Mark.

On 3/28/06, Tim Ellison <t.p.ellison@gmail.com> wrote:
> Yep, I agree this is a good convention. I missed it here but will go and
> fix it.
>
> Thanks
> Tim
>
> Stepan Mishura wrote:
> > Hi,
> >
> > We agreed some time ago to mark regression tests with comments that inc=
ludes
> > a reference to JIRA issue.
> >  There were no objections and I believe this is the good rule so I'd li=
ke to
> > ask everybody to follow it.
> > I've update testing wiki page to fix this agreement (see
> > http://wiki.apache.org/harmony/Testing_Convention)
> >
> > Thanks,
> > Stepan.

--
Mark Hindess <mark.hindess@googlemail.com>
IBM Java Technology Centre, UK.