certgraph 0.2.0__tar.gz → 0.3.0__tar.gz

{certgraph-0.2.0 → certgraph-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: certgraph
-Version: 0.2.0
+Version: 0.3.0
 Summary: Utility for exploring and mapping X509 certificate chains.
 Author: Chris Adshead
 License: MIT License

{certgraph-0.2.0 → certgraph-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "certgraph"
-version = "0.2.0"
+version = "0.3.0"
 description = "Utility for exploring and mapping X509 certificate chains."
 readme = "README.md"
 requires-python = ">=3.12"

{certgraph-0.2.0 → certgraph-0.3.0}/src/certgraph/certgraph.py

@@ -5,7 +5,7 @@ from rapidfuzz import fuzz
 
 
 class certgraph:
-    """Class for creating and exploring directed graphs of X509 certificates."""
+    """Class for creating and exploring directed graphs of X.509 certificates."""
 
     def __init__(self) -> None:
         """Initialise an empty certgraph object."""
@@ -88,25 +88,27 @@ class certgraph:
         """
         return [f"{edge[0][:8]} -> {edge[1][:8]}" for edge in self._graph.edges()]
 
-    def export_dot(self, format: str = "svg") -> str:
-        """Function to export the current certificate digraph in the dot language. NOTE: Still in progress."""
-        allowed_types = ["svg", "png"]
-
-        if format not in allowed_types:
-            raise ValueError(
-                f"Cannot export dot graph of type {format} - must be one of {allowed_types}"
-            )
+    def export_dot(self) -> str:
+        """
+        Export the current certificate digraph in the dot language.
 
+        Returns:
+            The certificate digraph rendered as a dot language string.
+        """
         dot_graph = nx.DiGraph()
 
         for fingerprint, data in self._graph.nodes(data=True):
-            label = data["certificate"].subject.rfc4514_string()
-            dot_graph.add_node(fingerprint, label=label)
-        dot_graph.add_edges_from(self._graph.edges())
+            cert: x509.Certificate = data["certificate"]
+            validity_time_str = f"{cert.not_valid_before_utc.isoformat()} → {cert.not_valid_after_utc.isoformat()}"
+
+            label = f"DN: {cert.subject.rfc4514_string()}"
+            label += f"\nValid: {validity_time_str}"
 
-        nx.drawing.nx_pydot.write_dot(dot_graph, "./test_out.dot")
+            dot_graph.add_node(fingerprint, label=label, shape="box")
+
+        dot_graph.add_edges_from(self._graph.edges())
 
-        return "dot"
+        return nx.drawing.nx_pydot.to_pydot(dot_graph).to_string()
 
     def clear(self) -> certgraph:
         """

{certgraph-0.2.0 → certgraph-0.3.0}/src/certgraph.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: certgraph
-Version: 0.2.0
+Version: 0.3.0
 Summary: Utility for exploring and mapping X509 certificate chains.
 Author: Chris Adshead
 License: MIT License

certgraph-0.3.0/tests/test_export_dot.py

@@ -0,0 +1,54 @@
+def test_export_dot_returns_string(graph):
+    assert isinstance(graph.export_dot(), str)
+
+
+def test_export_dot_empty_graph_has_no_edges(graph):
+    dot = graph.export_dot()
+    assert "digraph" in dot
+    assert "->" not in dot
+
+
+def test_export_dot_includes_node_labels(graph, self_signed_cert):
+    graph.import_certificates(self_signed_cert)
+    dn = self_signed_cert.subject.rfc4514_string()
+
+    dot = graph.export_dot()
+
+    assert f"DN: {dn}" in dot
+
+
+def test_export_dot_includes_validity_period(graph, self_signed_cert):
+    graph.import_certificates(self_signed_cert)
+    not_before = self_signed_cert.not_valid_before_utc.isoformat()
+    not_after = self_signed_cert.not_valid_after_utc.isoformat()
+
+    dot = graph.export_dot()
+
+    # joined with an arrow character rather than '->', to avoid being confused with edge syntax
+    assert f"Valid: {not_before} → {not_after}" in dot
+
+
+def test_export_dot_node_shape_is_box(graph, self_signed_cert):
+    graph.import_certificates(self_signed_cert)
+
+    dot = graph.export_dot()
+
+    assert "shape=box" in dot
+
+
+def test_export_dot_includes_edges(graph, chain_certs):
+    graph.import_certificates(chain_certs)
+
+    dot = graph.export_dot()
+
+    # one self-loop for the root, plus one edge per subsequent certificate
+    assert dot.count("->") == len(chain_certs)
+
+
+def test_export_dot_does_not_write_file(graph, self_signed_cert, tmp_path, monkeypatch):
+    monkeypatch.chdir(tmp_path)
+    graph.import_certificates(self_signed_cert)
+
+    graph.export_dot()
+
+    assert not (tmp_path / "test_out.dot").exists()

certgraph-0.2.0/tests/test_export_dot.py

@@ -1,9 +0,0 @@
-import pytest
-
-# export_dot()'s actual output generation is still rough and not covered here.
-# Only the argument validation, which happens before anything is written, is tested.
-
-
-def test_export_dot_rejects_invalid_format(graph):
-    with pytest.raises(ValueError):
-        graph.export_dot(format="jpeg")