[Avocado-devel] Avocado test report with statistics

[Cleber Rosa]

On 2/22/19 7:00 AM, Tejas Gadaria wrote:
> Thank you very much Cleber,
> 
> As discussed here
> : https://github.com/avocado-framework/avocado/issues/3045#issuecomment-464739722 
> I would like to concentrate on displaying data in /Info column. /To get
> familiar, I was going through `plugin_interfaces.py` and `output.py`. 
> 
> If you can direct me, on where to look for and how to proceed further,
> It would be great. 
> 
> Warm Regards,
> Tejas
> 

Hi Tejas,

IMO, the first step is to define an API that will allow tests passing to
record the relevant information that signals that condition.

Basically, if you look at "avocado.Test.fail()" or
"avocado.Test.cancel()", they take the reason for the
failure/cancellation as a parameter.  Likewise, we'd need something for
a test PASS condition.

I see two options:

 1) A "avocado.Test.pass_('Reason why it passed')" that ends the test
immediately
 2) A "avocado.Test.set_status_info('Info on whatever happens'), that
just records it, and lets the test continue to its final result

We should probably brainstorm a bit more about it, think about the
possible use cases, and them jump into the development.

What do you think?

Regard,
- Cleber.

> On Mon, Feb 18, 2019 at 2:29 AM Cleber Rosa <crosa at redhat.com
> <mailto:crosa at redhat.com>> wrote:
> 
> 
> 
>     On 2/15/19 9:58 PM, Tejas Gadaria wrote:
>     > Hi Cleber,
>     > Thanks for your encouraging response :) 
>     >
>     > I would describe RFC, under issue in github and Initially I would
>     > require guidance to develop this feature. 
>     >
> 
>     Great, be sure that you can count on my help!
> 
>     Regards,
>     - Cleber.
> 
>     > Thanks again,
>     > Tejas
>     >
>     > On Fri, Feb 15, 2019 at 11:56 PM Cleber Rosa <crosa at redhat.com
>     <mailto:crosa at redhat.com>
>     > <mailto:crosa at redhat.com <mailto:crosa at redhat.com>>> wrote:
>     >
>     >
>     >
>     >     ----- Original Message -----
>     >     > From: "Tejas Gadaria" <refond.gmrt at gmail.com
>     <mailto:refond.gmrt at gmail.com>
>     >     <mailto:refond.gmrt at gmail.com <mailto:refond.gmrt at gmail.com>>>
>     >     > To: avocado-devel at redhat.com
>     <mailto:avocado-devel at redhat.com> <mailto:avocado-devel at redhat.com
>     <mailto:avocado-devel at redhat.com>>
>     >     > Sent: Friday, February 15, 2019 8:16:33 AM
>     >     > Subject: [Avocado-devel] Avocado test report with statistics
>     >     >
>     >     > Hi,
>     >     >
>     >     > I have just started using avocado.
>     >     > I am using HTML result plugin to get the report, it serves my
>     >     purpose to
>     >     > some  extent.
>     >     >
>     >
>     >     Hi Tejas,
>     >
>     >     Good to hear.
>     >
>     >     > As of now reports are notifying, what is the status of
>     executed test,
>     >     > however I would like to display statistics of tests on the
>     report
>     >     with test
>     >     > status.
>     >     >
>     >
>     >     What kind of statistics?  General test related statistics, or
>     >     statistics specific to your tests?
>     >
>     >     > As of now my tests are mostly related to cpu.
>     >     > I'm able to push those numbers in debug log but not able figure
>     >     out how can
>     >     > I pull that up in HTML report.
>     >     >
>     >
>     >     The whiteboard is place intended for tests to store arbitrary data
>     >     to be preserved on the test results.  It can be any type of
>     textual
>     >     or binary data.
>     >
>     >     But, that is now yet shown on the HTML report.  I believe it'd be
>     >     very nice to have them shown on the HTML report, but that would
>     >     require either guessing of the type of data stored, or that
>     the user
>     >     tells Avocado about it.
>     >
>     >     > Any help would be greatly appreciated.
>     >     >
>     >     > Thanks,
>     >     > Tejas
>     >     >
>     >
>     >     This looks like a nice RFC, would you care to describe that in an
>     >     issue on our GitHub page?  If you need guidance developing the
>     >     feature, I would definitely like to help.
>     >
>     >     Thanks,
>     >     - Cleber.
>     >
> 
>     -- 
>     Cleber Rosa
>     [ Sr Software Engineer - Virtualization Team - Red Hat ]
>     [ Avocado Test Framework - avocado-framework.github.io
>     <http://avocado-framework.github.io> ]
>     [  7ABB 96EB 8B46 B94D 5E0F  E9BB 657E 8D33 A5F2 09F3  ]
> 

-- 
Cleber Rosa
[ Sr Software Engineer - Virtualization Team - Red Hat ]
[ Avocado Test Framework - avocado-framework.github.io ]
[  7ABB 96EB 8B46 B94D 5E0F  E9BB 657E 8D33 A5F2 09F3  ]