Adds the ability to use --behave-runner in the behave command #100

kingbuzzman · 2019-09-06T09:29:12Z

I'm making a rather large test migration from Aloe to Behave.

$ find . -name *.feature | xargs cat | wc -l
  157533

Currently, all our tests are inside our apps like so: (py + feature files all in the same folder inside EACH app)

<project>/<app>/features
                        /__init__.py
                        /sometest.feature
                        /sometest_steps.py
                        /steps.py

I do not want to make this migration any more painful than it needs to be, so my plan is to modify behave.runner.Runner ~~BehaviorDrivenTestRunner~~ to find my tests in the appropriate place. Right now there is no way for me to modify the way this works. ~~This is the exact reason django exposes --testrunner and i was very surprised this was something overlooked in this project.~~

Making this modification works great: ./manage.py behave --behave-runner myproject.runner.Runner

import os

from behave.runner import Runner as BaseRunner, load_step_modules
from django.conf import settings


class Runner(BaseRunner):

    def load_step_definitions(self, extra_step_paths=None):
        step_paths = [] + list(extra_step_paths or [])
        for root, dirs, _ in os.walk(settings.BASE_DIR):
            for dir in dirs:
                if dir.endswith('features'):
                    full_path = os.path.join(root, dir)
                    step_paths.append(full_path)

        load_step_modules(step_paths)

tox.ini

bittner

This is a rather large PR.

Can you please provide an initial description, which provides the motivation for all your changes and/or a reference to an open issue (in this repository)?

Specifically, I have a hard time to see why you prefer to replace a short command line option by a rather lengthy, hard to memorize one.

docs/usage.rst

behave_django/management/commands/behave.py

docs/usage.rst

tox.ini

behave_django/management/commands/behave.py

kingbuzzman · 2019-09-18T09:53:35Z

@bittner I drastically reduced the changes, turns out i was wrong with my original approach since the TestCase is not used to run the tests, I discovered this when i finally implemented the code. Let me know if you want any additional changes.

kingbuzzman · 2019-10-01T13:38:02Z

@bittner friendly reminder, would love some feedback.

kingbuzzman · 2019-10-17T19:07:10Z

@bittner ?

bittner

Hmm, not bad! I love how much you reduced the code needed for this contribution!

Looks like there is some more potential to reduce the code. Go for it! 💯

behave_django/environment.py

behave_django/management/commands/behave.py

docs/usage.rst

behave_django/management/commands/behave.py

kingbuzzman · 2019-10-21T15:29:25Z

@bittner Made changes, let me know.

kingbuzzman · 2019-11-20T12:24:24Z

@bittner ?

bittner · 2019-11-20T12:51:51Z

Sorry about that. Taking a look now.

bittner

Sorry, still not all good yet. 😟

bittner · 2019-11-20T12:56:10Z

behave_django/environment.py


+from behave import __main__ as main


I think you want to import main like in the management command:

from behave.__main__ import main as behave_main

Cant do this, need to be able to override the function inside behave.__main__ called run_behave

bittner · 2019-11-20T12:56:47Z

behave_django/environment.py

@@ -1,7 +1,9 @@
 from copy import copy
+from functools import partial


Can you explain why it's important to use partial? What's your motivation for this?

behave_main.run_behave() takes an optional parameter called runner_class, if this is not specified, it defaults to behave.runner.Runner further down the code.

https://github.com/behave/behave/blob/9a438ebb29a21f3953009381e6949e8f64f57b07/behave/__main__.py#L52

With partial all im doing is keeping the same callable with no arguments as before but setting the "default" value of runner_class to what ever class may be inside behave_runner

docs/usage.rst

behave_django/management/commands/behave.py

bittner

Just a few more things to change until we reach the finish line. Congratulations! 👍

Would you mind squashing all the commits into one, two or three commits only? Whatever makes sense to put in single commits together. That would be great. The version bump, probably, as a separate commit at the end.

bittner · 2019-11-21T07:16:29Z

docs/usage.rst

@@ -257,6 +257,14 @@ each scenario instead of flushing the entire database. Tests run much quicker,
 however HTTP server is not started and therefore web browser automation is
 not available.

+``--runner``
+*******************


Please make the ***** only as long as the section title.

bittner · 2019-11-21T07:18:12Z

docs/usage.rst

+``--runner``
+*******************
+
+Allows to override the test runner class that Behave uses by default. e.g.,


The "e.g.," is lost at the end of this line here. Why not remove it here and use it properly in the next sentence?

bittner · 2019-11-21T07:18:52Z

docs/usage.rst

+*******************
+
+Allows to override the test runner class that Behave uses by default. e.g.,
+this will allow you to customize where your feature files are located.


I'd suggest:

This will allow you, e.g., to customize ...

bittner · 2019-11-21T07:23:31Z

behave_django/management/commands/behave.py

+    parser.add_argument(
+        '--runner', action='store', dest='runner_class',
+        default='behave.runner.Runner', type=valid_python_module,
+        help='Tells Behave to use a specific runner. (default: %(default)s)',


This is actually the Behave runner, not any of those we provide in this project. I'm fascinated!

While I start liking this PR more and more I now start ~~worrying that~~ wondering whether 😏 this feature should actually go into Behave. What do you think about that? 🤔

I'm looking forward to your feedback here. The behave command actually has no -r --runner option, currently. Maybe it would be desirable to have that possibility also for plain Behave, not only tied to using it with Django, hmm?

I would still merge your efforts here, probably, but:

name the option appropriately --behave-runner (as you had it before) and

open a new issue to discuss migrating the feature to the Behave code base.

I hope that makes sense.

bittner · 2019-11-21T07:30:21Z

behave_django/__init__.py

@@ -5,4 +5,4 @@
 __email__ = 'mixxorz@gmail.com'
 __url__ = 'https://github.com/behave/behave-django'
 __license__ = 'MIT'
-__version__ = '1.3.0'
+__version__ = '1.3.1'


That's more than just a bug fix or something. Let's make it 1.4.0, what do you think?

kingbuzzman · 2019-11-21T10:45:29Z

@bittner I think this makes all the sense in the world, if i move this code over to https://github.com/behave/behave, then there is no need for this PR

kingbuzzman · 2019-11-25T16:22:59Z

I tested the code in master with the modification ive done to https://github.com/behave/behave-django and it looks good. Closing this PR.

Code has been moved to behave/behave#795

kingbuzzman · 2020-11-23T21:17:55Z

@bittner so.. i think for the time being, maybe we can just add this here. When @jenisys gets around to merging the other PR we can delete it.. what do you think?

bittner · 2020-11-23T23:24:22Z

Let me try to get hold of @jenisys a last time. This should be possible. He has merged things before.

kingbuzzman commented Sep 6, 2019

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

bittner requested changes Sep 12, 2019

View reviewed changes

kingbuzzman added 2 commits September 12, 2019 13:47

Squash code

221e1da

Update behave.py

c572cbc

bittner reviewed Sep 13, 2019

View reviewed changes

behave_django/management/commands/behave.py Outdated Show resolved Hide resolved

bittner reviewed Sep 13, 2019

View reviewed changes

behave_django/management/commands/behave.py Outdated Show resolved Hide resolved

bittner reviewed Sep 13, 2019

View reviewed changes

behave_django/management/commands/behave.py Outdated Show resolved Hide resolved

kingbuzzman added 7 commits September 13, 2019 14:39

Update behave.py

cd8bad3

Update behave.py

89c2aa6

Fixes argparse

0df9f9d

Missing argument

49d9b43

Fixes test

f2ca435

Fixes the real issue

f790cd2

Rolls back changes to the absolute minimum

ad0c45f

kingbuzzman changed the title ~~Adds the ability to use --testrunner in the behave command~~ Adds the ability to use --behave-runner in the behave command Sep 18, 2019

kingbuzzman added 2 commits September 18, 2019 11:29

Fixes py2.7 tests

e51554c

Version bump

27c624d

MaurizioPilia approved these changes Sep 18, 2019

View reviewed changes

kingbuzzman requested a review from bittner September 25, 2019 15:25

bittner requested changes Oct 21, 2019

View reviewed changes

bittner mentioned this pull request Oct 21, 2019

Add option to pass custom test runner from CLI #82

Closed

kingbuzzman added 6 commits October 21, 2019 10:27

Rename validate_runner function

b5ec9dc

Update environment.py

700fa9c

Update usage.rst

d0abb3e

Update behave.py

c8a3cf3

Update behave.py

1372c1c

Update behave.py

dbca78f

kingbuzzman requested a review from bittner November 20, 2019 12:24

bittner requested changes Nov 20, 2019

View reviewed changes

kingbuzzman added 8 commits November 20, 2019 11:30

Update behave.py

e0fe058

Update test_cli.py

8fbdfcb

Update usage.rst

5fb4241

Update environment.py

b800324

Update behave.py

bbdeb13

Update environment.py

3c8cc86

Update environment.py

90a0452

Fixes rename issue

d2ab2a2

kingbuzzman requested a review from bittner November 20, 2019 18:11

kingbuzzman added 2 commits November 20, 2019 15:44

Update environment.py

ec98bb1

Update environment.py

690c92a

bittner requested changes Nov 21, 2019

View reviewed changes

kingbuzzman mentioned this pull request Nov 21, 2019

Adds the ability to use a custom runner in the behave command behave/behave#795

Merged

kingbuzzman closed this Nov 25, 2019

kingbuzzman mentioned this pull request Jun 18, 2020

[docs] Allow to use custom test runner #78

Closed

bittner mentioned this pull request Dec 24, 2021

Adds ability to modify the django runner class #125

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds the ability to use --behave-runner in the behave command #100

Adds the ability to use --behave-runner in the behave command #100

kingbuzzman commented Sep 6, 2019 •

edited

Loading

bittner left a comment

kingbuzzman commented Sep 18, 2019

kingbuzzman commented Oct 1, 2019

kingbuzzman commented Oct 17, 2019

bittner left a comment

kingbuzzman commented Oct 21, 2019

kingbuzzman commented Nov 20, 2019

bittner commented Nov 20, 2019

bittner left a comment

bittner Nov 20, 2019

kingbuzzman Nov 20, 2019

bittner Nov 20, 2019

kingbuzzman Nov 20, 2019

bittner left a comment

bittner Nov 21, 2019

bittner Nov 21, 2019

bittner Nov 21, 2019

bittner Nov 21, 2019

bittner Nov 21, 2019

bittner Nov 21, 2019

bittner Nov 21, 2019

kingbuzzman commented Nov 21, 2019

kingbuzzman commented Nov 25, 2019 •

edited

Loading

kingbuzzman commented Nov 23, 2020 •

edited

Loading

bittner commented Nov 23, 2020

		@@ -1,7 +1,9 @@
		from copy import copy
		from functools import partial

Adds the ability to use --behave-runner in the behave command #100

Adds the ability to use --behave-runner in the behave command #100

Conversation

kingbuzzman commented Sep 6, 2019 • edited Loading

bittner left a comment

Choose a reason for hiding this comment

kingbuzzman commented Sep 18, 2019

kingbuzzman commented Oct 1, 2019

kingbuzzman commented Oct 17, 2019

bittner left a comment

Choose a reason for hiding this comment

kingbuzzman commented Oct 21, 2019

kingbuzzman commented Nov 20, 2019

bittner commented Nov 20, 2019

bittner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bittner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kingbuzzman commented Nov 21, 2019

kingbuzzman commented Nov 25, 2019 • edited Loading

kingbuzzman commented Nov 23, 2020 • edited Loading

bittner commented Nov 23, 2020

kingbuzzman commented Sep 6, 2019 •

edited

Loading

kingbuzzman commented Nov 25, 2019 •

edited

Loading

kingbuzzman commented Nov 23, 2020 •

edited

Loading