def test_collect_from_localhost(self, path_mock):
"""
Should initialize collectors for the example file "collect-from-localhost.xml"
"""
from instructionparsers.xmlparser import XmlParser
instructions = '../examples/collect-from-localhost.xml'
try:
xml_parser = XmlParser(instructionspath=instructions,
protocol=None)
xml_parser._instructionspath = instructions
xml_parser._init_instructions()
except Exception:
self.fail(f"Failed to initialize parser for '{instructions}'.")
def test__validate_schema_minimal_valid_instructions(self):
"""
Should do nothing.
"""
from instructionparsers.xmlparser import XmlParser
try:
XmlParser.XMLSCHEMA_PATH = '../instructionparsers/xmlparser.xsd'
XmlParser._validate_schema(
xmlfilepath='./instructions/minimal_valid_instructions.xml')
except XMLSchemaException:
self.fail(
"_validate_schema should not raise exception with valid xml instructions."
)
def test_instructionspath_instruction_file_not_there(
self, placeholder_mock, xmlparser_mock, isfile_mock, schema_mock,
initmetadata_mock):
"""
Will raise FileNotFound exeption.
"""
from instructionparsers.xmlparser import XmlParser
expected_file = 'test_instructions.xml'
isfile_mock.return_value = True
xml_parser = XmlParser(instructionspath=expected_file, protocol=None)
isfile_mock.return_value = False
with self.assertRaises(FileNotFoundError):
xml_parser.instructionspath = expected_file
def test__get_first_instruction_element(self, path_mock):
"""
Should return the xml element with the title "Root".
"""
from instructionparsers.xmlparser import XmlParser
instructions = './instructions/valid_instructions.xml'
xml_parser = XmlParser(instructionspath=instructions, protocol=None)
xml_parser._instructionspath = instructions
element = xml_parser._get_first_instruction_element()
self.assertIsInstance(element, Element)
self.assertEqual(element.localName, 'Root')
def test__init_instructions_valid_instructions(self, path_mock):
"""
Should initialize collectors for all XML elements which have the attribute "module".
"""
from instructionparsers.xmlparser import XmlParser
from instructionparsers.wrapper import InstructionWrapper
instructions = './instructions/valid_instructions.xml'
xml_parser = XmlParser(instructionspath=instructions, protocol=None)
xml_parser._instructionspath = instructions
instructionstree = xml_parser._init_instructions()
self.assertIsInstance(instructionstree, InstructionWrapper)
def test__initializemetadata_valid_instructions(self, path_mock):
"""
Should initialize member 'metadata' with all elements which have the attribute "title".
"""
metadata = ('Examiner', 'Assignment', 'Client',
'Description of Artefact', 'Task Description')
from instructionparsers.xmlparser import XmlParser
instructions = './instructions/valid_instructions.xml'
xml_parser = XmlParser(instructionspath=instructions, protocol=None)
xml_parser._instructionspath = instructions
xml_parser._initializemetadata()
for data in metadata:
with self.subTest(data):
self.assertIsNotNone(xml_parser.metadata[data])
def test_collect_all(self, path_mock):
"""
Should initialize collectors for the example file "collect-all.xml"
"""
from instructionparsers.xmlparser import XmlParser
instructions = '../examples/collect-all.xml'
if platform.system() == 'Windows':
instructions = '..\examples\collect-all-windows.xml'
try:
xml_parser = XmlParser(instructionspath=instructions,
protocol=None)
xml_parser._instructionspath = instructions
xml_parser._init_instructions()
except Exception:
self.fail(f"Failed to initialize parser for '{instructions}'.")
def test_collect_from_image(self, path_mock):
"""
Should initialize collectors for the example file "collect-from-image.xml"
"""
from instructionparsers.xmlparser import XmlParser
instructions = '../examples/collect-from-image.xml'
try:
xml_parser = XmlParser(instructionspath=instructions,
protocol=None)
xml_parser._instructionspath = instructions
xml_parser._init_instructions()
except FileNotFoundError:
# Assume the file not found is from the missing ewf file in the example instructions.
pass
except Exception:
self.fail(f"Failed to initialize parser for '{instructions}'.")
def test__get_placeholder_name_no_placeholder(self):
"""
If XmlElement does not contain attribute "placeholder" method should return an empty string.
"""
from instructionparsers.xmlparser import XmlParser
#from xml.dom.minidom import Element
element = Element('Demo')
result = XmlParser._get_placeholder_name(element)
self.assertEqual(result, '')
def test__get_placeholder_name(self):
"""
If XmlElement contains attribute "placeholder" method should return value of this attribute.
"""
from instructionparsers.xmlparser import XmlParser
document = Document()
element = document.createElement('Demo')
element.setAttribute(XmlParser.PLACEHOLDERNAME_ATTRIBUTE, "test")
result = XmlParser._get_placeholder_name(element)
self.assertEqual(result, 'test')
def test_instructionspath(self, placeholder_mock, xmlparser_mock,
isfile_mock, schema_mock, initmetadata_mock):
"""
Will return the instructions file path set in __init__
"""
from instructionparsers.xmlparser import XmlParser
expected_file = 'test_instructions.xml'
isfile_mock.return_value = True
xml_parser = XmlParser(instructionspath=expected_file, protocol=None)
actual_file = xml_parser.instructionspath
self.assertEqual(expected_file, actual_file)
def get_collector(
cls,
instructionsfile: str,
examiner: str = '',
placeholderfile: str = Placeholder.get_globalplaceholderfile(),
protocollogfile: str = ''):
Placeholder.set_globalplaceholderfile(placeholderfile)
cls._logger.debug(f"Protocol log file: '{protocollogfile}'")
protocol = LogFileProtocol(examiner,
own_protocol_filename=protocollogfile)
xmlparser = XmlParser(instructionsfile, protocol)
collector = cls(parser=xmlparser, protocol=protocol)
return collector
def test__get_parameter_attributes_return_userdict(self, path_mock):
"""
Should return UserDict
"""
from instructionparsers.xmlparser import XmlParser
from collections import UserDict
elem = parse("./instructions/instructions_stub.xml"
).documentElement.childNodes[1]
actual = XmlParser._get_parameter_attributes(
attributes=elem.attributes)
self.assertIsInstance(actual, UserDict)
def test__get_parameter_attributes_return_userdict_with_2_entries(
self, path_mock):
"""
Should return dict with two entries
"""
from instructionparsers.xmlparser import XmlParser
from collections import UserDict
elem = parse("./instructions/instructions_stub.xml"
).documentElement.childNodes[1]
actual = XmlParser._get_parameter_attributes(
attributes=elem.attributes)
self.assertEqual(len(actual), 2)
def test__get_parameter_attributes_should_return_none_special_attributes(
self, path_mock):
"""
Should return dicitionry with "users_with_homedir" key and with "properties" key.
"""
from instructionparsers.xmlparser import XmlParser
from collections import UserDict
elem = parse("./instructions/instructions_stub.xml"
).documentElement.childNodes[1]
actual = XmlParser._get_parameter_attributes(
attributes=elem.attributes)
self.assertIsNotNone(actual.get("properties"))
self.assertIsNotNone(actual.get("users_with_homedir"))
def test__init_instructions_valid_instructions(self, path_mock):
"""
Should return the instruction tree starting with "Root" node.
"""
from instructionparsers.xmlparser import XmlParser
instructions = './instructions/valid_instructions.xml'
xml_parser = XmlParser(instructionspath=instructions, protocol=None)
xml_parser._instructionspath = instructions
instructionstree = xml_parser._init_instructions()
self.assertEqual(instructionstree.instructionname, 'Root')
self.assertEqual(
instructionstree.instructionchildren[0].instructionname,
'LocalHost')
self.assertEqual(
instructionstree.instructionchildren[0].instructionchildren[0].
instructionname, 'MachineName')
self.assertEqual(
instructionstree.instructionchildren[1].instructionname,
'LocalHost')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[0].
instructionname, 'OSName')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[1].
instructionname, 'OSVersion')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[2].
instructionname, 'OSTimezone')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[3].
instructionname, 'AllUsernames')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[4].
instructionname, 'CurrentUser')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[5].
instructionname, 'SudoVersion')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[6].
instructionname, 'FileExistence')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[7].
instructionname, 'FileExistence')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[8].
instructionname, 'FileExistence')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[9].
instructionname, 'FileExistence')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[10].
instructionname, 'FileExistence')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[11].
instructionname, 'ShellHistoryOfAllUsers')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[12].
instructionname, 'NVRAMCollector')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[13].
instructionname, 'TimeFromNTPServer')
self.assertEqual(
instructionstree.instructionchildren[1].instructionchildren[14].
instructionname, 'LocalTime')