Fixing tests

Author: choldgraf

docs/source/index.md

@@ -7,6 +7,3 @@
 :hidden:
 socialcards
 ```
-<!-- 
-```{image} _static/images/
-``` -->

noxfile.py

@@ -6,6 +6,7 @@
 
 @nox.session
 def docs(session):
+    """Build the documentation. Use `-- live` to build with a live server."""
     session.install("-e", ".")
     session.install("-r", "docs/requirements.txt")
     if "live" in session.posargs:
@@ -14,3 +15,10 @@ def docs(session):
         session.run(*split("sphinx-autobuild -b html docs/source docs/build/html"))
     else:
         session.run(*split("sphinx-build -nW --keep-going -b html docs/source docs/build/html"))
+
+
+@nox.session
+def test(session):
+    """Run the test suite."""
+    session.install("-e", ".")
+    session.run(*(["pytest"] + session.posargs))

sphinxext/opengraph/__init__.py

@@ -134,13 +134,21 @@ def get_tags(
         image_url = fields["og:image"]
         ogp_use_first_image = False
         ogp_image_alt = fields.get("og:image:alt")
-        fields.pop("og:image", None)
-    # This will only be False if the user explicitly sets it
-    elif app.config.ogp_social_cards.get("enable") is not False:
-        # Set up our configuration and update it with new information
-        config_social = DEFAULT_SOCIAL_CONFIG.copy()
-        config_social.update(app.config.ogp_social_cards)
+        fields.pop("og:image", None)  
+    else:
+        image_url = config["ogp_image"]
+        ogp_use_first_image = config["ogp_use_first_image"]
+        ogp_image_alt = fields.get("og:image:alt", config["ogp_image_alt"])
+
+    # Decide whether to add social media card images for each page.
+    # Only do this as a fallback if the user hasn't given any configuration
+    # to add other images.
+    config_social = DEFAULT_SOCIAL_CONFIG.copy()
+    social_card_user_options = app.config.ogp_social_cards or {}
+    config_social.update(social_card_user_options)
 
+    # This will only be False if the user explicitly sets it
+    if not (image_url or ogp_use_first_image) and config_social.get("enable") is not False:
         # Description
         description_max_length = config_social.get(
             "description_max_length", DEFAULT_DESCRIPTION_LENGTH_SOCIAL_CARDS - 3
@@ -170,16 +178,17 @@ def get_tags(
             url_text,
             context["pagename"]
         )
-        ogp_image_alt = description
         ogp_use_first_image = False
 
+        # Alt text is taken from description unless given
+        if "og:image:alt" in fields:
+            ogp_image_alt = fields.get("og:image:alt")
+        else:
+            ogp_image_alt = description
+
         # Link the image in our page metadata
         url = app.config.ogp_site_url.strip("/")
         image_url = f"{url}/{image_path}"
-    else:
-        image_url = config["ogp_image"]
-        ogp_use_first_image = config["ogp_use_first_image"]
-        ogp_image_alt = fields.get("og:image:alt", config["ogp_image_alt"])
 
     fields.pop("og:image:alt", None)
 

tests/test_options.py

@@ -92,6 +92,20 @@ def test_image_alt(og_meta_tags):
     assert get_tag_content(og_meta_tags, "image:alt") == "Example's Docs!"
 
 
+@pytest.mark.sphinx("html", testroot="simple")
+def test_image_social_cards(og_meta_tags):
+    """Social cards should automatically be added if no og:image is given."""
+    # Asserting `in` instead of `==` because of the hash that is generated
+    assert (
+        "http://example.org/en/latest/_images/social_previews/summary_index" in
+        get_tag_content(og_meta_tags, "image")
+    )
+    # Image alt text should be taken from page content.
+    assert (
+        "Lorem ipsum dolor sit amet, consectetur adipiscing elit." in
+        get_tag_content(og_meta_tags, "image:alt")
+    )
+
 @pytest.mark.sphinx("html", testroot="type")
 def test_type(og_meta_tags):
     assert get_tag_content(og_meta_tags, "type") == "article"