annet 0.7__py3-none-any.whl → 0.8__py3-none-any.whl

annet/annlib/jsontools.py

@@ -87,3 +87,26 @@ def apply_patch(content: Optional[bytes], patch_bytes: bytes) -> bytes:
 
     new_contents = format_json(new_doc, stable=True).encode()
     return new_contents
+
+
+def apply_acl_filters(content: Dict[str, Any], filters: List[str]) -> Dict[str, Any]:
+    result = {}
+    for f in filters:
+        pointer = jsonpointer.JsonPointer(f)
+
+        try:
+            part = pointer.get(copy.deepcopy(content))
+
+            sub_tree = result
+            for i in pointer.get_parts():
+                if i not in sub_tree:
+                    sub_tree[i] = {}
+                sub_tree = sub_tree[i]
+
+            patch = jsonpatch.JsonPatch([{"op": "add", "path": f, "value": part}])
+            result = patch.apply(result)
+        except jsonpointer.JsonPointerException:
+            # no value found in new_fragment by the pointer, skip the ACL item
+            continue
+
+    return result

annet/gen.py

@@ -182,6 +182,7 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
         if not ctx.args.no_acl:
             acl_rules = generators.compile_acl_text(res.acl_text(), device.hw.vendor)
             old = (old and patching.apply_acl(old, acl_rules))
+
             new = patching.apply_acl(
                 new,
                 acl_rules,
@@ -232,11 +233,29 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
 
         entire_results = res.entire_results
         json_fragment_results = res.json_fragment_results
+        old_json_fragment_files = old_files.json_fragment_files
+
         new_files = res.new_files()
-        new_json_fragment_files = res.new_json_fragment_files(old_files.json_fragment_files)
+        new_json_fragment_files = res.new_json_fragment_files(old_json_fragment_files)
+
         if ctx.args.acl_safe:
             safe_new_files = res.new_files(safe=True)
 
+        filters = build_filter_text(filterer, device, ctx.stdin, ctx.args, ctx.config).split("\n")
+
+        for file_name in new_json_fragment_files:
+            new_json_fragment_files = _update_json_config(
+                new_json_fragment_files,
+                file_name,
+                jsontools.apply_acl_filters(new_json_fragment_files[file_name][0], filters)
+            )
+        for file_name in old_json_fragment_files:
+            old_json_fragment_files = _update_json_config(
+                old_json_fragment_files,
+                file_name,
+                jsontools.apply_acl_filters(old_json_fragment_files[file_name][0], filters)
+            )
+
     if ctx.args.profile:
         perf = res.perf_mesures()
         combined_perf[ALL_GENS] = {"total": time.monotonic() - start}
@@ -253,7 +272,7 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
         new_files=new_files,
         partial_result=partial_results,
         entire_result=entire_results,
-        old_json_fragment_files=old_files.json_fragment_files,
+        old_json_fragment_files=old_json_fragment_files,
         new_json_fragment_files=new_json_fragment_files,
         json_fragment_result=json_fragment_results,
         implicit_rules=implicit_rules,
@@ -266,6 +285,13 @@ def _old_new_per_device(ctx: OldNewDeviceContext, device: Device, filterer: Filt
     )
 
 
+def _update_json_config(json_files, file_name, new_config):
+    file = list(json_files[file_name])
+    file[0] = new_config
+    json_files[file_name] = tuple(file)
+    return json_files
+
+
 @dataclasses.dataclass
 class DeviceDownloadedFiles:
     # map file path to file content for entire generators

annet/generators/__init__.py

@@ -296,8 +296,8 @@ def run_partial_generators(gens: List["PartialGenerator"], run_args: GeneratorPa
     for gen in gens:
         try:
             result = _run_partial_generator(gen, run_args)
-        except NotSupportedDevice:
-            logger.info("generator %s is not supported for this device, skip generator for this devices!", gen)
+        except NotSupportedDevice as exc:
+            logger.info("generator %s raised unsupported error: %r", gen, exc)
             continue
 
         if not result:
@@ -317,13 +317,17 @@ def run_partial_generators(gens: List["PartialGenerator"], run_args: GeneratorPa
 
 
 @tracing.function(name="run_partial_generator")
-def _run_partial_generator(gen: "PartialGenerator", run_args: GeneratorPartialRunArgs) -> GeneratorPartialResult:
+def _run_partial_generator(gen: "PartialGenerator", run_args: GeneratorPartialRunArgs) -> Optional[GeneratorPartialResult]:
     logger = get_logger(generator=_make_generator_ctx(gen))
     device = run_args.device
     output = ""
     config = odict()
     safe_config = odict()
 
+    if not gen.supports_device(device):
+        logger.info("generator %s is not supported for device %s", gen, device.hostname)
+        return None
+
     span = tracing_connector.get().get_current_span()
     if span:
         tracing_connector.get().set_device_attributes(span, run_args.device)
@@ -439,8 +443,8 @@ def run_file_generators(
             raise RuntimeError(f"Unknown generator class type: cls={gen.__class__} TYPE={gen.__class__.TYPE}")
         try:
             result = run_generator_fn(gen, device, storage)
-        except NotSupportedDevice:
-            logger.info("generator %s is not supported for this device", gen)
+        except NotSupportedDevice as exc:
+            logger.info("generator %s raised unsupported error: %r", gen, exc)
             continue
         if result:
             add_result_fn(result)
@@ -450,33 +454,34 @@ def run_file_generators(
 
 @tracing.function(min_duration="0.5")
 def _run_entire_generator(gen: "Entire", device: "Device", storage: Storage) -> Optional[GeneratorResult]:
+    logger = get_logger(generator=_make_generator_ctx(gen))
+    if not gen.supports_device(device):
+        logger.info("generator %s is not supported for device %s", gen, device.hostname)
+        return
+
     span = tracing_connector.get().get_current_span()
     if span:
         tracing_connector.get().set_device_attributes(span, device)
         tracing_connector.get().set_dimensions_attributes(span, gen, device)
 
-    logger = get_logger(generator=_make_generator_ctx(gen))
     path = gen.path(device)
-    if path:
-        logger.info("Generating ENTIRE ...")
-
-        with GeneratorPerfMesurer(gen, storage, trace_min_duration="0.5") as pm:
-            output = gen(device)
-
-        reload_cmds = gen.get_reload_cmds(device)
-        prio = gen.prio
-
-        return GeneratorEntireResult(
-            name=gen.__class__.__name__,
-            tags=gen.TAGS,
-            path=path,
-            output=output,
-            reload=reload_cmds,
-            prio=prio,
-            perf=pm.last_result,
-            is_safe=gen.is_safe(device),
-        )
-    return None
+    if not path:
+        raise RuntimeError("entire generator should return non-empty path")
+
+    logger.info("Generating ENTIRE ...")
+    with GeneratorPerfMesurer(gen, storage, trace_min_duration="0.5") as pm:
+        output = gen(device)
+
+    return GeneratorEntireResult(
+        name=gen.__class__.__name__,
+        tags=gen.TAGS,
+        path=path,
+        output=output,
+        reload=gen.get_reload_cmds(device),
+        prio=gen.prio,
+        perf=pm.last_result,
+        is_safe=gen.is_safe(device),
+    )
 
 
 def _make_generator_ctx(gen):
@@ -489,34 +494,36 @@ def _run_json_fragment_generator(
         storage: Storage,
 ) -> Optional[GeneratorResult]:
     logger = get_logger(generator=_make_generator_ctx(gen))
+    if not gen.supports_device(device):
+        logger.info("generator %s is not supported for device %s", gen, device.hostname)
+
     path = gen.path(device)
+    if not path:
+        raise RuntimeError("json fragment generator should return non-empty path")
 
     acl_item_or_list_of_items = gen.acl(device)
+    if not acl_item_or_list_of_items:
+        raise RuntimeError("json fragment generator should return non-empty acl")
     if isinstance(acl_item_or_list_of_items, list):
         acl = acl_item_or_list_of_items
     else:
         acl = [acl_item_or_list_of_items]
 
-    if path:
-        logger.info("Generating JSON_FRAGMENT ...")
-
-        with GeneratorPerfMesurer(gen, storage) as pm:
-            config = gen(device)
-
-        reload_cmds = gen.get_reload_cmds(device)
-
-        return GeneratorJSONFragmentResult(
-            name=gen.__class__.__name__,
-            tags=gen.TAGS,
-            path=path,
-            acl=acl,
-            config=config,
-            reload=reload_cmds,
-            perf=pm.last_result,
-            is_safe=gen.is_safe(device),
-            reload_prio=gen.reload_prio,
-        )
-    return None
+    logger.info("Generating JSON_FRAGMENT ...")
+    with GeneratorPerfMesurer(gen, storage) as pm:
+        config = gen(device)
+    reload_cmds = gen.get_reload_cmds(device)
+    return GeneratorJSONFragmentResult(
+        name=gen.__class__.__name__,
+        tags=gen.TAGS,
+        path=path,
+        acl=acl,
+        config=config,
+        reload=reload_cmds,
+        perf=pm.last_result,
+        is_safe=gen.is_safe(device),
+        reload_prio=gen.reload_prio,
+    )
 
 
 def _get_generators(module_paths: Union[List[str], dict], storage, device=None):
@@ -587,7 +594,7 @@ class BaseGenerator:
     TYPE: str
     TAGS: list[str]
 
-    def supports_vendor(self, vendor: str) -> bool:  # pylint: disable=unused-argument
+    def supports_device(self, device: Device) -> bool:  # pylint: disable=unused-argument
         return True
 
 
@@ -681,36 +688,36 @@ class PartialGenerator(TreeGenerator):
         self._annotations = []
         self._annotation_module = self.__class__.__module__ or ""
 
-    def supports_vendor(self, vendor: str) -> bool:
+    def supports_device(self, device: Device) -> bool:
         if self.__class__.run is PartialGenerator.run:
-            return hasattr(self, f"run_{vendor}")
+            return bool(self._get_vendor_func(device.hw.vendor, "run"))
         else:
             return True
 
     def acl(self, device):
-        if hasattr(self, "acl_" + device.hw.vendor):
-            return getattr(self, "acl_" + device.hw.vendor)(device)
+        acl_func = self._get_vendor_func(device.hw.vendor, "acl")
+        if acl_func:
+            return acl_func(device)
 
     def acl_safe(self, device):
-        if hasattr(self, "acl_safe_" + device.hw.vendor):
-            return getattr(self, "acl_safe_" + device.hw.vendor)(device)
+        acl_func = self._get_vendor_func(device.hw.vendor, "acl_safe")
+        if acl_func:
+            return acl_func(device)
 
     def run(self, device) -> Iterable[Union[str, tuple]]:
-        if hasattr(self, "run_" + device.hw.vendor):
-            return getattr(self, "run_" + device.hw.vendor)(device)
-        logger = get_logger()
-        logger.info(
-            "generator %s is not supported for vendor %s",
-            self,
-            device.hw.vendor,
-        )
-        return iter(())
+        run_func = self._get_vendor_func(device.hw.vendor, "run")
+        if run_func:
+            return run_func(device)
 
     def get_user_runner(self, device):
         if self.__class__.run is not PartialGenerator.run:
             return self.run
-        elif hasattr(self, "run_" + device.hw.vendor):
-            return getattr(self, "run_" + device.hw.vendor)
+        return self._get_vendor_func(device.hw.vendor, "run")
+
+    def _get_vendor_func(self, vendor: str, func_name: str):
+        attr_name = f"{func_name}_{vendor}"
+        if hasattr(self, attr_name):
+            return getattr(self, attr_name)
         return None
 
     # =====
@@ -790,6 +797,9 @@ class Entire(BaseGenerator):
             self.prio = 100
         self.__device = None
 
+    def supports_device(self, device: Device):
+        return bool(self.path(device))
+
     def run(self, device) -> Union[None, str, Iterable[Union[str, tuple]]]:
         raise NotImplementedError
 
@@ -907,6 +917,9 @@ class JSONFragment(TreeGenerator):
         if not hasattr(self, "reload_prio"):
             self.reload_prio = 100
 
+    def supports_device(self, device: Device):
+        return bool(self.path(device))
+
     def path(self, device: Device) -> Optional[str]:
         raise NotImplementedError("Required PATH for JSON_FRAGMENT generator")
 

{annet-0.7.dist-info → annet-0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: annet
-Version: 0.7
+Version: 0.8
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT

{annet-0.7.dist-info → annet-0.8.dist-info}/RECORD

@@ -8,7 +8,7 @@ annet/deploy.py,sha256=B8E0P_VvCrS2URjFvgmUiIkHp95g7pAWfmT34igaDeo,18893
 annet/diff.py,sha256=zLcaCnb4lZRUb7frpH1CstQ3kacRcCblZs1uLG8J5lk,3391
 annet/executor.py,sha256=bw7COJNtssuxIqbQehlHYJnkdUeYvvL8WO5B-c67XE0,19040
 annet/filtering.py,sha256=F4ZKUCU3Yb1RlL2zKdyHtVUaWPzjWF4vWyMcdygKNYk,852
-annet/gen.py,sha256=WC3ZMjTKtUCRXE4yy-Z3n5MOm3LkLJbXvspyfW8BeVs,31426
+annet/gen.py,sha256=MI82tdc-r3leiyp4Oa35PBsrfj0jNKdbASRnQ8Rk39g,32336
 annet/hardware.py,sha256=HYPDfji_GdRn5S0_0fl4rvM7byOY9aHxG6VMAtsLaxE,1090
 annet/implicit.py,sha256=QigK4uoxvrFho2h9yFjOq1d9rLsC5xFlAU4bKkCuMWk,5139
 annet/lib.py,sha256=zQIfNBg7fAAk2BHbHAqy_McAiXhz0RqpBAcfdU-6pAA,3742
@@ -44,7 +44,7 @@ annet/annlib/command.py,sha256=uuBddMQphtn8P5MO5kzIa8_QrtMns-k05VeKv1bcAuA,1043
 annet/annlib/diff.py,sha256=UPt3kYFQdQdVVy3ePYzNHPAxMVmHxCrCnZnMCV6ou2Q,4587
 annet/annlib/errors.py,sha256=jBcSFzY6Vj-FxR__vqjFm-87AwYQ0xHuAopTirii5AU,287
 annet/annlib/filter_acl.py,sha256=0w1VF6WcONiTYTQh0yWi6_j9rCTc_kMLAUMr0hbdkNU,7203
-annet/annlib/jsontools.py,sha256=X4gtKcnDArnzKcZDJmRKcZGuUgi3nEFSVKdGPi2uGDw,2644
+annet/annlib/jsontools.py,sha256=TJazOP-1njwbGN7iIz8oGYgWPdry4XfKLjpzNYxdvjg,3364
 annet/annlib/lib.py,sha256=eJ4hcVuQ6pdYBzLs4YKCHFtq45idOfZCYp92XfF7_QI,15317
 annet/annlib/output.py,sha256=_SjJ6G6bejvnTKqNHw6xeio0FT9oO3OIkLaOC3cEga4,7569
 annet/annlib/patching.py,sha256=Gh8uUjFyYND9TJBBQH-DH6-AwFiiR-dXVXOisMS7elg,19784
@@ -68,7 +68,7 @@ annet/annlib/rulebook/common.py,sha256=9kCZwZpsH5UliF2OzaN9nLs2eLlz_d__4L7_oZ3Sr
 annet/api/__init__.py,sha256=VooP9u9f6e8vF7FPUE-r0JAGqCjck9-2b0dVNWAtoLM,33752
 annet/configs/context.yml,sha256=nt4QnzYzrG2hqmaWOUsab2wgFl-CXmFSzbto6rqqFt4,291
 annet/configs/logging.yaml,sha256=Hu42lRK248dssp9TgkbHCaZNl0E6f4IChGb0XaQnTVo,970
-annet/generators/__init__.py,sha256=LQoqGz_0imhtxvyuwBrBpB6iSuzS2S0UxNJEpO77BiM,33829
+annet/generators/__init__.py,sha256=iOTaIfTQfGoExmSAzqt1RSWP7V1O_pEkuqvjnsEjBkQ,34476
 annet/generators/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet/generators/common/initial.py,sha256=XI7uWLMuLrHC-uXm38oRbM1YVuELAvMHLZFHM9x5IF8,1229
 annet/rulebook/__init__.py,sha256=14IpOfTbeJtre7JKrfXVYiH0qAXsUSOL7AatUFmSQs0,3847
@@ -120,10 +120,10 @@ annet/rulebook/texts/routeros.rul,sha256=ipfxjj0mjFef6IsUlupqx4BY_Je_OUb8u_U1019
 annet_generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 annet_generators/example/__init__.py,sha256=zVd8_DrXuOASrNzg2Ab94rPyvJff83L-_HppDFxnUjM,228
 annet_generators/example/lldp.py,sha256=68CLrK7vxTQQy9XIBxtywuEdBNlIlfXGYj8_wYWs5UI,1146
-annet-0.7.dist-info/AUTHORS,sha256=rh3w5P6gEgqmuC-bw-HB68vBCr-yIBFhVL0PG4hguLs,878
-annet-0.7.dist-info/LICENSE,sha256=yPxl7dno02Pw7gAcFPIFONzx_gapwDoPXsIsh6Y7lC0,1079
-annet-0.7.dist-info/METADATA,sha256=hkf7Zql0Tekm9u10L6exfVSV6LjhQ7367c7VZ8WxOw8,691
-annet-0.7.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-annet-0.7.dist-info/entry_points.txt,sha256=yHimujIzR2bwNIbb--MTs_GpXiAve89Egpu2LlgTEkg,119
-annet-0.7.dist-info/top_level.txt,sha256=QsoTZBsUtwp_FEcmRwuN8QITBmLOZFqjssRfKilGbP8,23
-annet-0.7.dist-info/RECORD,,
+annet-0.8.dist-info/AUTHORS,sha256=rh3w5P6gEgqmuC-bw-HB68vBCr-yIBFhVL0PG4hguLs,878
+annet-0.8.dist-info/LICENSE,sha256=yPxl7dno02Pw7gAcFPIFONzx_gapwDoPXsIsh6Y7lC0,1079
+annet-0.8.dist-info/METADATA,sha256=biTv9OtMLS-HnbvanEbTm3B-tYG9SGFV-TSQCtem7cE,691
+annet-0.8.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+annet-0.8.dist-info/entry_points.txt,sha256=yHimujIzR2bwNIbb--MTs_GpXiAve89Egpu2LlgTEkg,119
+annet-0.8.dist-info/top_level.txt,sha256=QsoTZBsUtwp_FEcmRwuN8QITBmLOZFqjssRfKilGbP8,23
+annet-0.8.dist-info/RECORD,,