Merge pull request #31 from alexamici/master

Big option rename. Closes #30.

Author: alexamici

CHANGELOG.rst

@@ -2,8 +2,11 @@
 0.9.8 (unreleased)
 ------------------
 
-- Add the `pytest.mark.target` marker in the place of `pytest_nodev.search`.
+- Add the ``pytest.mark.candidate`` marker in the place of ``pytest_nodev.search``.
   Issue `#28 <https://github.com/nodev-io/pytest-nodev/issues/28>`_.
+- Rename main fixture to ``candidate`` from ``wish``.
+  Issue `#30 <https://github.com/nodev-io/pytest-nodev/issues/30>`_.
+  So long, and thanks for all the fish.
 
 
 0.9.7 (2016-03-13)
@@ -47,7 +50,7 @@
 0.9.2 (2016-02-20)
 ------------------
 
-- Disable potentially dangerous ``--wish-from-all`` by default.
+- Disable potentially dangerous ``--candidates-from-all`` by default.
 
 
 0.9.1 (2016-02-16)

CONTRIBUTING.rst

@@ -15,5 +15,9 @@ along with a detailed description.
 Submit a pull request
 ---------------------
 
+Contributors are invited to review the
+`product high level design <https://pytest-nodev.readthedocs.org/en/stable/design.html>`_
+and the `short term planning <https://github.com/nodev-io/pytest-nodev/milestones>`_.
+
 Tests can be run with `pytest <https://pytest.org>`_ and `tox <https://tox.readthedocs.org>`_,
 please ensure the coverage at least stays the same before you submit a pull request.

Dockerfile

@@ -12,6 +12,7 @@ COPY . /src
 WORKDIR /src
 
 # setup the python and pytest environments
+RUN pip install --upgrade pip setuptools
 RUN pip install --upgrade -r requirements.txt
 RUN pip install --upgrade -r requirements-tests.txt
 RUN pip install -e .

README.rst

@@ -60,7 +60,7 @@ decorate it with ``pytest.mark.target`` as follows::
 
 Finally, instruct pytest to run your test on all functions in the Python standard library::
 
-    $ py.test test_parse_bool.py --wish-from-stdlib
+    $ py.test test_parse_bool.py --candidates-from-stdlib
     ======================= test session starts ==========================
     platform darwin -- Python 3.5.0, pytest-2.8.7, py-1.4.31, pluggy-0.3.1
     rootdir: /tmp, inifile: setup.cfg
@@ -103,7 +103,7 @@ BIG FAT WARNING!
 A lot of functions called with the wrong set of arguments may have unexpected consequences ranging
 from slightly annoying, think ``os.mkdir('false')``,
 to **utterly catastrophic**, think ``shutil.rmtree('/', True)``.
-Serious use of pytest-nodev, in particular using ``--wish-from-all``,
+Serious use of pytest-nodev, in particular using ``--candidates-from-all``,
 require running the tests with operating-system level isolation,
 e.g. as a dedicated user or even better inside a dedicated container.
 The `User's guide <http://pytest-nodev.readthedocs.org/en/stable/usersguide.html>`_

docs/design.rst

@@ -56,19 +56,19 @@ No completeness and no performance guarantees.
 
 - Search environment definition:
 
-  - Support defining which modules to search. Command line ``--wish-from-*`` options.
+  - Support defining which modules to search. Command line ``--candidates-from-*`` options.
 
   - Support defining which objects to include/exclude by name or via a predicate test function.
-    Command line ``--wish-includes/excludes/predicate`` options.
+    Command line ``--candidates-includes/excludes/predicate`` options.
 
 - Object collection:
 
   - Collect most objects from the defined environment. It is ok to miss some objects for now.
 
 - Test execution:
 
-  - Execute tests instrumented with the ``wish`` fixture once for every object collected.
-    The tests are marked ``xfail`` unless the ``--wish-fail`` command line option is given to
+  - Execute tests instrumented with the ``candidate`` fixture once for every object collected.
+    The tests are marked ``xfail`` unless the ``--candidates-fail`` command line option is given to
     make standard pytest reporting the most useful.
 
 - Report:
@@ -83,9 +83,9 @@ No completeness and no performance guarantees.
 
   - Potentially dangerous, crashing, hard hanging or simply annoying objects
     belonging to the standard library are unconditionally blacklisted
-    so that new users can test ``--wish-from-stdlib`` without bothering with OS-level isolation.
+    so that new users can test ``--candidates-from-stdlib`` without bothering with OS-level isolation.
 
-  - Limited use of ``--wish-from-all``.
+  - Limited use of ``--candidates-from-all``.
 
 - Documentation:
 

docs/usersguide.rst

@@ -18,17 +18,17 @@ from the Python Package Index::
 Basic usage
 -----------
 
-Write a specification test instrumented with the ``wish`` fixture in the ``test_example.py`` file.
-Run pytest with one of the ``--wish-from-*`` options to select the search space,
+Write a specification test instrumented with the ``candidate`` fixture in the ``test_example.py`` file.
+Run pytest with one of the ``--candidates-from-*`` options to select the search space,
 e.g. to search in the Python standard library::
 
-    $ py.test --wish-from-stdlib test_example.py
+    $ py.test --candidates-from-stdlib test_example.py
 
 
 Advanced usage
 --------------
 
-Use of ``--wish-from-all`` may be very dangerous
+Use of ``--candidates-from-all`` may be very dangerous
 and it is disabled by default.
 
 In order to search safely in all modules we suggest to use docker for OS-level isolation.
@@ -43,40 +43,41 @@ build the nodev docker image with all module from requirements.txt installed::
 
 and run tests with::
 
-    $ docker run --rm -it -v `pwd`:/home/pytest nodev --wish-from-all tests/test_factorial.py
+    $ docker run --rm -it -v `pwd`:/home/pytest nodev --candidates-from-all tests/test_factorial.py
 
 Alternatively you can enable it on your regular user only after you have understood the risks
 and set up appropriate mitigation strategies
 by setting the ``PYTEST_NODEV_MODE`` environment variable to ``FEARLESS``::
 
-    $ PYTEST_NODEV_MODE=FEARLESS py.test --wish-from-all --wish-includes .*util -- test_example.py
+    $ PYTEST_NODEV_MODE=FEARLESS py.test --candidates-from-all --candidates-includes .*util -- test_example.py
 
 
 Command line reference
 ----------------------
 
 The plugin adds the following options to pytest command line::
 
-    wish:
-      --wish-from-stdlib    Collects objects form the Python standard library.
-      --wish-from-all       Collects objects form the Python standard library and
-                            all installed packages. Disabled by default, see the
-                            docs.
-      --wish-from-specs=WISH_FROM_SPECS=[WISH_FROM_SPECS=...]
-                            Collects objects from installed packages. Space
+    nodev:
+      --candidates-from-stdlib
+                            Collects candidates form the Python standard library.
+      --candidates-from-all
+                            Collects candidates form the Python standard library
+                            and all installed packages. Disabled by default, see
+                            the docs.
+      --candidates-from-specs=CANDIDATES_FROM_SPECS=[CANDIDATES_FROM_SPECS=...]
+                            Collects candidates from installed packages. Space
                             separated list of `pip` specs.
-      --wish-from-modules=WISH_FROM_MODULES=[WISH_FROM_MODULES=...]
-                            Collects objects from installed modules. Space
+      --candidates-from-modules=CANDIDATES_FROM_MODULES=[CANDIDATES_FROM_MODULES=...]
+                            Collects candidates from installed modules. Space
                             separated list of module names.
-      --wish-includes=WISH_INCLUDES=[WISH_INCLUDES=...]
+      --candidates-includes=CANDIDATES_INCLUDES=[CANDIDATES_INCLUDES=...]
                             Space separated list of regexs matching full object
                             names to include, defaults to include all objects
-                            collected via `--wish-from-*`.
-      --wish-excludes=WISH_EXCLUDES=[WISH_EXCLUDES=...]
+                            collected via `--candidates-from-*`.
+      --candidates-excludes=CANDIDATES_EXCLUDES=[CANDIDATES_EXCLUDES=...]
                             Space separated list of regexs matching full object
                             names to exclude.
-      --wish-predicate=WISH_PREDICATE
+      --candidates-predicate=CANDIDATES_PREDICATE
                             Full name of the predicate passed to
                             `inspect.getmembers`, defaults to `builtins.callable`.
-      --wish-fail           Show wish failures.
-
+      --candidates-fail     Show candidates failures.

pytest_nodev/blacklists.py

@@ -25,7 +25,7 @@
 
 Potentially dangerous, crashing, hard hanging or simply annoying objects
 belonging to the standard library and to and the pytest-nodev dependencies
-are unconditionally blacklisted so that new users can test ``--wish-from-stdlib``
+are unconditionally blacklisted so that new users can test ``--candidates-from-stdlib``
 without bothering with OS-level isolation.
 """
 

pytest_nodev/collect.py

@@ -48,7 +48,7 @@
 MODULE_BLACKLIST_PATTERN = '|'.join(blacklists.MODULE_BLACKLIST) or NOMATCH_PATTERN
 OBJECT_BLACKLIST_PATTERN = '|'.join(blacklists.OBJECT_BLACKLIST) or NOMATCH_PATTERN
 
-logger = logging.getLogger('wish')
+logger = logging.getLogger('nodev')
 
 
 def recurse_import_path(path=None, prefix='', spec='UNKOWN'):

pytest_nodev/plugin.py

@@ -38,39 +38,39 @@
 
 
 def pytest_addoption(parser):
-    group = parser.getgroup('wish')
+    group = parser.getgroup('nodev')
     group.addoption(
-        '--wish-from-stdlib', action='store_true',
-        help="Collects objects form the Python standard library.")
+        '--candidates-from-stdlib', action='store_true',
+        help="Collects candidates form the Python standard library.")
     group.addoption(
-        '--wish-from-all', action='store_true',
-        help="Collects objects form the Python standard library and all installed packages. "
+        '--candidates-from-all', action='store_true',
+        help="Collects candidates form the Python standard library and all installed packages. "
              "Disabled by default, see the docs.")
     group.addoption(
-        '--wish-from-specs', default=[], nargs='+',
-        help="Collects objects from installed packages. Space separated list of `pip` specs.")
+        '--candidates-from-specs', default=[], nargs='+',
+        help="Collects candidates from installed packages. Space separated list of `pip` specs.")
     group.addoption(
-        '--wish-from-modules', default=[], nargs='+',
-        help="Collects objects from installed modules. Space separated list of module names.")
+        '--candidates-from-modules', default=[], nargs='+',
+        help="Collects candidates from installed modules. Space separated list of module names.")
     group.addoption(
-        '--wish-includes', nargs='+',
+        '--candidates-includes', nargs='+',
         help="Space separated list of regexs matching full object names to include, "
-             "defaults to include all objects collected via `--wish-from-*`.")
+             "defaults to include all objects collected via `--candidates-from-*`.")
     group.addoption(
-        '--wish-excludes', default=[], nargs='+',
+        '--candidates-excludes', default=[], nargs='+',
         help="Space separated list of regexs matching full object names to exclude.")
     group.addoption(
-        '--wish-predicate', default='builtins:callable',
+        '--candidates-predicate', default='builtins:callable',
         help="Full name of the predicate passed to `inspect.getmembers`, "
              "defaults to `builtins.callable`.")
-    group.addoption('--wish-fail', action='store_true', help="Show wish failures.")
+    group.addoption('--candidates-fail', action='store_true', help="Show candidates failures.")
 
 
-def make_wish_index(config):
-    if config.getoption('wish_from_all') and os.environ.get('PYTEST_NODEV_MODE') != 'FEARLESS':
-        raise ValueError("Use of --wish-from-all may be very dangerous, see the docs.")
+def make_candidate_index(config):
+    if config.getoption('candidates_from_all') and os.environ.get('PYTEST_NODEV_MODE') != 'FEARLESS':
+        raise ValueError("Use of --candidates-from-all may be very dangerous, see the docs.")
 
-    if not hasattr(config, '_wish_index_items'):
+    if not hasattr(config, '_candicate_index'):
         # take over collect logging
         collect.logger.propagate = False
         collect.logger.setLevel(logging.DEBUG)  # FIXME: loglevel should be configurable
@@ -82,70 +82,69 @@ def make_wish_index(config):
         # build the object index
         distributions = collections.OrderedDict()
 
-        if config.getoption('wish_from_stdlib') or config.getoption('wish_from_all'):
+        if config.getoption('candidates_from_stdlib') or config.getoption('candidates_from_all'):
             distributions.update(collect.collect_stdlib_distributions())
 
-        if config.getoption('wish_from_all'):
+        if config.getoption('candidates_from_all'):
             distributions.update(collect.collect_installed_distributions())
 
-        distributions.update(collect.collect_distributions(config.getoption('wish_from_specs')))
+        distributions.update(collect.collect_distributions(config.getoption('candidates_from_specs')))
 
-        if config.getoption('wish_from_modules'):
-            distributions['unknown distribution'] = config.getoption('wish_from_modules')
+        if config.getoption('candidates_from_modules'):
+            distributions['unknown distribution'] = config.getoption('candidates_from_modules')
 
         top_level_modules = collect.import_distributions(distributions.items())
 
-        includes = config.getoption('wish_includes')
+        includes = config.getoption('candidates_includes')
         if not includes:
-            includes = ['.'] if config.getoption('wish_from_all') else sorted(top_level_modules)
-        excludes = config.getoption('wish_excludes')
-        predicate = config.getoption('wish_predicate')
+            includes = ['.'] if config.getoption('candidates_from_all') else sorted(top_level_modules)
+        excludes = config.getoption('candidates_excludes')
+        predicate = config.getoption('candidates_predicate')
 
         # NOTE: 'copy' is needed here because indexing may unexpectedly trigger a module load
         modules = sys.modules.copy()
         object_index = dict(
-            collect.generate_objects_from_modules(modules, includes, excludes,
-                                                  predicate)
+            collect.generate_objects_from_modules(modules, includes, excludes, predicate)
         )
 
         # store index
-        config._wish_index_items = list(zip(*sorted(object_index.items()))) or [(), ()]
+        config._candicate_index = list(zip(*sorted(object_index.items()))) or [(), ()]
 
-    return config._wish_index_items
+    return config._candicate_index
 
 
 def pytest_pycollect_makeitem(collector, name, obj):
-    target_marker = getattr(obj, 'target', None)
-    if target_marker and getattr(target_marker, 'args', []):
-        target_name = target_marker.args[0]
+    candidate_marker = getattr(obj, 'candidate', None)
+    if candidate_marker and getattr(candidate_marker, 'args', []):
+        candidate_name = candidate_marker.args[0]
 
-        def wrapper(wish, monkeypatch, *args, **kwargs):
-            if '.' in target_name:
-                monkeypatch.setattr(target_name, wish, raising=False)
+        def wrapper(candidate, monkeypatch, *args, **kwargs):
+            if '.' in candidate_name:
+                monkeypatch.setattr(candidate_name, candidate, raising=False)
             else:
-                monkeypatch.setattr(inspect.getmodule(obj), target_name, wish, raising=False)
+                monkeypatch.setattr(inspect.getmodule(obj), candidate_name, candidate, raising=False)
             return obj(*args, **kwargs)
 
         wrapper.__dict__ = obj.__dict__
         return list(collector._genfunctions(name, wrapper))
 
 
 def pytest_generate_tests(metafunc):
-    if 'wish' not in metafunc.fixturenames:
+    if 'candidate' not in metafunc.fixturenames:
         return
 
-    ids, params = make_wish_index(metafunc.config)
-    metafunc.parametrize('wish', params, ids=ids, scope='module')
+    ids, params = make_candidate_index(metafunc.config)
+    metafunc.parametrize('candidate', params, ids=ids, scope='module')
 
-    if not metafunc.config.getoption('wish_fail'):
+    if not metafunc.config.getoption('candidates_fail'):
         metafunc.function = pytest.mark.xfail(metafunc.function)
 
 
 def pytest_terminal_summary(terminalreporter):
-    if not hasattr(terminalreporter.config, '_wish_index_items'):
+    if not hasattr(terminalreporter.config, '_candicate_index'):
         return
 
-    hit_state = 'passed' if terminalreporter.config.getoption('wish_fail') else 'xpassed'
+    hit_state = 'passed' if terminalreporter.config.getoption('candidates_fail') else 'xpassed'
     hits = terminalreporter.getreports(hit_state)
     terminalreporter.write_sep('=', '%d hit' % len(hits), bold=True)
     terminalreporter.write_line('')

setup.cfg

@@ -2,7 +2,7 @@
 universal=1
 
 [pytest]
-pep8maxlinelength = 99
+pep8maxlinelength = 104
 norecursedirs =
     build
     docs