Behave-jenkins

-------------------------------------------------------------------------------

GOALS:

- Improve support for Windows

DOCUMENTATION:

* pull 327: Fix typo in Django doc (provided by: nikolas)
* pull 321: Update Django integration (provided by: bittner, contains: 315, 316)
* FIX: cmdline/config-param doc-generator, avoid duplicated param entries (related to: 318)
* issue 317: Update comparison: lettuce tags (provided by: ramiabughazaleh)
* pull 307: Typo in readme (provided by: dflock)
* pull 305: behave.rst related fixes reapplied (provided by: bittner)
* pull 292: Use title-cased keywords in tutorial scenario (provided by: neoblackcap)
* pull 291: Tiny tweaks in tutorial docs (provided by: bernardpaulus)

ENHANCEMENTS:

* issue 301: Support default tags in configfile
* issue 299: Runner can continue after a failed step (same as: 314)

CHANGES:

* parser: language comment in feature file has higher priority than --lang option (related to: 334).

FIXED:

* issue 319: python-version requirements in behave.whl for Python2.6 (submitted by: darkfoxprime)
* issue 310: Use setuptools_behave.py with behave module
* issue 309: behave --lang-list fails on Python3 (and Python2)

-------------------------------------------------------------------------------

:Same as: Version 1.2.5a1 (unreleased).

NEWS and CHANGES:

- General:

* Improve support for Python3 (py3.3, py3.4; 268)
* Various unicode related fixes (Unicode errors with non-ASCII, etc.)
* Drop support for Python 2.5

- Running:

* ScenarioOutline: Annotates name with row.id, ... to better represent row.
* NEW: Active Tags, see docs (`New and Noteworthy`_).
* NEW: Test stages, see docs (`New and Noteworthy`_).
* NEW: User-specific configuration data, see docs (`New and Noteworthy`_).
* CHANGED: Undefined step snippet uses now NotImplementedError (related to: 254)

- Model:

* ScenarioOutline: Various improvements, see docs (`New and Noteworthy`_).

- Formatters:

* plain: Can now show tags, but currently disabled per default
* NEW: steps.catalog: Readable summary of all steps (similar to: steps.doc, 271)
* NEW: User-defined formatters, see docs (`New and Noteworthy`_).

ENHANCEMENTS:

* pull 285: Travis CI improvements to use container environment, etc. (provided by: thedrow)
* pull 272: Use option role to format command line arg docs (provided by: helenst)
* pull 271: Provide steps.catalog formatter (provided by: berdroid)
* pull 261: Support "setup.cfg" as configuration file, too (provided by: bittner)
* pull 260: Documentation tweaks and typo fixes (provided by: bittner)
* pull 254: Undefined step raises NotImplementedError instead of assert False (provided by: mhfrantz)
* issue 242: JUnitReporter can show scenario tags (provided by: rigomes)
* issue 240: Test Stages with different step implementations (provided by: attilammagyar, jenisys)
* issue 238: Allow to skip scenario in step function (provided by: hotgloupi, jenisys)
* issue 228: Exclude scenario fron run (provided by: jdeppe, jenisys)
* issue 227: Add a way to add command line options to behave (provided by: attilammagyar, jenisys)

FIXED:

* pull 283: Fix "fork me" image in docs (provided by: frodopwns)
* issue 280: Fix missing begin/end-markers in RegexMatcher (provided by: tomekwszelaki, jenisys)
* pull 268: Fix py3 compatibility with all tests passed (provided by: sunliwen)
* pull 252: Related to 251 (provided by: mcepl)
* pull 190: UnicodeDecodeError in tracebacks (provided by: b3ni, vrutkovs, related to: 226, 230)
* issue 257: Fix JUnitReporter (XML) for Python3 (provided by: actionless)
* issue 249: Fix a number of docstring problems (provided by: masak)
* issue 253: Various problems in PrettyFormatter.exception()
* issue 251: Unicode crash in model.py (provided by: mcepl, jenisys)
* issue 236: Command line docs are confusing (solved by: 272)
* issue 230: problem with assert message that contains ascii over 128 value (provided by: jenisys)
* issue 226: UnicodeDecodeError in tracebacks (provided by: md1023, karulis, jenisys)
* issue 221: Fix some PY2/PY3 incompatibilities (provided by: johbo)
* pull 219: IDE's unknown modules import issue (provided by: xbx)
* issue 216: Using --wip option does not disable ANSI escape sequences (coloring).
* issue 119: Python3 support for behave (solved by: 268 and ...)
* issue 82: JUnitReporter fails with Python 3.x (fixed with: 257, 268)


.. _`New and Noteworthy`: https://github.com/behave/behave/blob/master/docs/new_and_noteworthy.rst

-------------------------------------------------------------------------------

:Same as: Version 1.2.4a1 (unreleased).

NEWS and CHANGES:

- Running:

* ABORT-BY-USER: Better handle KeyboardInterrupt to abort a test run.
* feature list files (formerly: feature configfiles) support wildcards.
* Simplify and improve setup of logging subsystem (related to: 143, 177)

- Step matchers:

* cfparse: Step matcher with "Cardinality Field" support (was: optional).

- Formatters:

* steps.usage: Avoid duplicated steps usage due to Scenario Outlines.
* json: Ensures now that matched step params (match args) cause valid JSON.


IMPROVEMENT:

* issue 108: behave.main() can be called with command-line args (provided by: medwards, jenisys)
* issue 172: Subfolders in junit XML filenames (provided by: roignac).
* issue 203: Integration with pdb (debug on error; basic support)
* Simple test runner to run behave tests from "setup.py"

FIXED:

* issue 143: Logging starts with a StreamHandler way too early (provided by: jtatum, jenisys).
* issue 175: Scenario isn't marked as 'failed' when Background step fails
* issue 177: Cannot setup logging_format
* issue 181: Escape apostrophes in undefined steps snippets
* issue 184: TypeError when running behave with --include option (provided by: s1ider).
* issue 186: ScenarioOutline uses wrong return value when if fails (provided by: mdavezac)
* issue 188: Better diagnostics if nested step is undefined
* issue 191: Using context.execute_steps() may change context.table/.text
* issue 194: Nested steps prevent that original stdout/stderr is restored
* issue 199: behave tag expression bug when or-not logic is used

-------------------------------------------------------------------------------

Latest stable version.
Same as last development version.

-------------------------------------------------------------------------------

NEWS and CHANGES:

- Install:

* Require now parse>=1.6.2 to enforce log-bugfix 14 (was: parse>=1.6)

- Running:

* load_step_definitions: Are now sorted before loading (due to: Linux, ...).
* NEW: Use lazy-loading for formatters if possible (speed up self-tests by 20%).

- Model:

* location: Now a FileLocation object (was: string), required for ordering.

- Formatters:

* NEW: progress3 formatter, ScenarioStepProgressFormatter (provided by: roignac).
* NEW: sphinx.steps formatter, generate Sphinx-based docs for step definitions (related to 166).
* NEW: steps formatter, shows available step definitions.
* NEW: steps.doc formatter, shows documentation of step definitions (related to: 55).
* NEW: steps.usage formatter, shows where step definitions are used.
* RENAMED: json-pretty, tag_count, tag_location => json.pretty, tags, tags.location
* help: Shows now a better formatted list (improve readability).

IMPROVEMENT:

* issue 166: behave should have a tool (or formatter) that generates Sphinx-based documentation (basics provided).

FIXED:

* issue 172: JUnit report filename sometimes truncated (provided by: roignac).
* issue 171: Importing step from other step file fails with AmbiguousStep Error.
* issue 165: FIX issue 114: do not print a blank line when the feature is skipped (provided by: florentx).
* issue 164: StepRegistry.find_match() extends registered step_type lists.
* issue 122: Failing selftest feature: selftest.features/duplicated_step.feature.
* issue 110: Normalize paths provided at the command line (provided by: jesper).

-------------------------------------------------------------------------------

NEWS and CHANGES:

- Running (and model):

* NEW: Support scenario file locations on command-line, ala: "{filename}:{line}" (related to: 160).
* Formatters are now created only once (was: once for each feature).
* Scenarios can be now be selected by name or regular expression (87).
* Dry-run mode: Detects now undefined steps.
* Dry-run mode: Uses untested counts now (was using: skipped counts).
* Run decision logic: Use ModelElement.mark_skipped() to preselect what not to run.
* Run decision logic: Use ModelElement.should_run() to decide if element should run.

- Parsing (and model):

* Parser: Add support for Scenario/ScenarioOutline descriptions (related to: 79).
* Parser: Refactor to simplify and avoid code duplications (related to: 79).
* Parser: Improve diagnostics when parse errors occur.
* Parser: Check that Backgrounds have no tags.
* NEW: json_parser, parses JSON output and builds model.
* json_parser: Add support for scenario descriptions (related to: 79).

- Formatters:

* INCOMPATIBLE CHANGE:
Formatter Ctor uses now StreamOpener instead of opened Stream.
Formatter output streams are now opened late, under control of the formatter.
This allows the formatter to support also directory mode (if needed).
Needed for RerunFormatter whose file was overwritten before it was read (160).

* NEW: RerunFormatter to simplify to rerun last failing scenarios (related to: 160).
* NEW: TagLocationFormatter, shows where tags are used.
* NEW: TagCountFormatter, shows which tags are used and how often (reborn).
* JSONFormatter: Use JSON array mode now (related to: 161).
* JSONFormatter: Added "type" to Background, Scenario, ScenerioOutline (related to: 161).
* JSONFormatter: Added "error_message" to result (related to: 161).
* JSONFormatter: Use now list<lines> instead of string for multi-line text (related to: 161).
* JSONFormatter: Add support for scenario descriptions (related to: 79).
* JSONFormatter: Generates now valid JSON (well-formed).
* PlainFormatter: Shows now multi-line step parts (text, table), too.
* PrettyFormatter: Enters now monochrome mode if output is piped/redirected.
* ProgressFormatter: Flushes now output to provide better feedback.

- Reporters:

* JUnitReporter: Show complete scenario w/ text/tables. Improve readability.
* SummaryReporter: Summary shows now untested items if one or more exist.

- Testing, development:

* tox: Use tox now in off-line mode per default (use: "tox -e init"...).
* Add utility script to show longest step durations based on JSON data.
* JSON: Add basic JSON schema to support JSON output validation (related to: 161).
* JSON: Add helper script to validate JSON output against its schema (related to: 161).


IMPROVEMENT:

* issue 161: JSONFormatter: Should use a slightly different output schema (provided by: jenisys)
* issue 160: Support rerun file with failed features/scenarios during the last test run (provided by: jenisys)
* issue 154: Support multiple formatters (provided by: roignac, jenisys)
* issue 103: sort feature file by name in a given directory (provided by: gurneyalex).
* issue 102: Add configuration file setting for specifying default feature paths (provided by: lrowe).
* issue 87: Add --name option support (provided by: johbo, jenisys).
* issue 79: Provide Support for Scenario Descriptions (provided by: caphrim007, jenisys).
* issue 42: Show all undefined steps taking tags into account (provided by: roignac, jenisys)

FIXED:

* issue 162 Unnecessary ContextMaskWarnings when assert fails or exception is raised (provided by: jenisys).
* issue 159: output stream is wrapped twice in the codecs.StreamWriter (provided by: florentx).
* issue 153: The runtime should not by-pass the formatter to print line breaks minor.
* issue 152: Fix encoding issues (provided by: devainandor)
* issue 145: before_feature/after_feature should not be skipped (provided by: florentx).
* issue 141: Don't check for full package in issue 112 (provided by: roignac).
* issue 125: Duplicate "Captured stdout" if substep has failed (provided by: roignac).
* issue 60: JSONFormatter has several problems (last problem fixed).
* issue 48: Docs aren't clear on how Background is to be used.
* issue 47: Formatter processing chain is broken (solved by: 154).
* issue 33: behave 1.1.0: Install fails under Windows (verified, solved already some time ago).
* issue 28: Install fails on Windows (verified, solved already some time ago).