Testing: Difference between revisions

From FreeCAD Documentation
No edit summary
(Fixed Docnav)
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>

<!--T:20-->
<!--T:20-->
{{Docnav
{{docnav|Debugging|Continuous Integration}}
|[[Debugging|Debugging]]
|[[FreeCAD_Build_Tool|FreeCAD Build Tool]]
}}

<!--T:32-->
[[Image:Workbench_Test.svg|thumb|128px|Test workbench icon]]

</translate>
</translate>
{{TOCright}}
[[Image:Workbench_Test.svg|64px]]
<translate>
<translate>


== Introduction == <!--T:2-->
== Introduction == <!--T:2-->

<!--T:1-->
The [[Test Framework Workbench|Test Framework Workbench]] is not really a modelling workbench, but it contains a set of [[Python|Python]] scripts to perform different tests on the core components of FreeCAD, in order to debug problems. See also [[debugging|debugging]].

<!--T:25-->
You can run the tests from the command line, by using the {{incode|-t}} or {{incode|--run-test}} options.

<!--T:26-->
Run all tests:

</translate>
</translate>
{{Code|code=
{{TOCright}}
freecad --run-test 0
}}
<translate>
<translate>

<!--T:1-->
<!--T:27-->
The [[Test Framework Workbench]] is not really a modelling workbench, but it contains a set of [[Python]] scripts to perform different tests on the core components of FreeCAD, in order to debug problems. See also [[debugging]].
Run only some the specified unit test, for example:

</translate>
{{Code|code=
freecad -t TestDraft
}}
<translate>

== Test menu == <!--T:29-->

<!--T:30-->
Each top level directory in FreeCAD should have a file with the tests that can be run for that particular workbench or module. The file usually starts with the word {{incode|Test}}.

<!--T:31-->
To run a test from within FreeCAD, switch to the Test Workbench, then {{MenuCommand|Test commands → TestToolsGui → Self test → Select test name}}, then enter the name of the Python file with the tests; for example, for the [[Draft Workbench|Draft Workbench]], this would be {{MenuCommand|TestDraft}}, then press {{Button|Start}}.


== Test functions == <!--T:19-->
== Test functions == <!--T:19-->
Line 33: Line 68:


=== MeshTestsApp === <!--T:9-->
=== MeshTestsApp === <!--T:9-->
Add test function

=== TestDraft === <!--T:28-->
Add test function
Add test function


Line 55: Line 93:
=== Menu.MenuCreateCases === <!--T:16-->
=== Menu.MenuCreateCases === <!--T:16-->
Add test function
Add test function



<!--T:17-->
<!--T:17-->
{{Docnav
{{docnav|Debugging|Continuous Integration}}
|[[Debugging|Debugging]]
|[[FreeCAD_Build_Tool|FreeCAD Build Tool]]
}}


</translate>
<!--T:21-->
<!--T:21-->
{{Userdocnavi}}
{{Userdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]

[[Category:Test Framework{{#translation:}}]]
<!--T:22-->
[[Category:Developer Documentation]]
[[Category:Workbenches{{#translation:}}]]
[[Category:Testing{{#translation:}}]]

<!--T:23-->
[[Category:Test Framework]]

<!--T:24-->
[[Category:Workbenches]]
</translate>

Revision as of 21:33, 29 December 2020

Test workbench icon

Introduction

The Test Framework Workbench is not really a modelling workbench, but it contains a set of Python scripts to perform different tests on the core components of FreeCAD, in order to debug problems. See also debugging.

You can run the tests from the command line, by using the -t or --run-test options.

Run all tests:

freecad --run-test 0

Run only some the specified unit test, for example:

freecad -t TestDraft

Test menu

Each top level directory in FreeCAD should have a file with the tests that can be run for that particular workbench or module. The file usually starts with the word Test.

To run a test from within FreeCAD, switch to the Test Workbench, then Test commands → TestToolsGui → Self test → Select test name, then enter the name of the Python file with the tests; for example, for the Draft Workbench, this would be TestDraft, then press Start.

Test functions

This is the list of test apps as of 0.15 git 4207:

TestAPP.All

Add test function

BaseTests

Add test function

UnitTests

Add test function

Document

Add test function

UnicodeTests

Add test function

MeshTestsApp

Add test function

TestDraft

Add test function

TestSketcherApp

Add test function

TestPartApp

Add test function

TestPartDesignApp

Add test function

Workbench

Add test function

Menu

Add test function

Menu.MenuDeleteCases

Add test function

Menu.MenuCreateCases

Add test function