improve config checks (#186)

* Breaking changes
  * `nichtparasoup config --check`'s "duplicate image crawler" is no longer a Warning but an Error.
  * renamed `nichtparasoup.testing.config.ConfigFileTest` to `ConfigFileTest` - without an "s".
* Changes
  * `nichtparasoup config --check` now does a probe crawl.
* Added
  * added additional test function: `nichtparasoup.testing.config.ConfigFileTest.probe()`.

Author: jkowalleck

.github/workflows/pythonpackage.yml

@@ -1,6 +1,6 @@
 name: "Test"
 
-on: 
+on:
   push:
   pull_request:
   schedule:
@@ -24,16 +24,16 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.pyhon }}
+      - name: Python version
+        run: python --version
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade setuptools tox
+          python -m pip install --upgrade setuptools 'tox>3.10'
       - name: Test nichtparasoup
-        run: |
-          python -m tox -e py3-coverageXML
+        run: python -m tox -e py3-coverageXML
       - name: "Test examples::nichtparasoup-imagecrawler-plugin"
-        run: |
-          python -m tox -c examples/nichtparasoup-imagecrawler-plugin/
+        run:  python -m tox -c examples/nichtparasoup-imagecrawler-plugin/
       - name: Upload coverage to Codecov
         # see https://github.com/codecov/codecov-action
         uses: codecov/codecov-action@v1

.github/workflows/pythonpublish.yml

@@ -18,10 +18,12 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: '3.8'
+      - name: Python version
+        run: python --version
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade setuptools tox
+          python -m pip install --upgrade setuptools 'tox>3.10'
       - name: Test nichtparasoup
         run: |
           python -m tox -e py3

HISTORY.md

@@ -3,14 +3,21 @@
 
 ## Unreleased
 
+### Breaking changes
+
+* `nichtparasoup config --check`'s "duplicate image crawler" is no longer a Warning but an Error.
+* renamed `nichtparasoup.testing.config.ConfigFileTest` to `ConfigFileTest` - without an "s".
+
 ### Changes
 
+* `nichtparasoup config --check` now does a probe crawl.
 * class `ImageCrawlerInfo` lost support for positional arguments, supports keyword-arguments only - prepare future extensibility.
 * class `Image` lost support for positional arguments, supports keyword-arguments only - prepare future extensibility.
 
 ### Added
 
 * added image crawler for [pr0gramm](https://pr0gramm.com) - Read the [docs](./docs/imagecrawlers/pr0gramm.md).
+* added additional test function: `nichtparasoup.testing.config.ConfigFileTest.probe()`.
 
 
 ## 2.2.2

docs/usage.md

@@ -21,7 +21,7 @@ use a won config for the server. If omitted, the default is used. to write your
 
 when you start _nichtparasoup_
 1. system will fill up cache by startup
-1. system starts up the webserver
+1. system starts up the web-server
 1. point your browser to the configured localhost:5000/ or whatever is configured in the config
 1. start page will request single images randomly by /get and show it
 1. when system's cache is empty, it will be refilled by the crawler automatically
@@ -41,14 +41,14 @@ for an eay handling this sub-command comes into play.
 `nichtparasoup config` 
 
 the following switches are available:
-* `--check` - validate a YAML config file
+* `--check` - validate and probe a YAML config file
 * `--dump`  - dump YAML config into a file
 
 
 ### check a config
 
 check if a file is a valid config.
-will prompt promt errors and warnings, if any.
+will prompt prompt errors and warnings, if any.
 
 `nichtparasoup config --check <file>`
 

examples/nichtparasoup-imagecrawler-plugin/pytest.ini

@@ -1,7 +1,11 @@
 
 [pytest]
-addopts = -v
+addopts = --verbose --strict-markers
 testpaths = ./tests/
 minversion = 3.0
 console_output_style = classic
 junit_family = xunit2
+markers =
+    slow: marks tests as slow (deselect with '-m "not slow"')
+    online: marks tests as "requires internet connection" (deselect with '-m "not online"')
+

examples/nichtparasoup-imagecrawler-plugin/setup.py

@@ -14,13 +14,17 @@
         ],
     ),
     install_requires=[
-        'nichtparasoup>=2.2',
+        'nichtparasoup',
+        # This example requires `nichtparasoup>=2.3`
+        # You SHOULD write the min-version dependency in your real-world.
+        # This was not done here, since its an in-dev example.
     ],
     extras_require=dict(
         testing=[
             'mypy',
-            'pytest',
+            'pytest>=5,<5.3.4',  # 5.3.4 has a bug: https://github.com/pytest-dev/pytest/issues/6517
             'coverage',
+            'ddt',
         ]
     ),
 )

examples/nichtparasoup-imagecrawler-plugin/tests/README.md

@@ -52,4 +52,5 @@ stick to these rules:
 * write the test with`unittest`: test cases inherit `unittest.TestCase.`
 * each testable package/module has its own folder: name the test folder `test_*`
 * each testable function/class has its own file:   name the test file   `test_*.py`
+* test files are performed in alphabetical order - so add a number to have them ordered
 * name the test functions `test_*`

…parasoup_placeholders/test_dummyimage.py …parasoup_placeholders/test_dummyimage.pyexamples/nichtparasoup-imagecrawler-plugin/tests/test_nichtparasoup_placeholders/test_dummyimage.py renamed to examples/nichtparasoup-imagecrawler-plugin/tests/test_10_nichtparasoup_placeholders/test_dummyimage.py examples/nichtparasoup-imagecrawler-plugin/tests/test_nichtparasoup_placeholders/test_dummyimage.py renamed to examples/nichtparasoup-imagecrawler-plugin/tests/test_10_nichtparasoup_placeholders/test_dummyimage.py

@@ -6,14 +6,14 @@
 from nichtparasoup.imagecrawler import BaseImageCrawler
 from nichtparasoup.testing.imagecrawler import ImageCrawlerLoaderTest
 
-_dummyimage_right_config = {'width': 800, 'height': 600}
+_DUMMYIMAGE_RIGHT_CONFIG = {'width': 800, 'height': 600}
 
 
 class DummyImageConfigCorrect(unittest.TestCase):
 
     def test__check_config_right_value(self) -> None:
         # arrange
-        config_in = _dummyimage_right_config.copy()
+        config_in = _DUMMYIMAGE_RIGHT_CONFIG.copy()
         # act
         config_out = DummyImage.check_config(config_in)
         # assert
@@ -23,7 +23,7 @@ def test__check_config_right_value(self) -> None:
 class DummyImageConfigWidthTest(unittest.TestCase):
 
     def setUp(self) -> None:
-        self._dummyimage_right_config_wo_width = _dummyimage_right_config.copy()
+        self._dummyimage_right_config_wo_width = _DUMMYIMAGE_RIGHT_CONFIG.copy()
         del self._dummyimage_right_config_wo_width["width"]
 
     def tearDown(self) -> None:
@@ -58,7 +58,7 @@ def test__check_config_wrong_value(self) -> None:
 class DummyImageConfigHeightTest(unittest.TestCase):
 
     def setUp(self) -> None:
-        self._dummyimage_right_config_wo_height = _dummyimage_right_config.copy()
+        self._dummyimage_right_config_wo_height = _DUMMYIMAGE_RIGHT_CONFIG.copy()
         del self._dummyimage_right_config_wo_height["height"]
 
     def tearDown(self) -> None:
@@ -94,7 +94,7 @@ class DummyImageCrawlTest(unittest.TestCase):
 
     def test_crawl(self) -> None:
         # arrange
-        crawler = DummyImage(**_dummyimage_right_config)
+        crawler = DummyImage(**_DUMMYIMAGE_RIGHT_CONFIG)
         # act
         images_crawled = crawler.crawl()
         images_crawled_len = len(images_crawled)
@@ -112,8 +112,8 @@ def test_description_config(self) -> None:
         description = DummyImage.info()
         # assert
         assert isinstance(description.config, dict)
-        for config_key in _dummyimage_right_config.keys():
-            self.assertTrue(config_key in description.config, config_key)
+        for config_key in _DUMMYIMAGE_RIGHT_CONFIG.keys():
+            self.assertIn(config_key, description.config)
 
 
 class DummyImageLoaderTest(ImageCrawlerLoaderTest):

examples/nichtparasoup-imagecrawler-plugin/tests/test_90_examples/test_shipped_config_files.py

@@ -0,0 +1,25 @@
+from glob import glob
+from os.path import basename, dirname, join as path_join, realpath
+
+import pytest  # type: ignore
+from ddt import ddt, idata, unpack  # type: ignore
+
+from nichtparasoup.testing.config import ConfigFileTest
+
+
+@ddt
+class ShippedExampleConfigFileTest(ConfigFileTest):
+    __EXAMPLE_DIR = path_join(dirname(__file__), '..', '..', 'examples')
+    __EXAMPLE_FILES = glob(path_join(__EXAMPLE_DIR, '*.*'), recursive=False)
+
+    def test_has_examples(self) -> None:
+        self.assertGreater(len(self.__class__.__EXAMPLE_FILES), 0)
+
+    @pytest.mark.online  # type: ignore  # probing goes over the internet
+    @pytest.mark.slow  # type: ignore  # probing might be slow
+    @idata((basename(file),) for file in __EXAMPLE_FILES)  # type: ignore
+    @unpack  # type: ignore
+    def test_example(self, filename: str) -> None:
+        file = realpath(path_join(self.__class__.__EXAMPLE_DIR, filename))
+        self.validate(file)
+        self.probe(file)