unit tests (#38)

* unit tests 
* github action to run unit test in env with miniconda

Co-authored-by: Zhang Yunjun <[email protected]>

Author: LiangJYu

.github/workflows/unit_tests.yaml

@@ -0,0 +1,25 @@
+name: Unit tests
+on: [push]
+
+jobs:
+  unit_tests:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          activate-environment: s1reader
+          auto-update-conda: true
+          environment-file: environment.yaml
+          python-version: 3.9
+          auto-activate-base: false
+      - name: Run pytest
+        shell: bash -l {0}
+        run: |
+          conda activate s1reader
+          pip install .
+          conda install pytest
+          pytest

environment.yaml

@@ -0,0 +1,9 @@
+name: s1reader
+channels:
+  - defaults
+  - conda-forge
+dependencies:
+  - numpy
+  - gdal
+  - isce3
+  - shapely

src/s1reader/s1_burst_slc.py

@@ -369,7 +369,7 @@ def as_dict(self):
                 temp['lut2d']['data'] = val.lut2d.data.flatten().tolist()
 
                 val = temp
-            elif key in ['orbit']:
+            elif key == 'orbit':
                 temp = {}
                 temp['ref_epoch'] = str(val.reference_epoch)
                 temp['time'] = {}

src/s1reader/s1_reader.py

@@ -368,7 +368,7 @@ def burst_from_xml(annotation_path: str, orbit_path: str, tiff_path: str,
 
         # get orbit from state vector list/element tree
         sensing_duration = datetime.timedelta(
-            seconds=n_samples * azimuth_time_interval)
+            seconds=n_lines * azimuth_time_interval)
         orbit = get_burst_orbit(sensing_start, sensing_start + sensing_duration,
                                 osv_list)
 

tests/README.md

@@ -0,0 +1,3 @@
+The SAFE zip in the data directory is a light version of an actual Sentinel-1 SAFE zip. The paths within the zip adhere to the ESA specifications. To keep the file size small, the tiff files in the ```measurement` directory have been replaced with empty files (crated with `touch`).
+
+Extra, empty orbit files created with touch to test orbit file finding.

tests/conftest.py

@@ -0,0 +1,27 @@
+import pathlib
+import pytest
+import types
+
+from s1reader import s1_reader
+
+@pytest.fixture(scope="session")
+def test_paths():
+    test_paths = types.SimpleNamespace()
+
+    test_path = pathlib.Path(__file__).parent.resolve()
+    test_paths.safe = f"{test_path}/data/S1A_IW_SLC__1SDV_20200511T135117_20200511T135144_032518_03C421_7768.zip"
+    test_paths.orbit_dir = f"{test_path}/data/orbits"
+    test_paths.orbit_file = "S1A_OPER_AUX_POEORB_OPOD_20210318T120818_V20200510T225942_20200512T005942.EOF"
+
+    return test_paths
+
+@pytest.fixture(scope="session")
+def bursts(test_paths):
+    i_subswath = 3
+    pol = 'vv'
+
+    orbit_path = f'{test_paths.orbit_dir}/{test_paths.orbit_file}'
+    bursts = s1_reader.load_bursts(test_paths.safe, orbit_path, i_subswath,
+                                   pol)
+
+    return bursts