Issue 88 - robotframework - Listener interface methods need more information about suites, tests and keywords

Issue 88:	Listener interface methods need more information about suites, tests and keywords
	1 person starred this issue and may be notified of changes.	Back to list

Status:	Done
Owner:	janne.t.harkonen
Closed:	Apr 2009
Type-Enhancement
Priority-Medium
Target-2.1

Reported by laukpe, Sep 04, 2008

Current listener interface implementation does not provide as much
information to the listener as it could. 

We also got a special request that the listener should get the full suite name.

For more information about listener interface, see Extending Robot
Framework section of the user guide.

Comment 1 by laukpe, Oct 17, 2008

We probably want to send a dictionary/map to all start/end methods so that the
signature is not too long and we can easily add more information to the dict/map
without changing the high level API.

Owner: ---
Labels: -Type-Defect Type-Enhancement

Comment 2 by pekka.klarck, Dec 10, 2008

(No comment was entered for this change.)

Summary: Listener interface methods need more information about suites, tests and keywords
Labels: Target-2.1

Comment 3 by pekka.klarck, Jan 28, 2009

 Issue 221  has been merged into this issue.

Comment 4 by janne.t.harkonen, Apr 02, 2009

(No comment was entered for this change.)

Status: Started
Owner: janne.t.harkonen

Comment 5 by janne.t.harkonen, Apr 06, 2009

This still needs user guide updates, the code related tasks are done

Comment 6 by janne.t.harkonen, Apr 14, 2009

Rewrote the chapter on listener methods in r1799.
Needs proofreading etc.

Comment 7 by pekka.klarck, Apr 14, 2009

IMHO everything about the old API can be removed from 2.1 UG with a reference to the
2.0.4 UG for those who need to still use the old API for some reason.

Additionally, all examples need to be updated to use the new API. This includes also
the Java interface example.

Comment 8 by pekka.klarck, Apr 14, 2009

The documentation looks really good. The addition that must be done is explaining how
to tell RF to use the new listener API. The needed attribute must be explained and
also used in the examples.

It might also be a good idea to briefly explain why the API was changed. The main
reason obviously was making it easier to add new information to attributes dictionary
without changing signatures.

Comment 9 by pekka.klarck, Apr 14, 2009

We should also think is there some new information we actually wanted to add to
attribute dictionaries -- that's kind of the whole point of this issue. The original
description mentions suites' full name explicitly. Let's talk this f2f on Wednesday.

Comment 10 by pekka.klarck, Apr 14, 2009

Possible information to add:

1) All the same information to end_xxx that start_xxx get
2) longname (or fullname) to suites and tests (and to keywords unless their 'name' is
already the long version).
3) doc to keywords
4) starttime to all start_xxx methods (if it's already available that time)
5) starttime, endtime, elapsedtime to all end_xxx methods
6) Separate statistics and message to suite (instead of having them both in message)

Additionally we need to discuss do we want to use format 'starttime', 'start_time',
'start-time', 'start time', 'Start Time', ...

Comment 11 by janne.t.harkonen, Apr 14, 2009

Modified to ug still in r1829.
Still need to decide which (if any) information to add.

Comment 12 by janne.t.harkonen, Apr 16, 2009

Added more data to listener methods in r1839.
Latest changes to UG in r1851

Status: Done