a 4jI@sdZddlmZddlmZddlZddlmZddlm Z ddl m Z m Z ddl mZmZmZmZdd lmZGd d d e ZGd d d eZGdddeZGdddeZGdddeZddZdS)zf Provides a formatter that provides an overview of available step definitions (step implementations). )absolute_import) attrgetterN)zip) Formatter) StepRegistryregistry)compute_words_maxsizeindentmake_indentationtext)i18ncs^eZdZdZdZfddZddZddZd d Zd d Z d dZ ddZ dddZ Z S)AbstractStepsFormatterz Provides a formatter base class that provides the common functionality for formatter classes that operate on step definitions (implementations). .. note:: Supports behave dry-run mode. )givenwhenZthenstepcs*tt|||d|_d|_|j|_dSN)superr __init__ step_registrycurrent_featureZ show_sourceshows_locationselfZ stream_openerconfig __class__s  zAbstractStepsFormatter.closecCs tdSr)NotImplementedErrorrrrrr+LszAbstractStepsFormatter.reportNcCs |s |j}|sJd||jfS)Nz @%s('%s'))r"pattern)rr$r"rrrdescribe_step_definitionPsz/AbstractStepsFormatter.describe_step_definition)N)__name__ __module__ __qualname____doc__ step_typesrrr%r'r(r,r+r/ __classcell__rrrrr s  r c@s0eZdZdZdZdZdZdZddZdd Z d S) StepsFormattera Provides formatter class that provides an overview which step definitions are available. EXAMPLE: $ behave --dry-run -f steps features/ GIVEN STEP DEFINITIONS[21]: Given a new working directory Given I use the current directory as working directory Given a file named "{filename}" with ... Given a step passes Given a step fails WHEN STEP DEFINITIONS[14]: When I run "{command}" ... When a step passes When a step fails THEN STEP DEFINITIONS[45]: Then the command should fail with returncode="{result:int}" Then it should pass with Then it should fail with Then the command output should contain "{text}" ... Then a step passes Then a step fails GENERIC STEP DEFINITIONS[13]: * I remove the directory "{directory}" * a file named "{filename}" exists * a file named "{filename}" does not exist ... * a step passes * a step fails .. note:: Supports behave dry-run mode. r z.Shows step definitions (step implementations).T(cCs |dSr)report_steps_by_typerrrrr+szStepsFormatter.reportc s|t|jt|jjksJ|jjp(d}tj|}|jD]:}t |jj|}|dkrj| |jjd|spq:| }|dkrdd}n6||}|ddkrt |dksJ|dn|dfdd|D}|j rt|}||jkr|j}d t|d } nd } d } |j| |t |ft||D]:\} } |j rV|j| | | jfn|j| | q.|jd q:dS)zMShow an overview of the existing step implementations per step type. enr*ZGENERICrcsg|]}d|jfqS)%s %s)r..0rZ step_keywordrr sz7StepsFormatter.report_steps_by_type.. %-s # %s z %s z%s STEP DEFINITIONS[%s]:  N)setr4rr keysrlangr languageslistextendupperlenrrmin_location_column_textr*writerlocation) rlanguageZlanguage_keywordsr"r Zstep_type_namekeywords steps_textmax_sizeschemamessager step_textrr?rr8sD       z#StepsFormatter.report_steps_by_typeN) r0r1r2r3name descriptionrrLr+r8rrrrr6Zs(r6c@sDeZdZdZdZdZdZdZdZe dZ ddZ dd Z d d Z d S) StepsDocFormattera= Provides formatter class that shows the documentation of all registered step definitions. The primary purpose is to provide help for a test writer. EXAMPLE: $ behave --dry-run -f steps.doc features/ @given('a file named "{filename}" with') Function: step_a_file_named_filename_with() Location: behave4cmd0/command_steps.py:50 Creates a textual file with the content provided as docstring. @when('I run "{command}"') Function: step_i_run_command() Location: behave4cmd0/command_steps.py:80 Run a command as subprocess, collect its output and returncode. @step('a file named "{filename}" exists') Function: step_file_named_filename_exists() Location: behave4cmd0/command_steps.py:305 Verifies that a file with this filename exists. .. code-block:: gherkin Given a file named "abc.txt" exists When a file named "abc.txt" exists ... .. note:: Supports behave dry-run mode. z steps.docz)Shows documentation for step definitions.TcCs||jddSNrC)report_step_definition_docsr*rNrrrrr+szStepsDocFormatter.reportcCshg}|jD].}|jj|D]}|jdus,J||qq |jrPt|tdd}|D]}||qTdS)NrOkey) r4rr r"appendordered_by_locationsortedrwrite_step_definition)rr#r"r$rrrr\s z-StepsDocFormatter.report_step_definition_docscCs||}|jd|t|j}|jj}|jrL|dvrL|jd||jrd|jd|j |r| }|jt ||j |jd|jddS)Nz%s )rimplz Function: %s() z Location: %s rC) r/r*rNinspectgetdocfuncr0shows_function_namerrOstripr doc_prefix)rr$Zstep_definition_textdoc func_namerrrrbs   z'StepsDocFormatter.write_step_definitionN)r0r1r2r3rWrXrrgr`r rir+r\rbrrrrrYsrYc@s6eZdZdZdZdZdZdZdZe dZ d ddZ dS) StepsCatalogFormattera Provides formatter class that shows the documentation of all registered step definitions. The primary purpose is to provide help for a test writer. In order to ease work for non-programmer testers, the technical details of the steps (i.e. function name, source location) are ommited and the steps are shown as they would apprear in a feature file (no noisy '@', or '(', etc.). Also, the output is sorted by step type (Given, When, Then) Generic step definitions are listed with all three step types. EXAMPLE: $ behave --dry-run -f steps.catalog features/ Given a file named "{filename}" with Creates a textual file with the content provided as docstring. When I run "{command}" Run a command as subprocess, collect its output and returncode. Given a file named "{filename}" exists When a file named "{filename}" exists Then a file named "{filename}" exists Verifies that a file with this filename exists. .. code-block:: gherkin Given a file named "abc.txt" exists When a file named "abc.txt" exists ... .. note:: Supports behave dry-run mode. z steps.catalogz7Shows non-technical documentation for step definitions.FrZNcCsr|s |j}|sJg}|dkrP|jddD] }d||jf}||q,n|d||jfd|S)Nrz%5s %sr<rC)r"r4titler.r_join)rr$r"descZ step_type1r rrrr/:sz.StepsCatalogFormatter.describe_step_definition)N) r0r1r2r3rWrXrrgr`r rir/rrrrrls#rlcseZdZdZdZdZedZdZfddZ fdd Z d d Z d d Z ddZ ddZddZfddZddZddZddZddZZS)StepsUsageFormatterz Provides formatter class that shows how step definitions are used by steps. EXAMPLE: $ behave --dry-run -f steps.usage features/ ... .. note:: Supports behave dry-run mode. z steps.usagez-Shows how step definitions are used by steps.rZr7cs"tt|||i|_g|_dSr)rrqrstep_usage_databaseundefined_stepsrrrrr\szStepsUsageFormatter.__init__cstt|i|_g|_dSr)rrqrrrrsrrrrraszStepsUsageFormatter.resetcCsB|j}|s>|jsJ|jjD]\}}||vr |Sq d}|S)Nr)r"rr items)rr$r"valuesrrr!get_step_type_for_step_definitiongs  z5StepsUsageFormatter.get_step_type_for_step_definitioncCs@t}|jjD]\}}||qt|j}||}|Sr)rDrr rtupdaterrrE)rr#r"ruZused_step_definitionsunused_step_definitionsrrrselect_unused_step_definitionsts  z2StepsUsageFormatter.select_unused_step_definitionscCsJ|j|d}|dur2|jdus$Jg}|j|<t||sF||dSr)rrgetr" steps_containr_)rr$rZmatching_stepsrrrupdate_usage_database|s  z)StepsUsageFormatter.update_usage_databasecCs:|j|}|r|||nt|j|s6|j|dSr)rZfind_step_definitionr|r{rsr_)rrr$rrrupdate_usage_database_for_steps   z2StepsUsageFormatter.update_usage_database_for_stepcCsF|jr|jjD]}||q|D]}|jD]}||q0q&dSr) backgroundr r}Zwalk_scenarios)rr'rZscenariorrr!update_usage_database_for_features     z5StepsUsageFormatter.update_usage_database_for_featurecstt||||dSr)rrqr'rr&rrrr'szStepsUsageFormatter.featurecCs(||||jddSr[)report_used_step_definitionsreport_unused_step_definitionsreport_undefined_stepsr*rNrrrrr+szStepsUsageFormatter.reportc Csdd}|j}t||d}|D]\}}||}dd|D}||t|}||jkrd|j}dt|d}|j |||j fdt|d}t ||D]\} } |j || | j fq|j dq"dS) NcSs |djS)NrrOxrrrzBStepsUsageFormatter.report_used_step_definitions..r]cSsg|]}d|j|jfqSz %s %skeywordrWr=rrrr@szDStepsUsageFormatter.report_used_step_definitions..%-rBrC) rrrtrar/r_rrLrMr*rNrOr) r get_locationZstep_definition_itemsr$r Z stepdef_textrRrSrTrrVrrrrs$      z0StepsUsageFormatter.report_used_step_definitionsc s}|sdSdd}t||d}fdd|D}t|}|jdkrVjd}dt|d}jd t|t||D]\}}j|||j fqdS) NcSs|jSrrrrrrrrzDStepsUsageFormatter.report_unused_step_definitions..r]csg|]}|qSr)r/)r>r$rrrr@szFStepsUsageFormatter.report_unused_step_definitions..rArBzUNUSED STEP DEFINITIONS[%d]: ) ryrarrLrMr*rNrKrrO) rrxrr#Z step_textsrSrTr$rVrrrrs   z2StepsUsageFormatter.report_unused_step_definitionscCs|js dSt|jtdd}dd|D}t|}||jkrB|j}|jdt|dt|d}t ||D]\}}|j|||j fqpdS)NrOr]cSsg|]}d|j|jfqSrrr=rrrr@sz>StepsUsageFormatter.report_undefined_steps..z UNDEFINED STEPS[%d]: rrB) rsrarrrLr*rNrKrMrrO)rrsrRrSrTrrVrrrrs z*StepsUsageFormatter.report_undefined_steps)r0r1r2r3rWrXr rirLrrrvryr|r}rr'r+rrrr5rrrrrqLs"       rqcCs(|D]}||kr|j|jkrdSqdS)NTFr)r rZ other_steprrrr{sr{)r3 __future__roperatorrrdZ six.movesrZbehave.formatter.baserZbehave.step_registryrrZbehave.textutilrr r r rMZbehaver r r6rYrlrqr{rrrrs     EgM>