state: change architecture and add get subjects (without property fill)

opencombat/state.py

@@ -1,8 +1,7 @@
 # coding: utf-8
 import importlib
 import typing
-from io import StringIO
-import sys
+from _elementtree import Element
 
 from lxml import etree
 
@@ -11,22 +10,73 @@ from synergine2.log import get_logger
 from synergine2.simulation import Subject
 
 from opencombat.exception import StateLoadError
+from opencombat.simulation.base import TileStrategySimulation
+from opencombat.util import get_class_from_string_path
+
+
+class State(object):
+    def __init__(
+        self,
+        config: Config,
+        state_root: Element,
+        simulation: TileStrategySimulation,
+    ) -> None:
+        self._config = config
+        self._state_root = state_root
+        self._subjects = None  # type: typing.List[Subject]
+        self._simulation = simulation
+
+    @property
+    def subjects(self) -> typing.List[Subject]:
+        if self._subjects is None:
+            self._subjects = self._get_subjects()
+
+        return self._subjects
+
+    def _get_subjects(self) -> typing.List[Subject]:
+        subjects = []
+        subject_elements = self._state_root.find('subjects').findall('subject')
+
+        for subject_element in subject_elements:
+            subject_class_path = subject_element.find('type').text
+            subject_class = get_class_from_string_path(
+                self._config,
+                subject_class_path,
+            )
+            subject = subject_class(self._config, self._simulation)
+
+            # TODO BS 2018-06-13: Fill subject with property
+            subjects.append(subject)
+
+        return subjects
 
 
 class StateLoader(object):
     def __init__(
         self,
         config: Config,
-        state_file_path: str,
+        simulation: TileStrategySimulation,
     ) -> None:
-        self.logger = get_logger('StateLoader', config)
-        self.config = config
-        self.state_file_path = state_file_path
-        self._validate()
+        self._logger = get_logger('StateLoader', config)
+        self._config = config
+        self._simulation = simulation
+
+    def get_state(
+        self,
+        state_file_path: str,
+    ) -> State:
+        return State(
+            self._config,
+            self._validate_and_return_state_element(state_file_path),
+            self._simulation,
+        )
 
-    def _validate(self) -> None:
+    def _validate_and_return_state_element(
+        self,
+        state_file_path: str,
+    ) -> Element:
         # open and read schema file
-        schema_file_path = self.config.get(
+        schema_file_path = self._config.get(
             'global.state_schema',
             'opencombat/state.xsd',
         )
@@ -34,32 +84,32 @@ class StateLoader(object):
             schema_to_check = schema_file.read()
 
         # open and read xml file
-        with open(self.state_file_path, 'r') as xml_file:
+        with open(state_file_path, 'r') as xml_file:
             xml_to_check = xml_file.read()
 
-        xmlschema_doc = etree.parse(StringIO(schema_to_check))
+        xmlschema_doc = etree.fromstring(schema_to_check.encode('utf-8'))
         xmlschema = etree.XMLSchema(xmlschema_doc)
 
         try:
-            doc = etree.parse(StringIO(xml_to_check))
+            doc = etree.fromstring(xml_to_check.encode('utf-8'))
         # check for file IO error
         except IOError as exc:
-            self.logger.error(exc)
+            self._logger.error(exc)
             raise StateLoadError('Invalid File "{}": {}'.format(
-                self.state_file_path,
+                state_file_path,
                 str(exc),
             ))
         # check for XML syntax errors
         except etree.XMLSyntaxError as exc:
-            self.logger.error(exc)
+            self._logger.error(exc)
             raise StateLoadError('XML Syntax Error in "{}": {}'.format(
-                self.state_file_path,
+                state_file_path,
                 str(exc.error_log),
             ))
         except Exception as exc:
-            self.logger.error(exc)
+            self._logger.error(exc)
             raise StateLoadError('Unknown error with "{}": {}'.format(
-                self.state_file_path,
+                state_file_path,
                 str(exc),
             ))
 
@@ -67,44 +117,47 @@ class StateLoader(object):
         try:
             xmlschema.assertValid(doc)
         except etree.DocumentInvalid as exc:
-            self.logger.error(exc)
+            self._logger.error(exc)
             raise StateLoadError(
                 'Schema validation error with "{}": {}'.format(
-                    self.state_file_path,
+                    state_file_path,
                     str(exc),
                 )
             )
         except Exception as exc:
-            self.logger.error(exc)
+            self._logger.error(exc)
             raise StateLoadError(
                 'Unknown validation error with "{}": {}'.format(
-                    self.state_file_path,
+                    state_file_path,
                     str(exc),
                 )
             )
 
-    def get_subjects(self) -> typing.List[Subject]:
-        raise NotImplementedError('TODO')
+        return doc
 
 
 class StateLoaderBuilder(object):
     def __init__(
         self,
         config: Config,
+        simulation: TileStrategySimulation,
     ) -> None:
-        self.logger = get_logger('StateLoader', config)
-        self.config = config
+        self._logger = get_logger('StateLoader', config)
+        self._config = config
+        self._simulation = simulation
 
     def get_state_loader(
         self,
-        state_file_path: str,
     ) -> StateLoader:
-        class_address = self.config.get(
+        class_address = self._config.resolve(
             'global.state_loader',
             'opencombat.state.StateLoader',
         )
-        module_address = '.'.join(class_address.split('.')[:-1])
-        class_name = class_address.split('.')[-1]
-        module_ = importlib.import_module(module_address)
-        state_loader_class = getattr(module_, class_name)
-        return state_loader_class(self.config, state_file_path)
+        state_loader_class = get_class_from_string_path(
+            self._config,
+            class_address,
+        )
+        return state_loader_class(
+            self._config,
+            self._simulation,
+        )

opencombat/util.py

@@ -0,0 +1,15 @@
+# coding: utf-8
+import importlib
+
+
+def get_class_from_string_path(config, string_path: str) -> type:
+    """
+    Return class matching with given path, eg "mymodule.MyClass"
+    :param config: config object
+    :param string_path: class path, eg "mymodule.MyClass"
+    :return: imported class
+    """
+    module_address = '.'.join(string_path.split('.')[:-1])
+    class_name = string_path.split('.')[-1]
+    module_ = importlib.import_module(module_address)
+    return getattr(module_, class_name)

tests/fixtures/main.py

@@ -1,6 +1,7 @@
 # coding: utf-8
 import pytest
 from synergine2.config import Config
+from opencombat.simulation.base import TileStrategySimulation
 
 
 @pytest.fixture()
@@ -8,3 +9,8 @@ def config() -> Config:
     config_ = Config()
     config_.load_yaml('test_config.yaml')
     return config_
+
+
+@pytest.fixture
+def simulation(config) -> TileStrategySimulation:
+    return TileStrategySimulation(config, 'tests/fixtures/map_a/map_a.tmx')

tests/fixtures/map_a/map_a.tmx

@@ -0,0 +1,128 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<map version="1.0" tiledversion="1.1.5" orientation="orthogonal" renderorder="right-down" width="25" height="25" tilewidth="8" tileheight="8" infinite="0" nextobjectid="1">
+ <tileset firstgid="1" source="../../../maps/shared/tilesets/trees.tsx"/>
+ <tileset firstgid="82" source="../../../maps/shared/tilesets/terrain.tsx"/>
+ <tileset firstgid="131" source="../../../maps/shared/tilesets/interiors.tsx"/>
+ <layer name="ground" width="25" height="25">
+  <data encoding="csv">
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
+</data>
+ </layer>
+ <layer name="interiors" width="25" height="25">
+  <data encoding="csv">
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
+</data>
+ </layer>
+ <layer name="terrain" width="25" height="25">
+  <data encoding="csv">
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
+</data>
+ </layer>
+ <layer name="top" width="25" height="25">
+  <data encoding="csv">
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,
+0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0
+</data>
+ </layer>
+ <imagelayer name="interior">
+  <image source="interiors.png" width="200" height="200"/>
+ </imagelayer>
+ <imagelayer name="background">
+  <image source="background.png" width="200" height="200"/>
+ </imagelayer>
+</map>

tests/fixtures/state_empty.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?>

tests/fixtures/state_error_schema.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<state type="before_battle">
+    <map>
+        <name>001</name>
+    </map>
+    <subjects>
+        <subject>
+            <type>opencombat.simulation.subject.ManSubject</type>
+            <position>1,1</position>
+            <direction>90</direction>
+            <mode>standup</mode>
+            <side>URSS</side>
+        </subject>
+        <subjectFOO>
+            <type>opencombat.simulation.subject.ManSubject</type>
+            <position>10,10</position>
+            <direction>270</direction>
+            <mode>hiding</mode>
+            <side>DE</side>
+        </subjectFOO>
+    </subjects>
+</state>

tests/fixtures/state_ok.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<state type="before_battle">
+    <map>
+        <name>001</name>
+    </map>
+    <subjects>
+        <subject>
+            <type>opencombat.simulation.subject.ManSubject</type>
+            <position>1,1</position>
+            <direction>90</direction>
+            <mode>standup</mode>
+            <side>URSS</side>
+        </subject>
+        <subject>
+            <type>opencombat.simulation.subject.ManSubject</type>
+            <position>10,10</position>
+            <direction>270</direction>
+            <mode>hiding</mode>
+            <side>DE</side>
+        </subject>
+    </subjects>
+</state>

tests/test_state.py

@@ -0,0 +1,57 @@
+# coding: utf-8
+import pytest
+from synergine2.config import Config
+
+from opencombat.exception import StateLoadError
+from opencombat.state import StateLoaderBuilder, StateLoader
+
+
+class MyStateLoader(StateLoader):
+    pass
+
+
+@pytest.fixture
+def state_loader(config, simulation):
+    return StateLoader(config, simulation)
+
+
+def test_state_loader_builder__ok__nominal_case(
+    simulation,
+):
+    config = Config({
+        'global': {
+            'state_loader': 'tests.test_state.MyStateLoader',
+        }
+    })
+    builder = StateLoaderBuilder(config, simulation)
+    state_loader = builder.get_state_loader()
+    assert type(state_loader) == MyStateLoader
+
+
+def test_state_loader__ok__load_state(
+    state_loader,
+):
+    assert state_loader.get_state('tests/fixtures/state_ok.xml')
+
+
+def test_state_loader__error__state_empty(
+    state_loader,
+):
+    with pytest.raises(StateLoadError):
+        assert state_loader.get_state('tests/fixtures/state_empty.xml')
+
+
+def test_state_loader__error__state_invalid(
+    state_loader,
+):
+    with pytest.raises(StateLoadError):
+        assert state_loader.get_state(
+            'tests/fixtures/state_error_schema.xml',
+        )
+
+
+def test_state__ok__subjects(
+    state_loader,
+):
+    state = state_loader.get_state('tests/fixtures/state_ok.xml')
+    assert 2 == len(state.subjects)