| Table of Contents |
|---|
Introduction
...
- Comply with PEP8. It should be enabled by default in Pycharm; for VS Code: https://code.visualstudio.com/docs/python/linting
- Exceptions: you can disable PEP8 E501: line too long. PyCharm: settings > inspections > python > ignore errors. Click '+' and add E501 to the list.
- For vscode, using pycodestyle as linter you can add "python.linting.pycodestyleArgs": ["ignore=E501"] to your settings .json file
- Exceptions: you can disable PEP8 E501: line too long. PyCharm: settings > inspections > python > ignore errors. Click '+' and add E501 to the list.
- Use single quotes, not double quotes
- Class names in PascalCase: class LogServerConnectionNoVsx
- File names in snake_case: log_server_connection_novsx.py
- No "parser" or ".1" in file name (awk naming convention is: fwaccel-stat-novsx.parser.1.awk – don't do this
) - Multi-step scripts are an exception to this: you will want to number your multi-step scripts. See e.g., parsers/src/checkpoint/management/cpmiquery-check-SIC-mds
- No "parser" or ".1" in file name (awk naming convention is: fwaccel-stat-novsx.parser.1.awk – don't do this
- TextFSM templates should have the same base name as the .ind.yaml and .py files, and should have the .textfsm file extension.
- log_server_connection_novsx.ind.yaml
- log_server_connection_novsx.py
- log_server_connection_novsx.textfsm
...
The class name should be UpperCamelCase for example MpstatParser.
2. Data Extraction
The first thing we need to do is to take the raw data and convert it to python object.
...
| Code Block | ||
|---|---|---|
| ||
import os
import unittest
from parsers.test.panw.panos.panos_anti_spyware_info_low_severity.panos_anti_spyware_info_low_severity_parser_1 import LowSevParser1
from parser_service.public.action import WriteDynamicVariable
class TestLowSevParser1(unittest.TestCase):
def setUp(self):
# Arrange
self.parser = LowSevParser1()
self.current_dir = os.path.dirname(os.path.realpath(__file__))
def test_valid_input(self):
# Act
result = self.parser.parse_file(self.current_dir + '/valid_input.xml', {}, {})
# Assert
self.assertEqual(2, len(result))
self.assertTrue(isinstance(result[0], WriteDynamicVariable))
self.assertEqual('profile', result[0].key)
self.assertEqual('Test', result[0].value)
self.assertTrue(isinstance(result[1], WriteDynamicVariable))
self.assertEqual('profile', result[1].key)
self.assertEqual('Test-1', result[1].value)
def test_invalid_input(self):
# Act
result = self.parser.parse_file(self.current_dir + '/invalid_input.xml', {}, {})
# Assert
self.assertEqual(0, len(result))
if __name__ == '__main__':
unittest.main()
|
...