From 8596042acd64c82acf58d7536d6125b8f962c3ae Mon Sep 17 00:00:00 2001
From: Karolina Surma <ksurma@redhat.com>
Date: Fri, 20 Sep 2024 16:10:35 +0200
Subject: [PATCH] Tests sphinx extensions with the package

Tested extensions:
- python-sphinx-theme-alabaster
- python-sphinx_rtd_theme
- python-sphinxcontrib-jquery

The tested extensions are the one that we pull to CentOS Stream/RHEL.
---
 tests/include-sphinxcontrib-jquery/main.fmf       | 11 +++++++++++
 tests/include-sphinxcontrib-jquery/source/conf.py |  7 +++++++
 .../source/index.rst                              |  0
 tests/{smoke => smoke-alabaster}/main.fmf         |  1 +
 tests/{smoke => smoke-alabaster}/source/conf.py   |  0
 tests/smoke-alabaster/source/index.rst            | 15 +++++++++++++++
 tests/smoke-rtd-theme/main.fmf                    | 11 +++++++++++
 tests/smoke-rtd-theme/source/conf.py              |  8 ++++++++
 tests/smoke-rtd-theme/source/index.rst            | 15 +++++++++++++++
 9 files changed, 68 insertions(+)
 create mode 100644 tests/include-sphinxcontrib-jquery/main.fmf
 create mode 100644 tests/include-sphinxcontrib-jquery/source/conf.py
 rename tests/{smoke => include-sphinxcontrib-jquery}/source/index.rst (100%)
 rename tests/{smoke => smoke-alabaster}/main.fmf (83%)
 rename tests/{smoke => smoke-alabaster}/source/conf.py (100%)
 create mode 100644 tests/smoke-alabaster/source/index.rst
 create mode 100644 tests/smoke-rtd-theme/main.fmf
 create mode 100644 tests/smoke-rtd-theme/source/conf.py
 create mode 100644 tests/smoke-rtd-theme/source/index.rst

diff --git a/tests/include-sphinxcontrib-jquery/main.fmf b/tests/include-sphinxcontrib-jquery/main.fmf
new file mode 100644
index 0000000..e447827
--- /dev/null
+++ b/tests/include-sphinxcontrib-jquery/main.fmf
@@ -0,0 +1,11 @@
+summary: run the basic documentation build
+test: |
+    sphinx-build -M html source/ build/ &&
+    grep '<script src="_static/jquery.js' build/html/index.html &&
+    grep '<script src="_static/_sphinx_javascript_frameworks_compat.js' build/html/index.html &&
+    test -f build/html/_static/jquery.js &&
+    test -f build/html/_static/_sphinx_javascript_frameworks_compat.js &&
+    rm -rf build/
+require:
+  - python3-sphinx
+  - python3-sphinxcontrib-jquery
diff --git a/tests/include-sphinxcontrib-jquery/source/conf.py b/tests/include-sphinxcontrib-jquery/source/conf.py
new file mode 100644
index 0000000..012519f
--- /dev/null
+++ b/tests/include-sphinxcontrib-jquery/source/conf.py
@@ -0,0 +1,7 @@
+project = 'Test'
+copyright = '2024, Test'
+author = 'Test'
+release = '0.3.0'
+extensions = [
+    "sphinxcontrib.jquery",
+]
diff --git a/tests/smoke/source/index.rst b/tests/include-sphinxcontrib-jquery/source/index.rst
similarity index 100%
rename from tests/smoke/source/index.rst
rename to tests/include-sphinxcontrib-jquery/source/index.rst
diff --git a/tests/smoke/main.fmf b/tests/smoke-alabaster/main.fmf
similarity index 83%
rename from tests/smoke/main.fmf
rename to tests/smoke-alabaster/main.fmf
index 80e8276..8faae01 100644
--- a/tests/smoke/main.fmf
+++ b/tests/smoke-alabaster/main.fmf
@@ -3,6 +3,7 @@ test: |
     sphinx-build -M html source/ build/ &&
     grep '<section id="test-docfile">' build/html/index.html &&
     grep '<h1>Test docfile' build/html/index.html &&
+    grep '_static/alabaster.css' build/html/index.html &&
     rm -rf build/
 require:
   - python3-sphinx
diff --git a/tests/smoke/source/conf.py b/tests/smoke-alabaster/source/conf.py
similarity index 100%
rename from tests/smoke/source/conf.py
rename to tests/smoke-alabaster/source/conf.py
diff --git a/tests/smoke-alabaster/source/index.rst b/tests/smoke-alabaster/source/index.rst
new file mode 100644
index 0000000..4d6fdff
--- /dev/null
+++ b/tests/smoke-alabaster/source/index.rst
@@ -0,0 +1,15 @@
+Test docfile
+============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/tests/smoke-rtd-theme/main.fmf b/tests/smoke-rtd-theme/main.fmf
new file mode 100644
index 0000000..b0f5efd
--- /dev/null
+++ b/tests/smoke-rtd-theme/main.fmf
@@ -0,0 +1,11 @@
+summary: run the basic documentation build with sphinx-rtd-theme
+test: |
+    sphinx-build -M html source/ build/ &&
+    grep '<section id="test-docfile">' build/html/index.html &&
+    grep '<h1>Test docfile' build/html/index.html &&
+    grep 'SphinxRtdTheme' build/html/_static/js/theme.js &&
+    grep '<script src="_static/js/theme.js' build/html/index.html &&
+    rm -rf build/
+require:
+  - python3-sphinx
+  - python3-sphinx_rtd_theme
diff --git a/tests/smoke-rtd-theme/source/conf.py b/tests/smoke-rtd-theme/source/conf.py
new file mode 100644
index 0000000..81ad4b7
--- /dev/null
+++ b/tests/smoke-rtd-theme/source/conf.py
@@ -0,0 +1,8 @@
+project = 'Test'
+copyright = '2024, Test'
+author = 'Test'
+release = '0.3.0'
+html_theme = 'sphinx_rtd_theme'
+extensions = [
+    'sphinx_rtd_theme',
+]
\ No newline at end of file
diff --git a/tests/smoke-rtd-theme/source/index.rst b/tests/smoke-rtd-theme/source/index.rst
new file mode 100644
index 0000000..4d6fdff
--- /dev/null
+++ b/tests/smoke-rtd-theme/source/index.rst
@@ -0,0 +1,15 @@
+Test docfile
+============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`