Add codecov.io to test suite (#851)

Author: ericmjl

.github/workflows/tests.yml

@@ -71,16 +71,14 @@ jobs:
         run: |
           source /tmp/pyjanitor-dev_env/bin/activate
           python -m pip install -e .
-          pytest
-
-#      - name: Inspect coverage
-#        run: |
-#          cat coverage.xml
+          make test
 
+      # https://github.com/codecov/codecov-action
       - name: Upload code coverage
-        run: |
-          source /tmp/pyjanitor-dev_env/bin/activate
-          bash <(curl -s https://codecov.io/bash)
+        uses: codecov/codecov-action@v2
+        with:
+          fail_ci_if_error: true # optional (default = false)
+          verbose: true # optional (default = false)
 
   jupyter-notebook:
     name: Execute all Jupyter notebooks
@@ -125,7 +123,6 @@ jobs:
       - name: Unpack environment and activate it
         run: bash scripts/ci/unpack_environment.sh
 
-
       - name: Build docs
         run: |
           source /tmp/pyjanitor-dev_env/bin/activate

Makefile

@@ -20,7 +20,7 @@ format:
 
 test:
 	@echo "Running test suite..."
-	pytest --cov-report html
+	pytest
 
 lint:
 	@echo "Checking code formatting..."

pyproject.toml

@@ -28,3 +28,20 @@ ignore-private = false
 ignore-semiprivate = false
 quiet = false
 verbose = 2
+
+# https://docs.pytest.org/en/6.2.x/mark.html#registering-marks
+[tool.pytest.ini_options]
+addopts = "--cov=janitor/ --cov-report=html --cov-report=xml --cov-report=term-missing"
+markers = [
+    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
+    "biology",
+    "chemistry",
+    "engineering",
+    "finance",
+    "functions: main janitor functions suite",
+    "ml: Machine learning-specific data cleaning functions.",
+    "spark_functions",
+    "timeseries",
+    "utils",
+    "xarray",
+]

tests/finance/test_convert_stock.py

@@ -1,24 +1,24 @@
 from janitor.finance import get_symbol
+import pytest
 
-"""
-Tests get_symbol function,
-get_symbol should return appropriate string
-corresponding to abbreviation.
-This string will be a company's full name,
-and the abbreviation will be the NSYE
-symbol for the company.
 
-Example:
-    print(get_symbol("aapl"))
-    console >> Apple Inc.
-
-If the symbol does not have a corresponding
-company, Nonetype should be returned.
-
-"""
+@pytest.mark.xfail(reason="Flaky because it depends on internet connectivity.")
+def test_convert_stock():
+    """
+    Tests get_symbol function,
+    get_symbol should return appropriate string
+    corresponding to abbreviation.
+    This string will be a company's full name,
+    and the abbreviation will be the NSYE
+    symbol for the company.
 
+    Example:
+        print(get_symbol("aapl"))
+        console >> Apple Inc.
 
-def test_convert_stock():
+    If the symbol does not have a corresponding
+    company, Nonetype should be returned.
+    """
     assert get_symbol("GME") == "GameStop Corp."
     assert get_symbol("AAPL") != "Aramark"
     assert get_symbol("ASNF") is None

tests/finance/test_get_symbol.py

@@ -1,4 +1,5 @@
 from janitor.finance import get_symbol
+import pytest
 
 """
 tests the convert_symbol helper function.
@@ -13,6 +14,9 @@
 """
 
 
+@pytest.mark.xfail(
+    reason="Flaky, because it depends on internet connectivity."
+)
 def test_get_symbol():
     assert get_symbol("GME") == "GameStop Corp."
     assert get_symbol("GME") != "Globus Medical Inc."