devaci 0.1.0__tar.gz → 1.0.1__tar.gz

{devaci-0.1.0 → devaci-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: devaci
-Version: 0.1.0
+Version: 1.0.1
 Summary: Python library that generates Cisco ACI configuration and optionally pushes it to an APIC controller via Cisco's official Cobra SDK.
 Project-URL: Homepage, https://github.com/cocuni80/devaci
 Project-URL: Repository, https://github.com/cocuni80/devaci

{devaci-0.1.0 → devaci-1.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "devaci"
-version = "0.1.0"
+version = "1.0.1"
 description = "Python library that generates Cisco ACI configuration and optionally pushes it to an APIC controller via Cisco's official Cobra SDK."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -62,6 +62,13 @@ exclude = ["src/devaci/_legacy"]
 testpaths = ["tests"]
 addopts = "-ra"
 
+[tool.coverage.run]
+source = ["devaci"]
+omit = ["*/_legacy/*"]
+
+[tool.coverage.report]
+show_missing = true
+
 [tool.ruff]
 target-version = "py310"
 line-length = 100

{devaci-0.1.0 → devaci-1.0.1}/src/devaci/__init__.py

@@ -1,11 +1,16 @@
 """devaci - Generate and push Cisco ACI configuration via the Cobra SDK."""
 
+from importlib.metadata import PackageNotFoundError, version
+
 from devaci.cobra import CobraBuilder
 from devaci.deploy import DeployClass
 from devaci.exceptions import CobraError, DataError, DeployError, DevaciError, JinjaError
 from devaci.jinja import JinjaRenderer
 
-__version__ = "0.1.0"
+try:
+    __version__ = version("devaci")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
 
 __all__ = [
     "CobraBuilder",

{devaci-0.1.0 → devaci-1.0.1}/src/devaci/cobra/__init__.py

@@ -40,12 +40,16 @@ class CobraBuilder:
 
     @property
     def xml(self) -> str | None:
-        """Return the rendered XML payload."""
+        """Return the rendered XML payload, or None when the config is empty."""
+        if not self.config.configMos:
+            return None
         return cast(str | None, self.config.xmldata)
 
     @property
     def json(self) -> Any:
-        """Return the rendered JSON payload as a dict."""
+        """Return the rendered JSON payload as a dict, or None when the config is empty."""
+        if not self.config.configMos:
+            return None
         return json.loads(self.config.data)
 
     def render(self, output: dict[str, Any]) -> CobraResult:

{devaci-0.1.0 → devaci-1.0.1}/src/devaci/deploy.py

@@ -120,7 +120,7 @@ class DeployClass:
 
         try:
             renderer = JinjaRenderer()
-            output = renderer.render(content, name=name, **self._variables)
+            output = renderer.render(content, **self._variables)
             logs.append(f"[Jinja]: Template {name} was rendered successfully.")
             logger.info(logs[-1])
 

{devaci-0.1.0 → devaci-1.0.1}/src/devaci/jinja.py

@@ -26,7 +26,7 @@ class JinjaRenderer:
         self._env.filters["range"] = range_filter
         self._env.filters["nan"] = nan_filter
 
-    def render(self, template: str, name: str | None = None, **variables: Any) -> dict[str, Any]:
+    def render(self, template: str, **variables: Any) -> dict[str, Any]:
         """Render ``template`` with ``variables`` and parse the YAML output."""
         try:
             rendered = self._env.from_string(template).render(**variables)
@@ -36,7 +36,5 @@ class JinjaRenderer:
 
         output = load_yaml(rendered)
         if not isinstance(output, dict):
-            raise JinjaError(
-                f"[Jinja] -> [ConfigError]: Template {name} did not produce a mapping."
-            )
+            raise JinjaError("[Jinja] -> [ConfigError]: Template did not produce a mapping.")
         return output

{devaci-0.1.0 → devaci-1.0.1}/src/devaci/results.py

@@ -5,7 +5,7 @@ from __future__ import annotations
 import json
 from dataclasses import dataclass, field
 from datetime import datetime
-from typing import Any
+from typing import Any, cast
 
 
 def _timestamp() -> str:
@@ -44,11 +44,15 @@ class CobraResult(Result):
 
     @property
     def xml(self) -> str | None:
-        return self.config.xmldata if self.config is not None else None
+        if self.config is None or not self.config.configMos:
+            return None
+        return cast(str | None, self.config.xmldata)
 
     @property
     def json(self) -> Any:
-        return json.loads(self.config.data) if self.config is not None else None
+        if self.config is None or not self.config.configMos:
+            return None
+        return json.loads(self.config.data)
 
     def to_dict(self) -> dict[str, Any]:
         data = super().to_dict()

devaci-1.0.1/tests/test_cobra.py

@@ -0,0 +1,59 @@
+import cobra.mit.request
+import cobra.model.coop
+
+from devaci.cobra import CobraBuilder
+from devaci.cobra.base import not_nan_str
+from devaci.cobra.registry import REGISTRY
+
+
+def test_cobra_model_coop_available():
+    assert hasattr(cobra.model.coop, "Pol")
+
+
+def test_cobra_mit_request_available():
+    assert hasattr(cobra.mit.request, "ConfigRequest")
+
+
+def test_not_nan_str():
+    assert not_nan_str({"name": "ok"}, ["name"]) is True
+    assert not_nan_str({"name": None}, ["name"]) is False
+    assert not_nan_str({"name": ""}, ["name"]) is False
+    assert not_nan_str({"name": "  "}, ["name"]) is False
+    assert not_nan_str({"name": "nan"}, ["name"]) is False
+    assert not_nan_str({"name": " NaN "}, ["name"]) is False
+    assert not_nan_str({"name": float("nan")}, ["name"]) is False
+    assert not_nan_str({}, ["name"]) is True
+    assert not_nan_str({"other": "x"}, ["name"]) is True
+
+
+def test_cobra_builder_renders_tenant():
+    builder = CobraBuilder()
+    result = builder.render({"fvTenant": [{"name": "acme"}]})
+    assert result.success is True
+    assert builder.xml is not None
+    assert "acme" in builder.xml
+
+
+def test_cobra_builder_unknown_key():
+    builder = CobraBuilder()
+    result = builder.render({"unknownKey": [{"x": 1}]})
+    assert result.success is False
+    assert any("does not exist" in msg for msg in result.log)
+
+
+def test_cobra_builder_empty_output():
+    builder = CobraBuilder()
+    result = builder.render({})
+    assert result.success is False
+    assert any("No object was found" in msg for msg in result.log)
+
+
+def test_cobra_builder_skips_empty_values():
+    builder = CobraBuilder()
+    result = builder.render({"fvTenant": []})
+    assert result.success is False
+
+
+def test_registry_handlers_are_callable():
+    assert "fvTenant" in REGISTRY
+    assert all(callable(handler) for handler in REGISTRY.values())

devaci-1.0.1/tests/test_data.py

@@ -0,0 +1,56 @@
+import pandas as pd
+import pytest
+
+from devaci.data import apply_filter, load_csv, load_xlsx
+from devaci.exceptions import DataError
+
+
+def _df() -> pd.DataFrame:
+    return pd.DataFrame({"tag": ["a", "b", None, ""], "name": ["x", "y", "z", "w"]})
+
+
+def test_apply_filter_no_filters():
+    assert len(apply_filter(_df(), "tag")) == 4
+
+
+def test_apply_filter_with_filters():
+    assert apply_filter(_df(), "tag", ["a"]) == [{"tag": "a", "name": "x"}]
+
+
+def test_apply_filter_missing_column():
+    assert apply_filter(_df(), "missing", ["a"]) == []
+
+
+def test_apply_filter_empty_filters():
+    assert len(apply_filter(_df(), "tag", [])) == 4
+
+
+def test_load_csv(tmp_path):
+    path = tmp_path / "tenants.csv"
+    pd.DataFrame({"tag": ["a", "b"], "name": ["x", "y"]}).to_csv(path, index=False)
+
+    assert load_csv(path, filters=["a"], by="tag") == {
+        "tenants": [{"tag": "a", "name": "x"}]
+    }
+
+
+def test_load_xlsx_with_filters_sheet(tmp_path):
+    path = tmp_path / "data.xlsx"
+    with pd.ExcelWriter(path) as writer:
+        pd.DataFrame({"tag": ["a", "b"], "name": ["x", "y"]}).to_excel(
+            writer, sheet_name="tenants", index=False
+        )
+        pd.DataFrame({"name": ["a"], "enabled": [True]}).to_excel(
+            writer, sheet_name="filters", index=False
+        )
+
+    result = load_xlsx(path, by="tag", filters_source_sheet="filters")
+    assert result["tenants"] == [{"tag": "a", "name": "x"}]
+
+
+def test_load_xlsx_missing_filters_sheet(tmp_path):
+    path = tmp_path / "data.xlsx"
+    pd.DataFrame({"tag": ["a"], "name": ["x"]}).to_excel(path, sheet_name="tenants", index=False)
+
+    with pytest.raises(DataError):
+        load_xlsx(path, by="tag", filters_source_sheet="nope")

devaci-1.0.1/tests/test_deploy.py

@@ -0,0 +1,98 @@
+import pandas as pd
+
+from devaci import DeployClass
+
+
+def test_deploy_in_memory_template(tmp_path):
+    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
+    aci.template = ("fvTenant:\n  - name: acme\n", "tenant.j2")
+    aci.deploy()
+
+    assert "acme" in aci.config
+    assert aci.results[0]["success"] is True
+
+
+def test_deploy_from_xlsx(tmp_path):
+    pd.DataFrame([{"name": "acme"}, {"name": "beta"}]).to_excel(
+        tmp_path / "data.xlsx", sheet_name="tenants", index=False
+    )
+
+    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
+    aci.xlsx = "data.xlsx"
+    aci.template = (
+        "fvTenant:\n{% for row in tenants %}\n  - name: {{ row.name }}\n{% endfor %}\n",
+        "tenant.j2",
+    )
+    aci.deploy()
+
+    config = aci.config
+    assert "acme" in config
+    assert "beta" in config
+
+
+def test_deploy_multiple_templates(tmp_path):
+    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
+    aci.template = [
+        ("fvTenant:\n  - name: one\n", "one.j2"),
+        ("fvTenant:\n  - name: two\n", "two.j2"),
+    ]
+    aci.deploy()
+
+    assert len(aci.results) == 2
+    assert all(result["success"] for result in aci.results)
+
+
+def test_deploy_template_from_file(tmp_path):
+    (tmp_path / "tenant.j2").write_text("fvTenant:\n  - name: acme\n", encoding="utf-8")
+
+    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
+    aci.template = "tenant.j2"
+    aci.deploy()
+
+    assert "acme" in aci.config
+
+
+def test_deploy_from_csv(tmp_path):
+    pd.DataFrame({"tag": ["a", "b"], "name": ["acme", "beta"]}).to_csv(
+        tmp_path / "tenants.csv", index=False
+    )
+
+    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
+    aci.csv = "tenants.csv"
+    aci.template = (
+        "fvTenant:\n{% for row in tenants %}\n  - name: {{ row.name }}\n{% endfor %}\n",
+        "tenant.j2",
+    )
+    aci.deploy()
+
+    config = aci.config
+    assert "acme" in config
+    assert "beta" in config
+
+
+def test_deploy_save_output(tmp_path):
+    aci = DeployClass(
+        testing=True,
+        working_folder=tmp_path,
+        logging=False,
+        file_output="scripts/config",
+    )
+    aci.template = ("fvTenant:\n  - name: acme\n", "tenant.j2")
+    aci.deploy()
+
+    output = tmp_path / "scripts" / "config.xml"
+    assert output.exists()
+    assert "acme" in output.read_text(encoding="utf-8")
+
+
+def test_deploy_variable_named_name(tmp_path):
+    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
+    aci.variables = {"name": "test", "descr": "Test tenant"}
+    aci.template = (
+        "fvTenant:\n  - name: {{ name }}\n    descr: {{ descr }}\n",
+        "tenant.j2",
+    )
+    aci.deploy()
+
+    assert aci.results[0]["success"] is True
+    assert "test" in aci.config

devaci-1.0.1/tests/test_devaci.py

@@ -0,0 +1,7 @@
+from importlib.metadata import version
+
+import devaci
+
+
+def test_version():
+    assert devaci.__version__ == version("devaci")

devaci-1.0.1/tests/test_filters.py

@@ -0,0 +1,65 @@
+import math
+
+from devaci.filters import (
+    load_yaml,
+    nan_filter,
+    range_filter,
+    replace_str_nan_with_empty,
+    split_filter,
+    str_to_bool,
+)
+
+
+def test_split_filter():
+    assert split_filter("a,b,c") == ["a", "b", "c"]
+
+
+def test_split_filter_custom_delimiter():
+    assert split_filter("a;b", delimiter=";") == ["a", "b"]
+
+
+def test_range_filter():
+    assert range_filter("1-3,5") == [1, 2, 3, 5]
+
+
+def test_range_filter_single():
+    assert range_filter("7") == [7]
+
+
+def test_nan_filter():
+    assert nan_filter("nan") is False
+    assert nan_filter("value") is True
+
+
+def test_str_to_bool():
+    assert str_to_bool(True) is True
+    assert str_to_bool("yes") is True
+    assert str_to_bool("1") is True
+    assert str_to_bool("false") is False
+    assert str_to_bool("0") is False
+
+
+def test_replace_str_nan_with_empty():
+    assert replace_str_nan_with_empty("nan") == ""
+    assert replace_str_nan_with_empty(" NaN ") == ""
+    assert replace_str_nan_with_empty("value") == "value"
+    assert replace_str_nan_with_empty(42) == 42
+    assert replace_str_nan_with_empty({"a": "nan", "b": {"c": "NaN"}}) == {
+        "a": "",
+        "b": {"c": ""},
+    }
+    assert replace_str_nan_with_empty(["nan", 1, None]) == ["", 1, None]
+
+
+def test_replace_str_nan_keeps_real_nan():
+    assert math.isnan(replace_str_nan_with_empty(float("nan")))
+
+
+def test_load_yaml_no_coercion():
+    result = load_yaml("key: 123\nflag: true\nratio: 1.5\nmissing: nan\n")
+    assert result == {"key": "123", "flag": "true", "ratio": "1.5", "missing": ""}
+
+
+def test_load_yaml_nested():
+    result = load_yaml("nested:\n  - 1\n  - false\n")
+    assert result == {"nested": ["1", "false"]}

devaci-1.0.1/tests/test_jinja.py

@@ -0,0 +1,34 @@
+import pytest
+
+from devaci.exceptions import JinjaError
+from devaci.jinja import JinjaRenderer
+
+
+def test_render_mapping():
+    renderer = JinjaRenderer()
+    out = renderer.render("fvTenant:\n  - name: acme\n")
+    assert out == {"fvTenant": [{"name": "acme"}]}
+
+
+def test_render_with_variables():
+    renderer = JinjaRenderer()
+    out = renderer.render("fvTenant:\n  - name: {{ tenant }}\n", tenant="acme")
+    assert out == {"fvTenant": [{"name": "acme"}]}
+
+
+def test_render_variable_named_name():
+    renderer = JinjaRenderer()
+    out = renderer.render("fvTenant:\n  - name: {{ name }}\n", name="acme")
+    assert out == {"fvTenant": [{"name": "acme"}]}
+
+
+def test_render_syntax_error():
+    renderer = JinjaRenderer()
+    with pytest.raises(JinjaError):
+        renderer.render("{% if %}")
+
+
+def test_render_non_mapping():
+    renderer = JinjaRenderer()
+    with pytest.raises(JinjaError):
+        renderer.render("- a\n- b\n")

devaci-1.0.1/tests/test_results.py

@@ -0,0 +1,38 @@
+from dataclasses import FrozenInstanceError
+
+import pytest
+
+from devaci.results import CobraResult, DeployResult, JinjaResult, Result
+
+
+def test_result_to_dict():
+    result = Result(success=True, log=["a"], date="d")
+    assert result.to_dict() == {"date": "d", "success": True, "log": ["a"]}
+
+
+def test_deploy_result_to_dict():
+    result = DeployResult(success=False, log=[], date="d", path="/p", name="n")
+    assert result.to_dict() == {
+        "date": "d",
+        "success": False,
+        "log": [],
+        "path": "/p",
+        "name": "n",
+    }
+
+
+def test_jinja_result_to_dict():
+    result = JinjaResult(success=True, log=[], date="d", output={"a": 1})
+    assert result.to_dict() == {"date": "d", "success": True, "log": [], "output": {"a": 1}}
+
+
+def test_cobra_result_none_config():
+    result = CobraResult(config=None)
+    assert result.xml is None
+    assert result.json is None
+
+
+def test_results_are_frozen():
+    result = Result()
+    with pytest.raises(FrozenInstanceError):
+        result.success = True

devaci-0.1.0/tests/test.py

@@ -1,22 +0,0 @@
-from pathlib import Path
-
-from devaci import DeployClass
-
-ROOT = Path(__file__).parent / "testing/working"
-
-OC = "OC164431"
-
-SETTINGS = {
-    "testing": True,
-    "filters_source_sheet": "OCs",
-    "file_output": f"scripts/{OC}_config",
-    "logging_output": f"logs/{OC}_logging",
-    "working_folder": ROOT,
-}
-
-
-if __name__ == "__main__":
-    aci = DeployClass(**SETTINGS)
-    aci.xlsx = "IBKACI6_v2.2_jriveros.xlsx"
-    aci.template = "template_v2.3.j2"
-    aci.deploy()

devaci-0.1.0/tests/test_cobra.py

@@ -1,10 +0,0 @@
-import cobra.mit.request
-import cobra.model.coop
-
-
-def test_cobra_model_coop_available():
-    assert hasattr(cobra.model.coop, "Pol")
-
-
-def test_cobra_mit_request_available():
-    assert hasattr(cobra.mit.request, "ConfigRequest")

devaci-0.1.0/tests/test_deploy.py

@@ -1,30 +0,0 @@
-import pandas as pd
-
-from devaci import DeployClass
-
-
-def test_deploy_in_memory_template(tmp_path):
-    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
-    aci.template = ("fvTenant:\n  - name: acme\n", "tenant.j2")
-    aci.deploy()
-
-    assert "acme" in aci.config
-    assert aci.results[0]["success"] is True
-
-
-def test_deploy_from_xlsx(tmp_path):
-    pd.DataFrame([{"name": "acme"}, {"name": "beta"}]).to_excel(
-        tmp_path / "data.xlsx", sheet_name="tenants", index=False
-    )
-
-    aci = DeployClass(testing=True, working_folder=tmp_path, logging=False)
-    aci.xlsx = "data.xlsx"
-    aci.template = (
-        "fvTenant:\n{% for row in tenants %}\n  - name: {{ row.name }}\n{% endfor %}\n",
-        "tenant.j2",
-    )
-    aci.deploy()
-
-    config = aci.config
-    assert "acme" in config
-    assert "beta" in config

devaci-0.1.0/tests/test_devaci.py

@@ -1,5 +0,0 @@
-import devaci
-
-
-def test_version():
-    assert devaci.__version__ == "0.1.0"

devaci-0.1.0/tests/test_outputs.py

@@ -1,48 +0,0 @@
-import json
-import xml.dom.minidom
-from pathlib import Path
-
-import pytest
-
-from devaci import DeployClass
-
-REPO = Path(__file__).resolve().parent.parent
-XLSX = REPO / "data" / "IBKACI6_v2.2_jriveros.xlsx"
-TEMPLATE = REPO / "data" / "templates" / "generic_v2.3.j2"
-
-OC = "OC180460"
-
-SETTINGS = {
-    "testing": True,
-    "filters_source_sheet": "OCs",
-    "file_output": f"outputs/scripts/{OC}_config",
-    "logging_output": f"outputs/logs/{OC}_logging",
-}
-
-
-@pytest.mark.skipif(not XLSX.exists() or not TEMPLATE.exists(), reason="private data not available")
-def test_deploy_outputs():
-    aci = DeployClass(working_folder=REPO, **SETTINGS)
-    aci.xlsx = "data/IBKACI6_v2.2_jriveros.xlsx"
-    aci.template = "data/templates/generic_v2.3.j2"
-    aci.deploy()
-
-    # 1. Resultado exitoso
-    assert aci.results[0]["success"] is True
-
-    # 2. XML de salida: existe, no vacio, valido y filtrado
-    xml_path = REPO / f"outputs/scripts/{OC}_config.xml"
-    assert xml_path.exists()
-    xml_text = xml_path.read_text(encoding="utf-8")
-    assert xml_text.strip()
-    xml.dom.minidom.parseString(xml_text)
-    assert "Backend_AP" in xml_text
-    assert 'name="Interbank"' in xml_text
-    assert "OC152069" not in xml_text
-
-    # 3. Logging JSON: lista valida con entradas
-    log_path = REPO / f"outputs/logs/{OC}_logging.json"
-    assert log_path.exists()
-    history = json.loads(log_path.read_text(encoding="utf-8"))
-    assert isinstance(history, list) and history
-    assert all(isinstance(e, dict) and "success" in e and "log" in e for e in history)