# Automation Tracker
Use this package to quickly track your automation projects and usage. It has been developed to ensure easy and
seamless integration with any third party automation tool.
Documentation: https://automation-tracker.readthedocs.io/en/latest/ for more information.
## Examples of How To Use it on your Robot Framework
### Setup Robot Framework
```robotframework
*** Settings ***
Library AutomationTracker
```
### Usage of the library in Robot Framework
```robotframework
*** Test Cases ***
Example
Start Tracker ${PROJECT_NAME} ${PROJECT_VERSION} ${PROJECT_DESCRIPTION} ${PROJECT_URL} ${PROJECT_EMAIL}
Start Suite ${SUITE_NAME} ${SUITE_DOCUMENTATION}
Start Test ${TEST_NAME} ${TEST_DOCUMENTATION}
Start Keyword ${KEYWORD_NAME} ${KEYWORD_DOCUMENTATION}
End Keyword
End Test
End Suite
End Tracker
```
### Examples of How To Use it on your Python
```python
#import the DB tracker and use functions from it
from RobotTracker.TrackerDB import *
#invoke the tracker
TrackerDB("https://your_ip_or_domain").manually_start_tracker_detailed("POS",
"justus","UAT", "CRQ-1234","Q-OPS", "testType","API", "200", "100", "50","150","0","0","0","0",
"0","0", "0","100", "100", "0", "200","TEST-1234")
```
### Using a listener to listen to your code runs and track the testcase runs
#### Setup the robot framework listener
```robotframework
*** Settings ***
Library AutomationTracker
Suite Setup Start Tracker ${PROJECT_NAME} ${PROJECT_VERSION} ${PROJECT_DESCRIPTION} ${PROJECT_URL} ${PROJECT_EMAIL}
Suite Teardown End Tracker
Test Setup Start Test ${TEST_NAME} ${TEST_DOCUMENTATION}
Test Teardown End Test
```
#### Create a folder in your directory Tracking and create file Justus_Shared.robot eg:
below is an example image of how the file should look like
#### Copy the below code into the file Justus_Shared.robot
```robotframework
*** Settings ***
Documentation This example demonstrates how to use current library and test status in a listener.
Library ListenerLibrary
#import another python file
Library ../Functions/tracker.py
*** Keywords ***
Listener Keyword
[Arguments] ${projectName} ${userName} ${crqReference} ${uniqueRunRef}
Log To Console This line is always executed, ${TEST NAME} : ${TEST STATUS}
# https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#automatic-variables
#send request to track testcase
tracker.Track Test Case ${TEST NAME} ${TEST STATUS} ${projectName} ${userName} ${crqReference} ${uniqueRunRef}
IF "${TEST STATUS}" == "FAIL"
Log To Console **********This line is only executed when the test failed.**********
Another Keyword
END
Another Keyword
Log To Console This keyword only gets called by the listner when the test failed.
Teardown Keyword
Log To Console The teardown is called after the Listener Keyword, ${TEST NAME}: ${TEST STATUS}
IF "${TEST STATUS}" == "FAIL"
Yet Another Keyword
END
Yet Another Keyword
Log To Console This keyword only gets called by the teardown when the test failed.
```
#### Create 'tracker.py' inside your Functions folder and copy the below code into it
```python:
Please contact mwangijustus12@gmail.com for the source code or be part of the development team.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "automation-tracker",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,robotframework,robotframework-library,robotframework-library,robotframework-tracking,robotframework-tracker,robotframework-tracker,robotframework-tracker",
"author": "Justus Mwangi",
"author_email": "<mwangijustus12@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/01/b4/8c88e9d87eca04d3dd2b29a3d949739c71d537be49459d9acceb27484ebf/automation-tracker-1.0.0.4.tar.gz",
"platform": null,
"description": "\n# Automation Tracker\n\nUse this package to quickly track your automation projects and usage. It has been developed to ensure easy and \nseamless integration with any third party automation tool.\n\nDocumentation: https://automation-tracker.readthedocs.io/en/latest/ for more information.\n\n## Examples of How To Use it on your Robot Framework\n\n### Setup Robot Framework\n\n```robotframework\n*** Settings ***\nLibrary AutomationTracker\n```\n\n### Usage of the library in Robot Framework\n\n```robotframework\n*** Test Cases ***\nExample\n Start Tracker ${PROJECT_NAME} ${PROJECT_VERSION} ${PROJECT_DESCRIPTION} ${PROJECT_URL} ${PROJECT_EMAIL}\n Start Suite ${SUITE_NAME} ${SUITE_DOCUMENTATION}\n Start Test ${TEST_NAME} ${TEST_DOCUMENTATION}\n Start Keyword ${KEYWORD_NAME} ${KEYWORD_DOCUMENTATION}\n End Keyword\n End Test\n End Suite\n End Tracker\n```\n\n### Examples of How To Use it on your Python\n\n\n```python\n#import the DB tracker and use functions from it\nfrom RobotTracker.TrackerDB import *\n\n#invoke the tracker\nTrackerDB(\"https://your_ip_or_domain\").manually_start_tracker_detailed(\"POS\",\n\"justus\",\"UAT\", \"CRQ-1234\",\"Q-OPS\", \"testType\",\"API\", \"200\", \"100\", \"50\",\"150\",\"0\",\"0\",\"0\",\"0\", \n \"0\",\"0\", \"0\",\"100\", \"100\", \"0\", \"200\",\"TEST-1234\")\n```\n\n### Using a listener to listen to your code runs and track the testcase runs\n\n#### Setup the robot framework listener\n\n```robotframework\n*** Settings ***\nLibrary AutomationTracker\nSuite Setup Start Tracker ${PROJECT_NAME} ${PROJECT_VERSION} ${PROJECT_DESCRIPTION} ${PROJECT_URL} ${PROJECT_EMAIL}\nSuite Teardown End Tracker\nTest Setup Start Test ${TEST_NAME} ${TEST_DOCUMENTATION}\nTest Teardown End Test\n```\n\n#### Create a folder in your directory Tracking and create file Justus_Shared.robot eg:\n\nbelow is an example image of how the file should look like\n\n\n\n#### Copy the below code into the file Justus_Shared.robot\n\n```robotframework\n*** Settings ***\nDocumentation This example demonstrates how to use current library and test status in a listener.\nLibrary ListenerLibrary\n#import another python file\nLibrary ../Functions/tracker.py\n\n*** Keywords ***\nListener Keyword\n [Arguments] ${projectName} ${userName} ${crqReference} ${uniqueRunRef}\n\t\n\tLog To Console This line is always executed, ${TEST NAME} : ${TEST STATUS}\n\t# https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#automatic-variables\n \n\t#send request to track testcase\n\ttracker.Track Test Case ${TEST NAME} ${TEST STATUS} ${projectName} ${userName} ${crqReference} ${uniqueRunRef} \n\n\tIF \"${TEST STATUS}\" == \"FAIL\"\n\tLog To Console **********This line is only executed when the test failed.**********\n\t\tAnother Keyword\n\tEND\n\nAnother Keyword\n\tLog To Console This keyword only gets called by the listner when the test failed.\n\nTeardown Keyword\n\tLog To Console The teardown is called after the Listener Keyword, ${TEST NAME}: ${TEST STATUS}\n\tIF \"${TEST STATUS}\" == \"FAIL\"\n\t\tYet Another Keyword\n\tEND\n\nYet Another Keyword\n\tLog To Console This keyword only gets called by the teardown when the test failed.\n```\n#### Create 'tracker.py' inside your Functions folder and copy the below code into it\n\n```python:\nPlease contact mwangijustus12@gmail.com for the source code or be part of the development team.\n```\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Robot Framework Library for Tracking Test Cases",
"version": "1.0.0.4",
"project_urls": null,
"split_keywords": [
"python",
"robotframework",
"robotframework-library",
"robotframework-library",
"robotframework-tracking",
"robotframework-tracker",
"robotframework-tracker",
"robotframework-tracker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cb338465c51ee2b58216664246bc4bcc8db72ee12b25264e1f3dbfd23d141413",
"md5": "5387c6f6020494d3fcbc6c49fdebd050",
"sha256": "987b140a984cec339a5e09fe2c014f02554a5273de4517e66f5bb3aa993454ac"
},
"downloads": -1,
"filename": "automation_tracker-1.0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5387c6f6020494d3fcbc6c49fdebd050",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6581,
"upload_time": "2023-08-21T06:32:24",
"upload_time_iso_8601": "2023-08-21T06:32:24.188520Z",
"url": "https://files.pythonhosted.org/packages/cb/33/8465c51ee2b58216664246bc4bcc8db72ee12b25264e1f3dbfd23d141413/automation_tracker-1.0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "01b48c88e9d87eca04d3dd2b29a3d949739c71d537be49459d9acceb27484ebf",
"md5": "29ee9a0545b0b1e28b5ad0eeff02c7c1",
"sha256": "70f43b84ed83debb71c37663d10e40298c5a2995faf92de9afb1f4a230c9bbf8"
},
"downloads": -1,
"filename": "automation-tracker-1.0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "29ee9a0545b0b1e28b5ad0eeff02c7c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5236,
"upload_time": "2023-08-21T06:32:26",
"upload_time_iso_8601": "2023-08-21T06:32:26.097120Z",
"url": "https://files.pythonhosted.org/packages/01/b4/8c88e9d87eca04d3dd2b29a3d949739c71d537be49459d9acceb27484ebf/automation-tracker-1.0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 06:32:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "automation-tracker"
}
JSON