Merge pull request astropy#11 from mwcraig/make-tests-sensible

Move test files and add test

Author: mwcraig

.github/workflows/run_tests.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    # Weekly Friday 5AM build
+    # * is a special character in YAML so you have to quote this string
+    - cron: '0 5 * * 5'
+
+jobs:
+    tests:
+        runs-on: ${{ matrix.os }}
+        strategy:
+          fail-fast: true
+          matrix:
+            os: [ubuntu-latest]
+        steps:
+        - name: Checkout code
+          uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+        - name: Set up Python
+          uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55  # v5.5.0
+          with:
+            python-version: '3.13'
+        - name: Install and build
+          run: python -m pip install .[test]
+        - name: Run tests
+          run: pytest tests

pyproject.toml

@@ -20,7 +20,25 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: Implementation :: CPython",
 ]
-dependencies = []
+dependencies = [
+  "astropy",
+  "numpy",
+]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx",
+    "sphinx-astropy[confv2]",
+    "sphinx-design",
+    "graphviz",
+]
+test = [
+    "black",
+    "pre-commit",
+    "pytest-astropy",
+    "ruff",
+    "tox",
+]
 
 [project.urls]
 Documentation = "https://github.com/astropy/astro-image-display-api#readme"

src/astro_image_display_api/interface_definition.py

@@ -119,7 +119,7 @@ def save(self, filename: str | os.PathLike, overwrite: bool = False) -> None:
 
     # Marker-related methods
     @abstractmethod
-    def start_marking(self, marker_name: str | None = None) -> None:
+    def start_marking(self, marker_name: str | None = None, marker: Any = None) -> None:
         """
         Start interactive marking of points on the image.
 
@@ -128,6 +128,10 @@ def start_marking(self, marker_name: str | None = None) -> None:
         marker_name : str, optional
             The name of the marker set to use. If not given, a unique
             name will be generated.
+
+        marker : Any, optional
+            The marker to use. If not given, a default marker will be
+            used.
         """
         raise NotImplementedError
 
@@ -258,13 +262,13 @@ def offset_by(self, dx: float | Quantity, dy: float | Quantity) -> None:
         raise NotImplementedError
 
     @abstractmethod
-    def zoom(self) -> None:
+    def zoom(self, val: float) -> None:
         """
         Zoom in or out by the given factor.
 
         Parameters
         ----------
-        val : int
+        val : float
             The zoom level to zoom the image.
             See `zoom_level`.
         """

tests/widget_api_test.py renamed to src/astro_image_display_api/widget_api_test.py

@@ -12,6 +12,8 @@
 from astropy import units as u  # noqa: E402
 from astropy.wcs import WCS  # noqa: E402
 
+__all__ = ['ImageWidgetAPITest']
+
 
 class ImageWidgetAPITest:
     cursor_error_classes = (ValueError)
@@ -52,6 +54,11 @@ def _check_marker_table_return_properties(self, table):
         assert len(table) == 0
         assert sorted(table.colnames) == sorted(['x', 'y', 'coord', 'marker name'])
 
+    def test_default_marker_names(self):
+        # Check only that default names are set to a non-empty string
+        assert self.image.DEFAULT_MARKER_NAME
+        assert self.image.DEFAULT_INTERACTIVE_MARKER_NAME
+
     def test_width_height(self):
         assert self.image.image_width == 250
         assert self.image.image_height == 100
@@ -314,6 +321,9 @@ def test_adding_markers_as_world(self, data, wcs):
                                    mark_coord_table['coord'].dec.deg)
 
     def test_stretch(self):
+        # Check that the stretch options is not an empty list
+        assert len(self.image.stretch_options) > 0
+
         original_stretch = self.image.stretch
 
         with pytest.raises(ValueError, match='must be one of'):
@@ -403,12 +413,14 @@ def test_scroll_pan(self):
     def test_save(self, tmp_path):
         filename = tmp_path / 'woot.png'
         self.image.save(filename)
+        assert filename.is_file()
 
     def test_save_overwrite(self, tmp_path):
         filename = tmp_path / 'woot.png'
 
         # First write should be fine
         self.image.save(filename)
+        assert filename.is_file()
 
         # Second write should raise an error because file exists
         with pytest.raises(FileExistsError):

tests/test_astro_image_display_api.py

@@ -0,0 +1,29 @@
+from astropy.utils.data import get_pkg_data_contents
+
+from astro_image_display_api.interface_definition import ImageViewerInterface
+
+
+def test_api_test_class_completeness():
+    """
+    Test that the ImageWidgetAPITest class is complete and has tests
+    for all of the required methods and attributes.
+    """
+    # Get the attributes on the protocol
+    required_attributes = ImageViewerInterface.__protocol_attrs__
+
+    # Get the text of the api tests
+    widget_api_test_content = get_pkg_data_contents("widget_api_test.py", package="astro_image_display_api")
+    # Loop over the attributes and check that the test class has a method
+    # for each one whose name starts with test_ and ends with the attribute
+    # name.
+    attr_present = []
+    image_viewer_name = "self.image"
+    for attr in required_attributes:
+        attr_present.append(f"{image_viewer_name}.{attr}" in widget_api_test_content)
+
+
+
+    assert all(attr_present), (
+        "ImageWidgetAPITest does not access these attributes/methods:\n "
+        f"{"\n".join(attr for attr, present in zip(required_attributes, attr_present) if not present)}. "
+    )