Merge pull request #18 from Anselmoo/pytest

Change from unitest to pytest

Author: Anselmoo

.github/workflows/python-package.yml

@@ -35,10 +35,14 @@ jobs:
         isort . --check -v
         flake8 . --count --exit-zero --max-complexity=10 --statistics
         pydocstyle --convention=numpy -e bashplot/bashplot.py
-    - name: Test with pytest
+    - name: Install bashplot
       run: |
-        coverage run  --source=./test -m unittest
+        pip install .
+    - name: Test with pytest and coverage
+      run: |
+        coverage run -m pytest test/test*.py -vv
         coverage report -m
+        coverage xml
     - name: Codecov
       uses: codecov/codecov-action@v1
       with:

MANIFEST.in

@@ -1,6 +1,6 @@
 include Pipfile
-include Pipfile.lock
 include requirements.txt
+include dev-requirements.txt
 include LICENSE
 include MANIFEST.in
 include README.md

Pipfile

@@ -8,11 +8,14 @@ bashplot = {editable = true, path = "."}
 
 [dev-packages]
 coverage = "*"
-pytest = "*"
 isort = "*"
 black = "==20.8b1"
 flake8 = "*"
 pydocstyle = "*"
+pytest = "*"
+pytest-clarity = "*"
+pytest-cov = "*"
+pytest-sugar = "*"
 
 [requires]
 python_version = "3.8"

azure-pipelines.yml

@@ -28,23 +28,23 @@ steps:
 - script: |
     python -m pip install --upgrade pip
     pip install -r requirements.txt
-    pip install black
-    pip install flake8
-    pip install pydocstyle
-    flake8 bashplot/ --count --max-line-length=88 --ignore=W293,W291 --statistic
-    black bashplot/ --check -v
-    pydocstyle bashplot/bashplot.py
+    pip install -r dev-requirements.txt
   displayName: 'Install dependencies'
 
+- script: |
+    flake8 bashplot/ --count --max-line-length=88 --ignore=W293,W291 --statistic
+    black . --check -v
+    isort . --check -v
+    flake8 . --count --exit-zero --max-complexity=10 --statistics
+    pydocstyle --convention=numpy -e bashplot/bashplot.py
+  displayName: 'Check style and  settings'
+
 - script: |
     python setup.py install
   displayName: 'Install bashplot'
 
 - script: |
-
-    pip install coverage
-    pip install pytest-azurepipelines
-    cd test
-    coverage run -m unittest test_bashplot.py
-    coverage report
+    coverage run -m pytest test/test*.py -vv
+    coverage report -m
+    coverage xml
   displayName: 'pytest'

bashplot/__init__.py

@@ -1,2 +1,2 @@
 """bashplot."""
-__version__ = "0.25"
+__version__ = "0.3"

bashplot/bashplot.py

@@ -17,14 +17,7 @@
 import numpy as np
 import plotille as plt
 
-try:
-    from . import __version__
-except ImportError:
-    from __init__ import __version__
-
-if sys.version < "3":
-    print("Unsupported Python Version (version < 3)!")
-    sys.exit(1)
+from . import __version__
 
 
 def log(msg, mode=None):

dev-requirements.txt

@@ -25,6 +25,8 @@ pydocstyle==5.1.1
 pyflakes==2.2.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
 pyparsing==2.4.7; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'
 pytest==6.2.1
+pytest-clarity==0.3.0a0
+pytest-sugar==0.9.4
 regex==2020.11.13
 snowballstemmer==2.0.0
 toml==0.10.2; python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'

test/sample_generator.py

@@ -45,8 +45,4 @@ def generate(fname="test_data"):
     x = np.linspace(-0.3, 0.3)
     y = np.random.normal(mu, sigma, 50)
     data = np.array([x, y]).T
-    np.savetxt(Path(f"./{fname}__random_gaussian.txt"), data)
-
-
-if __name__ == "__main__":
-    generate()
+    np.savetxt(Path(f"./{fname}_random_gaussian.txt"), data)

test/test_bashplot.py

@@ -1,104 +1,126 @@
-#!/usr/bin/env python
-
 """Test for basplot."""
-import unittest
-from glob import glob
+
 from pathlib import Path
+from unittest import mock
+
+import sample_generator
 
 from bashplot import bashplot
 
+sample_generator.generate()
+
+print()
+
+test_txt = Path.cwd().glob("test*.txt")
+test_dat = Path.cwd().glob("test*.dat")
+
+args_1 = {
+    "infile": test_txt,
+    "comments": None,
+    "delimiter": None,
+    "skip_header": 0,
+    "skip_footer": 0,
+    "usecols": (0, 1),
+    "size": [30, 20],
+    "x_limits": None,
+    "y_limits": None,
+    "scatter": False,
+    "color": False,
+    "legend": True,
+    "version": False,
+}
+args_2 = {
+    "infile": test_txt,
+    "comments": None,
+    "delimiter": None,
+    "skip_header": 2,
+    "skip_footer": 2,
+    "usecols": (0, 1),
+    "size": [60, 40],
+    "x_limits": [0.0, 3.0],
+    "y_limits": [0.0, 3.0],
+    "scatter": True,
+    "color": True,
+    "legend": False,
+    "version": True,
+}
+# Example with different delimiter
+args_3 = {
+    "infile": test_dat,
+    "comments": None,
+    "delimiter": "\t",
+    "skip_header": 2,
+    "skip_footer": 2,
+    "usecols": (0, 1, 2, 3),
+    "size": [40, 30],
+    "x_limits": [0.0, 3.0],
+    "y_limits": [0.0, 3.0],
+    "scatter": False,
+    "color": True,
+    "legend": True,
+    "version": True,
+}
+
+
+def test_fnames():
+    assert bashplot.get_args(opt={"infile": test_txt})["infile"] == test_txt
+
+
+def test_options_scatter():
+    assert bashplot.get_args(opt={"scatter": True})["scatter"] is True
+
+
+def test_options_color():
+    assert bashplot.get_args(opt={"color": True})["color"] is True
+
+
+def test_options_legend():
+    assert bashplot.get_args(opt={"legend": False})["legend"] is False
+
+
+def test_options_version():
+    assert bashplot.get_args(opt={"version": True})["version"] is True
+
+
+def test_xlimits():
+    assert bashplot.get_args(opt={"x_limits": [0.0, 20.0]})["x_limits"] == [0.0, 20.0]
+
+
+def test_ylimits():
+    assert bashplot.get_args(opt={"y_limits": [0.0, 20.0]})["y_limits"] == [0.0, 20.0]
+
+
+def test_size():
+    assert bashplot.get_args(opt={"size": [60, 60]})["size"] == [60, 60]
+
+
+def test_ranges_default():
+    assert bashplot.get_args()["size"] == [60, 40]
+
+
+def test_usecols():
+    assert bashplot.get_args(opt={"usecols": [0, 2, 5]})["usecols"] == [0, 2, 5]
+
+
+@mock.patch("bashplot.bashplot.bashplot")
+def test_default_run(bashplot):
+    bashplot.bashplot(fnames=test_txt, args=args_1)
+    assert bashplot.bashplot.is_called
+
+
+@mock.patch("bashplot.bashplot.bashplot")
+def test_customize_run_1(bashplot):
+    bashplot.bashplot(fnames=test_txt, args=args_2)
+    assert bashplot.bashplot.is_called
+
+
+@mock.patch("bashplot.bashplot.bashplot")
+def test_customize_run_2(bashplot):
+    bashplot.bashplot(fnames=test_dat, args=args_3)
+    assert bashplot.bashplot.is_called
+
 
-class BashplotTestCase(unittest.TestCase):
-    def call_bashplot(self, args):
-        args = bashplot.get_args()
-        return bashplot.bashplot(args)
-
-    def setUp(self):
-        self.infile = glob("test*.txt")
-        self.args_1 = {
-            "infile": self.infile,
-            "comments": None,
-            "delimiter": None,
-            "skip_header": 0,
-            "skip_footer": 0,
-            "usecols": (0, 1),
-            "size": [30, 20],
-            "x_limits": None,
-            "y_limits": None,
-            "scatter": False,
-            "color": False,
-            "legend": True,
-            "version": False,
-        }
-        self.args_2 = {
-            "infile": self.infile,
-            "comments": None,
-            "delimiter": None,
-            "skip_header": 2,
-            "skip_footer": 2,
-            "usecols": (0, 1),
-            "size": [60, 40],
-            "x_limits": [0.0, 3.0],
-            "y_limits": [0.0, 3.0],
-            "scatter": True,
-            "color": True,
-            "legend": False,
-            "version": True,
-        }
-        # Example with different delimiter
-        self.singlefile = [Path("./test_data_mixed.dat")]
-        self.args_3 = {
-            "infile": self.singlefile,
-            "comments": None,
-            "delimiter": "\t",
-            "skip_header": 2,
-            "skip_footer": 2,
-            "usecols": (0, 1, 2, 3),
-            "size": [40, 30],
-            "x_limits": [0.0, 3.0],
-            "y_limits": [0.0, 3.0],
-            "scatter": False,
-            "color": True,
-            "legend": True,
-            "version": True,
-        }
-
-    def test_fnames(self):
-        self.assertEqual(
-            bashplot.get_args(opt={"infile": self.infile})["infile"], self.infile
-        )
-
-    def test_options(self):
-        self.assertTrue(bashplot.get_args(opt={"scatter": True})["scatter"])
-        self.assertTrue(bashplot.get_args(opt={"color": True})["color"])
-        self.assertFalse(bashplot.get_args(opt={"legend": False})["legend"])
-        self.assertTrue(bashplot.get_args(opt={"version": True})["version"])
-
-    def test_ranges(self):
-        self.assertEqual(
-            bashplot.get_args(opt={"x_limits": [0.0, 20.0]})["x_limits"], [0.0, 20.0]
-        )
-        self.assertEqual(
-            bashplot.get_args(opt={"y_limits": [0.0, 20.0]})["y_limits"], [0.0, 20.0]
-        )
-        self.assertEqual(bashplot.get_args(opt={"size": [60, 60]})["size"], [60, 60])
-        self.assertEqual(bashplot.get_args()["size"], [60, 40])
-        self.assertEqual(
-            bashplot.get_args(opt={"usecols": [0, 2, 5]})["usecols"], [0, 2, 5]
-        )
-
-    def test_default_run(self):
-        bashplot.bashplot(fnames=self.infile, args=self.args_1)
-        assert 1
-
-    def test_customize_run_1(self):
-        bashplot.bashplot(fnames=self.infile, args=self.args_2)
-        assert 1
-
-    def test_customize_run_2(self):
-        bashplot.bashplot(fnames=self.singlefile, args=self.args_3)
-        assert 1
-
-
-if __name__ == "__main__":
-    unittest.main()
+@mock.patch("bashplot.bashplot.command_line_runner")
+def test_command_line(command_line_runner):
+    bashplot.command_line_runner()
+    assert bashplot.command_line_runner.is_called