Skip to content

Commit

Permalink
Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
anibalinn committed Aug 15, 2024
1 parent e2e75dd commit c153cf0
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 21 deletions.
11 changes: 11 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
Version History
===============================================================================

Version: 3.3.0
-------------------------------------------------------------------------------
ENHANCEMENTS:

* Enabling BehaveX to attach screenshots to the HTML report (by incorporating the behavex-images library)
* Improvement in progress bar, to remove any trailing content displayed in console when printing the progress bar

FIXES:
* Updated the HTML report to use an absolute url when opening the attached report logs and images, as relative urls were causing issues when opening the report in different browsers


Version: 3.2.13
-------------------------------------------------------------------------------
ENHANCEMENTS:
Expand Down
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,43 +53,43 @@ Examples:

>Run scenarios tagged as **TAG_1** but not **TAG_2**:
>
> <pre>behavex -t @TAG_1 -t ~@TAG_2</pre>
> <pre>behavex -t=@TAG_1 -t=~@TAG_2</pre>
>Run scenarios tagged as **TAG_1** or **TAG_2**:
>
><pre>behavex -t @TAG_1,@TAG_2</pre>
><pre>behavex -t=@TAG_1,@TAG_2</pre>
>Run scenarios tagged as **TAG_1**, using **4** parallel processes:
>
><pre>behavex -t @TAG_1 --parallel-processes 4 --parallel-scheme scenario</pre>
><pre>behavex -t=@TAG_1 --parallel-processes=4 --parallel-scheme=scenario</pre>
>Run scenarios located at "**features/features_folder_1**" and "**features/features_folder_2**" folders, using **2** parallel processes
>
><pre>behavex features/features_folder_1 features/features_folder_2 --parallel-processes 2</pre>
><pre>behavex features/features_folder_1 features/features_folder_2 --parallel-processes=2</pre>
>Run scenarios from "**features_folder_1/sample_feature.feature**" feature file, using **2** parallel processes
>
><pre>behavex features_folder_1/sample_feature.feature --parallel-processes 2</pre>
><pre>behavex features_folder_1/sample_feature.feature --parallel-processes=2</pre>
>Run scenarios tagged as **TAG_1** from "**features_folder_1/sample_feature.feature**" feature file, using **2** parallel processes
>
><pre>behavex features_folder_1/sample_feature.feature -t @TAG_1 --parallel-processes 2</pre>
><pre>behavex features_folder_1/sample_feature.feature -t=@TAG_1 --parallel-processes=2</pre>
>Run scenarios located at "**features/feature_1**" and "**features/feature_2**" folders, using **2** parallel processes
>
><pre>behavex features/feature_1 features/feature_2 --parallel-processes 2</pre>
><pre>behavex features/feature_1 features/feature_2 --parallel-processes=2</pre>
>Run scenarios tagged as **TAG_1**, using **5** parallel processes executing a feature on each process:
>
><pre>behavex -t @TAG_1 --parallel-processes 5 --parallel-scheme feature</pre>
><pre>behavex -t=@TAG_1 --parallel-processes=5 --parallel-scheme=feature</pre>
>Perform a dry run of the scenarios tagged as **TAG_1**, and generate the HTML report:
>
><pre>behavex -t @TAG_1 --dry-run</pre>
><pre>behavex -t=@TAG_1 --dry-run</pre>
>Run scenarios tagged as **TAG_1**, generating the execution evidence into the "**exec_evidence**" folder (instead of the default "**output**" folder):
>
><pre>behavex -t @TAG_1 -o execution_evidence</pre>
><pre>behavex -t=@TAG_1 -o=execution_evidence</pre>

## Constraints
Expand Down Expand Up @@ -153,15 +153,15 @@ BehaveX will be in charge of managing each parallel process, and consolidate all
Parallel test executions can be performed by **feature** or by **scenario**.

Examples:
> behavex --parallel-processes 3
> behavex --parallel-processes=3
> behavex -t @\<TAG\> --parallel-processes 3
> behavex -t=@\<TAG\> --parallel-processes=3
> behavex -t @\<TAG\> --parallel-processes 2 --parallel-scheme scenario
> behavex -t=@\<TAG\> --parallel-processes=2 --parallel-scheme=scenario
> behavex -t @\<TAG\> --parallel-processes 5 --parallel-scheme feature
> behavex -t=@\<TAG\> --parallel-processes=5 --parallel-scheme=feature
> behavex -t @\<TAG\> --parallel-processes 5 --parallel-scheme feature --show-progress-bar
> behavex -t=@\<TAG\> --parallel-processes=5 --parallel-scheme=feature --show-progress-bar
When the parallel-scheme is set by **feature**, all tests within each feature will be run sequentially.

Expand Down Expand Up @@ -264,7 +264,7 @@ The HTML report generated as part of the dry run can be used to share the scenar

Example:

> behavex -t @TAG --dry-run
> behavex -t=@TAG --dry-run
## Muting test scenarios

Expand All @@ -287,11 +287,11 @@ This file allows you to run all failing scenarios again.

This can be done by executing the following command:

> behavex -rf ./<OUTPUT_FOLDER\>/failing_scenarios.txt
> behavex -rf=./<OUTPUT_FOLDER\>/failing_scenarios.txt
or

> behavex --rerun-failures ./<OUTPUT_FOLDER\>/failing_scenarios.txt
> behavex --rerun-failures=./<OUTPUT_FOLDER\>/failing_scenarios.txt
To avoid the re-execution to overwrite the previous test report, we suggest to provide a different output folder, using the **-o** or **--output-folder** argument.

Expand All @@ -306,7 +306,7 @@ To enable the progress bar, just add the **--show-progress-bar** argument to the

Example:

> behavex -t @TAG --parallel-processes 3 --show-progress-bar
> behavex -t=@TAG --parallel-processes=3 --show-progress-bar
In case you are printing logs in the console, you can configure the progress bar to be displayed in a new line on every update, by adding the following setting to the BehaveX configuration file

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

setup(
name='behavex',
version='3.2.13',
version='3.3.0',
python_requires='>=3.5',
author='Hernan Rey',
author_email='behavex_users@googlegroups.com',
Expand All @@ -23,7 +23,7 @@
},
install_requires=[
'behave==1.2.6',
'behavex-images'
'behavex-images',
'jinja2',
'configobj',
'htmlmin',
Expand Down

0 comments on commit c153cf0

Please sign in to comment.