Custom testsuite documentation at keyword level

Robot Framework
1

I am looking for solution to make flat custom Testsuite documentation.

Requirements:

  • Documentation is generated based on Test Cases definitions.
  • Generation is done without running the actual tests.
  • Arguments values passed into keywords has to be included.
  • Documentation must be flat without HTML like drop-downs.

At the moment it seems to me that the best solution is to equip every used keyword at the lowest level with two way flow path:

  1. Documentation generation - Log information about keyword and passed variables. This could take the form of: action execution description + expected results.
  2. Actual operation.

So far I have tried the following:

  • Use of Testdoc - unfortunately the lowest level I can get is the keyword in a testcase.
  • Excluding/including by tags - it is possible only for testcase level.
  • Use of SuiteVistor, prerunmodifier, listener, dryrun - without success.

If you have any ideas, I would be very grateful for your help.

2

Hi @kordop,

I’m no expert on this area of robot framework, but as a suggestion of something to try:

  • If you run robot with the --dryrun option the test cases will run but not execute any library keywords, this should still generate the log.html report.html and output.xml with the documentation information and the data passed to your keywords.
  • After the --dryrun, you can apply your own custom xslt to output.xml and display in whatever format you want, as I expect all the data you want will be in this xml file.

Hope that helps,

Dave.