annet 0.14.3__tar.gz → 0.14.5__tar.gz

{annet-0.14.3/annet.egg-info → annet-0.14.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: annet
-Version: 0.14.3
+Version: 0.14.5
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT
@@ -21,5 +21,5 @@ Requires-Dist: contextlog>=1.1
 Requires-Dist: valkit>=0.1.4
 Requires-Dist: aiohttp>=3.8.4
 Requires-Dist: yarl>=1.8.2
-Requires-Dist: adaptix==3.0.0b5
+Requires-Dist: adaptix==3.0.0b7
 Requires-Dist: dataclass-rest==0.4

{annet-0.14.3 → annet-0.14.5}/README.md

@@ -13,15 +13,6 @@ Usage help can be obtained by calling ```annet -h``` or for a specific command,
 
 ## Overview
 
-## Configuration
-
-Provide `NETBOX_URL` and `NETBOX_TOKEN` environment variable to setup data source.
-
-```shell
-export NETBOX_URL="https://demo.netbox.dev"
-export NETBOX_TOKEN="1234567890abcdef01234567890abcdef0123456"
-```
-
 ### annet gen
 
 The annet_generators directory contains many files called generators.
@@ -109,3 +100,77 @@ Normal layout. The screen with patches will be shown and the process of laying o
 annet deploy -g snmp $HOST
 ```
 Credentials will be used from the current user (username, ssh key, ssh agent, encrypted password in $HOME). -->
+
+## Configuration
+
+The path to the configuration file is searched in following order:
+- `ANN_CONTEXT_CONFIG_PATH` env.
+- `~/.annet/context.yml`.
+- `annet/configs/context.yml`.
+
+Config example:
+
+```yaml
+connection:
+  default:
+    login: ~
+    passwords: ~
+
+generators:
+  default:
+    - my_annet_generators.example
+
+storage:
+  default:
+    adapter: annet.adapters.file.provider
+    params:
+      path: /path/to/file
+
+context:
+  default:
+    connection: default
+    generators: default
+    storage: default
+
+selected_context: default
+```
+
+Environment variable `ANN_SELECTED_CONTEXT` can be used to override `selected_context` parameter.
+
+### Storages
+
+Storages provide information about devices like FQDN, interface and so on.
+
+#### Netbox storage
+
+Provide `NETBOX_URL` and `NETBOX_TOKEN` environment variable to setup data source.
+
+```shell
+export NETBOX_URL="https://demo.netbox.dev"
+export NETBOX_TOKEN="1234567890abcdef01234567890abcdef0123456"
+```
+
+#### File storage
+```yaml
+storage:
+  default:
+    adapter: annet.adapters.file.provider
+    params:
+      path: /path/to/file
+```
+
+cat /path/to/file:
+
+```yaml
+devices:
+  - fqdn: myhost.yndx.net
+    vendor: mikrotik
+    interfaces:
+      - name: eth0
+        description: test
+```
+
+## Extending
+
+Annet uses [Entry Points](https://setuptools.pypa.io/en/latest/userguide/entry_point.html) mechanism for customization.
+For example, you can implement the Storage interface on top of your favorite inventory system.

{annet-0.14.3 → annet-0.14.5}/annet/adapters/netbox/common/storage_opts.py

@@ -1,4 +1,5 @@
 import os
+from typing import Any
 
 
 class NetboxStorageOpts:
@@ -7,7 +8,7 @@ class NetboxStorageOpts:
         self.token = token
 
     @classmethod
-    def from_cli_opts(cls, cli_opts):
+    def parse_params(cls, conf_params: dict[str, str] | None, cli_opts: Any):
         return cls(
             url=os.getenv("NETBOX_URL", "http://localhost"),
             token=os.getenv("NETBOX_TOKEN", "").strip(),

{annet-0.14.3 → annet-0.14.5}/annet/adapters/netbox/provider.py

@@ -32,3 +32,6 @@ class NetboxProvider(StorageProvider):
 
     def query(self):
         return NetboxQuery
+
+    def name(self) -> str:
+        return "netbox"

{annet-0.14.3 → annet-0.14.5}/annet/adapters/netbox/v37/storage.py

@@ -4,7 +4,7 @@ from ipaddress import ip_interface
 from collections import defaultdict
 
 from adaptix import P
-from adaptix.conversion import impl_converter, link
+from adaptix.conversion import impl_converter, link, link_constant
 from annetbox.v37 import models as api_models
 from annetbox.v37.client_sync import NetboxV37
 
@@ -24,13 +24,13 @@ logger = getLogger(__name__)
 @impl_converter(recipe=[
     link(P[api_models.Device].name, P[models.NetboxDevice].hostname),
     link(P[api_models.Device].name, P[models.NetboxDevice].fqdn),
+    link_constant(P[models.NetboxDevice].neighbours, value=None),
 ])
 def extend_device_base(
         device: api_models.Device,
         interfaces: List[models.Interface],
         hw: Optional[HardwareView],
         breed: str,
-        neighbours: Optional[List[models.NetboxDevice]],
         storage: Storage,
 ) -> models.NetboxDevice:
     ...
@@ -45,7 +45,7 @@ def extend_device(
     platform_name: str = ""
     if device.platform:
         platform_name = device.platform.name
-    return extend_device_base(
+    res = extend_device_base(
         device=device,
         interfaces=interfaces,
         breed=get_breed(
@@ -57,9 +57,10 @@ def extend_device(
             device.device_type.model,
             platform_name,
         ),
-        neighbours=neighbours,
         storage=storage,
     )
+    res.neighbours = neighbours
+    return res
 
 
 @impl_converter

{annet-0.14.3 → annet-0.14.5}/annet/annlib/netdev/devdb/data/devdb.json

@@ -52,6 +52,8 @@
     "Huawei.CE.CE8800.CE8850": " CE8850",
     "Huawei.CE.CE8800.CE8851": " CE8851",
     "Huawei.CE.CE9800": " CE98\\d\\d",
+    "Huawei.DC": " DC\\d+",
+    "Huawei.DC.DC908": " DC908",
     "Huawei.Quidway": " S\\d+",
     "Huawei.Quidway.S2x": " S2\\d{3}",
     "Huawei.Quidway.S2x.S2300": " S23\\d\\d",
@@ -129,6 +131,10 @@
     "Aruba.AP.AP500": " AP-5\\d\\d",
     "Aruba.AP.AP500.AP514": " AP-514",
     "Aruba.AP.AP500.AP515": " AP-515",
+    "Aruba.AP.AP600": " AP-6\\d\\d",
+    "Aruba.AP.AP600.AP615": " AP-615",
+    "Aruba.AP.AP600.AP635": " AP-635",
+    "Aruba.AP.AP600.AP655": " AP-655",
     "Aruba.AP.IAP": " IAP-",
     "Aruba.AP.IAP.IAP300": " IAP-3\\d\\d",
     "Aruba.AP.IAP.IAP300.IAP304": " IAP-304",

{annet-0.14.3 → annet-0.14.5}/annet/api/__init__.py

@@ -45,7 +45,7 @@ from annet.output import (
 )
 from annet.parallel import Parallel, TaskResult
 from annet.reference import RefTracker
-from annet.storage import Device, storage_connector
+from annet.storage import Device, get_storage
 from annet.types import Diff, ExitCode, OldNewResult, Op, PCDiff, PCDiffFile
 
 
@@ -218,8 +218,8 @@ def log_host_progress_cb(pool: Parallel, task_result: TaskResult):
         stacklevel=2,
     )
     args = cast(cli_args.QueryOptions, pool.args[0])
-    connector = storage_connector.get()
-    storage_opts = connector.opts().from_cli_opts(args)
+    connector, connector_opts = get_storage()
+    storage_opts = connector.opts().parse_params(connector_opts, args)
     with connector.storage()(storage_opts) as storage:
         fqdns = storage.resolve_fdnds_by_query(args.query)
     PoolProgressLogger(device_fqdns=fqdns)(pool, task_result)

{annet-0.14.3 → annet-0.14.5}/annet/cli.py

@@ -19,7 +19,7 @@ from annet.diff import gen_sort_diff
 from annet.gen import Loader, old_raw
 from annet.lib import get_context_path, repair_context_file
 from annet.output import output_driver_connector, OutputDriver
-from annet.storage import storage_connector
+from annet.storage import get_storage
 
 
 def fill_base_args(parser: ArgParser, pkg_name: str, logging_config: str):
@@ -62,12 +62,11 @@ def _gen_current_items(
 @contextmanager
 def get_loader(gen_args: cli_args.GenOptions, args: cli_args.QueryOptions):
     exit_stack = ExitStack()
-    connectors = storage_connector.get_all()
     storages = []
     with exit_stack:
-        for connector in connectors:
-            storage_opts = connector.opts().from_cli_opts(args)
-            storages.append(exit_stack.enter_context(connector.storage()(storage_opts)))
+        connector, connector_opts = get_storage()
+        storage_opts = connector.opts().parse_params(connector_opts, args)
+        storages.append(exit_stack.enter_context(connector.storage()(storage_opts)))
         yield Loader(*storages, args=gen_args)
 
 

{annet-0.14.3 → annet-0.14.5}/annet/cli_args.py

@@ -10,7 +10,7 @@ from valkit.common import valid_string_list
 
 from annet.argparse import Arg, ArgGroup, DefaultFromEnv
 from annet.hardware import hardware_connector
-from annet.storage import Query, storage_connector
+from annet.storage import Query, get_storage
 
 
 # ====
@@ -361,14 +361,9 @@ class QueryOptionsBase(CacheOptions):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         if not isinstance(self.query, Query):
-            connectors = storage_connector.get_all()
-            if not connectors:
-                pass
-            elif len(connectors) == 1:
-                query_type = connectors[0].query()
-                self.query = query_type.new(self.query, hosts_range=self.hosts_range)
-            else:
-                logging.warning("Multiple connectors found, skip parsing query")
+            storage, _ = get_storage()
+            query_type = storage.query()
+            self.query = query_type.new(self.query, hosts_range=self.hosts_range)
 
 
 class QueryOptions(QueryOptionsBase):

{annet-0.14.3 → annet-0.14.5}/annet/configs/context.yml

@@ -10,9 +10,16 @@ generators:
   default:
     - annet_generators.example
 
+storage:
+  default:
+    adapter: annet.adapters.file.provider
+    params:
+      path: /path/to/file
+
 context:
   default:
     connection: default
     generators: default
+    storage: default
 
 selected_context: default

{annet-0.14.3 → annet-0.14.5}/annet/connectors.py

@@ -3,6 +3,7 @@ from abc import ABC
 from functools import cached_property
 from importlib.metadata import entry_points
 from typing import Generic, Optional, Type, TypeVar, List
+from annet.lib import get_context
 
 T = TypeVar("T")
 
@@ -33,7 +34,7 @@ class Connector(ABC, Generic[T]):
         res = self._classes[0]
         return res(*args, **kwargs)
 
-    def get_all(self, *args, **kwargs) -> T:
+    def get_all(self, *args, **kwargs) -> list[T]:
         if self._classes is None:
             self._classes = self._entry_point or [self._get_default()]
 

{annet-0.14.3 → annet-0.14.5}/annet/storage.py

@@ -1,10 +1,6 @@
 import abc
 from typing import Any, Iterable, Optional, Type, Union, Protocol
-
-try:
-    from annet.connectors import Connector
-except ImportError:
-    from noc.annushka.annet.connectors import Connector  # noqa: F401
+from annet.connectors import Connector, get_context
 
 
 class _StorageConnector(Connector["StorageProvider"]):
@@ -28,6 +24,10 @@ class StorageProvider(abc.ABC):
     def query(self) -> Type["Query"]:
         pass
 
+    @abc.abstractmethod
+    def name(self) -> str:
+        pass
+
 
 class Storage(abc.ABC):
     @abc.abstractmethod
@@ -69,7 +69,7 @@ class Storage(abc.ABC):
 class StorageOpts(abc.ABC):
     @classmethod
     @abc.abstractmethod
-    def from_cli_opts(cls, cli_opts) -> "StorageOpts":
+    def parse_params(cls, conf_params: dict[str, str] | None, cli_opts: Any):
         pass
 
 
@@ -123,3 +123,20 @@ class Device(Protocol):
     @abc.abstractmethod
     def breed(self):
         pass
+
+
+def get_storage() -> (Storage, dict[str, Any]):
+    connectors = storage_connector.get_all()
+    seen: list[str] = []
+    if context_storage := get_context().get("storage"):
+        for connector in connectors:
+            con_name = connector.name()
+            seen.append(con_name)
+            if "adapter" not in context_storage:
+                raise Exception("adapter is not set in %s" % context_storage)
+            if context_storage["adapter"] == con_name:
+                return connector, context_storage.get("params", {})
+        else:
+            raise Exception("unknown storage %s: seen %s" % (context_storage["adapter"], seen))
+    else:
+        return connectors[0], {}

{annet-0.14.3 → annet-0.14.5/annet.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: annet
-Version: 0.14.3
+Version: 0.14.5
 Summary: annet
 Home-page: https://github.com/annetutil/annet
 License: MIT
@@ -21,5 +21,5 @@ Requires-Dist: contextlog>=1.1
 Requires-Dist: valkit>=0.1.4
 Requires-Dist: aiohttp>=3.8.4
 Requires-Dist: yarl>=1.8.2
-Requires-Dist: adaptix==3.0.0b5
+Requires-Dist: adaptix==3.0.0b7
 Requires-Dist: dataclass-rest==0.4

{annet-0.14.3 → annet-0.14.5}/annet.egg-info/requires.txt

@@ -12,5 +12,5 @@ contextlog>=1.1
 valkit>=0.1.4
 aiohttp>=3.8.4
 yarl>=1.8.2
-adaptix==3.0.0b5
+adaptix==3.0.0b7
 dataclass-rest==0.4

{annet-0.14.3 → annet-0.14.5}/requirements.txt

@@ -12,5 +12,5 @@ contextlog>=1.1
 valkit>=0.1.4
 aiohttp>=3.8.4
 yarl>=1.8.2
-adaptix==3.0.0b5
+adaptix==3.0.0b7
 dataclass-rest==0.4