From 09928b19ff353955a3413bd4f4120693d4bb67e6 Mon Sep 17 00:00:00 2001
From: Bernd Hahnebach <bernd@bimstatik.org>
Date: Sat, 23 May 2020 08:18:44 +0200
Subject: [PATCH] FEM: test informatins, improve formating

---
 src/Mod/Fem/CMakeLists.txt                    |  1 +
 ...t_commands_to_copy.md => test_commands.sh} |  0
 src/Mod/Fem/test_information.md               | 37 ++++++++++++++++++-
 3 files changed, 37 insertions(+), 1 deletion(-)
 rename src/Mod/Fem/{test_commands_to_copy.md => test_commands.sh} (100%)

diff --git a/src/Mod/Fem/CMakeLists.txt b/src/Mod/Fem/CMakeLists.txt
index dd37bc96ad..43d65e7c7c 100755
--- a/src/Mod/Fem/CMakeLists.txt
+++ b/src/Mod/Fem/CMakeLists.txt
@@ -31,6 +31,7 @@ SET(FemBaseModules_SRCS
     Init.py
     InitGui.py
     ObjectsFem.py
+    test_commands.sh
     test_information.md
     TestFemApp.py
 )
diff --git a/src/Mod/Fem/test_commands_to_copy.md b/src/Mod/Fem/test_commands.sh
similarity index 100%
rename from src/Mod/Fem/test_commands_to_copy.md
rename to src/Mod/Fem/test_commands.sh
diff --git a/src/Mod/Fem/test_information.md b/src/Mod/Fem/test_information.md
index 634b44ebf3..97cdb5c51e 100644
--- a/src/Mod/Fem/test_information.md
+++ b/src/Mod/Fem/test_information.md
@@ -1,5 +1,5 @@
 # FEM unit test information
-Find in this fils some informatin how to run unit test for FEM
+- Find in this fils some informatin how to run unit test for FEM
 
 ## more information 
 - how to run a specific test class or a test method see file
@@ -16,6 +16,7 @@ Find in this fils some informatin how to run unit test for FEM
 - to run a specific FEM unit test to copy for fast tests :-)
 - they can be found in file test_commands_to_copy.md
 - greate them by
+
 ```python
 from femtest.app.support_utils import get_fem_test_defs
 get_fem_test_defs()
@@ -23,65 +24,94 @@ get_fem_test_defs()
 
 ## examples from within FreeCAD:
 ### create all objects test
+```python
 import Test, femtest.app.test_object
 Test.runTestsFromClass(femtest.app.test_object.TestObjectCreate)
+```
 
 ### all FEM tests
+```python
 import Test, TestFemApp
 Test.runTestsFromModule(TestFemApp)
+```
 
 ### module
+```python
 import Test, femtest.app.test_common
 Test.runTestsFromModule(femtest.app.test_common)
+```
 
 ### class
+```python
 import Test, femtest.app.test_common
 Test.runTestsFromClass(femtest.app.test_common.TestFemCommon)
+```
 
 ### method
+```python
 import unittest
 thetest = "femtest.app.test_common.TestFemCommon.test_pyimport_all_FEM_modules"
 alltest = unittest.TestLoader().loadTestsFromName(thetest)
 unittest.TextTestRunner().run(alltest)
+```
 
 ## examples from shell in build dir:
 ### all FreeCAD tests
+```python
 ./bin/FreeCADCmd --run-test 0
 ./bin/FreeCAD --run-test 0
+```
 
 ### all FEM tests
+```bash
 ./bin/FreeCADCmd --run-test "TestFemApp"
 ./bin/FreeCAD --run-test "TestFemApp"
+```
 
 ### import Fem and FemGui
+```bash
 ./bin/FreeCADCmd --run-test "femtest.app.test_femimport"
 ./bin/FreeCAD --run-test "femtest.app.test_femimport"
+```
 
 ### module
+```bash
 ./bin/FreeCAD --run-test "femtest.app.test_femimport"
+```
 
 ### class
+```bash
 ./bin/FreeCAD --run-test "femtest.app.test_common.TestFemCommon"
+```
 
 ### method
+```bash
 ./bin/FreeCAD --run-test "femtest.app.test_common.TestFemCommon.test_pyimport_all_FEM_modules"
+```
 
 ### Gui
+```bash
 ./bin/FreeCAD --run-test "femtest.gui.test_open.TestObjectOpen"
+```
 
 
 ## open files 
 ### from FEM test suite source code
 - be careful on updating these files, they contain the original results!
 - TODO update files, because some of them have non-existing FEM object classes
+
+```python
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/ccx/cube.FCStd')
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/ccx/cube_frequency.FCStd')
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/ccx/cube_static.FCStd')
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/ccx/Flow1D_thermomech.FCStd')
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/ccx/multimat.FCStd')
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/ccx/spine_thermomech.FCStd')
+```
+
 
 ### generated from test suite
+```python
 import femtest.utilstest as ut
 ut.all_test_files()
 
@@ -90,16 +120,21 @@ doc = ut.cube_static()
 doc = ut.Flow1D_thermomech()
 doc = ut.multimat()
 doc = ut.spine_thermomech()
+```
 
 ### load std FEM example files
+```python
 app_home = FreeCAD.ConfigGet("AppHomePath")
 doc = FreeCAD.open(app_home + "data/examples/FemCalculixCantilever2D.FCStd")
 doc = FreeCAD.open(app_home + "data/examples/FemCalculixCantilever3D.FCStd")
 doc = FreeCAD.open(app_home + "data/examples/FemCalculixCantilever3D_newSolver.FCStd")
 doc = FreeCAD.open(app_home + "data/examples/Fem.FCStd")
 doc = FreeCAD.open(app_home + "data/examples/Fem2.FCStd")
+```
 
 ### load all documents files
+```python
 app_home = FreeCAD.ConfigGet("AppHomePath")
 doc = FreeCAD.open(FreeCAD.ConfigGet("AppHomePath") + 'Mod/Fem/femtest/data/open/all_objects_de9b3fb438.FCStd')
+```