How can I access all test in suite in robot framework

Question

Is there any possible way to access list of all test execution in current test suite during it's execution. In my case I have one scripts with 20 test cases. Each of them has some tags. When starting Robot I can ask it to execute only test with specific tags. I'd like to know which test were chosen by Robot form my script. I know that such info is provided to listener. Can I access it for example in suite setup during execution?

Thanks Pawel R.

Could you explain your scenario a little more? From what I understand you want to know which test cases from a suite will execute when you provide certain tags? Wouldn't a simpler option be to just do CTRL+F and find the number of tests you use the tag in if you want a test case count? Otherwise what's the problem with executing and checking the log to see what test cases executed? — shicky
As I gather, you want to access the selected test cases programmatically, i.e. assign to a variable runtime and manipulate it in the code (presumably, in the same test suite), right? — Todor Minakov

Bence Kaulics Bence Kaulics · Accepted Answer · 2020-10-07T07:35:04

Today, you can create a small library that will act as a listener as well that can do a runtime check which tests have been selected. I am using Robot Framework 3.1.2 here.

It basically needs two things

A start_suite method from the listener API. This method will be invoked at the start of every suite or until it returns an explicit False. When invoked a parameter called attributes will be passed to it. This parameter is a dictionary, that has the following key/value pair, "tests: Names of the tests this suite has as a list. Does not include tests of the possible child suites.".
A keyword that will log all test names and could be used from Suite Setup.

lib.py

from robot.api import logger

class lib(object):
    ROBOT_LIBRARY_SCOPE = 'TEST SUITE'    # define library scope
    ROBOT_LISTENER_API_VERSION = 2        # select listener API
    ROBOT_LIBRARY_VERSION = 0.1
    
    def __init__(self):
        self.ROBOT_LIBRARY_LISTENER = self    # tell the framework that it will be a listener library
        self.attributes = None

    def _start_suite(self, name, attributes):
        self.attributes = attributes
        
    def log_suite_test_names(self):
        for test in self.attributes['tests']:
            logger.info(test)
        

globals()[__name__] = lib

test.robot

*** Settings ***
Library    lib
Suite Setup    log suite test names

*** Test Cases ***
Test 1
    [Tags]    A
    No Operation
    
Test 11
    [Tags]    A    B
    No Operation
    
Test 111
    [Tags]    A    B    C
    No Operation
    
Test 1111
    [Tags]    A    B    C    D
    No Operation

Results when launched like: robot --pythonpath . --include C test.robot

How can I access all test in suite in robot framework

3 Answers