Merge pull request #56 from scottyhq/pytest

basic test framework and github actions

Author: jpswinski

.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: Tests
+
+on:
+  push:
+    branches: "*"
+  pull_request:
+    branches: main
+
+jobs:
+  test:
+    name: ${{ matrix.CONDA_ENV }}-test
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        CONDA_ENV: [3.8, 3.9]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Cache conda environment
+        uses: actions/cache@v2
+        env:
+          # Increase this value to reset cache if environment.yml has not changed
+          CACHE_NUMBER: 0
+        with:
+          path: ~/conda_pkgs_dir
+          key: >
+            ${{ format('{0}-conda-{1}-{2}',
+            runner.os,
+            env.CACHE_NUMBER,
+            hashFiles(format('ci/environment-{0}.yml', matrix.CONDA_ENV))) }}
+
+      - name: Setup miniconda
+        uses: conda-incubator/setup-miniconda@v2
+        with:
+          auto-update-conda: true
+          auto-activate-base: false
+          activate-environment: sliderule-ci
+          environment-file: ci/environment-${{ matrix.CONDA_ENV }}.yml
+          use-only-tar-bz2: true
+
+      - name: Install sliderule from current commit
+        shell: bash -l {0}
+        run: |
+          python -m pip install .
+          conda list
+
+      - name: Run tests
+        shell: bash -l {0}
+        run: |
+          python -m pytest --verbose

README.md

@@ -1,5 +1,5 @@
 # sliderule-python
-
+[![Tests](https://github.com/ICESat2-SlideRule/sliderule-python/actions/workflows/test.yml/badge.svg)](https://github.com/ICESat2-SlideRule/sliderule-python/actions/workflows/test.yml)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://gke.mybinder.org/v2/gh/ICESat2-SlideRule/sliderule-python/main?urlpath=lab)
 [![badge](https://img.shields.io/static/v1.svg?logo=Jupyter&label=PangeoBinderAWS&message=us-west-2&color=orange)](https://aws-uswest2-binder.pangeo.io/v2/gh/ICESat2-SlideRule/sliderule-python/main?urlpath=lab)
 [![DOI](https://zenodo.org/badge/311384982.svg)](https://zenodo.org/badge/latestdoi/311384982)
@@ -35,7 +35,7 @@ python3 setup.py install
 
 ### Dependencies
 
-To use SlideRule's Python client, the only non-standard packages it depends on are `requests` and `numpy`.  But if you intend on running the example notebooks, please refer to the package requirements listed in `environment.yml` for a full list of dependencies needed by those notebooks.
+Basic functionality of sliderule-python depends on `requests` and `numpy`.  But if you intend on running the example notebooks, please refer to the package requirements listed in `environment.yml` for a full list of recommended python libraries.
 
 ## II. Getting Started Using SlideRule
 

ci/environment-3.8.yml

@@ -0,0 +1,11 @@
+name: sliderule-ci
+channels:
+  - conda-forge
+dependencies:
+  - python=3.8
+  - geopandas
+  - numpy
+  - pip
+  - pytest
+  - requests
+  - setuptools_scm

ci/environment-3.9.yml

@@ -0,0 +1,11 @@
+name: sliderule-ci
+channels:
+  - conda-forge
+dependencies:
+  - python=3.9
+  - geopandas
+  - numpy
+  - pip
+  - pytest
+  - requests
+  - setuptools_scm

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    network: mark a test that requires a network connection.

tests/__init__.py

@@ -0,0 +1,38 @@
+{
+  "type": "FeatureCollection",
+  "features": [
+    {
+      "type": "Feature",
+      "properties": {},
+      "geometry": {
+        "type": "Polygon",
+        "coordinates": [
+          [
+            [
+              -108.3087158203125,
+              38.81670618152057
+            ],
+            [
+              -107.87406921386717,
+              38.81670618152057
+            ],
+            [
+              -107.87406921386717,
+              39.122602866278996
+            ],
+            [
+              -108.3087158203125,
+              39.122602866278996
+            ],
+            [
+              -108.3087158203125,
+              38.81670618152057
+            ]
+          ]
+        ]
+      }
+    }
+  ]
+}
+
+

tests/data/polygon.geojson

@@ -0,0 +1,25 @@
+"""Tests for sliderule-python."""
+
+import pytest
+from requests.exceptions import ConnectTimeout, ConnectionError
+import sliderule
+
+class TestLocal:
+    def test_version(self):
+        assert hasattr(sliderule, '__version__')
+        assert isinstance(sliderule.__version__, str)
+
+    def test_seturl_empty(self):
+        with pytest.raises(TypeError, match=('url')):
+            sliderule.set_url()
+
+    def test_gps2utc(self):
+        utc = sliderule.gps2utc(1235331234)
+        assert utc == '2019-02-27 19:34:03'
+
+@pytest.mark.network
+class TestRemote:
+    def test_init_badurl(self):
+        with pytest.raises( (ConnectTimeout, ConnectionError) ):
+            sliderule.set_rqst_timeout((1, 60))
+            sliderule.set_url('incorrect.org')

tests/test_client.py

@@ -0,0 +1,56 @@
+"""Tests for sliderule-python icesat2 api."""
+
+import pytest
+from requests.exceptions import ConnectTimeout, ConnectionError
+import sliderule
+from sliderule import icesat2
+from pathlib import Path
+import os.path
+
+TESTDIR = Path(__file__).parent
+SERVER = "icesat2sliderule.org"
+
+# Change connection timeout from default 10s to 1s
+sliderule.set_rqst_timeout((1, 60))
+
+@pytest.fixture(scope='module')
+def grandmesa():
+    return [ {"lon": -108.3435200747503, "lat": 38.89102961045247},
+               {"lon": -107.7677425431139, "lat": 38.90611184543033},
+               {"lon": -107.7818591266989, "lat": 39.26613714985466},
+               {"lon": -108.3605610678553, "lat": 39.25086131372244},
+               {"lon": -108.3435200747503, "lat": 38.89102961045247} ]
+
+
+class TestLocal:
+    def test_init_empty_raises(self):
+        with pytest.raises(TypeError, match=('url')):
+            icesat2.init()
+
+    def test_toregion_empty_raises(self):
+        with pytest.raises(TypeError, match=('filename')):
+            region = icesat2.toregion()
+
+    def test_toregion(self):
+        region = icesat2.toregion(os.path.join(TESTDIR, 'data/polygon.geojson'))
+        assert len(region) == 1 # single polygon bbox
+        assert len(region[0]) == 5 # 5 coordinate pairs
+        assert {'lon', 'lat'} <= region[0][0].keys()
+
+@pytest.mark.network
+class TestRemote:
+    def test_init_badurl(self):
+        with pytest.raises( (ConnectTimeout, ConnectionError) ):
+            icesat2.init('incorrect.org')
+
+    def test_get_version(self):
+        icesat2.init(SERVER)
+        version = icesat2.get_version()
+        assert isinstance(version, dict)
+        assert {'icesat2', 'server', 'client'} <= version.keys()
+
+    def test_cmr(self, grandmesa):
+        icesat2.init(SERVER)
+        granules = icesat2.cmr(grandmesa, time_start='2018-10-01', time_end='2018-12-01')
+        assert isinstance(granules, list)
+        assert 'ATL03_20181017222812_02950102_004_01.h5' in granules