FreeCAD

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

23
import FreeCAD
24
import Part
25
import Path
26
import Path.Base.Generator.drill as generator
27
import Tests.PathTestUtils as PathTestUtils
28

29
Path.Log.setLevel(Path.Log.Level.INFO, Path.Log.thisModule())
30
Path.Log.trackModule(Path.Log.thisModule())
31

32

33
class TestPathDrillGenerator(PathTestUtils.PathTestBase):
34
    def test00(self):
35
        """Test Basic Drill Generator Return"""
36
        v1 = FreeCAD.Vector(0, 0, 10)
37
        v2 = FreeCAD.Vector(0, 0, 0)
38

39
        e = Part.makeLine(v1, v2)
40

41
        result = generator.generate(e)
42

43
        self.assertTrue(type(result) is list)
44
        self.assertTrue(type(result[0]) is Path.Command)
45

46
        command = result[0]
47

48
        self.assertTrue(command.Name == "G81")
49
        self.assertTrue(command.Parameters["R"] == 10)
50
        self.assertTrue(command.Parameters["X"] == 0)
51
        self.assertTrue(command.Parameters["Y"] == 0)
52
        self.assertTrue(command.Parameters["Z"] == 0)
53

54
        # repeat must be > 0
55
        args = {"edge": e, "repeat": 0}
56
        self.assertRaises(ValueError, generator.generate, **args)
57

58
        # repeat must be integer
59
        args = {"edge": e, "repeat": 1.5}
60
        self.assertRaises(ValueError, generator.generate, **args)
61

62
    def test10(self):
63
        """Test edge alignment check"""
64
        v1 = FreeCAD.Vector(0, 10, 10)
65
        v2 = FreeCAD.Vector(0, 0, 0)
66
        e = Part.makeLine(v1, v2)
67
        self.assertRaises(ValueError, generator.generate, e)
68

69
        v1 = FreeCAD.Vector(0, 0, 0)
70
        v2 = FreeCAD.Vector(0, 0, 10)
71
        e = Part.makeLine(v1, v2)
72

73
        self.assertRaises(ValueError, generator.generate, e)
74

75
    def test20(self):
76
        """Test Basic Peck Drill Generator Return"""
77
        v1 = FreeCAD.Vector(0, 0, 10)
78
        v2 = FreeCAD.Vector(0, 0, 0)
79

80
        e = Part.makeLine(v1, v2)
81

82
        result = generator.generate(e, peckdepth=1.2)
83

84
        self.assertTrue(type(result) is list)
85
        self.assertTrue(type(result[0]) is Path.Command)
86

87
        command = result[0]
88

89
        self.assertTrue(command.Name == "G83")
90
        self.assertTrue(command.Parameters["Q"] == 1.2)
91

92
        # peckdepth must be a float
93
        args = {"edge": e, "peckdepth": 1}
94
        self.assertRaises(ValueError, generator.generate, **args)
95

96
    def test30(self):
97
        """Test Basic Dwell Drill Generator Return"""
98
        v1 = FreeCAD.Vector(0, 0, 10)
99
        v2 = FreeCAD.Vector(0, 0, 0)
100

101
        e = Part.makeLine(v1, v2)
102

103
        result = generator.generate(e, dwelltime=0.5)
104

105
        self.assertTrue(type(result) is list)
106
        self.assertTrue(type(result[0]) is Path.Command)
107

108
        command = result[0]
109

110
        self.assertTrue(command.Name == "G82")
111
        self.assertTrue(command.Parameters["P"] == 0.5)
112

113
        # dwelltime should be a float
114
        args = {"edge": e, "dwelltime": 1}
115
        self.assertRaises(ValueError, generator.generate, **args)
116

117
    def test40(self):
118
        """Specifying retract height should set R parameter to specified value"""
119
        v1 = FreeCAD.Vector(0, 0, 10)
120
        v2 = FreeCAD.Vector(0, 0, 0)
121

122
        e = Part.makeLine(v1, v2)
123

124
        result = generator.generate(e, retractheight=20.0)
125

126
        command = result[0]
127

128
        self.assertTrue(command.Parameters["R"] == 20.0)
129

130
    def test41(self):
131
        """Not specifying retract height should set R parameter to Z position of start point"""
132
        v1 = FreeCAD.Vector(0, 0, 10)
133
        v2 = FreeCAD.Vector(0, 0, 0)
134

135
        e = Part.makeLine(v1, v2)
136

137
        result = generator.generate(e)
138

139
        command = result[0]
140

141
        self.assertTrue(command.Parameters["R"] == 10.0)
142

143
    def test42(self):
144
        """Non-float retract height should raise ValueError"""
145
        v1 = FreeCAD.Vector(0, 0, 10)
146
        v2 = FreeCAD.Vector(0, 0, 0)
147

148
        e = Part.makeLine(v1, v2)
149

150
        args = {"edge": e, "retractheight": 1}
151
        self.assertRaises(ValueError, generator.generate, **args)
152
        args = {"edge": e, "retractheight": "1"}
153
        self.assertRaises(ValueError, generator.generate, **args)
154

155
    def test50(self):
156
        """Test Error if dwell and peck"""
157
        v1 = FreeCAD.Vector(0, 0, 10)
158
        v2 = FreeCAD.Vector(0, 0, 0)
159

160
        e = Part.makeLine(v1, v2)
161

162
        # dwelltime should be a float
163
        args = {"edge": e, "dwelltime": 1.0, "peckdepth": 1.0}
164
        self.assertRaises(ValueError, generator.generate, **args)
165

166
    def test60(self):
167
        """Test chipBreak"""
168
        v1 = FreeCAD.Vector(0, 0, 10)
169
        v2 = FreeCAD.Vector(0, 0, 0)
170

171
        e = Part.makeLine(v1, v2)
172

173
        args = {"edge": e, "peckdepth": 1.0, "chipBreak": True}
174
        result = generator.generate(**args)
175
        command = result[0]
176

177
        self.assertTrue(command.Name == "G73")
178

179
    def test70(self):
180
        """Test feed retract enabled produces G85"""
181
        v1 = FreeCAD.Vector(0, 0, 10)
182
        v2 = FreeCAD.Vector(0, 0, 0)
183

184
        e = Part.makeLine(v1, v2)
185

186
        args = {"edge": e, "feedRetract": True}
187
        result = generator.generate(**args)
188
        command = result[0]
189

190
        self.assertEqual(command.Name, "G85")
191
        # G85 does not support peck or dwell
192
        self.assertFalse(hasattr(command.Parameters, "Q"))
193
        self.assertFalse(hasattr(command.Parameters, "P"))
194

195
    def test71(self):
196
        """Test that dwell can be used when feed retract is not enabled"""
197
        v1 = FreeCAD.Vector(0, 0, 10)
198
        v2 = FreeCAD.Vector(0, 0, 0)
199

200
        e = Part.makeLine(v1, v2)
201

202
        args = {"edge": e, "dwelltime": 0.5, "feedRetract": False}
203
        result = generator.generate(**args)
204

205
        command = result[0]
206

207
        self.assertEqual(command.Name, "G82")
208
        self.assertEqual(command.Parameters["P"], 0.5)
209

210
    def test72(self):
211
        """Test that peck can be used when feed retract is not enabled"""
212
        v1 = FreeCAD.Vector(0, 0, 10)
213
        v2 = FreeCAD.Vector(0, 0, 0)
214

215
        e = Part.makeLine(v1, v2)
216

217
        args = {"edge": e, "peckdepth": 1.0, "feedRetract": False}
218
        result = generator.generate(**args)
219

220
        command = result[0]
221

222
        self.assertTrue(command.Name == "G83")
223
        self.assertEqual(command.Parameters["Q"], 1.0)
224

225
    def test73(self):
226
        """Test error when feed retract and dwell are enabled"""
227
        v1 = FreeCAD.Vector(0, 0, 10)
228
        v2 = FreeCAD.Vector(0, 0, 0)
229

230
        e = Part.makeLine(v1, v2)
231

232
        args = {"edge": e, "dwelltime": 1.0, "feedRetract": True}
233
        self.assertRaises(ValueError, generator.generate, **args)
234

235
    def test74(self):
236
        """Test error when feed retract and peck are enabled"""
237
        v1 = FreeCAD.Vector(0, 0, 10)
238
        v2 = FreeCAD.Vector(0, 0, 0)
239

240
        e = Part.makeLine(v1, v2)
241

242
        args = {"edge": e, "peckdepth": 1.0, "chipBreak": True, "feedRetract": True}
243
        self.assertRaises(ValueError, generator.generate, **args)
244