more reorg and exercises (writing guide)

Author: dylex

.github/workflows/test.yml

@@ -6,7 +6,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: [3.7, 3.8]
 
     steps:
     - name: Checkout repository

README.md

@@ -1,6 +1,6 @@
 # Sciware Testing Examples and Exercises
 
-[![](https://github.com/flatironinstitute/sciware-testing-python/actions/workflows/test.yml/badge.svg)](https://github.com/flatironinstitute/sciware-testing-python/actions/workflows/test.yml/)
+[![](https://github.com/flatironinstitute/sciware-testing-python/actions/workflows/test.yml/badge.svg)](https://github.com/flatironinstitute/sciware-testing-python/actions)
 
 This is an example repository for writing tests, for the Sciware Testing session. 
 It demonstrates how to setup a repository to use GitHub actions to automatically run tests
@@ -41,10 +41,11 @@ pytest
 * **[`requirements.txt`](requirements.txt)** - File listing the packages required to run the code. It is included by setup.py.
 * **[`LICENSE`](LICENSE)** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
 * **[`sciware_testing_python/`](sciware_testing_python/)** - Directory for all the code.
-* **[`sciware_testing_python/__init.py__`** - File that python imports to define the `sciware_testing_python`](sciware_testing_python/__init.py__`** - File that python imports to define the `sciware_testing_python) package.
-* **[`sciware_testing_python/sciware_testing_python.py`](sciware_testing_python/sciware_testing_python.py)** - File with all of the code.
+* **[`sciware_testing_python/__init.py__`](sciware_testing_python/__init__.py)** - File that python imports to define the `sciware_testing_python package.
+* **[`sciware_testing_python/main.py`](sciware_testing_python/main.py)** - File with all of the code.
 * **[`tests/`** - Directory for the code which tests the code in `sciware_testing_python`](tests/`** - Directory for the code which tests the code in `sciware_testing_python).
-* **[`tests/test_sciware_testing_python.py`](tests/test_sciware_testing_python.py)** - File containing the tests.
+* **[`tests/test_1.py`](tests/test_1.py)** - File to fill in with some tests
+* **[`tests/test_examples.py`](tests/test_examples.py)** - File containing some tests
 * **[`.gitignore`](.gitignore)** - File which tells github what files to not track (optional)
 * **[`.github/workflows/`](.github/workflows/)** - Directory containing the configuration file for GitHub actions.
 * **[`.github/workflows/test.yml`](.github/workflows/test.yml)** - File detailing the system configurations to use for the tests.

sciware_testing_python/__init__.py

@@ -6,4 +6,4 @@
 __email__ = '[email protected]'
 __version__ = '0.1.0'
 
-from .sciware_testing_python import *
+from .main import *

sciware_testing_python/sciware_testing_python_sol.py renamed to sciware_testing_python/examples.py

@@ -130,3 +130,39 @@ def add_vectors(vector_1, vector_2):
         sum_vec.append(a + b)
 
     return sum_vec
+
+def count_ones(input_list):
+    """Example function. Counts the number of 1s in a list.
+
+    Parameters
+    ----------
+    input_list : list
+        List of values
+
+    Returns
+    -------
+    int
+        Numbers of values that == 1
+
+    Notes
+    -----
+    This is NOT good Python, just an example function for tests.
+
+    Examples
+    --------
+    >>> count_ones([2,1,1,3,-1])
+    2
+
+    Empty lists are returned as zero
+    >>> count_ones([])
+    0
+
+    """
+
+    count = 0
+    for n in input_list:
+        if n == 1:
+            count += 1
+
+    return count
+

sciware_testing_python/sciware_testing_python.py renamed to sciware_testing_python/main.py

@@ -19,6 +19,10 @@ def sum_numbers(number_list):
     -----
     This is NOT good Python, just an example function for tests.
 
+    Example
+    -------
+    >>> 1
+    1
     """
 
     sum_val = 0
@@ -52,6 +56,6 @@ def add_vectors(vector_1, vector_2):
     sum_vec = []
 
     for a, b in zip(vector_1, vector_2):
-        sum_vec.append(a + b)
+        sum_vec.append(a * b)
 
     return sum_vec

tests/test_sciware_testing_python.py renamed to tests/test_examples.py

@@ -9,15 +9,17 @@
 def test_sum_numbers():
     """Sample test function for sum_numbers."""
 
+    assert 0 == stp.sum_numbers([])
+
     number_list = [2, 3, 4]
     our_result = stp.sum_numbers(number_list)
     assert our_result == sum(number_list)
 
 
 def test_adding_vectors():
-    v1 = [2, 3, 4]
-    v2 = [4, 9, 16]
-    assert stp.add_vectors(v1, v2) == [6, 12, 20]
+    v1 = [2, 0]
+    v2 = [2, 0]
+    assert stp.add_vectors(v1, v2) == [4, 0]
 
 
 def test_add_zero_length_vectors():
@@ -82,7 +84,7 @@ def test_parametrize_sum_numbers(number_list, expect_val):
     assert stp.sum_numbers(number_list) == expect_val
 
 
-@pytest.mark.xfail(strict=True)
+@pytest.mark.xfail
 def test_add_different_length_vectors():
     """
     """

tests/test_exercise.py

@@ -0,0 +1,10 @@
+import pytest
+import sciware_testing_python
+
+def test_sum1():
+    # basic sanity test: do we get the right answer for a simple case?
+    assert True
+
+def test_sum2():
+    # what's the sum of an empty list
+    pass

tests/test_tdd.py

@@ -0,0 +1,6 @@
+import pytest
+import sciware_testing_python
+
+@pytest.mark.skip(reason="not yet implemented")
+def test_count_ones():
+    assert sciware_testing_python.count_ones([2,1,1,3,-1] == 2)