testrail-api-module 0.1.0__tar.gz

testrail_api_module-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Matt Troutman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

testrail_api_module-0.1.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: testrail_api_module
+Version: 0.1.0
+Summary: A simple wrapper for the TestRail API
+Author: Christian Thompson
+Author-email: Matt Troutman <github@trtmn.com>
+Project-URL: Homepage, https://github.com/trtmn/testrail_api_module
+License-File: LICENSE
+Requires-Dist: requests
+Dynamic: license-file

testrail_api_module-0.1.0/README.md

@@ -0,0 +1,9 @@
+# testrail_api_module
+
+A simple wrapper for the TestRail API.
+
+## Description
+
+This project provides a simple and easy-to-use wrapper for the TestRail API, allowing you to interact with TestRail programmatically.
+
+## •further usage info goes here•

testrail_api_module-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "testrail_api_module"
+version = "0.1.0"
+description = "A simple wrapper for the TestRail API"
+authors = [
+    { name = "Matt Troutman", email = "github@trtmn.com" },
+    { name = "Christian Thompson"}
+]
+dependencies = [
+    "requests",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[project.urls]
+Homepage = "https://github.com/trtmn/testrail_api_module"

testrail_api_module-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

testrail_api_module-0.1.0/src/testrail_api_module/__init__.py

@@ -0,0 +1,57 @@
+# src/testrail_api_module/__init__.py
+"""
+This package provides functionalities to interact with the TestRail API, including managing attachments, cases, tests, and results.
+
+Attributes:
+    __version__ (str): The version of the package.
+    __author__ (str): The authors of the package.
+    __all__ (list): A list of modules to be imported when `from testrail_api_module import *` is used.
+"""
+import os
+__version__ = '0.1.0'
+__author__ = 'Matt Troutman / Christian Thompson'
+package_version = __version__
+"""The version of the package, used for compatibility checks and logging."""
+
+authors = __author__
+"""authors of the package, used for documentation and attribution."""
+
+# Import all modules in the package
+__all__ = [
+    '_common',
+    'attachments',
+    'bdd',
+    'case_fields',
+    'case_types',
+    'cases',
+    'configurations',
+    'datasets',
+    'groups',
+    'milestones',
+    'plans',
+    'priorities',
+    'projects',
+    'reports',
+    'result_fields',
+    'results',
+    'roles',
+    'runs',
+    'sections',
+    'shared_steps',
+    'statuses',
+    'suites',
+    'templates',
+    'tests',
+    'users',
+    'variables'
+]
+
+def __import_all_modules__():
+    for _x in __all__:
+        _local_name = f".{_x}"
+        exec(f"from {_local_name} import *", globals())
+
+__import_all_modules__()
+del __import_all_modules__
+
+

testrail_api_module-0.1.0/src/testrail_api_module/_common.py

@@ -0,0 +1,115 @@
+"""
+`_common.py` serves as a foundational module for the TestRail API package, providing a base class for API requests and a function to set API credentials.
+"""
+import requests
+import json
+
+
+import os
+
+def set_testrail_api_credentials(baseurl=None, username=None, password=None):
+    """
+    Set the TestRail API credentials as environment variables.
+
+    Args:
+        baseurl (str): The base URL for the TestRail API.
+        username (str): The username for TestRail API authentication.
+        password (str): The password for TestRail API authentication.
+    """
+    if baseurl is not None:
+        os.environ["TESTRAIL_API_BASEURL"] = baseurl
+    if username is not None:
+        os.environ["TESTRAIL_API_USERNAME"] = username
+    if password is not None:
+        os.environ["TESTRAIL_API_PASSWORD"] = password
+
+def get_testrail_api_credentials():
+    """
+    Get the TestRail API credentials from environment variables.
+
+    Returns:
+        tuple: A tuple containing the baseurl, username, and password.
+
+    Raises:
+        ValueError: If any of the required credentials are not set.
+    """
+    baseurl = os.getenv("TESTRAIL_API_BASEURL")
+    username = os.getenv("TESTRAIL_API_USERNAME")
+    password = os.getenv("TESTRAIL_API_PASSWORD")
+
+    if baseurl is None:
+        raise ValueError("The base URL for the TestRail API is required. Set it as an environment variable or pass it as an argument.")
+    if username is None:
+        raise ValueError("The username for TestRail API authentication is required. Set it as an environment variable or pass it as an argument.")
+    if password is None:
+        raise ValueError("The password for TestRail API authentication is required. Set it as an environment variable or pass it as an argument.")
+
+    return baseurl, username, password
+
+class ApiConstructor:
+    """
+    A class to construct and make API requests to TestRail.
+    """
+
+    def __init__(self) -> object:
+        """
+        Initializes the ApiConstructor with default values for run_id, case_id, project_id,
+        baseurl, username, and password.
+        """
+        self.run_id = None  # Actual run id in demo project
+        """The run ID for the TestRail run. This is required."""
+        
+        self.case_id = None  # Actual case id in demo project
+        """The case ID for the TestRail case. This is required."""
+        
+        self.project_id = None
+        """The project ID for the TestRail project. This is required."""
+        
+        self.baseurl = get_testrail_api_credentials()[0] #Required!
+        """The base URL for the TestRail API (e.g., "https://your_testrail_instance.testrail.io"). This is required.
+        Can be set in the constructor or as an environment variable.
+        use testrail_api_module._common.set_testrail_api_credentials()"""
+        
+        self.username = get_testrail_api_credentials()[1] #Required!
+        """The username for TestRail API authentication. This is required.
+        Can be set in the constructor or as an environment variable.
+        use testrail_api_module._common.set_testrail_api_credentials()"""
+        
+        self.password = get_testrail_api_credentials()[2] #Required!
+        """The password for TestRail API authentication. This is required.
+        Can be set in the constructor or as an environment variable.
+        use testrail_api_module._common.set_testrail_api_credentials()"""
+
+    def api_request(self, method, endpoint, data=None):
+                """
+                Make an API request to TestRail.
+
+                Args:
+                    method (str): The HTTP method to use for the request (e.g., 'GET', 'POST').
+                    endpoint (str): The API endpoint to send the request to.
+                    data (dict, optional): The data to send with the request, if any.
+
+                Returns:
+                    dict: The JSON response from the API if the request is successful.
+                    None: If the request fails.
+                """
+                # Confirm that all 3 required variables are set
+                if not self.baseurl:
+                    raise ValueError("The base URL for the TestRail API is required. See documentation for more info")
+                if not self.username:
+                    raise ValueError("The username for TestRail API authentication is required. See documentation for more info")
+                if not self.password:
+                    raise ValueError("The password for TestRail API authentication is required. See documentation for more info")
+
+                url = f"{self.baseurl}/index.php?/api/v2/{endpoint}"
+                headers = {"Content-Type": "application/json"}
+                response = requests.request(method, url, headers=headers, data=json.dumps(data), auth=(self.username, self.password))
+                if response.status_code == 200:
+                    return response.json()
+                else:
+                    print(f"Failed to {method} {endpoint}. Response:", response.text)
+                    return None
+
+if __name__ == '__main__':
+    set_testrail_api_credentials(baseurl="https://your_testrail_instance.testrail.io", username="your_username", password="your_password")
+    print(get_testrail_api_credentials())

testrail_api_module-0.1.0/src/testrail_api_module/attachments.py

@@ -0,0 +1,187 @@
+from . import _common
+_api = _common.ApiConstructor()
+"""
+This module provides functionalities to interact with attachments in TestRail.
+"""
+
+
+def add_attachment_to_case(case_id, file_path):
+    """
+    Add an attachment to a specific test case.
+
+    Args:
+        case_id (str): The ID of the test case.
+        file_path (str): The path to the file to be attached.
+
+    Returns:
+        dict: The response from the API.
+    """
+    files = {'attachment': open(file_path, 'rb')}
+    headers = {'Content-Type': 'multipart/form-data'}
+    response = _api.api_request('POST', f'add_attachment_to_case/{case_id}', files=files, headers=headers)
+    return response
+
+def add_attachment_to_plan(plan_id, file_path):
+    """
+    Add an attachment to a specific test plan.
+
+    Args:
+        plan_id (str): The ID of the test plan.
+        file_path (str): The path to the file to be attached.
+
+    Returns:
+        dict: The response from the API.
+    """
+    files = {'attachment': open(file_path, 'rb')}
+    headers = {'Content-Type': 'multipart/form-data'}
+    response = _api.api_request('POST', f'add_attachment_to_plan/{plan_id}', files=files, headers=headers)
+    return response
+
+def add_attachment_to_plan_entry(plan_id, entry_id, file_path):
+    """
+    Add an attachment to a specific test plan entry.
+
+    Args:
+        plan_id (str): The ID of the test plan.
+        entry_id (str): The ID of the test plan entry.
+        file_path (str): The path to the file to be attached.
+
+    Returns:
+        dict: The response from the API.
+    """
+    files = {'attachment': open(file_path, 'rb')}
+    headers = {'Content-Type': 'multipart/form-data'}
+    response = _api.api_request('POST', f'add_attachment_to_plan_entry/{plan_id}/{entry_id}', files=files, headers=headers)
+    return response
+
+def add_attachment_to_result(result_id, file_path):
+    """
+    Add an attachment to a specific test result.
+
+    Args:
+        result_id (str): The ID of the test result.
+        file_path (str): The path to the file to be attached.
+
+    Returns:
+        dict: The response from the API.
+    """
+    files = {'attachment': open(file_path, 'rb')}
+    headers = {'Content-Type': 'multipart/form-data'}
+    response = _api.api_request('POST', f'add_attachment_to_result/{result_id}', files=files, headers=headers)
+    return response
+
+def add_attachment_to_run(run_id, file_path):
+    """
+    Add an attachment to a specific test run.
+
+    Args:
+        run_id (str): The ID of the test run.
+        file_path (str): The path to the file to be attached.
+
+    Returns:
+        dict: The response from the API.
+    """
+    files = {'attachment': open(file_path, 'rb')}
+    headers = {'Content-Type': 'multipart/form-data'}
+    response = _api.api_request('POST', f'add_attachment_to_run/{run_id}', files=files, headers=headers)
+    return response
+
+def get_attachments_for_case(case_id, limit=250, offset=0):
+    """
+    Get all attachments for a specific test case.
+
+    Args:
+        case_id (str): The ID of the test case.
+        limit (int, optional): The maximum number of attachments to return (default is 250).
+        offset (int, optional): The number of attachments to skip before starting to collect the result set (default is 0).
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('GET', f'get_attachments_for_case/{case_id}&limit={limit}&offset={offset}')
+    return response
+
+def get_attachments_for_plan(plan_id, limit=250, offset=0):
+    """
+    Get all attachments for a specific test plan.
+
+    Args:
+        plan_id (str): The ID of the test plan.
+        limit (int, optional): The maximum number of attachments to return (default is 250).
+        offset (int, optional): The number of attachments to skip before starting to collect the result set (default is 0).
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('GET', f'get_attachments_for_plan/{plan_id}&limit={limit}&offset={offset}')
+    return response
+
+def get_attachments_for_plan_entry(plan_id, entry_id, limit=250, offset=0):
+    """
+    Get all attachments for a specific test plan entry.
+
+    Args:
+        plan_id (str): The ID of the test plan.
+        entry_id (str): The ID of the test plan entry.
+        limit (int, optional): The maximum number of attachments to return (default is 250).
+        offset (int, optional): The number of attachments to skip before starting to collect the result set (default is 0).
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('GET', f'get_attachments_for_plan_entry/{plan_id}/{entry_id}&limit={limit}&offset={offset}')
+    return response
+
+def get_attachments_for_run(run_id, limit=250, offset=0):
+    """
+    Get all attachments for a specific test run.
+
+    Args:
+        run_id (str): The ID of the test run.
+        limit (int, optional): The maximum number of attachments to return (default is 250).
+        offset (int, optional): The number of attachments to skip before starting to collect the result set (default is 0).
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('GET', f'get_attachments_for_run/{run_id}?limit={limit}&offset={offset}')
+    return response
+
+def get_attachments_for_test(test_id):
+    """
+    Get all attachments for a specific test.
+
+    Args:
+        test_id (str): The ID of the test.
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('GET', f'get_attachments_for_test/{test_id}')
+    return response
+
+def get_attachment(attachment_id):
+    """
+    Get details of a specific attachment.
+
+    Args:
+        attachment_id (str): The ID of the attachment.
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('GET', f'get_attachment/{attachment_id}')
+    return response
+
+def delete_attachment(attachment_id):
+    """
+    Delete a specific attachment.
+
+    Args:
+        attachment_id (str): The ID of the attachment.
+
+    Returns:
+        dict: The response from the API.
+    """
+    response = _api.api_request('POST', f'delete_attachment/{attachment_id}')
+    return response

testrail_api_module-0.1.0/src/testrail_api_module/bdd.py

@@ -0,0 +1,34 @@
+from . import _common
+_api = _common.ApiConstructor()
+"""
+This module provides functionalities to interact with BDD scenarios in TestRail.
+"""
+
+def get_bdd(case_id):
+    """
+    Export a BDD scenario from a test case as a .feature file.
+
+    Args:
+        case_id (int): The ID of the test case.
+
+    Returns:
+        dict: The response from the API.
+    """
+    return _api.api_request('GET', f'get_bdd/{case_id}')
+
+def add_bdd(section_id, feature_file):
+    """
+    Import/upload a BDD scenario from a test case as a .feature file.
+
+    Args:
+        section_id (int): The ID of the section.
+        feature_file (str): The path to the .feature file.
+
+    Returns:
+        dict: The response from the API.
+    """
+    with open(feature_file, 'r') as file:
+        data = {
+            "file": file.read()
+        }
+    return _api.api_request('POST', f'add_bdd/{section_id}', data)

testrail_api_module-0.1.0/src/testrail_api_module/case_fields.py

@@ -0,0 +1,42 @@
+# src/testrail_api_module/case_fields.py
+"""
+This module provides functionalities to interact with test case fields in TestRail.
+"""
+from . import _common
+_api = _common.ApiConstructor()
+
+def get_case_fields():
+    """
+    Get all available test case fields.
+
+    Returns:
+        list: A list of dictionaries containing the details of each test case field.
+    """
+    return _api.api_request('GET', 'get_case_fields')
+
+def add_case_field(field_type, name, label, description=None, include_all=False, template_ids=None, configs=None):
+    """
+    Create a new test case custom field.
+
+    Args:
+        field_type (str): The type identifier for the new custom field.
+        name (str): The name for the new custom field.
+        label (str): The label for the new custom field.
+        description (str, optional): The description for the new custom field.
+        include_all (bool, optional): Flag to include the new custom field for all templates.
+        template_ids (list, optional): IDs of templates the new custom field will apply to if include_all is False.
+        configs (list, optional): A list of configuration objects for the new custom field.
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "type": field_type,
+        "name": name,
+        "label": label,
+        "description": description,
+        "include_all": include_all,
+        "template_ids": template_ids,
+        "configs": configs
+    }
+    return _api.api_request('POST', 'add_case_field', data)

testrail_api_module-0.1.0/src/testrail_api_module/case_types.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/cases.py

@@ -0,0 +1,229 @@
+from . import _common
+_api = _common.ApiConstructor()
+
+
+def add_case(section_id, title, template_id=None, type_id=None, priority_id=None, estimate=None, milestone_id=None, refs=None):
+    """
+    Add a new test case to  a specific section.
+
+    Args:
+        section_id (str): The ID of the section.
+        title (str): The title of the test case.
+        template_id (int, optional): The ID of the template.
+        type_id (int, optional): The ID of the type.
+        priority_id (int, optional): The ID of the priority.
+        estimate (str, optional): The estimate for the test case.
+        milestone_id (int, optional): The ID of the milestone.
+        refs (str, optional): A comma-separated list of references.
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "title": title,
+        "template_id": template_id,
+        "type_id": type_id,
+        "priority_id": priority_id,
+        "estimate": estimate,
+        "milestone_id": milestone_id,
+        "refs": refs
+    }
+    return _api.api_request('POST', f'add_case/{section_id}', data)
+
+def get_case(case_id):
+    """
+    Get details of a specific test case.
+
+    Args:
+        case_id (str): The ID of the test case.
+
+    Returns:
+        dict: The response from the API.
+    """
+    return _api.api_request('GET', f'get_case/{case_id}')
+
+def get_cases(project_id, suite_id=None, section_id=None, filters=None):
+    """
+    Get all test cases for a specific project, optionally filtered by suite, section, and other filters.
+
+    Args:
+        project_id (str): The ID of the project.
+        suite_id (str, optional): The ID of the suite.
+        section_id (str, optional): The ID of the section.
+        filters (dict, optional): Additional filters for the request.
+
+    Returns:
+        list: A list of dictionaries containing the details of each test case.
+    """
+    endpoint = f'get_cases/{project_id}'
+    if suite_id:
+        endpoint += f'&suite_id={suite_id}'
+    if section_id:
+        endpoint += f'&section_id={section_id}'
+    if filters:
+        for key, value in filters.items():
+            endpoint += f'&{key}={value}'
+    return _api.api_request('GET', endpoint)
+
+def update_case(case_id, title=None, template_id=None, type_id=None, priority_id=None, estimate=None, milestone_id=None, refs=None):
+    """
+    Update an existing test case.
+
+    Args:
+        case_id (str): The ID of the test case.
+        title (str, optional): The title of the test case.
+        template_id (int, optional): The ID of the template.
+        type_id (int, optional): The ID of the type.
+        priority_id (int, optional): The ID of the priority.
+        estimate (str, optional): The estimate for the test case.
+        milestone_id (int, optional): The ID of the milestone.
+        refs (str, optional): A comma-separated list of references.
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "title": title,
+        "template_id": template_id,
+        "type_id": type_id,
+        "priority_id": priority_id,
+        "estimate": estimate,
+        "milestone_id": milestone_id,
+        "refs": refs
+    }
+    return _api.api_request('POST', f'update_case/{case_id}', data)
+
+def delete_case(case_id):
+    """
+    Delete a specific test case.
+
+    Args:
+        case_id (str): The ID of the test case.
+
+    Returns:
+        dict: The response from the API.
+    """
+    return _api.api_request('POST', f'delete_case/{case_id}')
+
+def get_case_fields():
+    """
+    Get all available test case fields.
+
+    Returns:
+        list: A list of dictionaries containing the details of each test case field.
+    """
+    return _api.api_request('GET', 'get_case_fields')
+
+def get_case_types():
+    """
+    Get all available test case types.
+
+    Returns:
+        list: A list of dictionaries containing the details of each test case type.
+    """
+    return _api.api_request('GET', 'get_case_types')
+
+def get_history_for_case(case_id, limit=None, offset=None):
+    """
+    Get the history for a specific test case.
+
+    Args:
+        case_id (str): The ID of the test case.
+        limit (int, optional): The maximum number of history entries to return.
+        offset (int, optional): The number of history entries to skip before starting to collect the result set.
+
+    Returns:
+        list: A list of dictionaries containing the history of the test case.
+    """
+    endpoint = f'get_history_for_case/{case_id}'
+    if limit:
+        endpoint += f'&limit={limit}'
+    if offset:
+        endpoint += f'&offset={offset}'
+    return _api.api_request('GET', endpoint)
+
+def copy_cases_to_section(section_id, case_ids=None):
+    """
+    Copy test cases to a specific section.
+
+    Args:
+        section_id (str): The ID of the section.
+        case_ids (list, optional): A list of test case IDs to copy.
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "case_ids": case_ids
+    }
+    return _api.api_request('POST', f'copy_cases_to_section/{section_id}', data)
+
+def update_cases(suite_id, case_ids, section_id=None, title=None, template_id=None, type_id=None, priority_id=None, estimate=None, milestone_id=None, refs=None):
+    """
+    Update multiple test cases.
+
+    Args:
+        suite_id (str): The ID of the suite.
+        case_ids (list): A list of test case IDs to update.
+        section_id (str, optional): The ID of the section.
+        title (str, optional): The title of the test cases.
+        template_id (int, optional): The ID of the template.
+        type_id (int, optional): The ID of the type.
+        priority_id (int, optional): The ID of the priority.
+        estimate (str, optional): The estimate for the test cases.
+        milestone_id (int, optional): The ID of the milestone.
+        refs (str, optional): A comma-separated list of references.
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "case_ids": case_ids,
+        "section_id": section_id,
+        "title": title,
+        "template_id": template_id,
+        "type_id": type_id,
+        "priority_id": priority_id,
+        "estimate": estimate,
+        "milestone_id": milestone_id,
+        "refs": refs
+    }
+    return _api.api_request('POST', f'update_cases/{suite_id}', data)
+
+def move_cases_to_section(section_id, suite_id, case_ids):
+    """
+    Move test cases to a specific section.
+
+    Args:
+        section_id (str): The ID of the section.
+        suite_id (str): The ID of the suite.
+        case_ids (list): A list of test case IDs to move.
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "suite_id": suite_id,
+        "case_ids": case_ids
+    }
+    return _api.api_request('POST', f'move_cases_to_section/{section_id}', data)
+
+def delete_cases(suite_id, case_ids, project_id, soft=0):
+    """
+    Delete multiple test cases.
+
+    Args:
+        suite_id (str): The ID of the suite.
+        case_ids (list): A list of test case IDs to delete.
+        project_id (str): The ID of the project.
+        soft (int, optional): Whether to perform a soft delete (default is 0).
+
+    Returns:
+        dict: The response from the API.
+    """
+    data = {
+        "case_ids": case_ids,
+        "project_id": project_id,
+        "soft": soft
+    }
+    return _api.api_request('POST', f'delete_cases/{suite_id}', data)

testrail_api_module-0.1.0/src/testrail_api_module/configurations.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/datasets.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/groups.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/milestones.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/plans.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/priorities.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/projects.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/reports.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/result_fields.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/results.py

@@ -0,0 +1,91 @@
+import logging as _logging
+from . import _common
+_api = _common.ApiConstructor()
+
+# Print initializing message for file_name
+print("{0} is initializing...".format(__file__))
+
+def add(run_id=None, case_id=None, status_id=None, comment=None, version=None, elapsed=None, defects=None, assignedto_id=None):
+    """
+    Add a test result for a specific test case in a test run.
+
+    Args:
+        run_id (str): The ID of the test run.
+        case_id (str): The ID of the test case.
+        status_id (int): The status ID of the test result.
+        comment (str): A comment for the test result.
+        version (str): The version of the software under test.
+        elapsed (str): The time taken to execute the test.
+        defects (str): A comma-separated list of defects.
+        assignedto_id (int): The ID of the user the test is assigned to.
+
+    Returns:
+        bool: True if the test result was added successfully, False otherwise.
+    """
+    data = {
+        "status_id": status_id,
+        "comment": comment,
+        "version": version,
+        "elapsed": elapsed,
+        "defects": defects,
+        "assignedto_id": assignedto_id
+    }
+    response = _api.api_request('POST', f'add_result_for_case/{run_id}/{case_id}', data)
+    print("Test result added successfully." if response else "Failed to add test result.")
+    if response is not None:
+        _logging.info(f"Test result added successfully. Response: {response}")
+        return True
+    else:
+        _logging.error(f"Failed to add test result. Response: {response}")
+        return False
+
+def get_plans(project_id):
+    """
+    Get all test plans for a specific project.
+
+    Args:
+        project_id (str): The ID of the project.
+
+    Returns:
+        list: A list of dictionaries containing the name, ID, and description of each test plan.
+    """
+    response = _api.api_request('GET', f'get_plans/{project_id}')
+    return [{"name": plan["name"], "id": plan["id"], "description": plan["description"]} for plan in response['plans']] if response else []
+
+def get_run_ids_from_plan(plan_id):
+    """
+    Get all test run IDs from a specific test plan.
+
+    Args:
+        plan_id (str): The ID of the test plan.
+
+    Returns:
+        list: A list of dictionaries containing the name, ID, and description of each test run.
+    """
+    response = _api.api_request('GET', f'get_plan/{plan_id}')
+    return [{"name": run["name"], "id": run["id"], "description": run["description"]} for entry in response['entries'] for run in entry['runs']] if response else []
+
+def get_run(run_id):
+    """
+    Get details of a specific test run.
+
+    Args:
+        run_id (str): The ID of the test run.
+
+    Returns:
+        dict: A dictionary containing the details of the test run.
+    """
+    return _api.api_request('GET', f'get_run/{run_id}')
+
+def get_case_ids_from_run(run_id):
+    """
+    Get all test case IDs from a specific test run.
+
+    Args:
+        run_id (str): The ID of the test run.
+
+    Returns:
+        list: A list of test case IDs.
+    """
+    response = _api.api_request('GET', f'get_tests/{run_id}')
+    return [test['case_id'] for test in response['tests']] if response else []

testrail_api_module-0.1.0/src/testrail_api_module/roles.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/runs.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/sections.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/shared_steps.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/statuses.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/suites.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/templates.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/tests.py

@@ -0,0 +1,41 @@
+from . import _common
+_api = _common.ApiConstructor()
+"""
+
+"""
+# Print initializing message for file_name
+print("{0} is initializing...".format(__file__))
+
+def get_test(test_id):
+    """
+    Get details of a specific test.
+
+    Args:
+        test_id (str): The ID of the test.
+
+    Returns:
+        dict: A dictionary containing the details of the test.
+    """
+    return _api.api_request('GET', f'get_test/{test_id}')
+
+def get_tests(run_id, status_id=None, limit=None, offset=None):
+    """
+    Get all tests for a specific test run, optionally filtered by status, limit, and offset.
+
+    Args:
+        run_id (str): The ID of the test run.
+        status_id (int, optional): The status ID to filter the tests.
+        limit (int, optional): The maximum number of tests to return.
+        offset (int, optional): The number of tests to skip before starting to collect the result set.
+
+    Returns:
+        list: A list of dictionaries containing the details of each test.
+    """
+    endpoint = f'get_tests/{run_id}'
+    if status_id:
+        endpoint += f'&status_id={status_id}'
+    if limit:
+        endpoint += f'&limit={limit}'
+    if offset:
+        endpoint += f'&offset={offset}'
+    return _api.api_request('GET', endpoint)

testrail_api_module-0.1.0/src/testrail_api_module/users.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module/variables.py

@@ -0,0 +1,4 @@
+"""
+This hasn't been implemented yet.
+
+"""

testrail_api_module-0.1.0/src/testrail_api_module.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: testrail_api_module
+Version: 0.1.0
+Summary: A simple wrapper for the TestRail API
+Author: Christian Thompson
+Author-email: Matt Troutman <github@trtmn.com>
+Project-URL: Homepage, https://github.com/trtmn/testrail_api_module
+License-File: LICENSE
+Requires-Dist: requests
+Dynamic: license-file

testrail_api_module-0.1.0/src/testrail_api_module.egg-info/SOURCES.txt

@@ -0,0 +1,35 @@
+LICENSE
+README.md
+pyproject.toml
+src/testrail_api_module/__init__.py
+src/testrail_api_module/_common.py
+src/testrail_api_module/attachments.py
+src/testrail_api_module/bdd.py
+src/testrail_api_module/case_fields.py
+src/testrail_api_module/case_types.py
+src/testrail_api_module/cases.py
+src/testrail_api_module/configurations.py
+src/testrail_api_module/datasets.py
+src/testrail_api_module/groups.py
+src/testrail_api_module/milestones.py
+src/testrail_api_module/plans.py
+src/testrail_api_module/priorities.py
+src/testrail_api_module/projects.py
+src/testrail_api_module/reports.py
+src/testrail_api_module/result_fields.py
+src/testrail_api_module/results.py
+src/testrail_api_module/roles.py
+src/testrail_api_module/runs.py
+src/testrail_api_module/sections.py
+src/testrail_api_module/shared_steps.py
+src/testrail_api_module/statuses.py
+src/testrail_api_module/suites.py
+src/testrail_api_module/templates.py
+src/testrail_api_module/tests.py
+src/testrail_api_module/users.py
+src/testrail_api_module/variables.py
+src/testrail_api_module.egg-info/PKG-INFO
+src/testrail_api_module.egg-info/SOURCES.txt
+src/testrail_api_module.egg-info/dependency_links.txt
+src/testrail_api_module.egg-info/requires.txt
+src/testrail_api_module.egg-info/top_level.txt

testrail_api_module-0.1.0/src/testrail_api_module.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

testrail_api_module-0.1.0/src/testrail_api_module.egg-info/requires.txt

@@ -0,0 +1 @@
+requests

testrail_api_module-0.1.0/src/testrail_api_module.egg-info/top_level.txt

@@ -0,0 +1 @@
+testrail_api_module