kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

CAM: converted the refactored* postprocessors to the new (more object-oriented) API (#19006)

Browse Source 
* CAM:  converted the refactored* postprocessors to the new API

      with corresponding tests

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
LarryWoestman
2025-02-10 08:37:57 -08:00
committed by GitHub
parent 1de6c974c0
commit 0edcb29f09
14 changed files with 2557 additions and 1755 deletions
Download Patch File Download Diff File Expand all files Collapse all files

238
src/Mod/CAM/CAMTests/TestRefactoredCentroidPost.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2022 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2022 - 2025 Larry Woestman <LarryWoestman2@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) *
@@ -21,13 +21,11 @@
# * *
# ***************************************************************************
from importlib import reload
import FreeCAD
import Path
import CAMTests.PathTestUtils as PathTestUtils
from Path.Post.scripts import refactored_centroid_post as postprocessor
from Path.Post.Processor import PostProcessorFactory
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
@@ -35,9 +33,12 @@ Path.Log.trackModule(Path.Log.thisModule())
class TestRefactoredCentroidPost(PathTestUtils.PathTestBase):
"""Test the refactored_centroid_post.py postprocessor."""
@classmethod
def setUpClass(cls):
"""setUpClass()...
This method is called upon instantiation of this test class. Add code
and objects here that are needed for the duration of the test() methods
in this class. In other words, set up the 'global' test environment
@@ -46,63 +47,108 @@ class TestRefactoredCentroidPost(PathTestUtils.PathTestBase):
is able to call static methods within this same class.
"""
# Open existing FreeCAD document with test geometry
FreeCAD.newDocument("Unnamed")
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "True")
cls.doc = FreeCAD.open(FreeCAD.getHomePath() + "/Mod/CAM/CAMTests/boxtest.fcstd")
cls.job = cls.doc.getObject("Job")
cls.post = PostProcessorFactory.get_post_processor(cls.job, "refactored_centroid")
# locate the operation named "Profile"
for op in cls.job.Operations.Group:
if op.Label == "Profile":
# remember the "Profile" operation
cls.profile_op = op
return
@classmethod
def tearDownClass(cls):
"""tearDownClass()...
This method is called prior to destruction of this test class. Add
code and objects here that cleanup the test environment after the
test() methods in this class have been executed. This method does not
have access to the class `self` reference. This method is able to
call static methods within this same class.
"""
# Close geometry document without saving
FreeCAD.closeDocument(FreeCAD.ActiveDocument.Name)
FreeCAD.closeDocument(cls.doc.Name)
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "")
# Setup and tear down methods called before and after each unit test
def setUp(self):
"""setUp()...
This method is called prior to each `test()` method. Add code and
objects here that are needed for multiple `test()` methods.
"""
self.doc = FreeCAD.ActiveDocument
self.con = FreeCAD.Console
self.docobj = FreeCAD.ActiveDocument.addObject("Path::Feature", "testpath")
reload(
postprocessor
) # technical debt. This shouldn't be necessary but here to bypass a bug
# allow a full length "diff" if an error occurs
self.maxDiff = None
# reinitialize the postprocessor data structures between tests
self.post.reinitialize()
def tearDown(self):
"""tearDown()...
This method is called after each test() method. Add cleanup instructions here.
Such cleanup instructions will likely undo those in the setUp() method.
"""
FreeCAD.ActiveDocument.removeObject("testpath")
pass
def single_compare(self, path, expected, args, debug=False):
"""Perform a test with a single line of gcode comparison."""
nl = "\n"
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
# there are 4 lines of "other stuff" before the line we are interested in
self.assertEqual(gcode.splitlines()[4], expected)
def multi_compare(self, path, expected, args, debug=False):
"""Perform a test with multiple lines of gcode comparison."""
nl = "\n"
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def test000(self):
"""Test Output Generation.
Empty path. Produces only the preamble and postable.
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
# Test generating with header
# Header contains a time stamp that messes up unit testing.
# Only test length of result.
args = "--no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertTrue(len(gcode.splitlines()) == 16)
self.job.PostProcessorArgs = "--no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertTrue(len(gcode.splitlines()) == 25)
# Test without header
expected = """G90 G80 G40 G49
;T1=TC__Default_Tool
;Begin preamble
G53 G00 G17
G21
;Begin operation
;End operation: testpath
G54
;End operation: Fixture
;Begin operation
;TC: Default Tool
;Begin toolchange
M6 T1
;End operation: TC: Default Tool
;Begin operation
;End operation: Profile
;Begin postamble
M5
M25
@@ -111,17 +157,17 @@ G90 G80 G40 G49
M99
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
# test without comments
expected = """G90 G80 G40 G49
G53 G00 G17
G21
G54
M6 T1
M5
M25
G49 H0
@@ -129,29 +175,33 @@ G90 G80 G40 G49
M99
"""
args = "--no-header --no-comments --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-comments --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def test010(self):
"""Test command Generation.
Test Precision
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[14]
expected = "G0 X10.0000 Y20.0000 Z30.0000"
self.assertEqual(result, expected)
args = "--no-header --axis-precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --axis-precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[14]
expected = "G0 X10.00 Y20.00 Z30.00"
self.assertEqual(result, expected)
@@ -159,27 +209,32 @@ M99
"""
Test Line Numbers
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --line-numbers --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
expected = "N150 G0 X10.0000 Y20.0000 Z30.0000"
self.job.PostProcessorArgs = "--no-header --line-numbers --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[14]
expected = "N240 G0 X10.0000 Y20.0000 Z30.0000"
self.assertEqual(result, expected)
def test030(self):
"""
Test Pre-amble
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
args = "--no-header --no-comments --preamble='G18 G55' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = (
"--no-header --no-comments --preamble='G18 G55' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[1]
self.assertEqual(result, "G18 G55")
@@ -187,10 +242,15 @@ M99
"""
Test Post-amble
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
nl = "\n"
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = (
"--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[-2]
self.assertEqual(result, "G0 Z50")
self.assertEqual(gcode.splitlines()[-1], "M2")
@@ -199,22 +259,25 @@ M99
"""
Test inches
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = "--no-header --inches --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[3], "G20")
self.profile_op.Path = Path.Path([c])
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --inches --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[4], "G20")
result = gcode.splitlines()[14]
expected = "G0 X0.3937 Y0.7874 Z1.1811"
self.assertEqual(result, expected)
args = "--no-header --inches --axis-precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --inches --axis-precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[14]
expected = "G0 X0.39 Y0.79 Z1.18"
self.assertEqual(result, expected)
@@ -223,15 +286,17 @@ M99
Test test modal
Suppress the command name if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "X10.0000 Y30.0000 Z30.0000"
self.assertEqual(result, expected)
@@ -240,15 +305,17 @@ M99
Test axis modal
Suppress the axis coordinate if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --axis-modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --axis-modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "G0 Y30.0000"
self.assertEqual(result, expected)
@@ -256,33 +323,38 @@ M99
"""
Test tool change
"""
nl = "\n"
c = Path.Command("M6 T2")
c2 = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c, c2])
postables = [self.docobj]
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[6], "M6 T2")
self.assertEqual(gcode.splitlines()[7], "M3 S3000")
self.profile_op.Path = Path.Path([c, c2])
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[15], "M6 T2")
self.assertEqual(gcode.splitlines()[16], "M3 S3000")
# suppress TLO
args = "--no-header --no-tlo --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[7], "M3 S3000")
self.job.PostProcessorArgs = "--no-header --no-tlo --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[16], "M3 S3000")
def test090(self):
"""
Test comment
"""
nl = "\n"
c = Path.Command("(comment)")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[14]
expected = ";comment"
self.assertEqual(result, expected)

216
src/Mod/CAM/CAMTests/TestRefactoredGrblPost.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2022 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2022 - 2025 Larry Woestman <LarryWoestman2@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) *
@@ -21,13 +21,11 @@
# * *
# ***************************************************************************
from importlib import reload
import FreeCAD
import Path
import CAMTests.PathTestUtils as PathTestUtils
from Path.Post.scripts import refactored_grbl_post as postprocessor
from Path.Post.Processor import PostProcessorFactory
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
@@ -35,9 +33,12 @@ Path.Log.trackModule(Path.Log.thisModule())
class TestRefactoredGrblPost(PathTestUtils.PathTestBase):
"""Test the refactored_grbl_post.py postprocessor."""
@classmethod
def setUpClass(cls):
"""setUpClass()...
This method is called upon instantiation of this test class. Add code
and objects here that are needed for the duration of the test() methods
in this class. In other words, set up the 'global' test environment
@@ -46,108 +47,135 @@ class TestRefactoredGrblPost(PathTestUtils.PathTestBase):
is able to call static methods within this same class.
"""
# Open existing FreeCAD document with test geometry
FreeCAD.newDocument("Unnamed")
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "True")
cls.doc = FreeCAD.open(FreeCAD.getHomePath() + "/Mod/CAM/CAMTests/boxtest.fcstd")
cls.job = cls.doc.getObject("Job")
cls.post = PostProcessorFactory.get_post_processor(cls.job, "refactored_grbl")
# locate the operation named "Profile"
for op in cls.job.Operations.Group:
if op.Label == "Profile":
# remember the "Profile" operation
cls.profile_op = op
return
@classmethod
def tearDownClass(cls):
"""tearDownClass()...
This method is called prior to destruction of this test class. Add
code and objects here that cleanup the test environment after the
test() methods in this class have been executed. This method does not
have access to the class `self` reference. This method
is able to call static methods within this same class.
"""
# Close geometry document without saving
FreeCAD.closeDocument(FreeCAD.ActiveDocument.Name)
FreeCAD.closeDocument(cls.doc.Name)
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "")
# Setup and tear down methods called before and after each unit test
def setUp(self):
"""setUp()...
This method is called prior to each `test()` method. Add code and
objects here that are needed for multiple `test()` methods.
"""
self.doc = FreeCAD.ActiveDocument
self.con = FreeCAD.Console
self.docobj = FreeCAD.ActiveDocument.addObject("Path::Feature", "testpath")
reload(
postprocessor
) # technical debt. This shouldn't be necessary but here to bypass a bug
# allow a full length "diff" if an error occurs
self.maxDiff = None
# reinitialize the postprocessor data structures between tests
self.post.reinitialize()
def tearDown(self):
"""tearDown()...
This method is called after each test() method. Add cleanup instructions here.
Such cleanup instructions will likely undo those in the setUp() method.
"""
FreeCAD.ActiveDocument.removeObject("testpath")
pass
def test000(self):
"""Test Output Generation.
Empty path. Produces only the preamble and postable.
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
# Test generating with header
# Header contains a time stamp that messes up unit testing.
# Only test length of result.
args = "--no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertTrue(len(gcode.splitlines()) == 14)
self.job.PostProcessorArgs = "--no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertTrue(len(gcode.splitlines()) == 24)
# Test without header
expected = """(Begin preamble)
G17 G90
G21
(Begin operation: testpath)
(Path: testpath)
(Finish operation: testpath)
(Begin operation: Fixture)
(Path: Fixture)
G54
(Finish operation: Fixture)
(Begin operation: TC: Default Tool)
(Path: TC: Default Tool)
(TC: Default Tool)
(Begin toolchange)
( M6 T1 )
(Finish operation: TC: Default Tool)
(Begin operation: Profile)
(Path: Profile)
(Finish operation: Profile)
(Begin postamble)
M5
G17 G90
M2
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
args = "--no-header --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
# test without comments
expected = """G17 G90
G21
G54
M6 T1
M5
G17 G90
M2
"""
args = "--no-header --no-comments --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-comments --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def test010(self):
"""Test command Generation.
Test Precision
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "G0 X10.000 Y20.000 Z30.000"
self.assertEqual(result, expected)
args = "--no-header --precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "G0 X10.00 Y20.00 Z30.00"
self.assertEqual(result, expected)
@@ -155,27 +183,32 @@ M2
"""
Test Line Numbers
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --line-numbers --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
expected = "N150 G0 X10.000 Y20.000 Z30.000"
self.job.PostProcessorArgs = "--no-header --line-numbers --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "N250 G0 X10.000 Y20.000 Z30.000"
self.assertEqual(result, expected)
def test030(self):
"""
Test Pre-amble
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
args = "--no-header --no-comments --preamble='G18 G55' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = (
"--no-header --no-comments --preamble='G18 G55' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[0]
self.assertEqual(result, "G18 G55")
@@ -183,10 +216,15 @@ M2
"""
Test Post-amble
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
nl = "\n"
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = (
"--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[-2]
self.assertEqual(result, "G0 Z50")
self.assertEqual(gcode.splitlines()[-1], "M2")
@@ -195,22 +233,25 @@ M2
"""
Test inches
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = "--no-header --inches --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.profile_op.Path = Path.Path([c])
self.job.PostProcessorArgs = "--no-header --inches --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[2], "G20")
result = gcode.splitlines()[5]
result = gcode.splitlines()[15]
expected = "G0 X0.3937 Y0.7874 Z1.1811"
self.assertEqual(result, expected)
args = "--no-header --inches --precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --inches --precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "G0 X0.39 Y0.79 Z1.18"
self.assertEqual(result, expected)
@@ -219,15 +260,17 @@ M2
Test test modal
Suppress the command name if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[16]
expected = "X10.000 Y30.000 Z30.000"
self.assertEqual(result, expected)
@@ -236,15 +279,17 @@ M2
Test axis modal
Suppress the axis coordinate if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --axis-modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --axis-modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[16]
expected = "G0 Y30.000"
self.assertEqual(result, expected)
@@ -252,33 +297,38 @@ M2
"""
Test tool change
"""
nl = "\n"
c = Path.Command("M6 T2")
c2 = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c, c2])
postables = [self.docobj]
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[6], "( M6 T2 )")
self.assertEqual(gcode.splitlines()[7], "M3 S3000")
self.profile_op.Path = Path.Path([c, c2])
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[16], "( M6 T2 )")
self.assertEqual(gcode.splitlines()[17], "M3 S3000")
# suppress TLO
args = "--no-header --no-tlo --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[7], "M3 S3000")
self.job.PostProcessorArgs = "--no-header --no-tlo --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[17], "M3 S3000")
def test090(self):
"""
Test comment
"""
nl = "\n"
c = Path.Command("(comment)")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[15]
expected = "(comment)"
self.assertEqual(result, expected)

223
src/Mod/CAM/CAMTests/TestRefactoredLinuxCNCPost.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2022 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2022 - 2025 Larry Woestman <LarryWoestman2@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) *
@@ -29,13 +29,11 @@
# ***************************************************************************
from importlib import reload
import FreeCAD
import Path
import CAMTests.PathTestUtils as PathTestUtils
from Path.Post.scripts import refactored_linuxcnc_post as postprocessor
from Path.Post.Processor import PostProcessorFactory
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
@@ -43,9 +41,12 @@ Path.Log.trackModule(Path.Log.thisModule())
class TestRefactoredLinuxCNCPost(PathTestUtils.PathTestBase):
"""Test the refactored_linuxcnc_post.py postprocessor."""
@classmethod
def setUpClass(cls):
"""setUpClass()...
This method is called upon instantiation of this test class. Add code
and objects here that are needed for the duration of the test() methods
in this class. In other words, set up the 'global' test environment
@@ -54,108 +55,139 @@ class TestRefactoredLinuxCNCPost(PathTestUtils.PathTestBase):
is able to call static methods within this same class.
"""
# Open existing FreeCAD document with test geometry
FreeCAD.newDocument("Unnamed")
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "True")
cls.doc = FreeCAD.open(FreeCAD.getHomePath() + "/Mod/CAM/CAMTests/boxtest.fcstd")
cls.job = cls.doc.getObject("Job")
cls.post = PostProcessorFactory.get_post_processor(cls.job, "refactored_linuxcnc")
# locate the operation named "Profile"
for op in cls.job.Operations.Group:
if op.Label == "Profile":
# remember the "Profile" operation
cls.profile_op = op
return
@classmethod
def tearDownClass(cls):
"""tearDownClass()...
This method is called prior to destruction of this test class. Add
code and objects here that cleanup the test environment after the
test() methods in this class have been executed. This method does not
have access to the class `self` reference. This method
is able to call static methods within this same class.
"""
# Close geometry document without saving
FreeCAD.closeDocument(FreeCAD.ActiveDocument.Name)
FreeCAD.closeDocument(cls.doc.Name)
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "")
# Setup and tear down methods called before and after each unit test
def setUp(self):
"""setUp()...
This method is called prior to each `test()` method. Add code and
objects here that are needed for multiple `test()` methods.
"""
self.doc = FreeCAD.ActiveDocument
self.con = FreeCAD.Console
self.docobj = FreeCAD.ActiveDocument.addObject("Path::Feature", "testpath")
reload(
postprocessor
) # technical debt. This shouldn't be necessary but here to bypass a bug
# allow a full length "diff" if an error occurs
self.maxDiff = None
# reinitialize the postprocessor data structures between tests
self.post.reinitialize()
def tearDown(self):
"""tearDown()...
This method is called after each test() method. Add cleanup instructions here.
Such cleanup instructions will likely undo those in the setUp() method.
"""
FreeCAD.ActiveDocument.removeObject("testpath")
pass
def test000(self):
"""Test Output Generation.
Empty path. Produces only the preamble and postable.
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
# Test generating with header
# Header contains a time stamp that messes up unit testing.
# Only test length of result.
args = "--no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertTrue(len(gcode.splitlines()) == 14)
self.job.PostProcessorArgs = "--no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertTrue(len(gcode.splitlines()) == 26)
# Test without header
expected = """(Begin preamble)
G17 G54 G40 G49 G80 G90
G21
(Begin operation: testpath)
(Begin operation: Fixture)
(Machine units: mm/min)
(Finish operation: testpath)
G54
(Finish operation: Fixture)
(Begin operation: TC: Default Tool)
(Machine units: mm/min)
(TC: Default Tool)
(Begin toolchange)
M5
M6 T1
G43 H1
(Finish operation: TC: Default Tool)
(Begin operation: Profile)
(Machine units: mm/min)
(Finish operation: Profile)
(Begin postamble)
M05
G17 G54 G90 G80 G40
M2
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
args = "--no-header --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
# test without comments
expected = """G17 G54 G40 G49 G80 G90
G21
G54
M5
M6 T1
G43 H1
M05
G17 G54 G90 G80 G40
M2
"""
args = "--no-header --no-comments --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-comments --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def test010(self):
"""Test command Generation.
Test Precision
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "G0 X10.000 Y20.000 Z30.000"
self.assertEqual(result, expected)
args = "--no-header --precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "G0 X10.00 Y20.00 Z30.00"
self.assertEqual(result, expected)
@@ -163,27 +195,32 @@ M2
"""
Test Line Numbers
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --line-numbers --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
expected = "N150 G0 X10.000 Y20.000 Z30.000"
self.job.PostProcessorArgs = "--no-header --line-numbers --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "N270 G0 X10.000 Y20.000 Z30.000"
self.assertEqual(result, expected)
def test030(self):
"""
Test Pre-amble
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
args = "--no-header --no-comments --preamble='G18 G55' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = (
"--no-header --no-comments --preamble='G18 G55' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[0]
self.assertEqual(result, "G18 G55")
@@ -191,10 +228,15 @@ M2
"""
Test Post-amble
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
nl = "\n"
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = (
"--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[-2]
self.assertEqual(result, "G0 Z50")
self.assertEqual(gcode.splitlines()[-1], "M2")
@@ -203,22 +245,25 @@ M2
"""
Test inches
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = "--no-header --inches --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.profile_op.Path = Path.Path([c])
self.job.PostProcessorArgs = "--no-header --inches --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[2], "G20")
result = gcode.splitlines()[5]
result = gcode.splitlines()[17]
expected = "G0 X0.3937 Y0.7874 Z1.1811"
self.assertEqual(result, expected)
args = "--no-header --inches --precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --inches --precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "G0 X0.39 Y0.79 Z1.18"
self.assertEqual(result, expected)
@@ -227,15 +272,17 @@ M2
Test test modal
Suppress the command name if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[18]
expected = "X10.000 Y30.000 Z30.000"
self.assertEqual(result, expected)
@@ -244,15 +291,17 @@ M2
Test axis modal
Suppress the axis coordinate if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --axis-modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --axis-modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[18]
expected = "G0 Y30.000"
self.assertEqual(result, expected)
@@ -260,35 +309,41 @@ M2
"""
Test tool change
"""
nl = "\n"
c = Path.Command("M6 T2")
c2 = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c, c2])
postables = [self.docobj]
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[6], "M5")
self.assertEqual(gcode.splitlines()[7], "M6 T2")
self.assertEqual(gcode.splitlines()[8], "G43 H2")
self.assertEqual(gcode.splitlines()[9], "M3 S3000")
self.profile_op.Path = Path.Path([c, c2])
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
split_gcode = gcode.splitlines()
self.assertEqual(split_gcode[18], "M5")
self.assertEqual(split_gcode[19], "M6 T2")
self.assertEqual(split_gcode[20], "G43 H2")
self.assertEqual(split_gcode[21], "M3 S3000")
# suppress TLO
args = "--no-header --no-tlo --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[8], "M3 S3000")
self.job.PostProcessorArgs = "--no-header --no-tlo --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[19], "M3 S3000")
def test090(self):
"""
Test comment
"""
nl = "\n"
c = Path.Command("(comment)")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "(comment)"
self.assertEqual(result, expected)

249
src/Mod/CAM/CAMTests/TestRefactoredMach3Mach4Post.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2022 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2022 - 2025 Larry Woestman <LarryWoestman2@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) *
@@ -21,22 +21,24 @@
# * *
# ***************************************************************************
from importlib import reload
import FreeCAD
import Path
import CAMTests.PathTestUtils as PathTestUtils
from Path.Post.scripts import refactored_mach3_mach4_post as postprocessor
from Path.Post.Processor import PostProcessorFactory
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
Path.Log.trackModule(Path.Log.thisModule())
class TestRefactoredMach3Mach4Post(PathTestUtils.PathTestBase):
"""Test the refactored_mach3_mach4_post.py postprocessor."""
@classmethod
def setUpClass(cls) -> None:
"""setUpClass()...
This method is called upon instantiation of this test class. Add code
and objects here that are needed for the duration of the test() methods
in this class. In other words, set up the 'global' test environment
@@ -45,108 +47,162 @@ class TestRefactoredMach3Mach4Post(PathTestUtils.PathTestBase):
is able to call static methods within this same class.
"""
# Open existing FreeCAD document with test geometry
FreeCAD.newDocument("Unnamed")
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "True")
cls.doc = FreeCAD.open(FreeCAD.getHomePath() + "/Mod/CAM/CAMTests/boxtest.fcstd")
cls.job = cls.doc.getObject("Job")
cls.post = PostProcessorFactory.get_post_processor(cls.job, "refactored_mach3_mach4")
# locate the operation named "Profile"
for op in cls.job.Operations.Group:
if op.Label == "Profile":
# remember the "Profile" operation
cls.profile_op = op
return
@classmethod
def tearDownClass(cls) -> None:
"""tearDownClass()...
This method is called prior to destruction of this test class. Add
code and objects here that cleanup the test environment after the
test() methods in this class have been executed. This method does not
have access to the class `self` reference. This method is able to
call static methods within this same class.
"""
# Close geometry document without saving
FreeCAD.closeDocument(FreeCAD.ActiveDocument.Name)
FreeCAD.closeDocument(cls.doc.Name)
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "")
# Setup and tear down methods called before and after each unit test
def setUp(self) -> None:
"""setUp()...
This method is called prior to each `test()` method. Add code and
objects here that are needed for multiple `test()` methods.
"""
self.doc = FreeCAD.ActiveDocument
self.con = FreeCAD.Console
self.docobj = FreeCAD.ActiveDocument.addObject("Path::Feature", "testpath")
reload(
postprocessor
) # technical debt. This shouldn't be necessary but here to bypass a bug
# allow a full length "diff" if an error occurs
self.maxDiff = None
# reinitialize the postprocessor data structures between tests
self.post.reinitialize()
def tearDown(self) -> None:
"""tearDown()...
This method is called after each test() method. Add cleanup instructions here.
Such cleanup instructions will likely undo those in the setUp() method.
"""
FreeCAD.ActiveDocument.removeObject("testpath")
pass
def single_compare(self, path, expected, args, debug=False):
"""Perform a test with a single line of gcode comparison."""
nl = "\n"
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
# there are 4 lines of "other stuff" before the line we are interested in
self.assertEqual(gcode.splitlines()[4], expected)
def multi_compare(self, path, expected, args, debug=False):
"""Perform a test with multiple lines of gcode comparison."""
nl = "\n"
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def test000(self) -> None:
"""Test Output Generation.
Empty path. Produces only the preamble and postable.
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
# Test generating with header
# Header contains a time stamp that messes up unit testing.
# Only test length of result.
args = "--no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertTrue(len(gcode.splitlines()) == 14)
self.job.PostProcessorArgs = "--no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertTrue(len(gcode.splitlines()) == 26)
# Test without header
expected = """(Begin preamble)
G17 G54 G40 G49 G80 G90
G21
(Begin operation: testpath)
(Begin operation: Fixture)
(Machine: mach3_4, mm/min)
(Finish operation: testpath)
G54
(Finish operation: Fixture)
(Begin operation: TC: Default Tool)
(Machine: mach3_4, mm/min)
(TC: Default Tool)
(Begin toolchange)
M5
M6 T1
G43 H1
(Finish operation: TC: Default Tool)
(Begin operation: Profile)
(Machine: mach3_4, mm/min)
(Finish operation: Profile)
(Begin postamble)
M05
G17 G54 G90 G80 G40
M2
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--no-header --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
# test without comments
expected = """G17 G54 G40 G49 G80 G90
G21
G54
M5
M6 T1
G43 H1
M05
G17 G54 G90 G80 G40
M2
"""
args = "--no-header --no-comments --no-show-editor"
# args = ("--no-header --no-comments --no-show-editor --precision=2")
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = "--no-header --no-comments --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def test010(self):
"""Test command Generation.
Test Precision
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "G0 X10.000 Y20.000 Z30.000"
self.assertEqual(result, expected)
args = "--no-header --precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "G0 X10.00 Y20.00 Z30.00"
self.assertEqual(result, expected)
@@ -154,27 +210,32 @@ M2
"""
Test Line Numbers
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --line-numbers --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
expected = "N150 G0 X10.000 Y20.000 Z30.000"
self.job.PostProcessorArgs = "--no-header --line-numbers --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "N270 G0 X10.000 Y20.000 Z30.000"
self.assertEqual(result, expected)
def test030(self):
"""
Test Pre-amble
"""
nl = "\n"
self.docobj.Path = Path.Path([])
postables = [self.docobj]
self.profile_op.Path = Path.Path([])
args = "--no-header --no-comments --preamble='G18 G55' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = (
"--no-header --no-comments --preamble='G18 G55' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[0]
self.assertEqual(result, "G18 G55")
@@ -182,10 +243,15 @@ M2
"""
Test Post-amble
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
nl = "\n"
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = (
"--no-header --no-comments --postamble='G0 Z50\nM2' --no-show-editor"
)
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[-2]
self.assertEqual(result, "G0 Z50")
self.assertEqual(gcode.splitlines()[-1], "M2")
@@ -194,22 +260,25 @@ M2
"""
Test inches
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = "--no-header --inches --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.profile_op.Path = Path.Path([c])
self.job.PostProcessorArgs = "--no-header --inches --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[2], "G20")
result = gcode.splitlines()[5]
result = gcode.splitlines()[17]
expected = "G0 X0.3937 Y0.7874 Z1.1811"
self.assertEqual(result, expected)
args = "--no-header --inches --precision=2 --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --inches --precision=2 --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "G0 X0.39 Y0.79 Z1.18"
self.assertEqual(result, expected)
@@ -218,15 +287,17 @@ M2
Test test modal
Suppress the command name if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[18]
expected = "X10.000 Y30.000 Z30.000"
self.assertEqual(result, expected)
@@ -235,15 +306,17 @@ M2
Test axis modal
Suppress the axis coordinate if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c, c1])
args = "--no-header --axis-modal --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[6]
self.job.PostProcessorArgs = "--no-header --axis-modal --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[18]
expected = "G0 Y30.000"
self.assertEqual(result, expected)
@@ -251,35 +324,41 @@ M2
"""
Test tool change
"""
nl = "\n"
c = Path.Command("M6 T2")
c2 = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c, c2])
postables = [self.docobj]
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[6], "M5")
self.assertEqual(gcode.splitlines()[7], "M6 T2")
self.assertEqual(gcode.splitlines()[8], "G43 H2")
self.assertEqual(gcode.splitlines()[9], "M3 S3000")
self.profile_op.Path = Path.Path([c, c2])
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
split_gcode = gcode.splitlines()
self.assertEqual(split_gcode[18], "M5")
self.assertEqual(split_gcode[19], "M6 T2")
self.assertEqual(split_gcode[20], "G43 H2")
self.assertEqual(split_gcode[21], "M3 S3000")
# suppress TLO
args = "--no-header --no-tlo --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
self.assertEqual(gcode.splitlines()[8], "M3 S3000")
self.job.PostProcessorArgs = "--no-header --no-tlo --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[19], "M3 S3000")
def test090(self):
"""
Test comment
"""
nl = "\n"
c = Path.Command("(comment)")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
args = "--no-header --no-show-editor"
gcode = postprocessor.export(postables, "-", args)
result = gcode.splitlines()[5]
self.job.PostProcessorArgs = "--no-header --no-show-editor"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
result = gcode.splitlines()[17]
expected = "(comment)"
self.assertEqual(result, expected)

451
src/Mod/CAM/CAMTests/TestRefactoredTestPost.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2022 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022-2023 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2022-2025 Larry Woestman <LarryWoestman2@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) *
@@ -25,7 +25,7 @@ import FreeCAD
import Path
import CAMTests.PathTestUtils as PathTestUtils
from Path.Post.scripts import refactored_test_post as postprocessor
from Path.Post.Processor import PostProcessorFactory
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
@@ -33,6 +33,8 @@ Path.Log.trackModule(Path.Log.thisModule())
class TestRefactoredTestPost(PathTestUtils.PathTestBase):
"""Test the refactored_test_post.py postprocessor command line arguments."""
@classmethod
def setUpClass(cls):
"""setUpClass()...
@@ -44,8 +46,16 @@ class TestRefactoredTestPost(PathTestUtils.PathTestBase):
This method does not have access to the class `self` reference, but it
is able to call static methods within this same class.
"""
# Open existing FreeCAD document with test geometry
FreeCAD.newDocument("Unnamed")
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "True")
cls.doc = FreeCAD.open(FreeCAD.getHomePath() + "/Mod/CAM/CAMTests/boxtest.fcstd")
cls.job = cls.doc.getObject("Job")
cls.post = PostProcessorFactory.get_post_processor(cls.job, "refactored_test")
# locate the operation named "Profile"
for op in cls.job.Operations.Group:
if op.Label == "Profile":
# remember the "Profile" operation
cls.profile_op = op
return
@classmethod
def tearDownClass(cls):
@@ -57,8 +67,8 @@ class TestRefactoredTestPost(PathTestUtils.PathTestBase):
not have access to the class `self` reference. This method is able
to call static methods within this same class.
"""
# Close geometry document without saving
FreeCAD.closeDocument(FreeCAD.ActiveDocument.Name)
FreeCAD.closeDocument(cls.doc.Name)
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "")
# Setup and tear down methods called before and after each unit test
@@ -68,15 +78,12 @@ class TestRefactoredTestPost(PathTestUtils.PathTestBase):
This method is called prior to each `test()` method. Add code and
objects here that are needed for multiple `test()` methods.
"""
# allow a full length "diff" if an error occurs
self.maxDiff = None
self.doc = FreeCAD.ActiveDocument
self.con = FreeCAD.Console
self.docobj = FreeCAD.ActiveDocument.addObject("Path::Feature", "testpath")
#
# Re-initialize all of the values before doing a test.
# reinitialize the postprocessor data structures between tests
#
postprocessor.UNITS = "G21"
postprocessor.init_values(postprocessor.global_values)
self.post.reinitialize()
def tearDown(self):
"""tearDown()...
@@ -84,39 +91,42 @@ class TestRefactoredTestPost(PathTestUtils.PathTestBase):
This method is called after each test() method. Add cleanup instructions here.
Such cleanup instructions will likely undo those in the setUp() method.
"""
FreeCAD.ActiveDocument.removeObject("testpath")
pass
def single_compare(self, path, expected, args, debug=False):
"""Perform a test with a single comparison."""
"""Perform a test with a single line of gcode comparison."""
nl = "\n"
self.docobj.Path = Path.Path(path)
postables = [self.docobj]
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
# there are 4 lines of "other stuff" before the line we are interested in
self.assertEqual(gcode.splitlines()[4], expected)
def multi_compare(self, path, expected, args, debug=False):
"""Perform a test with multiple lines of gcode comparison."""
nl = "\n"
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def compare_third_line(self, path_string, expected, args, debug=False):
"""Perform a test with a single comparison to the third line of the output."""
nl = "\n"
if path_string:
self.docobj.Path = Path.Path([Path.Command(path_string)])
else:
self.docobj.Path = Path.Path([])
postables = [self.docobj]
gcode = postprocessor.export(postables, "-", args)
if debug:
print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[2], expected)
#############################################################################
#
# The tests are organized into groups:
#
# 00000 - 00099 tests that don't fit any other category
# 00100 - 00999 tests for all of the various arguments/options
# 01000 - 01999 tests for the various G codes at 1000 + 10 * g_code_value
# 02000 - 02999 tests for the various M codes at 2000 + 10 * m_code_value
# 00100 - 09999 tests for all of the various arguments/options
# 10000 - 18999 tests for the various G codes at 10000 + 10 * g_code_value
# 19000 - 19999 tests for the A, B, and C axis outputs
# 20000 - 29999 tests for the various M codes at 20000 + 10 * m_code_value
#
#############################################################################
@@ -125,37 +135,45 @@ class TestRefactoredTestPost(PathTestUtils.PathTestBase):
Suppress the axis coordinate if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.profile_op.Path = Path.Path([c, c1])
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
self.job.PostProcessorArgs = "--axis-modal"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[5], "G0 Y30.000")
args = "--axis-modal"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[3], "G0 Y30.000")
args = "--no-axis-modal"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[3], "G0 X10.000 Y30.000 Z30.000")
self.job.PostProcessorArgs = "--no-axis-modal"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[5], "G0 X10.000 Y30.000 Z30.000")
#############################################################################
def test00110(self):
"""Test axis-precision."""
self.compare_third_line("G0 X10 Y20 Z30", "G0 X10.00 Y20.00 Z30.00", "--axis-precision=2")
self.single_compare("G0 X10 Y20 Z30", "G0 X10.00 Y20.00 Z30.00", "--axis-precision=2")
#############################################################################
def test00120(self):
"""Test bcnc."""
self.single_compare(
self.multi_compare(
[],
"""G90
G21
(Block-name: testpath)
(Block-name: Fixture)
(Block-expand: 0)
(Block-enable: 1)
G54
(Block-name: TC: Default Tool)
(Block-expand: 0)
(Block-enable: 1)
M6 T1
(Block-name: Profile)
(Block-expand: 0)
(Block-enable: 1)
(Block-name: post_amble)
@@ -164,10 +182,12 @@ G21
""",
"--bcnc",
)
self.single_compare(
self.multi_compare(
[],
"""G90
G21
G54
M6 T1
""",
"--no-bcnc",
)
@@ -176,37 +196,38 @@ G21
def test00130(self):
"""Test comments."""
nl = "\n"
c = Path.Command("(comment)")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = "--comments"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[4], "(comment)")
self.profile_op.Path = Path.Path([c])
self.job.PostProcessorArgs = "--comments"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[12], "(comment)")
#############################################################################
def test00140(self):
"""Test feed-precision."""
#
nl = "\n"
c = Path.Command("G1 X10 Y20 Z30 F123.123456")
self.profile_op.Path = Path.Path([c])
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = ""
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.job.PostProcessorArgs = ""
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
# Note: The "internal" F speed is in mm/s,
# while the output F speed is in mm/min.
self.assertEqual(gcode.splitlines()[2], "G1 X10.000 Y20.000 Z30.000 F7387.407")
self.assertEqual(gcode.splitlines()[4], "G1 X10.000 Y20.000 Z30.000 F7387.407")
args = "--feed-precision=2"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.job.PostProcessorArgs = "--feed-precision=2"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
# Note: The "internal" F speed is in mm/s,
# while the output F speed is in mm/min.
self.assertEqual(gcode.splitlines()[2], "G1 X10.000 Y20.000 Z30.000 F7387.41")
self.assertEqual(gcode.splitlines()[4], "G1 X10.000 Y20.000 Z30.000 F7387.41")
#############################################################################
@@ -215,90 +236,107 @@ G21
Also tests the interactions between --comments and --header.
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
nl = "\n"
self.profile_op.Path = Path.Path([])
# Test generating with comments and header.
self.job.PostProcessorArgs = "--comments --header"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
split_gcode = gcode.splitlines()
self.assertEqual(split_gcode[0], "(Exported by FreeCAD)")
self.assertEqual(split_gcode[1], "(Post Processor: refactored_test_post)")
self.assertEqual(split_gcode[2], "(Cam File: boxtest.fcstd)")
# The header contains a time stamp that messes up unit testing.
# Only test the length of the line that contains the time.
args = "--comments --header"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[0], "(Exported by FreeCAD)")
self.assertEqual(
gcode.splitlines()[1],
"(Post Processor: Path.Post.scripts.refactored_test_post)",
)
self.assertEqual(gcode.splitlines()[2], "(Cam File: )")
self.assertIn("(Output Time: ", gcode.splitlines()[3])
self.assertTrue(len(gcode.splitlines()[3]) == 41)
self.assertEqual(gcode.splitlines()[4], "(Begin preamble)")
self.assertEqual(gcode.splitlines()[5], "G90")
self.assertEqual(gcode.splitlines()[6], "G21")
self.assertEqual(gcode.splitlines()[7], "(Begin operation)")
self.assertEqual(gcode.splitlines()[8], "(Finish operation: testpath)")
self.assertEqual(gcode.splitlines()[9], "(Begin postamble)")
self.assertIn("(Output Time: ", split_gcode[3])
self.assertTrue(len(split_gcode[3]) == 41)
self.assertEqual(split_gcode[4], "(Begin preamble)")
self.assertEqual(split_gcode[5], "G90")
self.assertEqual(split_gcode[6], "G21")
self.assertEqual(split_gcode[7], "(Begin operation)")
self.assertEqual(split_gcode[8], "G54")
self.assertEqual(split_gcode[9], "(Finish operation: Fixture)")
self.assertEqual(split_gcode[10], "(Begin operation)")
self.assertEqual(split_gcode[11], "(TC: Default Tool)")
self.assertEqual(split_gcode[12], "(Begin toolchange)")
self.assertEqual(split_gcode[13], "( M6 T1 )")
self.assertEqual(split_gcode[14], "(Finish operation: TC: Default Tool)")
self.assertEqual(split_gcode[15], "(Begin operation)")
self.assertEqual(split_gcode[16], "(Finish operation: Profile)")
self.assertEqual(split_gcode[17], "(Begin postamble)")
# Test with comments without header.
expected = """(Begin preamble)
G90
G21
(Begin operation)
(Finish operation: testpath)
G54
(Finish operation: Fixture)
(Begin operation)
(TC: Default Tool)
(Begin toolchange)
( M6 T1 )
(Finish operation: TC: Default Tool)
(Begin operation)
(Finish operation: Profile)
(Begin postamble)
"""
args = "--comments --no-header"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.job.PostProcessorArgs = "--comments --no-header"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
# Test without comments with header.
args = "--no-comments --header"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[0], "(Exported by FreeCAD)")
self.assertEqual(
gcode.splitlines()[1],
"(Post Processor: Path.Post.scripts.refactored_test_post)",
)
self.assertEqual(gcode.splitlines()[2], "(Cam File: )")
self.assertIn("(Output Time: ", gcode.splitlines()[3])
self.assertTrue(len(gcode.splitlines()[3]) == 41)
self.assertEqual(gcode.splitlines()[4], "G90")
self.assertEqual(gcode.splitlines()[5], "G21")
self.job.PostProcessorArgs = "--no-comments --header"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[0], "(Exported by FreeCAD)")
self.assertEqual(split_gcode[1], "(Post Processor: refactored_test_post)")
self.assertEqual(split_gcode[2], "(Cam File: boxtest.fcstd)")
# The header contains a time stamp that messes up unit testing.
# Only test the length of the line that contains the time.
self.assertIn("(Output Time: ", split_gcode[3])
self.assertTrue(len(split_gcode[3]) == 41)
self.assertEqual(split_gcode[4], "G90")
self.assertEqual(split_gcode[5], "G21")
self.assertEqual(split_gcode[6], "G54")
self.assertEqual(split_gcode[7], "M6 T1")
# Test without comments or header.
expected = """G90
G21
G54
M6 T1
"""
args = "--no-comments --no-header"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.job.PostProcessorArgs = "--no-comments --no-header"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
#############################################################################
def test00160(self):
"""Test Line Numbers."""
self.compare_third_line(
"G0 X10 Y20 Z30", "N120 G0 X10.000 Y20.000 Z30.000", "--line-numbers"
)
self.single_compare("G0 X10 Y20 Z30", "N140 G0 X10.000 Y20.000 Z30.000", "--line-numbers")
#############################################################################
def test00170(self):
"""Test inches."""
#
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30 A10 B20 C30 U10 V20 W30")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = "--inches"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.profile_op.Path = Path.Path([c])
self.job.PostProcessorArgs = "--inches"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[1], "G20")
self.assertEqual(
gcode.splitlines()[2],
gcode.splitlines()[4],
"G0 X0.3937 Y0.7874 Z1.1811 A10.0000 B20.0000 C30.0000 U0.3937 V0.7874 W1.1811",
)
@@ -309,18 +347,20 @@ G21
Suppress the command name if the same as previous
"""
nl = "\n"
c = Path.Command("G0 X10 Y20 Z30")
c1 = Path.Command("G0 X10 Y30 Z30")
self.docobj.Path = Path.Path([c, c1])
postables = [self.docobj]
args = "--modal"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[3], "X10.000 Y30.000 Z30.000")
args = "--no-modal"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[3], "G0 X10.000 Y30.000 Z30.000")
self.profile_op.Path = Path.Path([c, c1])
self.job.PostProcessorArgs = "--modal"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[5], "X10.000 Y30.000 Z30.000")
self.job.PostProcessorArgs = "--no-modal"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[5], "G0 X10.000 Y30.000 Z30.000")
#############################################################################
@@ -329,6 +369,8 @@ G21
Empty path. Outputs all arguments.
"""
nl = "\n"
expected = """Arguments that are commonly used:
--metric Convert output for Metric mode (G21) (default)
--inches Convert output for US imperial mode (G20)
@@ -390,9 +432,11 @@ G21
--wait-for-spindle WAIT_FOR_SPINDLE
Time to wait (in seconds) after M3, M4 (default = 0.0)
"""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
gcode: str = postprocessor.export(postables, "-", "--output_all_arguments")
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = "--output_all_arguments"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
# The argparse help routine turns out to be sensitive to the
# number of columns in the terminal window that the tests
# are run from. This affects the indenting in the output.
@@ -408,41 +452,48 @@ G21
Empty path. Outputs visible arguments.
"""
self.single_compare([], "", "--output_visible_arguments")
self.profile_op.Path = Path.Path([])
expected = ""
self.job.PostProcessorArgs = "--output_visible_arguments"
gcode = self.post.export()[0][1]
self.assertEqual(gcode, expected)
#############################################################################
def test00210(self):
"""Test Post-amble."""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--postamble='G0 Z50\nM2'"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[-2], "G0 Z50")
self.assertEqual(gcode.splitlines()[-1], "M2")
nl = "\n"
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = "--postamble='G0 Z50\nM2'"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[-2], "G0 Z50")
self.assertEqual(split_gcode[-1], "M2")
#############################################################################
def test00220(self):
"""Test Pre-amble."""
self.docobj.Path = Path.Path([])
postables = [self.docobj]
args = "--preamble='G18 G55'"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
nl = "\n"
self.profile_op.Path = Path.Path([])
self.job.PostProcessorArgs = "--preamble='G18 G55'"
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[0], "G18 G55")
#############################################################################
def test00230(self):
"""Test precision."""
self.compare_third_line(
self.single_compare(
"G1 X10 Y20 Z30 F100",
"G1 X10.00 Y20.00 Z30.00 F6000.00",
"--precision=2",
)
self.compare_third_line(
self.single_compare(
"G1 X10 Y20 Z30 F100",
"G1 X0.39 Y0.79 Z1.18 F236.22",
"--inches --precision=2",
@@ -452,75 +503,93 @@ G21
def test00240(self):
"""Test return-to."""
self.compare_third_line("", "G0 X12 Y34 Z56", "--return-to='12,34,56'")
self.single_compare("", "G0 X12 Y34 Z56", "--return-to='12,34,56'")
#############################################################################
def test00250(self):
"""Test tlo."""
nl = "\n"
c = Path.Command("M6 T2")
c2 = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c, c2])
postables = [self.docobj]
args = "--tlo"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M6 T2")
self.assertEqual(gcode.splitlines()[3], "G43 H2")
self.assertEqual(gcode.splitlines()[4], "M3 S3000")
self.profile_op.Path = Path.Path([c, c2])
self.job.PostProcessorArgs = "--tlo"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[5], "M6 T2")
self.assertEqual(split_gcode[6], "G43 H2")
self.assertEqual(split_gcode[7], "M3 S3000")
# suppress TLO
args = "--no-tlo"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M6 T2")
self.assertEqual(gcode.splitlines()[3], "M3 S3000")
self.job.PostProcessorArgs = "--no-tlo"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[4], "M6 T2")
self.assertEqual(split_gcode[5], "M3 S3000")
#############################################################################
def test00260(self):
"""Test tool_change."""
nl = "\n"
c = Path.Command("M6 T2")
c2 = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c, c2])
postables = [self.docobj]
args = "--tool_change"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M6 T2")
self.assertEqual(gcode.splitlines()[3], "M3 S3000")
args = "--comments --no-tool_change"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[5], "( M6 T2 )")
self.assertEqual(gcode.splitlines()[6], "M3 S3000")
self.profile_op.Path = Path.Path([c, c2])
self.job.PostProcessorArgs = "--tool_change"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[4], "M6 T2")
self.assertEqual(split_gcode[5], "M3 S3000")
self.job.PostProcessorArgs = "--comments --no-tool_change"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[13], "( M6 T2 )")
self.assertEqual(split_gcode[14], "M3 S3000")
#############################################################################
def test00270(self):
"""Test wait-for-spindle."""
nl = "\n"
c = Path.Command("M3 S3000")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
args = ""
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M3 S3000")
args = "--wait-for-spindle=1.23456"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M3 S3000")
self.assertEqual(gcode.splitlines()[3], "G4 P1.23456")
self.profile_op.Path = Path.Path([c])
self.job.PostProcessorArgs = ""
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[4], "M3 S3000")
self.job.PostProcessorArgs = "--wait-for-spindle=1.23456"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[4], "M3 S3000")
self.assertEqual(split_gcode[5], "G4 P1.23456")
c = Path.Command("M4 S3000")
self.docobj.Path = Path.Path([c])
postables = [self.docobj]
self.profile_op.Path = Path.Path([c])
# This also tests that the default for --wait-for-spindle
# goes back to 0.0 (no wait)
args = ""
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M4 S3000")
args = "--wait-for-spindle=1.23456"
gcode = postprocessor.export(postables, "-", args)
# print("--------\n" + gcode + "--------\n")
self.assertEqual(gcode.splitlines()[2], "M4 S3000")
self.assertEqual(gcode.splitlines()[3], "G4 P1.23456")
self.job.PostProcessorArgs = ""
gcode = self.post.export()[0][1]
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[4], "M4 S3000")
self.job.PostProcessorArgs = "--wait-for-spindle=1.23456"
gcode = self.post.export()[0][1]
split_gcode = gcode.splitlines()
# print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(split_gcode[4], "M4 S3000")
self.assertEqual(split_gcode[5], "G4 P1.23456")

550
src/Mod/CAM/CAMTests/TestRefactoredTestPostGCodes.py
View File

File diff suppressed because it is too large Load Diff

107
src/Mod/CAM/CAMTests/TestRefactoredTestPostMCodes.py
View File

@@ -1,7 +1,7 @@
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2022 sliptonic <shopinthewoods@gmail.com> *
# * Copyright (c) 2022-2023 Larry Woestman <LarryWoestman2@gmail.com> *
# * Copyright (c) 2022-2025 Larry Woestman <LarryWoestman2@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) *
@@ -25,7 +25,7 @@ import FreeCAD
import Path
import CAMTests.PathTestUtils as PathTestUtils
from Path.Post.scripts import refactored_test_post as postprocessor
from Path.Post.Processor import PostProcessorFactory
Path.Log.setLevel(Path.Log.Level.DEBUG, Path.Log.thisModule())
@@ -46,8 +46,16 @@ class TestRefactoredTestPostMCodes(PathTestUtils.PathTestBase):
This method does not have access to the class `self` reference, but it
is able to call static methods within this same class.
"""
# Open existing FreeCAD document with test geometry
FreeCAD.newDocument("Unnamed")
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "True")
cls.doc = FreeCAD.open(FreeCAD.getHomePath() + "/Mod/CAM/CAMTests/boxtest.fcstd")
cls.job = cls.doc.getObject("Job")
cls.post = PostProcessorFactory.get_post_processor(cls.job, "refactored_test")
# locate the operation named "Profile"
for op in cls.job.Operations.Group:
if op.Label == "Profile":
# remember the "Profile" operation
cls.profile_op = op
return
@classmethod
def tearDownClass(cls):
@@ -59,8 +67,8 @@ class TestRefactoredTestPostMCodes(PathTestUtils.PathTestBase):
not have access to the class `self` reference. This method is able
to call static methods within this same class.
"""
# Close geometry document without saving
FreeCAD.closeDocument(FreeCAD.ActiveDocument.Name)
FreeCAD.closeDocument(cls.doc.Name)
FreeCAD.ConfigSet("SuppressRecomputeRequiredDialog", "")
# Setup and tear down methods called before and after each unit test
@@ -70,14 +78,12 @@ class TestRefactoredTestPostMCodes(PathTestUtils.PathTestBase):
This method is called prior to each `test()` method. Add code and
objects here that are needed for multiple `test()` methods.
"""
self.doc = FreeCAD.ActiveDocument
self.con = FreeCAD.Console
self.docobj = FreeCAD.ActiveDocument.addObject("Path::Feature", "testpath")
# allow a full length "diff" if an error occurs
self.maxDiff = None
#
# Re-initialize all of the values before doing a test.
# reinitialize the postprocessor data structures between tests
#
postprocessor.UNITS = "G21"
postprocessor.init_values(postprocessor.global_values)
self.post.reinitialize()
def tearDown(self):
"""tearDown()...
@@ -85,30 +91,20 @@ class TestRefactoredTestPostMCodes(PathTestUtils.PathTestBase):
This method is called after each test() method. Add cleanup instructions here.
Such cleanup instructions will likely undo those in the setUp() method.
"""
FreeCAD.ActiveDocument.removeObject("testpath")
pass
def single_compare(self, path, expected, args, debug=False):
"""Perform a test with a single comparison."""
nl = "\n"
self.docobj.Path = Path.Path(path)
postables = [self.docobj]
gcode = postprocessor.export(postables, "-", args)
self.job.PostProcessorArgs = args
# replace the original path (that came with the job and operation) with our path
self.profile_op.Path = Path.Path(path)
# the gcode is in the first section for this particular job and operation
gcode = self.post.export()[0][1]
if debug:
print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode, expected)
def compare_third_line(self, path_string, expected, args, debug=False):
"""Perform a test with a single comparison to the third line of the output."""
nl = "\n"
if path_string:
self.docobj.Path = Path.Path([Path.Command(path_string)])
else:
self.docobj.Path = Path.Path([])
postables = [self.docobj]
gcode = postprocessor.export(postables, "-", args)
if debug:
print(f"--------{nl}{gcode}--------{nl}")
self.assertEqual(gcode.splitlines()[2], expected)
# there are 4 lines of "other stuff" before the line we are interested in
self.assertEqual(gcode.splitlines()[4], expected)
#############################################################################
#
@@ -116,99 +112,100 @@ class TestRefactoredTestPostMCodes(PathTestUtils.PathTestBase):
#
# 00000 - 00099 tests that don't fit any other category
# 00100 - 09999 tests for all of the various arguments/options
# 10000 - 19999 tests for the various G codes at 10000 + 10 * g_code_value
# 10000 - 18999 tests for the various G codes at 10000 + 10 * g_code_value
# 19000 - 19999 tests for the A, B, and C axis outputs
# 20000 - 29999 tests for the various M codes at 20000 + 10 * m_code_value
#
#############################################################################
def test20000(self):
"""Test M0 command Generation."""
self.compare_third_line("M0", "M0", "")
self.compare_third_line("M00", "M00", "")
self.single_compare("M0", "M0", "")
self.single_compare("M00", "M00", "")
#############################################################################
def test20010(self):
"""Test M1 command Generation."""
self.compare_third_line("M1", "M1", "")
self.compare_third_line("M01", "M01", "")
self.single_compare("M1", "M1", "")
self.single_compare("M01", "M01", "")
#############################################################################
def test20020(self):
"""Test M2 command Generation."""
self.compare_third_line("M2", "M2", "")
self.compare_third_line("M02", "M02", "")
self.single_compare("M2", "M2", "")
self.single_compare("M02", "M02", "")
#############################################################################
def test20030(self):
"""Test M3 command Generation."""
self.compare_third_line("M3", "M3", "")
self.compare_third_line("M03", "M03", "")
self.single_compare("M3", "M3", "")
self.single_compare("M03", "M03", "")
#############################################################################
def test20040(self):
"""Test M4 command Generation."""
self.compare_third_line("M4", "M4", "")
self.compare_third_line("M04", "M04", "")
self.single_compare("M4", "M4", "")
self.single_compare("M04", "M04", "")
#############################################################################
def test20050(self):
"""Test M5 command Generation."""
self.compare_third_line("M5", "M5", "")
self.compare_third_line("M05", "M05", "")
self.single_compare("M5", "M5", "")
self.single_compare("M05", "M05", "")
#############################################################################
def test20060(self):
"""Test M6 command Generation."""
self.compare_third_line("M6", "M6", "")
self.compare_third_line("M06", "M06", "")
self.single_compare("M6", "M6", "")
self.single_compare("M06", "M06", "")
#############################################################################
def test20070(self):
"""Test M7 command Generation."""
self.compare_third_line("M7", "M7", "")
self.compare_third_line("M07", "M07", "")
self.single_compare("M7", "M7", "")
self.single_compare("M07", "M07", "")
#############################################################################
def test20080(self):
"""Test M8 command Generation."""
self.compare_third_line("M8", "M8", "")
self.compare_third_line("M08", "M08", "")
self.single_compare("M8", "M8", "")
self.single_compare("M08", "M08", "")
#############################################################################
def test20090(self):
"""Test M9 command Generation."""
self.compare_third_line("M9", "M9", "")
self.compare_third_line("M09", "M09", "")
self.single_compare("M9", "M9", "")
self.single_compare("M09", "M09", "")
#############################################################################
def test20300(self):
"""Test M30 command Generation."""
self.compare_third_line("M30", "M30", "")
self.single_compare("M30", "M30", "")
#############################################################################
def test20480(self):
"""Test M48 command Generation."""
self.compare_third_line("M48", "M48", "")
self.single_compare("M48", "M48", "")
#############################################################################
def test20490(self):
"""Test M49 command Generation."""
self.compare_third_line("M49", "M49", "")
self.single_compare("M49", "M49", "")
#############################################################################
def test20600(self):
"""Test M60 command Generation."""
self.compare_third_line("M60", "M60", "")
self.single_compare("M60", "M60", "")