Skip to content

DOC: Update ITK testing macros names #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jhlegarreta merged 1 commit into from
Jun 12, 2019
Merged

DOC: Update ITK testing macros names #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions SoftwareGuide/Latex/Appendices/CodingStyleGuide.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2755,7 +2755,7 @@ \subsection{Empty Lines}
hMinimaFilter->SetInput( reader->GetOutput() );

// Run the filter
TRY_EXPECT_NO_EXCEPTION( hMinimaFilter->Update() );
ITK_TRY_EXPECT_NO_EXCEPTION( hMinimaFilter->Update() );


// Write the output
Expand All @@ -2764,7 +2764,7 @@ \subsection{Empty Lines}
writer->SetFileName( argv[2] );
writer->SetInput( hMinimaFilter->GetOutput() );

TRY_EXPECT_NO_EXCEPTION( writer->Update() );
ITK_TRY_EXPECT_NO_EXCEPTION( writer->Update() );


std::cout << "Test finished." << std::endl;
Expand Down Expand Up @@ -3146,7 +3146,7 @@ \section{Using Standard Macros}

\small
\begin{minted}[baselinestretch=1,fontsize=\footnotesize,linenos=false,bgcolor=ltgray]{cpp}
TRY_EXPECT_NO_EXCEPTION( writer->Update() );
ITK_TRY_EXPECT_NO_EXCEPTION( writer->Update() );
\end{minted}
\normalsize

Expand Down Expand Up @@ -3569,9 +3569,9 @@ \subsection{Code Layout in Tests}
\item Input argument number check.
\item Input image read (or generation).
\item \code{foo} class instantiation and basic object checks (e.g.
\code{EXERCISE\_BASIC\_OBJECT\_METHODS}).
\code{ITK\_EXERCISE\_BASIC\_OBJECT\_METHODS}).
\item \code{foo} class properties' input argument read and test (e.g. using the
macros in \code{itkTestingMacro.h}, such as \code{TEST\_SET\_GET\_OBJECT}, etc.).
macros in \code{itkTestingMacro.h}, such as \code{ITK\_TEST\_SET\_GET\_OBJECT}, etc.).
\item \code{foo} class \code{Update()}.
\item Regression checks.
\item Output image write.
Expand Down
10 changes: 5 additions & 5 deletions SoftwareGuide/Latex/DevelopmentGuidelines/CreateAModule.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,21 +365,21 @@ \section{Tests}
\item \texttt{itkTestingMacros.h}: it contains a number of macros that allow
testing of basic object properties:
\begin{itemize}
\item \code{EXERCISE\_BASIC\_OBJECT\_METHODS()}: verifies whether the class and
\item \code{ITK\_EXERCISE\_BASIC\_OBJECT\_METHODS()}: verifies whether the class and
superclass names provided match the RTTI, and exercises the \code{PrintSelf()}
method. Since the \code{PrintSelf()} method prints all class member variables,
this macro, when exercised, can identify uninitialized member variables.
\item \code{TEST\_SET\_GET\_VALUE()}: once a member variable value has been set
\item \code{ITK\_TEST\_SET\_GET\_VALUE()}: once a member variable value has been set
using the corresponding Set macro, this macro verifies that the value provided
to the \code{Set()} method was effectively assigned to the member variable
by comparing it to the value returned by the \code{Get()} value.
\item \code{TEST\_SET\_GET\_BOOLEAN()}: exercises the \code{Set()/Get()},
\item \code{ITK\_TEST\_SET\_GET\_BOOLEAN()}: exercises the \code{Set()/Get()},
and \code{On()/Off()} methods of class applied to a boolean member variable.
\end{itemize}
\item \code{TRY\_EXPECT\_NO\_EXCEPTION()}: exercises a method which is expected to
\item \code{ITK\_TRY\_EXPECT\_NO\_EXCEPTION()}: exercises a method which is expected to
return with no errors. It is only required for methods that are known to throw
exceptions, such as I/O operations, filter updates, etc.
\item \code{TRY\_EXPECT\_EXCEPTION()}: exercises a method in the hope of detecting
\item \code{ITK\_TRY\_EXPECT\_EXCEPTION()}: exercises a method in the hope of detecting
an exception. This macro allows a test to continue its execution when setting
test cases bound to hit a class' exception cases. It is only required for
methods that are known to throw exceptions, such as I/O operations, filter
Expand Down