docs: testing section added

Author: danila-schelkov

README.md

@@ -1,51 +1,89 @@
 # XCoder - easy to use modding tool
+
 Multiplatform modding tool for ANY Supercell\`s game.
 
 ## About
-Work with Supercell\`s files on **any** os! SC and CSV are supported for all Supercell\`s games.
+
+Work with Supercell\`s files on **any** os! SC and CSV are supported for all
+Supercell\`s games.
 
 ### Features:
+
 - SC compile / decompile;
 - Compression and decompression.
 
 ### How to install and use
+
 - On Windows:
-  - Download Python 3.7 or newer version from [official page](https://www.python.org/downloads/);
-  - Install Python. While Installing, enable such parameters as "Add Python to PATH", "Install pip", "Install py launcher", "Associate files with Python" and "Add Python to environment variables";
-  - Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
-  - Locate the extracted directory and install required modules: 
-    ```pip install -r requirements.txt```;
-  - Execute "main.py" file.
+    - Download Python 3.7 or newer version
+      from [official page](https://www.python.org/downloads/);
+    - Install Python. While Installing, enable such parameters as "Add Python to
+      PATH", "Install pip", "Install py launcher", "Associate files with Python" and "
+      Add Python to environment variables";
+    - Download XCoder from
+      the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
+    - Locate the extracted directory and install required modules:
+      ```pip install -r requirements.txt```;
+    - Execute "main.py" file.
 
 - On Linux:
-  - Open Terminal and install Python by executing following command: 
-    ```sudo apt-get update && sudo apt-get install python3 python3-pip```;
-  - Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
-  - Locate the extracted directory and install required modules by executing following command:
-    ```sudo pip3 install -r requirements.txt```;
-  - Execute "main.py" file.
+    - Open Terminal and install Python by executing following command:
+      ```sudo apt-get update && sudo apt-get install python3 python3-pip```;
+    - Download XCoder from
+      the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
+    - Locate the extracted directory and install required modules by executing following
+      command:
+      ```sudo pip3 install -r requirements.txt```;
+    - Execute "main.py" file.
 
 - On Android:
-  - Download and install PyDroid app from [Google Play](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3);
-  - Open PyDroid and wait until Python installs;
-  - Download XCoder from the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
-  - Install loguru using pip;
-  - In PyDroid open and execute "main.py" file.
+    - Download and install PyDroid app
+      from [Google Play](https://play.google.com/store/apps/details?id=ru.iiec.pydroid3);
+    - Open PyDroid and wait until Python installs;
+    - Download XCoder from
+      the [releases page](https://github.com/Vorono4ka/XCoder/releases) and extract it;
+    - Install loguru using pip;
+    - In PyDroid open and execute "main.py" file.
+
+### Testing
+
+The project supports unit-testing using the unittest module. To run tests by yourself, you can use the command:
+
+```cmd
+python -m unittest
+```
+
+or
+
+```sh
+python3 -m unittest
+```
+
+or using the poetry
+
+```sh
+poetry run python -m unittest
+```
 
 ### How to enable KTX section
 
-![KTX section demo](docs/KTX section.png)
+![KTX section demo](docs/KTX%20section.png)
 
-**Supercell also uses KTX textures in new versions of the games, so it is advisable to perform this step.**
+**Supercell also uses KTX textures in new versions of the games, so it is advisable to
+perform this step.**
 
-To enable the KTX module, you need to get the "PVRTexToolCLI" binary from the official site: https://developer.imaginationtech.com/pvrtextool/. 
+To enable the KTX module, you need to get the "PVRTexToolCLI" binary from the official
+site: https://developer.imaginationtech.com/pvrtextool/.
 
 Then it is necessary to put CLI in "system/bin/" folder in the main script folder.
 
 ### In the plans:
+
 - CSV updating.
 
 ## Credits
-This tool is based on Original [XCoder](https://github.com/MasterDevX/xcoder), Developer: [MasterDevX](https://github.com/MasterDevX)</br>
+
+This tool is based on Original [XCoder](https://github.com/MasterDevX/xcoder),
+Developer: [MasterDevX](https://github.com/MasterDevX)</br>
 
 Many thanks to [spiky_Spike](https://github.com/spiky-s) for the provided developments

tests/__init__.py

@@ -0,0 +1,62 @@
+from unittest import TestCase
+
+from system.lib.math.point import Point
+from system.lib.math.polygon import PointOrder, Polygon, get_polygon_point_order
+
+
+def create_polygon_from_tuple(*polygon: tuple[float, float]) -> Polygon:
+    return [Point(x, y) for x, y in polygon]
+
+
+class PolygonTestCase(TestCase):
+    def test_clockwise_square(self):
+        polygon = create_polygon_from_tuple(
+            (0.0, 0.0), (0.0, 1.0), (1.0, 1.0), (1.0, 0.0)
+        )
+
+        self.assertEqual(PointOrder.CLOCKWISE, get_polygon_point_order(polygon))
+
+    def test_clockwise_real1(self):
+        polygon = create_polygon_from_tuple(
+            (4.0, 4.0), (5.0, -2.0), (-1.0, -4.0), (-6.0, 0.0), (-2.0, 5.0), (0.0, 1.0)
+        )
+
+        self.assertEqual(PointOrder.CLOCKWISE, get_polygon_point_order(polygon))
+
+    def test_clockwise_real2(self):
+        polygon = create_polygon_from_tuple(
+            (160.0, -73.0),
+            (89.0, -73.0),
+            (89.0, -10.0),
+            (143.0, 10.0),
+            (156.0, 10.0),
+            (160.0, -46.0),
+        )
+
+        self.assertEqual(PointOrder.CLOCKWISE, get_polygon_point_order(polygon))
+
+    def test_counter_clockwise_real1(self):
+        polygon = create_polygon_from_tuple(
+            (5.0, 0.0), (6.0, 4.0), (4.0, 5.0), (1.0, 5.0), (1.0, 0.0)
+        )
+
+        self.assertEqual(PointOrder.COUNTER_CLOCKWISE, get_polygon_point_order(polygon))
+
+    def test_counter_clockwise_real2(self):
+        polygon = create_polygon_from_tuple(
+            (0.0, 0.0), (11.0, 0.0), (0.0, 10.0), (10.0, 10.0)
+        )
+
+        self.assertEqual(PointOrder.COUNTER_CLOCKWISE, get_polygon_point_order(polygon))
+
+    def test_counter_clockwise_real3(self):
+        polygon = create_polygon_from_tuple(
+            (20.0, -73.0),
+            (91.0, -73.0),
+            (91.0, -10.0),
+            (37.0, 10.0),
+            (24.0, 10.0),
+            (20.0, -46.0),
+        )
+
+        self.assertEqual(PointOrder.COUNTER_CLOCKWISE, get_polygon_point_order(polygon))