Bugifx and tests for external_need handling

* Calculated link gets .html file extension after docname
* Tests are updated to really check data

Fixes #137

Author: danwos

sphinxcontrib/needs/api/need.py

@@ -441,9 +441,6 @@ def add_external_need(
     kwargs["external_css"] = external_css
 
     return add_need(app=app, **kwargs)
-    # need_type=need_type, title=title, id=id,
-    # content=content, status=status, tags=tags, links_string=links_string,
-    # is_external=True, external_url=external_url, external_css=external_css)
 
 
 def _prepare_template(app, needs_info, template_key):

sphinxcontrib/needs/external_needs.py

@@ -12,6 +12,9 @@
 
 def load_external_needs(app, env, _docname):
     for source in app.config.needs_external_needs:
+        if source["base_url"].endswith("/"):
+            source["base_url"] = source["base_url"][:-1]
+
         log.info(f'Loading external needs from {source["json_url"]}')
 
         s = requests.Session()
@@ -53,7 +56,7 @@ def load_external_needs(app, env, _docname):
             need_params["need_type"] = need["type"]
             need_params["id"] = f'{prefix}{need["id"]}'
             need_params["external_css"] = source.get("css_class", None)
-            need_params["external_url"] = f'{source["base_url"]}/{need.get("docname", "__error__")}#{need["id"]}'
+            need_params["external_url"] = f'{source["base_url"]}/{need.get("docname", "__error__")}.html#{need["id"]}'
             need_params["content"] = need["description"]
             need_params["links"] = need.get("links", [])
             need_params["tags"] = ",".join(need.get("tags", []))

sphinxcontrib/needs/utils.py

@@ -45,6 +45,8 @@
     # "parent_needs",
     "parent_need",
     # "child_needs",
+    "is_external",
+    "external_css",
 ]
 
 

tests/doc_test/external_doc/conf.py

@@ -46,7 +46,10 @@
 test_json = os.path.join(test_dir, "needs_test_small.json")
 # test_json = os.path.join(test_dir, 'needs_test_invalid.json')
 
-needs_external_needs = [{"base_url": f"file://{test_dir}", "json_url": f"file://{test_json}", "id_prefix": "ext_"}]
+# needs_external_needs = [{"base_url": f"file://{test_dir}", "json_url": f"file://{test_json}", "id_prefix": "ext_"}]
+needs_external_needs = [
+    {"base_url": "http://my_company.com/docs/v1/", "json_url": f"file://{test_json}", "id_prefix": "ext_"}
+]
 
 plantuml = "java -jar %s" % os.path.join(os.path.dirname(__file__), "..", "utils", "plantuml.1.2021.5.jar")
 plantuml_output_format = "svg"

tests/test_external.py

@@ -1,3 +1,4 @@
+import json
 from pathlib import Path
 
 from sphinx_testing import with_app
@@ -6,10 +7,19 @@
 @with_app(buildername="html", srcdir="doc_test/external_doc")  # , warningiserror=True)
 def test_external_html(app, status, warning):
     app.build()
-    Path(app.outdir, "index.html").read_text()
+    html = Path(app.outdir, "index.html").read_text()
+    assert (
+        '<a class="external_link reference external" href="http://my_company.com/docs/v1/index.html#TEST_02">'
+        "EXT_TEST_02</a>" in html
+    )
 
 
 @with_app(buildername="needs", srcdir="doc_test/external_doc")  # , warningiserror=True)
 def test_external_json(app, status, warning):
     app.build()
-    Path(app.outdir, "needs.json").read_text()
+    json_data = Path(app.outdir, "needs.json").read_text()
+    needs = json.loads(json_data)
+    external_need = needs["versions"]["1.0"]["needs"]["EXT_TEST_01"]
+    assert external_need["external_url"] == "http://my_company.com/docs/v1/index.html#TEST_01"
+    assert external_need["external_css"] == "external_link"
+    assert external_need["is_external"] is True