From c073810ba52e36a55aef6317846f7d89fd4c5552 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 10 Nov 2021 11:49:13 +0100 Subject: [PATCH] Doc: Describe options for running tests without deployment Add screenshot of CTest options tab. Task-number: QTCREATORBUG-26278 Change-Id: I5edc97f32724946486d04965323ee81180857e9d Reviewed-by: Christian Stenger --- .../qtcreator-autotests-options-ctest.png | Bin 0 -> 7002 bytes .../howto/creator-only/creator-autotest.qdoc | 39 ++++++++++++------ 2 files changed, 27 insertions(+), 12 deletions(-) create mode 100644 doc/qtcreator/images/qtcreator-autotests-options-ctest.png diff --git a/doc/qtcreator/images/qtcreator-autotests-options-ctest.png b/doc/qtcreator/images/qtcreator-autotests-options-ctest.png new file mode 100644 index 0000000000000000000000000000000000000000..071cba4a718639aebda457a1e4cc5b91153b7b54 GIT binary patch literal 7002 zcmeAS@N?(olHy`uVBq!ia0y~yU|h?9z#y&Y>EaktaqI0|-~8Lh zb~XIA=enbo`K$Hbu5_LRw6vgWw$blB}NMW^WeP6u({O&Uzk-`uh< z5L?N&>*cZ+s~j31i~W`SXZro=_W}!*b|Y2ZrOz7^0uC!$$`r|+Jw4HM{a#*%3oOh1 z=i60(%UOQ;<@ev#c?zl%KY6S?H^(wK=+pI-tyBK(ztuLy(q?1X)cs43E@QI@o;|tt zaj&_HRdjUp^H`@-%1bA0np*kctoi*vKOXnn|NV0L^;<_T?bKY|)C_H9 zKl)U6ZI$NEk`vM4|E7t}mU`f$?Qiymf89>^()xg1TXol#Ywo<0vR1p^yW5wyVA)jl zZuXrgGo-ID$Q^0Eld^?3i-G@sp;;OQ<`_+z1 zId009d$a$Cf6#&ddtRL1U?;z4leNRz**?1eKCWhe+I~IbTgmIKz0X$f-BmSrWuuRy zm;S9Ur4KJ`4b%TN<*CN*9mN)r(fn+Db8Nis@AH{fD}Rgof?2V%+!y_Ts7(I2vybM@ zS;*e}TU&Q?y|c@EufEjio?SDuxAe{o*;vj?(Zs#hc9>6ubpcAW`D)Ugs#Q6 zr{uP&XFqqm-?WltdFbswwl@yg?(pE3>eBaos2GzcZM^DRS=ENP#Hip3umj_xIqE&r8f!@2i{5 z=IwY?bzSh&8Ky@&jZPmA(oLow?#0 zV>)wT`;*UF;YUSpUfEr%CTH@E{dJ{5Jy%zF+6^vK~-t0cCm-~RCVU{lXRxn|MgTDuijTX#B&#kGCPc^Nf3 zy^OocE}~#|TX~>V|CtXjZ}iwi$i1})WiI4=icQW^_?@fr5Fl7HnEADquW?z_HE-N%lWSRH?2&3 z=Toa?xZt0}p&1bZ;?u>e9-1b+;=g9`cjf#>od;2?`=?y`_^9hzVo&$$iVZI(ul@Mf z(e&Bb6>Bo)s0gH6nFvLic+EI&;rTAIH`G>_6 zKR(vmf5+MD=>N$gcMCTEwW|1h)Q+?G-@D1prUz!8`b0YkY9J@eSvBKbA?7#nc>L>f>1?OZn7?(Z-X@X?HwO=2+W?=ADnEW|6 zKYzE{LGS5$U#n~<#(JKN-_6Kyfo0zF+`K%i7YBQLc{L+EPsSH-mgi9?Y4GUeWc7A253?*`hH00Z zAMMz#J0a(a8pE17?Ds35%ia{@XFBkz>ci*r_Wxh6-@otYv)M-ced;fld~Kh1d8(k; z)d;WmA2gyAXU5p`Gt8LGe!u$t-ud@42@ z_uK9F`~UCTw=eF6WAj%PP5Ici(_Vkx-EI<{>R*&y#4(A{L{5H;mdONSWKMf*xM=; zD3q)|bN*S$?MAFSXP$i=;w%ueWxmp1QPE>5Z$Gx!sW`m0{c(_8{?C`o{tJJnJX>!6 z@5kfm@pYB||9;oDiCAnOF-2nU#?8xrURXL?yyC(I$1QL9-8#M6r^qQDm~`Z*(f7OS z_y7A9e&+7(^40t7BR}Rg*Uc{S0$0EbOfDmGcqfRjf>#`&N_Tz@>_S9hIM#u^hd=K7RY( z`bmo>_NdevdEOCRdi1f%!3O8D!(D5)=q)r;N|F~pF8$k8;~kq6*W|lvrKB#KvP4Mn zb45o-Z~njEYTrC2hI17Kj{7$^urnTzp^J#+Y%*RtmOk=&|Dm9VoiX96O~z7g z8xDrkGUC$eAAFy0@_8O6fBbTa+RUvnUZ*ZTOq@ION^fALk!FU8bB0;?hW5iJ3mqp; zVMxkple_2v2MwX3c~C$IjOP^a$Nn0rf6 z=ib_l3^y-Nyt1V|+qBq*VND;qaPpN831+va$Ze5W;V#ZdUhtnLs|@#jrdHXIv1{XJ;%;7r-kij7*x2*wdL)`X)~~a`fbfcAhy?DmE-&c&Vs$x1F6a%vz6)A!8%^&$+A&5v90u zGOn13;N}0cJDOp`E4e4-5saX^p5Z`qaJ7NC`!6Pr(+P8=j@XzBGdwuB%w~mO_Dfm0 zKJi7;r(a(FsK6jMr(7cJ&_8Rsus z1OBrIpZzN_xQY)%$+tZvGAZB!D~*lLeJT>ner9>MFfXYz zc*5%3N#_dJ>^ynnqV~o3r+Yrll9-TL{i32bz8V+jHKJXJq(pV{!j}Vop}a@(gL_fLH}tN-85 z{c%n+wku8E=Gc43z_iHs8zS`Z~k%j!P1yt$DjA66h}?WF*>@fVBh7Je?A=M z|9?tJbJDt}Q?k3*{hxtK?UNP-2Te+D&5J=F?42UOBk(_LQ3~ zmwhMC?BeIYoV?U>W@$wf|0<;~;){RPyh-m)ejbtY(yP{f);~Gz@c)Ko)}36vLPwf; zD+AsKs%Dv-Tewd3*d?#WFHf!AbZC0=4FYiv!-oM?fy1jaQm#_M!APy2Ln})8qV4kCzIM4&Ge-VfXue+LILI z=6wBpFiLLAd)IR(noqnxBImQK`DBw}`Yy9?YH~3e6&qH5eB`3^>cPgO=_Zl=-HXjL z@10t^#&*T=qg5N`^ma=cZv2$+t?t75v>N#*uZ=%HQT%SO`q=&79PBr` zFMq||Xwj9EF10nwdnWs+x&LYtjlNkOz*{l3P2~OlggGrcc1&aE-e}Uy4-K>ts6I9lO>__OicqU$+>P zV0|Ln*%z{1N?7v#K*@CP<``d<4z$JwJeM@AwE6Mmtm=gTtgv`h`Q_TA3TaG-hfhX+1A&FqW|V*ehz6O(rQmCA|7 z6-}F6ysOMq&-A6apKiai)1_AZRkd#My9$N|_Sqj61ct7ZX~(q%S$ zd0o4q=iV^BS(ySTr2+L=`EvV@+w z-27SZ9v#&(eWMs^#_-^vo9&7h-n`+DcT^ZzUXoXNb@S2px_cSh0~gGByFXQE>)e#~ zD5IIhAhVX8`B5(R;}aKy#ruPj&FqjuJ0cfa_D{F9km1|U(lAY#SMt8^d&iZIt2h_D zy)Xe(VlPpA?8pEr3K;mA2`NM*39i}WpQcS_U+sC8(D(_gJL&5 z=u16v`np()$bwIYomXYo*4F0c^721&ET0&*W&8GW!8H?KP4X%}-W=Vn{6}W%&nE|( zD=w7sd+lhy`)1;+qT|g?kL5&`9P8-*n85w3S^R+1@?Xu|-xoYpXO}zDTp_@}u8W+GGK#UH-hEUrA+6qa0ZL6E;}&&9uie?D39b}ccN;jNyoEA+g5 z&YHIumwLW`_io+toOk#47eCIrcsps`y&p=aX5M!R`uDu<&#yx}c5ga+*J;)2E6w3m zhky9ZKCSzpgI$>OS!f6Q+)oKL;bm-#FD|&eCnM`ddZbN8O!k)rdvD!(By2}9~M;0s75zjG67PbHDSfUHZ9W$By0q|FJ&Gdzy&n^&+oQ(TWT2In5-qd>$YC_hI$N!_|wc zKYvXCg+j?D`x$q_53*MX9Br{Zq7bd_CG%}vP0ER7EjRwf%D=lgV@2+4lSv7=`39Hz z7KxeaHRn8fzhHyS%zN%JZ|1#x@l0>SR`%xBw|_OZeVsfdqr5)&eB{%E@AmC_`}5LS z@x@MySx(!$2rqS<6IjCkLjKH8Y3JSRbsj&ewdr7AJ&%9c_h7fam$~B0mY)C7bCWAC z$vLU!b$XeE_+f!1+NmF|AN%E9EcVXWhi6Y@NKrHU@4x?|yvhxJEh<<2A13y$pDos2 zSEqAco**;4Vc-%{xQM1urQ%Vo7H?> z)%m0S)mob@-yQ4{TsVjQ=^9bq*qd^<%KpBpFu0prWD#x?;kl5#dmg{uR(9QN9{yc6 zevjG}Z)OB~dgjL`Z+rRZQO%Oz`^~MtO^zM?-urOFE624}OBXIXxMlhmCI3r##hNFT zqnziwI9Cw-P&U#cPNt-&`0>$Wua|mUzQ5|O+?_jro?Lr-e#>-~M~>5NS8TB}E$U&8 zJ1;H9>!@;ZseVUHPmWK>Hr?&B_pQ;Du zKx(Dl^Z)Zx80A7jS9pQj3mxp@j}HF)Yu_1WdH3D2J)cb5*gr0K4XzNHOoL)8Hk@d7 zoi9_dAyzKN@`Hk$O(!@w9yuB|5-1}c5|F#TdA>9Z>5R5-u*-M{kJw9`=B6K zGV8_lxOH)R>;6{pg9{O^>@%|bZI^R&Pc=`SD&}<|ZIzmokzC9MuEUY97YMD?C|8kC zioZ}?xzEa*^Ae~mLoU!fRB@JJ0vILTHaQu-_IM_T(-Yfz-Y>)1O53nVuIAH|lM7iV z^>VQ`JpHo3;$1GJKB|D$QwL{!d}5JmG;dqay@wY+UR-ECpKGE~`*ANZuTKmNa%;XN zyy1@Tyga+059BxtW&Ul)WGe(1_|L7gm(Z1ZDxo9emRNGmuyj+eYR9=XzRjOk*uP4j z?bCPY`?0ON*!O14FI2PPXkcGnVK?L05m&homBsECzTHgvFDa*)Ru;4{YQ00pW6upO z?2I20?*3blzw}7t(Z2@|aqP<5_QLnpVe7E!2{(DUudiyo-d6oVfkAGKym+_IC&5oT zwi2t&LkogfbRXzOWlyQNxR8;7|C)q);GRitD|{;hKITrcvqHeIvubBf{Fuu3lHI^exvPUz?u`t+l zurnrXwS|l(q&+5*_`P_8d>L}v+j`g;KPd1@@-sbf1oe>wKyG9K zd6*Hukc6eYgRRcZql*+DJFd96PA`664X=!Y-th%pYuB#*`t|G9t)?~|>PeApA6dU8#6U|M}BYoW*osTs)ut&c<*e&(|)FduwwW%m52#>1};AfJH zQRI&c*iroa!OP9hKTTpatW3k!cB=_a;!zIcu($)2jH79&} zFpKqXojkwQV@J*+<%^kxg)dy}4PX6Ab(K`Rpnaq{;K{+WXZ`c;{`0B!RFW$>-TZH} zeW`_oth%Sr-+v39^BON!T69k1cEdXbxt2Zb!bhsi^Y8k_eG1DxTybIU4v7y6XHGS* z;tJ&id9wJkg3ht#=bK7)&;E2t=;`w99~3|i(vmZ2V*jY{;9%;v2kl~Cs%*jW^27F3 zS>=Y?Z}W0;Kw-~Y9q>&3pkrUfhHzI6$Jr}qWt^xG$Wn;+Oy0MvthVH${E=n`(6}=L zNHGH_g22O94$jA#8BmE0Yg+7`{cU~1)lE`tI8I-9@KpZay0t<@*P6AS+<%{P%Ic@M zf=vf|qN>e~rvLFZE4hAN)IHhB{!w8KSH*>n=aol}`c-VW{PIRj_(`{3X1OijAGmUV zSfDL;=KRuvNjVG^7hW7}Zr=UrP;-UAhX-7hADRx$wPyF9Z##Xu&We}S)zuXn?#fMx zy!Uve_2TPWge6yhK61YJcKYt|f8pLn> z*y{ZF;4Ha2^0qPeI9;Dkxz2o~>b_m=vb`#XF}ru~?q>g}AQ$7y|E)c~SN@*#-DpNo zI+}i^d3yC>jVKuw<}=|{hczm`SWPnSQ{CHF$^Y`%_sKe$GP6{U-fY`DFIw)63hVAk zDpmIkR`qT=rFpA)qaTmywhOCf=;_@%-ds_jX}dzFoUP9L9S_&kbdN8tlBwTkZ=ZH~ z!rAjrC$PUi&MI?c*=ONU^{~*sO8%Wzg=@7wEI8QwT=&M!n+Kb{pF1vnE>wEINhI~p zk}J)1&m7$)`#Nsz*KaMDU%0JAKJVDkRm+#Hp7Y5n@S0ViD5wv5&?i{_$^LxVlF&`O zH|{lOKAO7X;`STO-=;RRN54O4%KhuFom|YR9XI~Gow?v(+)7Dt_P6m?%@0rcguF!6 z#S$FlVm|#>x17H8_T4Gdr)k*lZDpSeDyHT%v-g6MV@1JC+aC*A_r~$_KXQ!V4Ey|j zg|_OAw`JyLW*-#fT0%cAIOD%5OYTjmAgn%XNp;w#eY~dhm_Ns_<_ZA@P(}e4m(X#S z3IPUC`X@;ARu)*u)NwNCx=R`Dn|+VqFfO#lLX6o>JJS50pU3f1nc4QKh71f044$rj JF6*2UngH-a2=o8| literal 0 HcmV?d00001 diff --git a/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc b/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc index 22d6082d95e..85a7a2256c0 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-autotest.qdoc @@ -38,13 +38,20 @@ build system and uses it or even the build system as such to execute the respective tests. - \QC integrates the \l{Qt Test} framework, - \l{https://github.com/google/googletest}{Google C++ Testing Framework}, - \l{https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/index.html} - {Boost.Test}, and \l{https://github.com/catchorg/Catch2} - {Catch2 test framework} for unit testing applications and libraries. + \QC integrates the following testing frameworks for unit testing + applications and libraries: + + \list + \li \l{https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/index.html} + {Boost.Test} + \li \l{https://github.com/catchorg/Catch2}{Catch2 test framework} + \li \l{https://github.com/google/googletest}{Google C++ Testing Framework} + \li \l{Qt Test} framework + \endlist + Additional build system based support is provided for \l{https://cmake.org/cmake/help/latest/manual/ctest.1.html}{CTest}. + You can use \QC to create, build, and run code based tests for your projects. @@ -332,16 +339,23 @@ in the file currently open in the code editor. \endlist - \note By default, \QC builds a project before deploying and running - it. + \endlist + + By default, \QC builds a project before deploying and running it. + To run all tests without building and deploying them again, select + \uicontrol {Run All Tests Without Deployment} in the context menu. + To run the selected tests without deployment, select + \uicontrol {Run Selected Tests Without Deployment}. + + The functions to run tests are also available in the context menu in the + \uicontrol Tests view and in \uicontrol Tools > \uicontrol Tests. + \note If you have enabled build system based and code based tests, you may run tests twice when using \uicontrol {Run All Tests} or \uicontrol {Run Selected Tests}. This happens if the tests can be found by the code based test frameworks and are registered as test with the build system. - \endlist - If a test takes more than a minute to execute, the default timeout might stop the test execution. To increase the timeout, select \uicontrol Tools > \uicontrol Options > \uicontrol {Testing} > \uicontrol General. @@ -369,7 +383,8 @@ The test cases are listed in alphabetic, case insensitive order. To list them in the order in which they are defined in the source code, - select \inlineimage leafsort.png (\uicontrol {Sort Naturally}). + select \inlineimage leafsort.png + (\uicontrol {Sort Naturally}). \section2 Running and Debugging Tests from Code Editor @@ -511,7 +526,7 @@ \li To specify settings for running Catch2 tests, select \uicontrol Tools > \uicontrol Options > \uicontrol {Testing} > \uicontrol {Catch Test}. - \image qtcreator-autotests-options-catch2.png + \image qtcreator-autotests-options-catch2.png "Catch Test options" \li Select the \uicontrol {Show success} check box to show succeeding expressions as well. By default Catch2 will print only fails. \li Select the \uicontrol {Break on failure while debugging} check box @@ -543,7 +558,7 @@ \li To specify settings for running CTest-based tests, select \uicontrol Tools > \uicontrol Options > \uicontrol {Testing} > \uicontrol {CTest}. - //! insert image here + \image qtcreator-autotests-options-ctest.png "CTest options" \li Select the \uicontrol {Output on failure} check box to show test specific output if a test fails. Contrary to the CTest default this is enabled by default.