1 # Copyright (C) 2010-2013 CEA/DEN, EDF R&D
3 # This library is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU Lesser General Public
5 # License as published by the Free Software Foundation; either
6 # version 2.1 of the License.
8 # This library is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 # Lesser General Public License for more details.
13 # You should have received a copy of the GNU Lesser General Public
14 # License along with this library; if not, write to the Free Software
15 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 This module provides auxiliary classes, functions and variables for testing.
24 #from __future__ import print_function
30 from datetime import date
38 samples_dir = os.getenv("DATA_DIR")
41 if samples_dir is not None:
42 samples_dir = os.path.normpath(samples_dir)
43 datadir = samples_dir + "/MedFiles/"
44 tablesdir = samples_dir + "/Tables/"
46 # Graphics files extension
47 pictureext = os.getenv("PIC_EXT")
48 if pictureext == None:
53 class RepresentationType:
55 Types of representation.
65 _type2name = {OUTLINE: 'Outline',
67 WIREFRAME: 'Wireframe',
69 SURFACEEDGES: 'Surface With Edges',
71 POINTSPRITE: 'Point Sprite'}
74 def get_name(cls, type):
75 """Return paraview representation type by the primitive type."""
76 return cls._type2name[type]
79 class SalomeSession(object):
83 #sys.argv += ["--killall"]
84 #sys.argv += ["--portkill=" + port]
85 sys.argv += ["--show-desktop=1"]
86 sys.argv += ["--splash=0"]
87 sys.argv += ["--modules=MED,PARAVIS"]
88 sys.argv += ["--standalone=study"]
89 sys.argv += ["--embedded=SalomeAppEngine,cppContainer,registry,moduleCatalog"]
90 clt, d = runSalome.main()
95 #VTN: workaround for crash on CentOS.6.3.64
97 #os.system('killSalomeWithPort.py {0}'.format(self.port))
98 #os.system('killSalomeWithPort.py ' + self.port)
99 #import killSalomeWithPort
100 #killSalomeWithPort.killMyPort(self.port)
105 # Auxiliary functions
106 def test_values(value, et_value, check_error=0):
110 et_length = len(et_value)
111 if (length != et_length):
112 err_msg = "ERROR!!! There is different number of created " + str(length) + " and etalon " + str(et_length) + " values!!!"
116 for i in range(et_length):
117 if abs(et_value[i]) > 1:
118 max_val = abs(0.001 * et_value[i])
119 if abs(et_value[i] - value[i]) > max_val:
120 err_msg = "ERROR!!! Got value " + str(value[i]) + " is not equal to etalon value " + str(ret_value[i]) + "!!!"
125 if abs(et_value[i] - value[i]) > max_val:
126 err_msg = "ERROR!!! Got value " + value[i] + " is not equal to etalon value " + et_value[i] + "!!!"
128 if check_error and error > 0:
129 err_msg = ("There is(are) some error(s) was(were) found... "
130 "For more info see ERRORs above...")
131 raise RuntimeError(err_msg)
135 def get_picture_dir(subdir):
136 res_dir = os.getenv("PARAVIS_TEST_PICS")
138 # Add username and current date to unify the directory
139 cur_user = getpass.getuser()
140 cur_date = date.today().strftime("%Y%m%d")
141 res_dir = tempfile.gettempdir() + \
142 "/pic_" + cur_user + \
144 # Add subdirectory for the case to the directory path
145 res_dir += "/" + subdir
146 # Create the directory if doesn't exist
147 res_dir = os.path.normpath(res_dir)
148 if not os.path.exists(res_dir):
151 # Clean the directory
152 for root, dirs, files in os.walk(res_dir):
154 os.remove(os.path.join(root, f))
159 def call_and_check(prs, property_name, value, do_raise=1, compare_toler=-1.0):
160 """Utility function for 3D viewer test for common check of different
161 types of presentation parameters set"""
163 prs.SetPropertyWithName(property_name, value)
165 error_string = (str(value) + "value of " + property_name + " is not available for this type of presentations")
168 is_good = (error_string is None)
171 raise RuntimeError(error_string)
175 # compare just set value and the one got from presentation
176 really_set_value = prs.GetPropertyValue(property_name)
178 if compare_toler > 0:
179 is_equal = (fabs(really_set_value - value) < compare_toler)
181 is_equal = (really_set_value == value)
183 msg = str(really_set_value) + " has been set instead"
185 raise RuntimeError(msg)
193 def compare_lists(value, et_value, check_error=0, eps=1e-04):
195 Compare two lists: the same length and equality of corresponding items
196 param value - list to be compared
197 param et_value - etalon list
198 param check_error - flag to catch exception if errors>0
199 check_error=0 no exception, check_error !=0 catch exception
200 param eps - defines tolerance for comparison
201 return error - number of errors
206 et_length = len(et_value)
207 if length != et_length:
208 print "ERROR!!! There is different number of items in created ", length, " and etalon ", et_length, " lists!!!"
211 for i in range(et_length):
212 if abs(et_value[i]) > 1:
213 MAX = abs(eps*et_value[i])
216 if abs(et_value[i] - value[i])> MAX:
217 print "ERROR!!!", i, "-th item", value[i], " is not equal to etalon item", et_value[i], "!!!"
219 if check_error and error > 0:
220 raise RuntimeError, "There is(are) some error(s) was(were) found... For more info see ERRORs above..."
224 def setShaded(view, shading):
225 """Utility function to set shaded mode in view"""
227 view.LightDiffuseColor = [1, 1, 1]
229 view.LightDiffuseColor = [0, 0, 0]
232 def TimeStampId(proxy):
233 """Return tuple for the given MED proxy: (mesh_name, {field_name: [entity, timestamp_id]})
234 Originally defined in KERNEL_TEST/Tools/CommonFunctions file.
237 mesh_name = presentations.get_mesh_names(proxy).pop()
240 # get list of field names
241 fields_on_points = list(proxy.PointArrays)
242 fields_on_cells = list(proxy.CellArrays)
243 all_fields = fields_on_points + fields_on_cells
246 timestamps = proxy.TimestepValues.GetData()
247 timestamp_nb = len(timestamps)
249 for field in all_fields:
251 if fields_on_points.count(field) > 0:
252 entity = presentations.EntityType.NODE
253 elif fields_on_cells.count(field) > 0:
254 entity = presentations.EntityType.CELL
256 iterations[field] = [entity, timestamp_nb]
258 return mesh_name, iterations
261 def Import_Med_Field(paravis, file, field_names, check_errors=0, prs=[]):
262 """Builds presentations on the given fields of the MED file.
263 Originally defined in VISU_TEST/Grids/visu/ImportMedField/begin file.
266 paravis : PARAVIS instance
267 file_name : the full path to med file
268 field_names : the list of field names (for ex: ["pression","temperature","vitesse"])
269 prs : [[0,1,...], [], []]; empty list (sublist(s)) is ignored
275 5-VISU.TDEFORMEDSHAPE
279 9-VISU.TSCALARMAPONDEFORMEDSHAPE
287 # check the file accessibility
288 if not os.access(file, os.F_OK):
289 msg = "File " + file + " does not exist!!!"
290 raise RuntimeError, msg
293 paravis.ImportFile(file)
294 proxy = presentations.pvs.GetActiveSource()
296 raise RuntimeError, "ERROR!!! Can't import file!!!"
298 for i in range(len(field_names)):
299 print "Name of the field: ", field_names[i]
303 mesh_name, iterations = TimeStampId(proxy)
305 if iterations.has_key(field_names[i]):
306 entity = iterations[field_names[i]][0]
307 iteration = iterations[field_names[i]][1]
309 msg="There is no information about TimeStampId of the " + field_names[i] + " field!!!"
310 raise RuntimeError, msg
316 if presentations.GaussPointsOnField(proxy, entity, field_names[i], iteration) is None:
317 print "ERROR!!! Created GaussPoints presentation is None!!!"; nb_errors+=1
319 if presentations.ScalarMapOnField(proxy, entity, field_names[i], iteration) is None:
320 print "ERROR!!! Created ScalarMap presentation is None!!!"; nb_errors+=1
322 if presentations.IsoSurfacesOnField(proxy, entity, field_names[i], iteration) is None:
323 print "ERROR!!! Created IsoSurfaces presentation is None!!!"; nb_errors+=1
325 if presentations.CutPlanesOnField(proxy, entity, field_names[i], iteration) is None:
326 print "ERROR!!! Created CutPlanes presentation is None!!!"; nb_errors+=1
328 if presentations.CutLinesOnField(proxy, entity, field_names[i], iteration) is None:
329 print "ERROR!!! Created CutLines presentation is None!!!"; nb_errors+=1
331 if presentations.DeformedShapeOnField(proxy, entity, field_names[i], iteration) is None:
332 print "ERROR!!! Created DeformedShape presentation is None!!!"; nb_errors+=1
334 if presentations.VectorsOnField(proxy, entity, field_names[i], iteration) is None:
335 print "ERROR!!! Created Vectors presentation is None!!!"; nb_errors+=1
337 if presentations.StreamLinesOnField(proxy, entity, field_names[i], iteration) is None:
338 print "ERROR!!! Created StreamLines presentation is None!!!"; nb_errors+=1
340 if presentations.Plot3DOnField(proxy, entity, field_names[i], iteration) is None:
341 print "ERROR!!! Created Plot3D presentation is None!!!"; nb_errors+=1
343 if presentations.DeformedShapeAndScalarMapOnField(proxy, entity, field_names[i], iteration) is None:
344 print "ERROR!!! Created ScalarMapOnDeformedShape presentation is None!!!"; nb_errors+=1
346 # check if number of errors has increased
348 print "Presentation(s) creation...OK"
350 if nb_errors > 0 and check_errors:
351 raise RuntimeError, "There are some errors were occured!!! For more information see ERRORs above..."
355 def delete_with_inputs(obj):
356 """Deletes the given object with all its inputs"""
360 while obj_to_delete is not None:
361 tmp_obj = obj_to_delete
363 if hasattr(tmp_obj, 'Input'):
364 obj_to_delete = tmp_obj.Input
366 pvsimple.Delete(tmp_obj)
369 salome_session = SalomeSession()