You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@creadur.apache.org by Gavin <ga...@16degrees.com.au> on 2009/12/12 11:59:32 UTC

RAT Summary Page (was: RE: RAT with BuildBot at Apache)

OK, so back to this RAT Summary I promised.

I have a working version at:

http://ci.apache.org/projects/rat-master-summary.html

Still a basic interface currently but before I went too much further it
would be great if I could get feedback (from David mainly I guess in regards
to Clutch)

What extra information does Clutch need to make it useful for it?

There are (as of writing) 3 projects up there, these are the only 3 projects
using RAT at Buildbot that is configured to output xml, the others all being
txt. I guess I should leave .txt outputs as an alternative but change the
default so that all participating projects output .xml instead. This way I
get to convert the output to a better html presentation and at the same time
get to grab the xml content for the master rat summary page.

One main hurdle was (and still is to a point) matching the output with the
project it belongs to. As separate reports it was not a problem that in fact
no reports contain the name of the project. As a combined summary however
this information is most vital. For now, as part of as xsl that grabs the
content from each report, it then wraps it in a new <project name="blah">
element so then that can be used to get the project name into the output in
the correct column.

A tiny bit of a workaround is in place in that the project names currently
are hard coded in the aforementioned wrapper, but that will soon be replaced
by a fancy looking grep/find/sed/whatever that will insert the project name
from the file path.

I will continue to improve and work on this over the next few days.

Gav...

> -----Original Message-----
> From: David Crossley [mailto:crossley@apache.org]
> Sent: Tuesday, 21 July 2009 10:03 AM
> To: rat-dev@incubator.apache.org
> Subject: Re: RAT with BuildBot at Apache
> 
> David Crossley wrote:
> > Gavin wrote:
> > >
> > > Ross' suggestion went on to say that perhaps Clutch could be extended
> by an
> > > extra column or two and state whether a project passes RAT and if not
> say
> > > how many files fail the RAT validation.
> > >
> > > Would this be a useful addition?
> >
> > Yes definitely.
> >
> > > If so I can get to work on it Buildbot end
> > > - all I need from you is where you want the results putting so that
> Clutch
> > > can use it, how you want it represented (.xml , .txt, .html) etc. I
> could
> > > for instance put it in svn somewhere, or perhaps Clutch could gather
> the
> > > results from a ci.apache.org/projects/rat-output/ location?
> >
> > As long as it is publicly accessible and in a structured format,
> > then Clutch can handle it. Even just a CSV file would work.
> >
> > Perhaps a summary file at ci.apache.org/projects/rat-output/summary.txt
> >
> > #projectId,numFailed
> > foo,12
> > bar,0
> >
> > So, for each podling, Clutch would see if it is in your list.
> > If "numFailed gt 0" then alert it.
> >
> > The table cell would link directly to each project's html RAT report.
> >
> > Prod me when you have something.
> 
> By the way, no need to wait until you have RAT reports for
> all incubator projects. If one is not in the buildbot list,
> then Clutch will just give it a "?" and orange alert colour.
> 
> -David
> No virus found in this incoming message.
> Checked by AVG - www.avg.com
> Version: 8.5.392 / Virus Database: 270.13.20/2249 - Release Date: 07/21/09
> 05:58:00


Re: RAT Summary Page (was: RE: RAT with BuildBot at Apache)

Posted by "Hyrum K. Wright" <hy...@mail.utexas.edu>.
On Dec 12, 2009, at 4:59 AM, Gavin wrote:

> OK, so back to this RAT Summary I promised.
> 
> I have a working version at:
> 
> http://ci.apache.org/projects/rat-master-summary.html

This looks great!

> Still a basic interface currently but before I went too much further it
> would be great if I could get feedback (from David mainly I guess in regards
> to Clutch)
> 
> What extra information does Clutch need to make it useful for it?
> 
> There are (as of writing) 3 projects up there, these are the only 3 projects
> using RAT at Buildbot that is configured to output xml, the others all being
> txt. I guess I should leave .txt outputs as an alternative but change the
> default so that all participating projects output .xml instead. This way I
> get to convert the output to a better html presentation and at the same time
> get to grab the xml content for the master rat summary page.

Perhaps in the html-ized version, you could have links directly to the offending files' content, rather than embedding it in the report.

> One main hurdle was (and still is to a point) matching the output with the
> project it belongs to. As separate reports it was not a problem that in fact
> no reports contain the name of the project. As a combined summary however
> this information is most vital. For now, as part of as xsl that grabs the
> content from each report, it then wraps it in a new <project name="blah">
> element so then that can be used to get the project name into the output in
> the correct column.
> 
> A tiny bit of a workaround is in place in that the project names currently
> are hard coded in the aforementioned wrapper, but that will soon be replaced
> by a fancy looking grep/find/sed/whatever that will insert the project name
> from the file path.
> 
> I will continue to improve and work on this over the next few days.

Thanks!

> 
> Gav...
> 
>> -----Original Message-----
>> From: David Crossley [mailto:crossley@apache.org]
>> Sent: Tuesday, 21 July 2009 10:03 AM
>> To: rat-dev@incubator.apache.org
>> Subject: Re: RAT with BuildBot at Apache
>> 
>> David Crossley wrote:
>>> Gavin wrote:
>>>> 
>>>> Ross' suggestion went on to say that perhaps Clutch could be extended
>> by an
>>>> extra column or two and state whether a project passes RAT and if not
>> say
>>>> how many files fail the RAT validation.
>>>> 
>>>> Would this be a useful addition?
>>> 
>>> Yes definitely.
>>> 
>>>> If so I can get to work on it Buildbot end
>>>> - all I need from you is where you want the results putting so that
>> Clutch
>>>> can use it, how you want it represented (.xml , .txt, .html) etc. I
>> could
>>>> for instance put it in svn somewhere, or perhaps Clutch could gather
>> the
>>>> results from a ci.apache.org/projects/rat-output/ location?
>>> 
>>> As long as it is publicly accessible and in a structured format,
>>> then Clutch can handle it. Even just a CSV file would work.
>>> 
>>> Perhaps a summary file at ci.apache.org/projects/rat-output/summary.txt
>>> 
>>> #projectId,numFailed
>>> foo,12
>>> bar,0
>>> 
>>> So, for each podling, Clutch would see if it is in your list.
>>> If "numFailed gt 0" then alert it.
>>> 
>>> The table cell would link directly to each project's html RAT report.
>>> 
>>> Prod me when you have something.
>> 
>> By the way, no need to wait until you have RAT reports for
>> all incubator projects. If one is not in the buildbot list,
>> then Clutch will just give it a "?" and orange alert colour.
>> 
>> -David
>> No virus found in this incoming message.
>> Checked by AVG - www.avg.com
>> Version: 8.5.392 / Virus Database: 270.13.20/2249 - Release Date: 07/21/09
>> 05:58:00
> 


Re: RAT Summary Page (was: RE: RAT with BuildBot at Apache)

Posted by David Crossley <cr...@apache.org>.
David Crossley wrote:
> Gavin wrote:
> > 
> > http://ci.apache.org/projects/rat-master-summary.html
> > 
> > Still a basic interface currently but before I went too much further it
> > would be great if I could get feedback (from David mainly I guess in regards
> > to Clutch)
> > 
> > What extra information does Clutch need to make it useful for it?
> 
> That RAT page seems to be decent html. So we can just grab the
> relevant column data. That is sufficient.

I decided not to add such a column to the Clutch table.
Afraid that people will glance at Clutch, rather than
properly investigate a project's complete RAT report.

-David

Re: RAT Summary Page (was: RE: RAT with BuildBot at Apache)

Posted by David Crossley <cr...@apache.org>.
Gavin wrote:
> 
> http://ci.apache.org/projects/rat-master-summary.html
> 
> Still a basic interface currently but before I went too much further it
> would be great if I could get feedback (from David mainly I guess in regards
> to Clutch)
> 
> What extra information does Clutch need to make it useful for it?

That RAT page seems to be decent html. So we can just grab the
relevant column data. That is sufficient.

-David