Add some basic smoke tests

.github/workflows/ci.yaml

@@ -0,0 +1,18 @@
+---
+name: Run tests
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: ['master']
+  pull_request:
+
+jobs:
+  pytest:
+    uses: ros-infrastructure/ci/.github/workflows/pytest.yaml@main
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: yamllint -f github .

.gitignore

@@ -1,2 +1,3 @@
+/.coverage
 MANIFEST
 dist

setup.cfg

@@ -0,0 +1,7 @@
+[tool:pytest]
+junit_suite_name = catkin-sphinx
+markers =
+  sphinx
+
+[coverage:run]
+source = catkin_sphinx

setup.py

@@ -33,5 +33,11 @@
   description="Sphinx extension for Catkin projects",
   long_description="Sphinx extension for Catkin projects that provides a "
                    "custom ROS theme and a Sphinx domain for cmake.",
-  license="BSD"
+  license="BSD",
+  extras_require={
+    'test': [
+      'pytest',
+      'sphinx',
+    ],
+  },
 )

test/__init__.py

@@ -0,0 +1,6 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.join(
+    os.path.dirname(os.path.dirname(os.path.realpath(__file__))),
+    'src'))

test/conftest.py

@@ -0,0 +1,11 @@
+import pytest
+from sphinx.testing.path import path
+
+pytest_plugins = (
+    'sphinx.testing.fixtures',
+)
+
+
+@pytest.fixture(scope='session')
+def rootdir():
+    return path(__file__).parent.abspath() / 'roots'

test/roots/test-cmake-extension/conf.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+import sys
+
+import catkin_sphinx
+
+
+project = 'test_cmake_extension'
+
+sys.path.append(str(Path(catkin_sphinx.__file__).parent.resolve()))
+
+extensions = ['cmake']

test/roots/test-sh-lexer-extension/conf.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+import sys
+
+import catkin_sphinx
+
+
+project = 'test_sh_lexer'
+
+sys.path.append(str(Path(catkin_sphinx.__file__).parent.resolve()))
+
+extensions = ['ShLexer']

test/test_cmake_extension.py

@@ -0,0 +1,6 @@
+import pytest
+
+
+@pytest.mark.sphinx(testroot='cmake-extension')
+def test_cmake_extension_setup(app):
+    pass

test/test_sh_lexer_extension.py

@@ -0,0 +1,6 @@
+import pytest
+
+
+@pytest.mark.sphinx(testroot='sh-lexer-extension')
+def test_sh_lexer_setup(app):
+    pass

test/test_theme_path.py

@@ -0,0 +1,6 @@
+import catkin_sphinx
+
+
+def test_theme_path():
+    res = catkin_sphinx.get_theme_path()
+    assert res