Add Testing Harness base (magpylib#56)

* Add tox pytest configuration

* Add test examples

* Add checkDimension utility test case, edge case fix

* Comment out unused test error messages

* Add circleci configuration

* Add test summary report to CircleCI

* Fix test running pytest instead of tox interface

* Tweak path for storing test results in CircleCI

* Add test reports xml to tox output

* Change directory for storing tests on tox

* Store test artifacts in CircleCI

* Fix identation on circleci yml for test summary

* Store artifacts before storing test results

* Testing circleci output

* Check test results in Circle CI for summary

* Explicit test result file in Circle CI

* Upload explicit result file to circleci

* Add subdirectory to test result xml

* Replace XML coverage with Test Summary in tox

* Add Circle CI badge to Readme

* Remove placeholder configuration from CircleCI

* Add Box test cases
    - Error for zero magnetization vector
    - Error for zero dim vector
    - Edge Case Error

* Add test for fastnorm3D change docstring for test_randomAxis

Author: lucasgcb

.circleci/config.yml

@@ -0,0 +1,17 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: python:3
+    steps:
+      - checkout
+      - run: 
+          name: Install Testing Env
+          command: mkdir test-results && pip install tox
+      - run:
+          name: Run Test Suite
+          command: tox
+      - store_artifacts:
+          path: test-results/magpylib/
+      - store_test_results:
+          path: test-results/magpylib/

.gitignore

@@ -43,6 +43,7 @@ pip-delete-this-directory.txt
 
 # Unit test / coverage reports
 htmlcov/
+test-results/
 .tox/
 .nox/
 .coverage

README.md

@@ -1,11 +1,11 @@
+[![CircleCI](https://circleci.com/gh/OrtnerMichael/magPyLib.svg?style=svg)](https://circleci.com/gh/OrtnerMichael/magPyLib) 
 [![](https://readthedocs.com/projects/magpylib-magpylib/badge/?version=sphinx-docs)](https://magpylib-magpylib.readthedocs-hosted.com/)
 
 ---
 
 # About
 *A simple and user friendly magnetic toolbox for Python 3.2+*
 
-
 ### What is Magpylib ?
  - Magpylib is a Python library for calculating magnetic fields from permanent magnets and current distributions. 
  - It provides an intuitive magnetic source class to quickly generate, group, geometrically manipulate and visualize assemblies of magnets and currents and the fields they generate.

magpylib/_lib/utility.py

@@ -2,6 +2,8 @@
 from numpy import float64, isnan, array
 ## Helper function for validating input dimensions
 def checkDimensions(expectedD: int, dim: Tuple[float,float,float], exitMsg: str="Bad dim input") -> array:
+    if type(dim)==int or type(dim)==float:
+        dim=[dim]
     assert all(coord == 0 for coord in dim) is False, exitMsg + ", all values are zero"
     dimension = array(dim, dtype=float64, copy=False) 
     assert (not any(isnan(dimension))  and  len(dimension) == expectedD), exitMsg

tests/__init__.py

@@ -0,0 +1,18 @@
+from magpylib.source import magnet
+import pytest 
+
+def test_BoxZeroMagError():
+    with pytest.raises(AssertionError):
+        magnet.Box(mag=[0,0,0],dim=[1,1,1])
+
+def test_BoxZeroDimError():
+    with pytest.raises(AssertionError):
+        magnet.Box(mag=[1,1,1],dim=[0,0,0])
+
+def test_BoxEdgeCase1():
+    ## For now this returns NaN, may be an analytical edge case
+    ## Test the Methods in getB() before moving onto this
+    from numpy import isnan
+    pm = magnet.Box(mag=[0,0,1000],dim=[0.5,0.1,1],pos=[.25,.55,-1111])
+    result = pm.getB([.5,.5,5])
+    assert any(isnan(result)), "Results from getB is not NaN"

tests/test_magnets.py

@@ -0,0 +1,19 @@
+import unittest
+from magpylib._lib.mathLibPrivate import fastSum3D, fastNorm3D
+import numpy
+
+
+def test_fastSum3D():
+    """
+    #Test if it can sum a position vector
+    """
+    position=[2.3,5.6,2.0]
+    assert round(fastSum3D(position),2)==9.90, "Error, not adding correctly"
+
+###
+
+def test_fastNorm3D():
+    from numpy import isnan
+    result=round(fastNorm3D([58.2,25,25]),4)
+    assert result==68.0973, "Expected 68.0973, got " + str(result)
+

tests/test_privateMath.py

@@ -0,0 +1,12 @@
+import unittest
+from magpylib._lib.mathLibPublic import randomAxis, axisFromAngles, anglesFromAxis, rotatePosition
+import numpy
+
+def test_randomAxis():
+    """
+    #Test if returned random axis are valid
+    """
+    result = randomAxis()
+    assert len(result)==3, "Returning axis should be 3"
+    assert all(type(axis)==numpy.float64 for axis in result), "Axis values are not float64"
+    assert all(abs(axis)<=1 for axis in result), "Absolute axis values returned greater than 1"

tests/test_publicMath.py

@@ -0,0 +1,35 @@
+from typing import Tuple
+from magpylib._lib.utility import checkDimensions
+from numpy import float64, isnan, array
+import pytest
+
+def test_checkDimensionZero():
+    # errMsg = "Did not raise all zeros Error"
+    with pytest.raises(AssertionError):
+        checkDimensions(3,dim=(.0,0,.0))
+
+    with pytest.raises(AssertionError):
+        checkDimensions(0,dim=[])
+
+def test_checkDimensionMembers():
+    # errMsg = "Did not raise expected Value Error"
+    with pytest.raises(ValueError):
+        checkDimensions(3,dim=(3,'r',6))
+
+def test_checkDimensionSize():
+    errMsg = "Did not raise wrong dimension size Error"
+    with pytest.raises(AssertionError) as error:
+        checkDimensions(3,dim=(3,5,9,6))
+    assert error.type == AssertionError, errMsg
+
+def test_checkDimensionReturn():
+    errMsg = "Wrong return dimension size"
+    result = checkDimensions(4,dim=(3,5,9,10))
+    assert len(result) == 4, errMsg
+    result = checkDimensions(3,dim=(3,5,9))
+    assert len(result) == 3, errMsg
+    result = checkDimensions(2,dim=(3,5))
+    assert len(result) == 2, errMsg
+    result = checkDimensions(1,dim=(3))
+    assert len(result) == 1, errMsg
+    

tests/test_utility.py

@@ -0,0 +1,9 @@
+[tox]
+envlist = py32
+
+[testenv]
+# install pytest in the virtualenv where commands will be executed
+deps = pytest-cov
+commands =
+    # NOTE: you can run any command line tool here - not just tests
+    py.test --junitxml=test-results/magpylib/results.xml --cov-report html --cov-report term:skip-covered --cov=magpylib