Fix extra CSS files in Swagger UI iframe bug (#7)

Author: blueswen

mkdocs_swagger_ui_tag/plugin.py

@@ -128,10 +128,10 @@ def on_post_page(self, output, page, config, **kwargs):
             loader=FileSystemLoader(os.path.join(base_path, "swagger-ui"))
         )
         template = env.get_template("swagger.html")
-        extra_css_files = map(
-            lambda f: os.path.basename(f),
-            filter(lambda f: os.path.exists(f), self.config["extra_css"]),
-        )
+        extra_css_files = list(map(
+            lambda f: utils.get_relative_url(utils.normalize_url(f), page.url),
+            self.config["extra_css"],
+        ))
 
         page_dir = os.path.dirname(
             os.path.join(config["site_dir"], urlunquote(page.url))
@@ -376,17 +376,6 @@ def on_post_build(self, config, **kwargs):
                 os.path.join(css_path, file_name),
             )
 
-        for extra_css_file in self.config["extra_css"]:
-            extra_css_file_path = os.path.normpath(extra_css_file)
-            if not os.path.exists(extra_css_file_path):
-                logging.warning(f"extra_css: {extra_css_file} dose not exist")
-            else:
-                file_name = os.path.basename(extra_css_file_path)
-                utils.copy_file(
-                    os.path.join(extra_css_file_path),
-                    os.path.join(css_path, file_name),
-                )
-
         js_path = os.path.join(output_base_path, "javascripts")
         for file_name in os.listdir(
             os.path.join(base_path, "swagger-ui", "javascripts")

mkdocs_swagger_ui_tag/swagger-ui/swagger.html

@@ -7,7 +7,7 @@
   <link rel="stylesheet" type="text/css" href="{{ css_dir }}swagger-ui.css" />
   <link rel="stylesheet" type="text/css" id="slate-css" media="none" href="{{ css_dir }}swagger-ui-dark.css" />
   {% for css_file in extra_css_files %}
-  <link rel="stylesheet" type="text/css" href="{{ css_dir }}{{ css_file }}" />
+  <link rel="stylesheet" type="text/css" href="{{ css_file }}" />
   {% endfor %}
 </head>
 

tests/fixtures/docs/extra-1.css …ts/fixtures/docs/stylesheets/extra-1.csstests/fixtures/docs/extra-1.css renamed to tests/fixtures/docs/stylesheets/extra-1.css tests/fixtures/docs/extra-1.css renamed to tests/fixtures/docs/stylesheets/extra-1.css

@@ -13,7 +13,6 @@ plugins:
             - get
         validatorUrl: "https://validator.swagger.io/validator"
         extra_css:
-            - not_exist/extra.css
-            - docs/extra-1.css
-            - docs/sub_dir/extra-2.css
+            - stylesheets/extra-1.css
+            - stylesheets/sub_dir/extra-2.css
 

tests/fixtures/docs/sub_dir/extra-2.css …res/docs/stylesheets/sub_dir/extra-2.csstests/fixtures/docs/sub_dir/extra-2.css renamed to tests/fixtures/docs/stylesheets/sub_dir/extra-2.css tests/fixtures/docs/sub_dir/extra-2.css renamed to tests/fixtures/docs/stylesheets/sub_dir/extra-2.css

@@ -492,10 +492,28 @@ def test_plugin_options(tmp_path):
         r'"supportedSubmitMethods": \[(\n|\r)        "get"(\n|\r)    \]', iframe_content
     )
 
-    assert (testproject_path / "site/assets/stylesheets/extra-1.css").exists()
-    assert (testproject_path / "site/assets/stylesheets/extra-2.css").exists()
-    assert "assets/stylesheets/extra-1.css" in iframe_content
-    assert "assets/stylesheets/extra-2.css" in iframe_content
+    assert (testproject_path / "site/stylesheets/extra-1.css").exists()
+    assert (testproject_path / "site/stylesheets/sub_dir/extra-2.css").exists()
+    assert '"stylesheets/extra-1.css"' in iframe_content
+    assert '"stylesheets/sub_dir/extra-2.css"' in iframe_content
+
+    file = testproject_path / "site/sub_dir/page_in_sub_dir/index.html"
+    contents = file.read_text(encoding="utf8")
+
+    iframe_content_list = validate_iframe(contents, file.parent)
+    assert len(iframe_content_list) == 1
+    iframe_content = iframe_content_list[0]
+    assert '"../../stylesheets/extra-1.css"' in iframe_content
+    assert '"../../stylesheets/sub_dir/extra-2.css"' in iframe_content
+
+    file = testproject_path / "site/multiple/index.html"
+    contents = file.read_text(encoding="utf8")
+
+    iframe_content_list = validate_iframe(contents, file.parent)
+    assert len(iframe_content_list) == 3
+    for iframe_content in iframe_content_list:
+        assert '"../stylesheets/extra-1.css"' in iframe_content
+        assert '"../stylesheets/sub_dir/extra-2.css"' in iframe_content
 
 
 def test_attribute_options(tmp_path):