behavex 4.1.2__py3-none-any.whl

behavex/__init__.py

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+""" Create environment variables related to the framework path and config,
+    that are needed in framework modules.
+"""
+# __future__ import absolute_import  added for compatibility
+from __future__ import absolute_import
+
+import os
+
+# Set the framework path
+os.environ['BEHAVEX_PATH'] = os.path.dirname(os.path.realpath(__file__))
+# Set the features path
+os.environ['FEATURES_PATH'] = os.environ.get('FEATURES_PATH', 'features')
+

behavex/__main__.py

@@ -0,0 +1,4 @@
+from behavex.runner import main
+
+if __name__ == "__main__":
+    main()

behavex/arguments.py

@@ -0,0 +1,332 @@
+# -*- coding: utf-8 -*-
+"""
+
+/*
+* BehaveX - Agile test wrapper on top of Behave (BDD)
+*/
+
+Parse all framework arguments, the ones from BehaveX and
+the ones from Behave supported by the wrapper
+"""
+# __future__ has been added to maintain compatibility
+from __future__ import absolute_import
+
+import argparse
+
+BEHAVE_ARGS = [
+    'no_color',
+    'color',
+    'define',
+    'exclude',
+    'include',
+    'no_junit',
+    'junit',
+    'junit_directory',
+    'steps_catalog',
+    'no_skipped',
+    'show_skipped',
+    'lang',
+    'no_snippets',
+    'snippets',
+    'no_multiline',
+    'multiline',
+    'no_capture',
+    'name',
+    'capture',
+    'no_capture_stderr',
+    'capture_stderr',
+    'no_logcapture',
+    'logcapture',
+    'logging_level',
+    'logging_format',
+    'logging_datefmt',
+    'logging_filter',
+    'logging_clear_handlers',
+    'no_summary',
+    'summary',
+    'outfile',
+    'quiet',
+    'no_source',
+    'show_source',
+    'stage',
+    'stop',
+    'tags',
+    'no_timings',
+    'show_timings',
+    'verbose',
+    'wip',
+    'expand',
+    'lang_list',
+    'lang_help',
+    'tags_help',
+]
+
+BEHAVEX_ARGS = [
+    'output_folder',
+    'config',
+    'dry_run',
+    'tags',
+    'parallel_scheme',
+    'parallel_processes',
+    'show_progress_bar',
+]
+
+
+def parse_arguments(args):
+    """Process all command line arguments"""
+    parser = argparse.ArgumentParser(
+        description='BehaveX - test automation wrapper on top of Behave'
+    )
+    parser.add_argument("paths", nargs="*",
+                        help="Features path")
+    parser.add_argument(
+        '-c',
+        '--config',
+        help='BehaveX configuration file to use by default.',
+        required=False,
+    )
+    parser.add_argument(
+        '-t',
+        '--tags',
+        action='append',
+        help='Tags used to properly filter the tests to run. \
+                                When multiple --tags (-t) arguments are \
+                                provided it means a logical AND \
+                                (e.g. -t @TAG_1 -t @TAG_2 means \
+                                @TAG_1 AND @TAG_2). \
+                                When multiple comma separated tags are \
+                                provided as part of the same --tags (-t) \
+                                argument it means a logical OR \
+                                (e.g. -t @TAG_1,@TAG_2 means \
+                                @TAG_1 OR @TAG_2)',
+        required=False,
+    )
+    parser.add_argument(
+        '-o',
+        '--output-folder',
+        default='',
+        help='Specifies the output folder path where the test report will be stored. '
+             'The path can be specified as a relative path. The value of this argument '
+             'can be accessed in testing implementations using the "OUTPUT" environment variable',
+        required=False,
+    )
+    parser.add_argument(
+        '-d',
+        '--dry-run',
+        default='',
+        action='store_true',
+        help='Invokes formatters without executing the steps.',
+        required=False,
+    )
+
+    # ------------------- Behave arguments -------------------#
+    parser.add_argument(
+        '--no-color',
+        '--no_color',
+        help='Disable the use of ANSI color escapes.',
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--color',
+        help='Use ANSI color escapes. This is the default '
+        'behaviour. This switch is used to override a '
+        'configuration file setting.',
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '-D',
+        '--define',
+        help='Define user-specific data in config.userdata '
+        'dictionary. Example: -D foo=bar to store it in '
+        "config.userdata['foo'].",
+        action='append',
+        required=False,
+    )
+    parser.add_argument(
+        '--exclude',
+        help="Don't run feature files matching regular expression PATTERN.",
+        required=False,
+    )
+    parser.add_argument(
+        '-i',
+        '--include',
+        help='Only run feature files matching regular expression PATTERN.',
+        required=False,
+    )
+    parser.add_argument(
+        '--name',
+        help='Execute feature elements matching a part of the given name. '
+             'If this option is specified more than once, '
+             'it will match against all given names.',
+        required=False,
+    )
+    parser.add_argument(
+        '--no-capture',
+        '--no_capture',
+        help="Don't capture stdout (any stdout output will be printed immediately.)",
+        default=False,
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--capture',
+        help='Capture stdout (any stdout output will be '
+        'printed if there is a failure.) This is the '
+        'default behaviour. This switch is used to '
+        'override a configuration file setting.',
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--no-capture-stderr',
+        '--no_capture_stderr',
+        help="Don't capture stderr (any stderr output will be printed immediately.)",
+        default=False,
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--capture-stderr',
+        '--capture_stderr',
+        help='Capture stderr (any stderr output will be pri'
+        'nted if there is a failure) This is the default'
+        ' behaviour. This switch is used to override a '
+        'configuration file setting.',
+        default=False,
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--no-logcapture',
+        '--no_logcapture',
+        help="Don't capture logging. Logging configuration will be left intact.",
+        action='store_true',
+        default=False,
+        required=False,
+    )
+    parser.add_argument(
+        '--log-capture',
+        '--log_capture',
+        help='Capture logging. All logging during a step will'
+        ' be captured and displayed in the event of a '
+        'failure. This is the default behaviour. This '
+        'switch is used to override a configuration file'
+        ' setting.',
+        action='store_true',
+        required=False,
+    )
+    # parser.add_argument('--summary',
+    #                     help="Display the summary at the end of the run.",
+    #                     action="store_true",
+    #                     required=False)
+    # parser.add_argument('-q',
+    #                     '--quiet',
+    #                     help="Alias for --no-snippets --no-source.",
+    #                     action="store_true",
+    #                     required=False)
+    # parser.add_argument('-s',
+    #                     '--no-source',
+    #                     help="Don't print the file and line of the step d"
+    #                          "efinition with the steps.",
+    #                     action="store_true",
+    #                     required=False)
+    # parser.add_argument('--show-source',
+    #                     help="Print the file and line of the step definition "
+    #                          "with the steps. This is the default behaviour."
+    #                          "This switch is used to override a configuration"
+    #                          " file setting.",
+    #                     action='store_true',
+    #                     required=False)
+    parser.add_argument(
+        '-ns',
+        '--no-snippets',
+        '--no_snippets',
+        help="Don't print snippets for unimplemented steps.",
+        default=False,
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--stop',
+        help='Specifies that the test execution should stop at the first failure. '
+             'Note that this argument is not supported for parallel test executions',
+        action='store_true',
+        required=False,
+    )
+    parser.add_argument(
+        '--tags-help',
+        '--tags_help',
+        help='Show help for tag expressions.',
+        action='store_true',
+        required=False,
+    )
+    # -------------------- adding lastly ---------------------------------------
+    parser.add_argument(
+        '--logging-level',
+        '--logging_level',
+        default='INFO',
+        choices=['CRITICAL', 'ERROR', 'WARNING', 'INFO', 'DEBUG', 'NOTSET'],
+        help='Specifies the logging level to capture.',
+        required=False,
+    )
+    parser.add_argument(
+        '--parallel-processes',
+        default=1,
+        type=int,
+        help='Specifies the number of parallel processes that can be executed simultaneously.',
+        required=False,
+    )
+    parser.add_argument(
+        '--parallel-scheme',
+        choices=['feature', 'scenario'],
+        default='scenario',
+        help="Specifies whether parallel execution should be performed at the scenario or feature level.",
+        required=False,
+    )
+    parser.add_argument(
+        '--parallel-delay',
+        type=int,
+        default=0,
+        help='Delay in milliseconds before starting each parallel process')
+    parser.add_argument(
+        '-ip',
+        '--include-paths',
+        default=[],
+        nargs='*',
+        help='Filters the test set to the specified list of features.'
+        'or feature file locations (FEATURE_FILE:LINE).',
+    )
+    parser.add_argument(
+        '-rf',
+        '--rerun-failures',
+        help='Enables re-execution of the failing scenarios. '
+             'After each execution, the failing scenarios are saved '
+             'in a "failing_scenarios.txt" file in the output folder. '
+             'This argument specifies the location of the "failing_scenarios.txt" file. '
+             'For example: --rf ./output/failing_scenarios.txt',
+        required=False
+    )
+    parser.add_argument(
+        '-spb',
+        '--show-progress-bar',
+        help="Shows the execution progress bar in console.",
+        default=False,
+        action='store_true',
+        required=False,
+    )
+
+    # parser.add_argument('--logging-format',
+    #                    help="Specify custom format to print statements. Uses "
+    #                          " the same format as used by standard logging "
+    #                        "handlers. The default is (%levelname)s:w%(name)s:"
+    #                          "%(message)s%.",
+    #                     required=False)
+    # parser.add_argument('--logging-datefmt',
+    #                     help="Specify custom date/time format to print "
+    #                          "statements. Uses the same format as used by "
+    #                          "standard logging handlers.",
+    #                     required=False)
+    #
+    return parser.parse_args(args)

behavex/conf_behavex.cfg

@@ -0,0 +1,5 @@
+[output]
+path=output
+
+[test_run]
+tags_to_skip=

behavex/conf_logging.cfg

@@ -0,0 +1,26 @@
+[loggers]
+keys=root
+
+[handlers]
+keys=consoleHandler
+
+[formatters]
+keys=simpleFormatter
+
+[file_handler]
+encoding=utf-8-sig
+
+[logger_root]
+level=DEBUG
+handlers=consoleHandler
+
+[handler_consoleHandler]
+class=StreamHandler
+level=DEBUG
+encoding=utf-8-sig
+formatter=simpleFormatter
+args=(sys.stdout, )
+
+[formatter_simpleFormatter]
+format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+datefmt=%H:%M:%S

behavex/conf_mgr.py

@@ -0,0 +1,135 @@
+# -*- coding: utf-8 -*-
+"""
+/*
+* BehaveX - Agile test wrapper on top of Behave (BDD)
+*/
+
+This module process the configuration required by the framework. Default values
+ are used if no config file is provided.
+"""
+# pylint: disable=W0703
+# pylint: disable=W0603
+
+from __future__ import absolute_import
+
+import os
+
+from configobj import ConfigObj
+from validate import Validator
+
+from behavex.execution_singleton import ExecutionSingleton
+
+CONFIG = None
+CONFIG_PATH = None
+
+
+def get_config():
+    """Returns a dictionary containing
+    the framework configuration values"""
+    config_spec = """
+    [output]
+    path=string(default="output")
+
+    [progress_bar]
+    print_updates_in_new_lines=boolean(default=False)
+
+    [test_run]
+    tags_to_skip=string(default="")
+
+    [params]
+    requirements_config=string(default="")
+    tags=list(default=list())
+    dry_run=boolean(default=False)
+    no_color=boolean(default=False)
+    define=string(default="")
+    exclude=string(default="")
+    include=string(default="")
+    name=string(default="")
+    no_capture=boolean(default=False)
+    capture=boolean(default=True)
+    capture_stderr=boolean(default=False)
+    no_logcapture=boolean(default=False)
+    logcapture=boolean(default=True)
+    no_snippets=boolean(default=False)
+    stop=boolean(default=False)
+    tags_help=boolean(default=False)
+    logging_level=option('CRITICAL', \
+                         'ERROR', \
+                         'WARNING', \
+                         'INFO', \
+                         'DEBUG', \
+                         'NOTSET', \
+                         default='INFO')
+    parallel_processes=integer(default=1)
+    parallel_scheme=option('feature', 'scenario', default='scenario')
+    include_paths=list(default=list())
+    rerun_failures=string(default="")
+    """
+    global CONFIG
+    global CONFIG_PATH
+    if CONFIG is None or CONFIG_PATH != os.environ.get('CONFIG'):
+        CONFIG_PATH = os.environ.get('CONFIG')
+        spec = config_spec.split('\n')
+        validator = Validator()
+        CONFIG = ConfigObj(CONFIG_PATH, configspec=spec)
+        CONFIG.validate(validator, copy=True)
+
+    return CONFIG
+
+
+class ConfigRun(metaclass=ExecutionSingleton):
+    def __init__(self):
+        self.config = get_config()
+        self.args = None
+        self.environ = {}
+
+    def prepare_environment(self):
+        output = self.get_param('output.path', 'output_folder')
+        self.environ['output'] = output
+        self.environ['temp'] = os.path.join(output, 'temp')
+        self.environ['logs'] = os.path.join(output, 'outputs', 'logs')
+
+    def set_args(self, args):
+        self.args = args
+        self.prepare_environment()
+
+    def set_env(self, key, value):
+        self.environ[key] = value
+
+    def get_param_config(self, key_chain):
+        keys = key_chain.split('.')
+        if len(keys) == 1:
+            keys = ['params'] + keys
+        dictionary = self.config
+        for key in keys:
+            result = dictionary.get(key, '')
+            if isinstance(result, str):
+                return result
+            if isinstance(result, dict):
+                dictionary = result
+            else:
+                return result
+        return ''
+
+    def get_param(self, key_chain, arg=None):
+        if not arg:
+            arg = key_chain.split('.')[-1]
+        if getattr(self.args, arg):
+            return getattr(self.args, arg)
+        else:
+            return self.get_param_config(key_chain)
+
+    def get_env(self, key, optional=None):
+        return self.environ.get(key.lower(), optional)
+
+
+def get_param(key_chain, arg=None):
+    return ConfigRun().get_param(key_chain, arg)
+
+
+def get_env(key, optional=None):
+    return ConfigRun().get_env(key, optional)
+
+
+def set_env(key, value):
+    ConfigRun().set_env(key, value)