src/Mod/CAM/CAMTests/PathTestUtils.py

# SPDX-License-Identifier: LGPL-2.1-or-later

# ***************************************************************************
# *   Copyright (c) 2016 sliptonic <shopinthewoods@gmail.com>               *
# *                                                                         *
# *   This program is free software; you can redistribute it and/or modify  *
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
# *   as published by the Free Software Foundation; either version 2 of     *
# *   the License, or (at your option) any later version.                   *
# *   for detail see the LICENCE text file.                                 *
# *                                                                         *
# *   This program is distributed in the hope that it will be useful,       *
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
# *   GNU Library General Public License for more details.                  *
# *                                                                         *
# *   You should have received a copy of the GNU Library General Public     *
# *   License along with this program; if not, write to the Free Software   *
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
# *   USA                                                                   *
# *                                                                         *
# ***************************************************************************

import FreeCAD
import os
import Part
import Path
import math
import pathlib
import unittest
from Path.Tool.assets import AssetManager, MemoryStore, DummyAssetSerializer
from Path.Tool.library.serializers import FCTLSerializer
from Path.Tool.toolbit.serializers import FCTBSerializer
from Path.Tool.camassets import ensure_assets_initialized, ensure_toolbitshape_assets_present
from Path.Tool.library import Library
from Path.Tool.toolbit import ToolBit
from Path.Tool.shape import ToolBitShape
from Path.Tool.shape.models.icon import ToolBitShapeSvgIcon, ToolBitShapePngIcon

from FreeCAD import Vector


class PathTestBase(unittest.TestCase):
    """Base test class with some additional asserts."""

    def assertRoughly(self, f1, f2, error=0.00001):
        """Verify that two float values are approximately the same."""
        self.assertTrue(math.fabs(f1 - f2) < error, "%f != %f" % (f1, f2))

    def assertCoincide(self, pt1, pt2, error=0.0001):
        """Verify that two points coincide - roughly speaking."""
        self.assertRoughly(pt1.x, pt2.x, error)
        self.assertRoughly(pt1.y, pt2.y, error)
        self.assertRoughly(pt1.z, pt2.z, error)

    def assertPlacement(self, p1, p2):
        """Verify that two placements are roughly identical."""
        self.assertCoincide(p1.Base, p2.Base)
        self.assertCoincide(p1.Rotation.Axis, p2.Rotation.Axis)
        self.assertTrue(p1.Rotation.isSame(p2.Rotation))

    def assertLine(self, edge, pt1, pt2):
        """Verify that edge is a line from pt1 to pt2."""
        # Depending on the setting of LineOld ....
        self.assertTrue(type(edge.Curve) is Part.Line or type(edge.Curve) is Part.LineSegment)
        self.assertCoincide(pt1, edge.valueAt(edge.FirstParameter))
        self.assertCoincide(pt2, edge.valueAt(edge.LastParameter))

    def assertLines(self, edgs, tail, points):
        """Verify that the edges match the polygon resulting from points."""
        edges = list(edgs)
        if tail:
            edges.append(tail)
        self.assertEqual(len(edges), len(points) - 1)

        for i in range(0, len(edges)):
            self.assertLine(edges[i], points[i], points[i + 1])

    def assertArc(self, edge, pt1, pt2, direction="CW"):
        """Verify that edge is an arc between pt1 and pt2 with the given direction."""
        self.assertIs(type(edge.Curve), Part.Circle)
        self.assertCoincide(edge.valueAt(edge.FirstParameter), pt1)
        self.assertCoincide(edge.valueAt(edge.LastParameter), pt2)
        ptm = edge.valueAt((edge.LastParameter + edge.FirstParameter) / 2)
        side = Path.Geom.Side.of(pt2 - pt1, ptm - pt1)
        if "CW" == direction:
            self.assertEqual(side, Path.Geom.Side.Left)
        else:
            self.assertEqual(side, Path.Geom.Side.Right)

    def assertCircle(self, edge, pt, r):
        """Verify that edge is a circle at given location."""
        curve = edge.Curve
        self.assertIs(type(curve), Part.Circle)
        self.assertCoincide(curve.Center, Vector(pt.x, pt.y, pt.z))
        self.assertRoughly(curve.Radius, r)

    def assertCurve(self, edge, p1, p2, p3):
        """Verify that the edge goes through the given 3 points, representing start, mid and end point respectively."""
        self.assertCoincide(edge.valueAt(edge.FirstParameter), p1)
        self.assertCoincide(edge.valueAt(edge.LastParameter), p3)
        self.assertCoincide(edge.valueAt((edge.FirstParameter + edge.LastParameter) / 2), p2)

    def assertCylinderAt(self, solid, pt, r, h):
        """Verify that solid is a cylinder at the specified location."""
        self.assertEqual(len(solid.Edges), 3)

        lid = solid.Edges[0]
        hull = solid.Edges[1]
        base = solid.Edges[2]

        self.assertCircle(lid, Vector(pt.x, pt.y, pt.z + h), r)
        self.assertLine(hull, Vector(pt.x + r, pt.y, pt.z), Vector(pt.x + r, pt.y, pt.z + h))
        self.assertCircle(base, Vector(pt.x, pt.y, pt.z), r)

    def assertConeAt(self, solid, pt, r1, r2, h):
        """Verify that solid is a cone at the specified location."""
        self.assertEqual(len(solid.Edges), 3)

        lid = solid.Edges[0]
        hull = solid.Edges[1]
        base = solid.Edges[2]

        self.assertCircle(lid, Vector(pt.x, pt.y, pt.z + h), r2)
        self.assertLine(hull, Vector(pt.x + r1, pt.y, pt.z), Vector(pt.x + r2, pt.y, pt.z + h))
        self.assertCircle(base, Vector(pt.x, pt.y, pt.z), r1)

    def assertCommandEqual(self, c1, c2):
        """Verify that the 2 commands are equivalent."""
        self.assertEqual(c1.Name, c2.Name)

        self.assertRoughly(c1.Parameters.get("X", 0), c2.Parameters.get("X", 0))
        self.assertRoughly(c1.Parameters.get("Y", 0), c2.Parameters.get("Y", 0))
        self.assertRoughly(c1.Parameters.get("Z", 0), c2.Parameters.get("Z", 0))

        self.assertRoughly(c1.Parameters.get("I", 0), c2.Parameters.get("I", 0))
        self.assertRoughly(c1.Parameters.get("J", 0), c2.Parameters.get("J", 0))
        self.assertRoughly(c1.Parameters.get("K", 0), c2.Parameters.get("K", 0))

    def assertEqualLocale(self, s1, s2):
        """Verify that the 2 strings are equivalent, but converts eventual , into . for the first string that may be affected by locale."""
        # self.assertEqual(s1.replace(",","."), s2)
        q1 = FreeCAD.Units.Quantity(s1)
        q2 = FreeCAD.Units.Quantity(s2)
        self.assertEqual(q1.UserString, q2.UserString)

    def assertEdgeShapesMatch(self, e1, e2):
        """Verify that 2 edges have the same shape, regardless of orientation."""
        self.assertEqual(type(e1.Curve), type(e2.Curve))
        self.assertEqual(len(e1.Vertexes), len(e2.Vertexes))
        if not e1.Vertexes:
            self.assertEqual(Part.Line, type(e1.Curve))
            k1 = e1.valueAt(e1.LastParameter) - e1.valueAt(e1.FirstParameter)
            k2 = e2.valueAt(e2.LastParameter) - e2.valueAt(e2.FirstParameter)
            self.assertCoincide(k1, -k2)
        elif 1 == len(e1.Vertexes):
            self.assertEqual(Part.Circle, type(e1.Curve))
            self.assertRoughly(e1.Curve.Radius, e2.Curve.Radius)
            self.assertCoincide(e1.Curve.Center, e2.Curve.Center)
            self.assertCoincide(e1.Curve.Axis, -e2.Curve.Axis)
        else:

            def valueAt(e, fraction):
                return e.valueAt(e.FirstParameter + (e.LastParameter - e.FirstParameter) * fraction)

            if Path.Geom.pointsCoincide(e1.Vertexes[0].Point, e2.Vertexes[0].Point):
                self.assertCoincide(e1.Vertexes[-1].Point, e2.Vertexes[-1].Point)
                self.assertCoincide(valueAt(e1, 0.10), valueAt(e2, 0.10))
                self.assertCoincide(valueAt(e1, 0.20), valueAt(e2, 0.20))
                self.assertCoincide(valueAt(e1, 0.25), valueAt(e2, 0.25))
                self.assertCoincide(valueAt(e1, 0.30), valueAt(e2, 0.30))
                self.assertCoincide(valueAt(e1, 0.40), valueAt(e2, 0.40))
                self.assertCoincide(valueAt(e1, 0.50), valueAt(e2, 0.50))
                self.assertCoincide(valueAt(e1, 0.60), valueAt(e2, 0.60))
                self.assertCoincide(valueAt(e1, 0.70), valueAt(e2, 0.70))
                self.assertCoincide(valueAt(e1, 0.75), valueAt(e2, 0.75))
                self.assertCoincide(valueAt(e1, 0.80), valueAt(e2, 0.80))
                self.assertCoincide(valueAt(e1, 0.90), valueAt(e2, 0.90))
            else:
                self.assertCoincide(e1.Vertexes[0].Point, e2.Vertexes[-1].Point)
                self.assertCoincide(e1.Vertexes[-1].Point, e2.Vertexes[0].Point)
                self.assertCoincide(valueAt(e1, 0.10), valueAt(e2, 0.90))
                self.assertCoincide(valueAt(e1, 0.20), valueAt(e2, 0.80))
                self.assertCoincide(valueAt(e1, 0.25), valueAt(e2, 0.75))
                self.assertCoincide(valueAt(e1, 0.30), valueAt(e2, 0.70))
                self.assertCoincide(valueAt(e1, 0.40), valueAt(e2, 0.60))
                self.assertCoincide(valueAt(e1, 0.50), valueAt(e2, 0.50))
                self.assertCoincide(valueAt(e1, 0.60), valueAt(e2, 0.40))
                self.assertCoincide(valueAt(e1, 0.70), valueAt(e2, 0.30))
                self.assertCoincide(valueAt(e1, 0.75), valueAt(e2, 0.25))
                self.assertCoincide(valueAt(e1, 0.80), valueAt(e2, 0.20))
                self.assertCoincide(valueAt(e1, 0.90), valueAt(e2, 0.10))

    def assertPointsMatch(self, pts0, pts1):
        """Verify that two arrays of points are the same, including their order."""
        self.assertEqual(len(pts0), len(pts1))
        for i in range(len(pts0)):
            self.assertCoincide(pts0[i], pts1[i])

    def assertSuccessfulRecompute(self, doc, *objs, msg=None):
        """Asserts that the given objects can be successfully recomputed."""
        if len(objs) == 0:
            doc.recompute()
            objs = doc.Objects
        else:
            doc.recompute(objs)
        failed_objects = [o.Name for o in objs if "Invalid" in o.State]
        if len(failed_objects) > 0:
            self.fail(msg or f"Recompute failed for {failed_objects}")


class PathTestWithAssets(PathTestBase):
    """
    A base class that creates an AssetManager, so tests can easily fetch
    test data. Examples:

        toolbit = self.assets.get("toolbit://ballend")
        toolbit = self.assets.get("toolbitshape://chamfer")
    """

    __tool_dir = pathlib.Path(os.path.realpath(__file__)).parent.parent / "Tools"

    def setUp(self):
        # Set up the manager with an in-memory store.
        self.assets: AssetManager = AssetManager()
        self.asset_store: MemoryStore = MemoryStore("local")
        self.assets.register_store(self.asset_store)

        # Register some asset classes.
        self.assets.register_asset(Library, FCTLSerializer)
        self.assets.register_asset(ToolBit, FCTBSerializer)
        self.assets.register_asset(ToolBitShape, DummyAssetSerializer)
        self.assets.register_asset(ToolBitShapeSvgIcon, DummyAssetSerializer)
        self.assets.register_asset(ToolBitShapePngIcon, DummyAssetSerializer)

        # Include the built-in assets from src/Mod/CAM/Tools.
        # These functions only copy if there are no assets, so this
        # must be done BEFORE adding the additional test assets below.
        ensure_toolbitshape_assets_present(self.assets, self.asset_store.name)
        ensure_assets_initialized(self.assets, self.asset_store.name)

        # Additional test assets.
        for path in pathlib.Path(self.__tool_dir / "Bit").glob("*.fctb"):
            self.assets.add_file("toolbit", path)
        for path in pathlib.Path(self.__tool_dir / "Shape").glob("*.fcstd"):
            self.assets.add_file("toolbitshape", path)

    def tearDown(self):
        del self.assets
        del self.asset_store