\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Vicnet} \pdfinfo{ /Title (u-test-automatic-tests-layer-atl.pdf) /Creator (Cheatography) /Author (Vicnet) /Subject (U-TEST Automatic Tests Layer (ATL) Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{3E56A3} \definecolor{LightBackground}{HTML}{F2F4F9} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{U-TEST Automatic Tests Layer (ATL) Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Vicnet} via \textcolor{DarkBackground}{\uline{cheatography.com/19532/cs/2536/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Vicnet \\ \uline{cheatography.com/vicnet} \\ \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 30th November, 2016.\\ Updated 30th November, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{3} \begin{tabularx}{5.377cm}{p{0.4977 cm} x{4.4793 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Variables (access)}} \tn % Row 0 \SetRowColor{LightBackground} Set & `VsUtils.variables{[}'\textless{}name\textgreater{}'{]} = v` \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Get & `v = VsUtils.variables{[}'\textless{}name\textgreater{}'{]}` \tn % Row Count 2 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{Tip: use \textless{}{\bf{`from VsUtils import variables as vs`}}\textgreater{} to access variables easily with \textless{}{\bf{`vs{[}'...'{]}`}}\textgreater{}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Assertion}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`assertTrue({\emph{expr}})`} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{`assertFalse({\emph{expr}})`} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`assertEqual({\emph{fisrt}},{\emph{second}})`} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{`assertNotEqual({\emph{fisrt}},{\emph{second}})`} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`assertAlmostEqual({\emph{fisrt}},{\emph{second}},{\emph{places}}=7)`} \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{`assertNotAlmostEqual({\emph{fisrt}},{\emph{second}},{\emph{places}}=7)`} \tn % Row Count 7 (+ 2) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`assertRaises({\emph{excClass}},{\emph{callObj}}, *args,**kwargs)`} \tn % Row Count 9 (+ 2) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{`fail()`} \tn % Row Count 10 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{all assertions with additional parameters: \newline `(..., msg=None, continueTest=True)` \newline {\emph{msg}} could use format string: `"...\%i" \% vs{[}...{]}`} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Async assertion}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\seqsplit{`assertTrueInterval(expr)`}} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{\seqsplit{`assertFalseInterval(expr)`}} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\seqsplit{`assertAlmostEqualInterval(first},sec,places)`} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{\seqsplit{`assertNotAlmostEqualInterval(first},sec,places)`} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{\seqsplit{`assertTrueAtLeastInterval(expr)`}} \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{\seqsplit{`assertAtLeastOnceTrue(expr)`}} \tn % Row Count 6 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{all assertions with additional parameters: \newline ~`(..., msg=None)`} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Async usage}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{async = ATLAsyncTest(self) \newline async.assert...(lambda:vs{[}{\emph{varname}}{]}...,msg) \newline async.assert...('vs{[}{\emph{varname}}{]}...',msg) \newline async.assert...({\emph{function}},msg) \newline async.execute(timeout)} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{{\emph{expr}} and {\emph{msg}} could be lamda, string or function \newline {\emph{expr}} should contains only one variable. \newline {\emph{expr}} is evaluated one time to get the variable} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Advanced tips}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{How to disable warning import msg} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`sys.modules{[}'ihooks'{]}.current\_importer.addOkModule('xxx)`} \tn % Row Count 3 (+ 3) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{In custom assert, how to get correct file/line} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}Use {\emph{tbskip}} param in {\emph{self.result.addFailure}}} \tn % Row Count 5 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{How to interact with operator ?} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}Use {\emph{wx}} python binding} \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Interact with Logbook}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{rtc.setLogLevel({\emph{level}}) \newline rtc.startLogSession('{\emph{SessionName}}', '{\emph{comment}}') \newline rtc.logMessage(RTC.Logger.{\emph{level}}, '{\emph{UserModule}}', '{\emph{msg}}') \newline ... \newline rtc.stopLogSession()} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Levels are: {\emph{Debug}}, {\emph{Info}}, {\emph{Warning}}, {\emph{Error}}, {\emph{Critical}}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{RTC services}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Creation} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`rtc = RTC.RTCManager({\emph{ip}} {[}, {\emph{port}}{]})`} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Connection} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`rtc.connect({\emph{ip}} {[}, {\emph{port}}{]})`} \tn % Row Count 4 (+ 2) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Configure {\emph{if not done by mmi}}} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`rtc.configure({\emph{client name}}, {\emph{dbPath}})`} \tn % Row Count 6 (+ 2) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Usercode control} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`rtc.{[}start/stop{]}Code({\emph{codeName}})`} \tn % Row Count 8 (+ 2) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Monitoring control} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`rtc.{[}start/stop{]}Monitor({\emph{taskName}})`} \tn % Row Count 10 (+ 2) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{Archiver control} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`rtc.{[}start/stop{]}Recordset({\emph{rsName}})`} \tn % Row Count 12 (+ 2) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Manage errors} \tn \mymulticolumn{1}{x{5.377cm}}{\hspace*{6 px}\rule{2px}{6px}\hspace*{6 px}`try:... except: SystemError , detail:`} \tn % Row Count 14 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{VS callback}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{class notifier(Vs.Callback): \newline def \seqsplit{variableDidChange(*args):} \newline print 'callback called' \newline callback = notifier() \newline notif = VsUtils.vc. \newline \seqsplit{registerCallbackValueChanged(name},callback) \newline ... \newline del notif} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Callback class should be created outside of {\emph{register}} method. \newline Other callback are available.} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Variables (creation)}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`VsUtils.vc.createVariable('\textless{}{\emph{name}}\textgreater{}', Vs.\textless{}{\emph{type}}\textgreater{}, {[}{\emph{capacity}}=1{]})`} \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{`VsUtils.vc.deleteVariable('\textless{}{\emph{name}}\textgreater{}')`} \tn % Row Count 3 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{Types are: {\emph{INTEGER}}, {\emph{DOUBLE}}, {\emph{OPAQUE}}} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Tips}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{`import time`\{\{nl\}\}`time.sleep(seconds)`} \tn % Row Count 1 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Testcase}} \tn \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{class {\emph{\textless{}TestCase name\textgreater{}}}(ATLTestCase): \newline ~~def initialize(self): \newline ~~~~\# no exception inside this method \newline ~~def finalize(self): \newline ~~~~\# no exception inside this method \newline ~~def execute(self): \newline ~~~~\# test steps here, see Assertions} \tn \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{p{0.4177 cm} x{1.50372 cm} x{1.29487 cm} x{0.96071 cm} } \SetRowColor{DarkBackground} \mymulticolumn{4}{x{5.377cm}}{\bf\textcolor{white}{Test structure (tsdef)}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{4}{x{5.377cm}}{TestSuite ({\emph{tsdef}})} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} & Root {\emph{TestGroup}} & & \tn % Row Count 3 (+ 2) % Row 2 \SetRowColor{LightBackground} & & {\emph{TestGroup}} & \tn % Row Count 4 (+ 1) % Row 3 \SetRowColor{white} & & & TestCase \tn % Row Count 5 (+ 1) % Row 4 \SetRowColor{LightBackground} & & & TestCase \tn % Row Count 6 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}----} \SetRowColor{LightBackground} \mymulticolumn{4}{x{5.377cm}}{Groups are optionals} \tn \hhline{>{\arrayrulecolor{DarkBackground}}----} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.24425 cm} x{3.73275 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Running tests}} \tn % Row 0 \SetRowColor{LightBackground} \seqsplit{\$PYTHONPATH} & /opt/gc/lib/python \tn % Row Count 2 (+ 2) % Row 1 \SetRowColor{white} & /opt/vs/lib \tn % Row Count 3 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{python ~ \seqsplit{utest/ATL/ATLTestRunner.py}} \tn % Row Count 4 (+ 1) % Row 3 \SetRowColor{white} & -c {\emph{config}}.xml \tn % Row Count 5 (+ 1) % Row 4 \SetRowColor{LightBackground} & -r {\emph{result}}.xml \tn % Row Count 6 (+ 1) % Row 5 \SetRowColor{white} & -v ~ {\emph{verbose in console}} \tn % Row Count 7 (+ 1) % Row 6 \SetRowColor{LightBackground} & {[}-{}-server{]} ~ {\emph{xmlrpc server}} \tn % Row Count 9 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{1.04517 cm} x{3.93183 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Test results}} \tn % Row 0 \SetRowColor{LightBackground} Passed & tests within limits \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} Failed & test not in limits \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} Aborted & not completed ({\emph{exception}}) \tn % Row Count 3 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}