Introduction:
TroubleShooting Framework is a generic open source test-analysis-fix automation framework for troubleshooting. TroubleShooting Framework is operating system and application independent. The core framework is implemented using Python, supports Python 2.6 and Python 2.7, and run also on Jython,IronPython and Pypy. TroubleShooting Framework project is hosted on GitHub where you can find source code, an issue tracker, and some further documentation.
Installation
If you already have Python with PIP installed,you can simply run:
pip install troubleshooting-framework
Alternatively you can get TroubleShooting Framework source code by downloading the source distribution from PyPI and extracting it, or by cloning the project repository from GitHub. After that you can install the framework with:
python setup.py install
A benefit of using pip is that it automatically installs paramiko and PyCrypto modules that troubleshooting-framework requires on Python. Using pip on Windows with Python works too, but you need to first install PyCrypto module manually.
Development:
1. Create a project
you can simply run:
pytsmgr --operation=startProject --project=<MyProject> --directory=<ProjectDirectory>
2. Add a keyword
new a <keywordName>.py file in <ProjectDirectory>/<MyProject>/keywords folder:
from troubleshooting.framework.template._BaseKeyword import _BaseKeyword
- class keywordName(_BaseKeyword):
- def __init__(self):
super(,self).__init__()
- def getExample(self):
return “example”
3. Add a testpoint
new a <testPointName>.py file in <ProjectDirectory>/<MyProject>/testpoint folder:
from framework.variable.variable import STATUS,LEVEL
from troubleshooting.framework.template._BaseTestPoint import _BaseTestPoint
- class testPointName(_BaseTestPoint):
- def __init__(self):
super(self.__class__,self).__init__()
self.level = LEVLE.CRITICAL
- def _checkpoint(self):
result = self.getExample()
- if result is “example”:
self.status = STATUS.PASS
- else:
self.status = STATUS.FAIL self.IMPACT.append(“system is not working”) self.RCA.append(“Bad luck”) self.FIXSTEP.append(“bathing”) self.FIXSTEP.append(“say hello god!”)
Note: self.status is mandatory, it’s enum type , value is STATUS.PASS or STATUS.FAIL
Note: self.level is option, it’s enum type , value is LEVLE.CRITICAL or LEVLE.NOCRITICAL , default is LEVLE.NOCRITICAL
Note: self.IMPACT , self.RCA and self.FIXSTEP is option, it’s list type.
4. Add a case
new a <caseName>.py file in <ProjectDirectory>/<MyProject>/case folder:
from troubleshooting.framework.template._BaseCase import _BaseCase
- class caseName(_BaseCase):
“”” To Check linux disk usage. “””
- def __init__(self):
super(caseName,self).__init__()
self.passCondition = “{testPointName} is True”
self.tags = “example goodcase”
Note: self.passCondition is mandatory, it’s condition of case pass.
Usage:
Switch folder to <ProjectDirectory>/<MyProject>/ , you can simple run:
pyts --host=192.168.10.10 --user=root --password=root --include=exampleANDsmoke --exclude=NoRunORdisable
Support And Contact:
License
TroubleShooting Framework is open source software provided under the Apache License 2.0. TroubleShooting Framework documentation and other similar content use the Creative Commons Attribution 3.0 Unported license. Most libraries and tools in the ecosystem are also open source, but they may use different licenses. ^
1 maintainer
Release files for troubleshooting-framework 1.3.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| troubleshooting-framework-1.3.1.3.tar.gz | 150.6 kB | Details |
Release files / troubleshooting-framework-1.3.1.3.tar.gz
| Download URL | troubleshooting-framework-1.3.1.3.tar.gz |
|---|---|
| Size | 150.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b1a1f2e45ed98a21abe9f2cbe05c29d24c74185d9952be1af4a484885be79d6
|
|
BLAKE2b-256 checksum How to use checksums |
79c238ff328e459294549ec2794b1580308884a2a0f05d16f27dc9436e03419a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
