TestRepeater.py

# pylint: disable=C0103
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

"""
Author: reharish, abi-sheak
Requirements: robotframework
"""

from robot.api import SuiteVisitor

class TestRepeater(SuiteVisitor):
    """
    TestRepeater is a Robot Framework Listener that repeats each test case in a suite a specified number of times.

    This listener is intended to be used as a listener plugin with Robot Framework.

    count (int): The number of times each test case should be repeated.

    Example:

    robot --listener TestRepeater:<count> <test-suite>

    robot --listener TestRepeater:2  example/example.robot

    """

    ROBOT_LISTENER_API_VERSION = 3

    def __init__(self, count):
        """
        Initialize TestRepeater with the given repetition count.

        count (int): The number of times each test case should be repeated.
        """
        self.count = int(count)

    def start_suite(self, suite, result):
        """
        Called when a suite starts.
        Creates a tests list as from the count.

        Repeats each test case in the suite.
        """
        testcases = []
        for iteration in range(1, self.count + 1):
            for test in suite.tests:
                copy = test.copy(name=f"{iteration} - {test.name}")
                testcases.append(copy)
        suite.tests = testcases

    def end_suite(self, suite, result):
        """
        Called when a suite ends.
        """
        pass

    def start_test(self, test, result):
        """
        Called when a test starts.
         """
        pass

    def end_test(self, test, result):
        """
        Called when a test ends.
        """
        pass

    def start_keyword(self, keyword, result):
        """
        Called when a keyword starts.
        """
        pass

    def end_keyword(self, keyword, result):
        """
        Called when a keyword ends.
        """
        pass

    def start_return(self, keyword, result):
        """
        Called when a return starts.
        """
        pass

    def end_return(self, keyword, result):
        """
        Called when a return ends.
        """
        pass

    def start_for(self, for_, result):
        """
        Called when a FOR loop starts.
        """
        pass

    def end_for(self, if_, result):
        """
        Called when a FOR loop ends.
        """
        pass

    def start_if(self, if_, result):
        """
        Called when an IF/ELSE structure starts.
        """
        pass

    def end_if(self, if_, result):
        """
        Called when an IF/ELSE structure ends.
        """
        pass

    def start_if_branch(self, branch, result):
        """
        Called when an IF/ELSE branch starts.
        """
        pass

    def end_if_branch(self, branch, result):
        """
        Called when an IF/ELSE branch ends.
        """
        pass

    def start_try(self, try_, result):
        """
        Called when a TRY/EXCEPT structure starts.
        """
        pass

    def end_try(self, try_, result):
        """
        Called when a TRY/EXCEPT structure ends.
        """
        pass

    def start_try_branch(self, branch, result):
        """
        Called when TRY, EXCEPT, ELSE or FINALLY branches start.
        """
        pass

    def end_try_branch(self, branch, result):
        """
        Called when TRY, EXCEPT, ELSE or FINALLY branches ends.
        """
        pass

    def start_while(self, while_, result):
        """
        Called when a WHILE loop starts.
        """
        pass

    def end_while(self, while_, result):
        """
        Called when a WHILE loop ends.
        """
        pass

    def start_while_iteration(self, iteration, result):
        """
        Called when a WHILE loop iteration starts.
        """
        pass

    def end_while_iteration(self, iteration, result):
        """
        Called when a WHILE loop iteration ends.
        """
        pass

    def start_var(self, var, result):
        """
        Called when a VAR element starts.
        """
        pass

    def end_var(self, var, result):
        """
        Called when a VAR element ends.
        """
        pass

    def start_continue(self, continue_, result):
        """
        Called when a CONTINUE element starts.
        """
        pass

    def end_continue(self, continue_, result):
        """
        Called when a CONTINUE element ends.
        """
        pass

    def start_break(self, break_, result):
        """
        Called when a BREAK element starts.
        """
        pass

    def end_break(self, break_, result):
        """
        Called when a BREAK element ends.
        """
        pass

    def start_error(self, error, result):
        """
        Called when a ERROR element starts.
        """
        pass

    def end_error(self, error, result):
        """
        Called when a ERROR element ends.
        """
        pass

    def start_message(self, message, result):
        """
        Called when a message starts.
        """
        pass

    def end_message(self, message, result):
        """
        Called when a message ends.
        """
        pass

    def start_body_item(self, item, result):
        """
        Called, by default, when keywords, messages or control structures start.
        """
        pass

    def end_body_item(self, item, result):
        """
        Called, by default, when keywords, messages or control structures end.
        """
        pass