Join 34,000+ subscribers and receive articles from our blog about software quality, testing, QA and security.

Python script for re-running test plans with previously failing tests


Before releasing software, we go through a 2 week certification period where we go through 800 manual test cases. When a bug is found, a test case goes from ‘untested’ to ‘failed’ and is then assigned to a developer. When it is fixed, the developer changes the test case status to ‘re-test’ and it is assigned back to QA. When it is verified, its status is changed to ‘passed.’

When we are finished verifying our product, the several hundred test case test plan has 100% passing test cases.

After release, we merge our release branch back into our develop branch. It’s important that we re-test any problems fixed during certification to make sure we have no regressions after the merge, but we don’t want to do all 800 manual test cases all over again!

Unfortunately, it’s impossible to re-run a test plan with ONLY tests that failed at any point during certification. It will only pick up tests that are CURRENTLY failing.

This script I wrote is pretty heavy handed, but it gets the job done. If 50 test cases were failed and then passed during certification, it will spin up a new test plan containing only 50 test cases and it also re-assigns the tests to the person who failed the test in the first place. I even provide a link to the original test plan so that the tester can see the history of the test case in the original test plan.

It’s been pretty helpful for us, maybe it is helpful for someone else!

Here it is!

import traceback
import argparse
import testrail

class Test_Plan:
    def __init__(self, plan_name, client_obj, entries=[]):
        self._plan_name = plan_name
        self._entries = entries
        self._client_obj = client_obj

    def get_plan_as_dict(self):
        return {
            "name": self._plan_name,
            "entries": [entry.get_entry_as_dict() for entry in self._entries]  # Use the entry class

    def get_entry(self, suite_id):
        for entry in self._entries:
            if suite_id == entry._suite_id:
                return entry

        return False

    def add_entry(self, suite_id, case_ids):
        entry_to_add = Entry(suite_id=suite_id, case_ids=case_ids)
        return entry_to_add        

    def add_test(self, test):
        case_id = test["case_id"]
        case = self._client_obj.send_get(uri=f"get_case/{case_id}")
        suite_id = case["suite_id"]

        entry = self.get_entry(suite_id)
        if entry:
            if entry.has_test_case(case_id):


            self.add_entry(suite_id=suite_id, case_ids=[case_id])
class Entry:
    def __init__(self, suite_id=None, case_ids=[]):
        self._suite_id = suite_id
        self._case_ids = case_ids

    def get_entry_as_dict(self):
                "suite_id": self._suite_id,
                "case_ids": self._case_ids,
                "include_all": False

    def add_test(self, test):
        if test["case_id"] not in self._case_ids:

    def has_test_case(self, case_id):
        if case_id in self._case_ids:
            return True
            return False

class Run:
    def __init__(self, suite_id=None, name=None,  milestone_id=None, assignedto_id=None, case_ids=[], config_ids=[],):
        self._suite_id = suite_id
        self._name = name
        self._milestone_id = milestone_id,
        self._assignedto_id = assignedto_id
        self._case_ids = case_ids
        self._config_ids = config_ids

    def get_run_as_dict(self):
        return {
            "suite_id": self._suite_id,
            "name": self._name,
            "assignedto_id": self._assignedto_id,
            "include_all": False,
            "case_ids": self._case_ids,
            "config_ids": self._config_ids

class Result:
    def __init__(self, case_id, suite_id, comment, assignedto_id):
        self._comment = comment
        self._suite_id = suite_id
        self._case_id = case_id
        self._assignedto_id = assignedto_id

    def get_result_as_dict(self):
        return{"status_id": 4,
               "assignedto_id": self._assignedto_id,
               "comment": self._comment}

def get_run_id_from_suite_id(test_plan_dict, suite_id):	
    for entry in test_plan_dict["entries"]:	
        for run in entry["runs"]:	
            if run["suite_id"] == suite_id:	
                return run["id"]

def add_results_to_test_plan(client_obj, test_plan_id, results):
    test_plan_dict = client_obj.send_get(uri=f"get_plan/{test_plan_id}")

    for result in results:
            run_id = get_run_id_from_suite_id(test_plan_dict, result._suite_id)
            case_id = result._case_id
            client_obj.send_post(f"add_result_for_case/{run_id}/{case_id}", result.get_result_as_dict())
        except Exception: # cases might have been deleted

def create_verification_test_plan(client_obj, test_plan_id): # I'm not very proud of all this. Pretty wonky. = / 
    test_plan_dict = client_obj.send_get(uri=f"get_plan/{test_plan_id}")
    project_id = test_plan_dict["project_id"]
    new_test_plan = Test_Plan(plan_name=test_plan_dict["name"]+" verification after release branch merge", client_obj=client_obj)
    results_to_add = []
    tests_to_add = []
        for entry in test_plan_dict["entries"]:
            suite_id = entry["suite_id"]
            for run in entry["runs"]:
                run_id = run["id"]
                run_results = client_obj.send_get(uri=f"get_results_for_run/{run_id}/&status_id=5")
                if run_results:
                    for result in run_results:
                        test_id = result["test_id"]
                        user_id = result["created_by"]
                        person_who_failed_it = client_obj.send_get(uri=f"get_user/{user_id}")["name"]
                        test = client_obj.send_get(uri=f"get_test/{test_id}") # get failed test
                        comment_to_add = f"original failed test ->{test_id} was failed by {person_who_failed_it}"
                        new_result = Result(case_id=test["case_id"], suite_id=suite_id, comment=comment_to_add, assignedto_id=user_id)

    for test in tests_to_add:
    new_test_plan_dict = new_test_plan.get_plan_as_dict()
    added_test_plan = client_obj.send_post(f"add_plan/{project_id}", new_test_plan_dict)
    added_test_plan_id = added_test_plan["id"]

    add_results_to_test_plan(client_obj=client_obj, test_plan_id=added_test_plan_id, results=results_to_add)

def main(client_url, username, password):
        client_obj = testrail.APIClient(args.client_url)
        client_obj.user = args.username
        client_obj.password = args.password

        create_verification_test_plan(client_obj, "3271")

if __name__ == "__main__":

    #Get all of the commandline arguments
    parser = argparse.ArgumentParser("Create things in testrail")
    parser.add_argument('-client_url', dest='client_url', help="The url of the TestRail Project", required=True)
    parser.add_argument('-username', dest='username', help="The TestRail Username", required=True)
    parser.add_argument('-password', dest='password', help="The associated password", required=True)
    parser.add_argument('-project_id', dest='project_id', help="The testrail project", required=True)
    args = parser.parse_args()

        main(args.client_url, args.username, args.password)