Added tenant creation

Author: fbattello

RELEASE-NOTES.md

@@ -1,3 +1,8 @@
+# ngsildclient 0.5.2
+## December 1, 2022
+
+- Allow to create tenant (auto-create is default for the sync Client)
+
 # ngsildclient 0.5.1
 ## November 24, 2022
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ngsildclient"
-version = "0.5.1"
+version = "0.5.2"
 description = "A Python library that helps building NGSI-LD entities and interacting with a NGSI-LD Context Broker"
 license = "Apache-2.0"
 readme="README.md"

src/ngsildclient/__init__.py

@@ -13,7 +13,7 @@
 import logging
 import sys
 
-__version__ = "0.5.1"
+__version__ = "0.5.2"
 
 from ngsildclient.settings import globalsettings as settings
 from .utils import iso8601, is_interactive

src/ngsildclient/api/asyn/client.py

@@ -37,6 +37,7 @@
 from .contexts import Contexts
 from .subscriptions import Subscriptions
 from .temporal import Temporal
+from ..exceptions import NgsiClientTooManyResultsError
 
 if TYPE_CHECKING:
     from ngsildclient.model.constants import EntityOrId
@@ -629,6 +630,18 @@ async def flush_all(self) -> None:
         await self.purge(type)
         await self.contexts.cleanup()
 
+    async def create_tenant(self, tenant: str) -> httpx.Response:
+        payload = {
+            "id": f"urn:ngsi-ld:__NGSILD-Tenant__:{tenant}",
+            "type": "__NGSILD-Tenant__",
+            "@context": ["https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"],
+        }
+        return await self.client.post(
+            f"{self.url}/{ENDPOINT_BATCH}/upsert/",
+            json=[payload],
+            headers={"Content-Type": "application/ld+json", "NGSILD-Tenant": tenant},
+        )
+
     # below the context manager methods
 
     async def __aenter__(self):

src/ngsildclient/api/client.py

@@ -95,6 +95,7 @@ def __init__(
         secure: bool = False,
         useragent: str = UA,
         tenant: str = None,
+        tenant_autocreate: bool = True,
         overwrite: bool = False,
         ignore_errors: bool = False,
         proxy: str = None,
@@ -121,6 +122,8 @@ def __init__(
             the User Agent string sent in the HTTP headers, by default UA
         tenant : str, optional
             the tenant string in case you make use of multi-tenancy, by default None
+        tenant_autocreate : boolean, optional
+            creates the tenant if not exists, default is True
         overwrite : bool, optional
             if set create() will behave like upsert(), by default False
         ignore_errors : bool, optional
@@ -144,6 +147,7 @@ def __init__(
         self.basepath = f"{self.url}/{NGSILD_PATH}"
         self.useragent = useragent
         self.tenant = tenant
+        self.tenant_autocreate = tenant_autocreate
         self.overwrite = overwrite
         self.ignore_errors = ignore_errors
         self.proxy = proxy
@@ -233,7 +237,12 @@ def is_connected(self, raise_for_disconnected=False) -> bool:
                 },  # overrides session headers
                 params=params,
             )
+
+            if not r.ok and self.tenant and self.tenant_autocreate:
+                r = self.create_tenant(self.tenant)
+
             r.raise_for_status()
+
         except Exception as e:
             if is_interactive():
                 self.console.print(str(e))
@@ -708,6 +717,16 @@ def flush_all(self) -> None:
         self.purge(type)
         self.contexts.cleanup()
 
+    def create_tenant(self, tenant: str) -> Response:
+        payload = {
+            "id": f"urn:ngsi-ld:__NGSILD-Tenant__:{tenant}",
+            "type": "__NGSILD-Tenant__",
+            "@context": ["https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"],
+        }
+        return self.session.post(
+            f"{self.url}/{ENDPOINT_BATCH}/upsert/", json=[payload], headers={"NGSILD-Tenant": tenant}
+        )
+
     def guess_vendor(self) -> tuple[Vendor, Version]:
         """Try to guess the Context Broker vendor.
 
@@ -790,10 +809,12 @@ def _broker_version_java_spring(self) -> Optional[Tuple[Vendor, str]]:
             return None
 
     def _welcome_message(self) -> str:
-        return f"[green]Connected[/] to Context Broker at [blue3]{self.hostname}:{self.port}[/] | vendor=[blue3]{self.broker.vendor.value}[/] | version=[blue3]{self.broker.version}[/]"
+        tenant = self.tenant if self.tenant else "N/A"
+        return f"[green]Connected[/] to Context Broker at [blue3]{self.hostname}:{self.port}[/] | tenant=[blue3]{tenant}[/] | vendor=[blue3]{self.broker.vendor.value}[/] | version=[blue3]{self.broker.version}[/]"
 
     def _fail_message(self) -> str:
-        return f"[red3]Failed[/] to connect to Context Broker at [blue3]{self.hostname}:{self.port}[/]"
+        tenant = self.tenant if self.tenant else "N/A"
+        return f"[red3]Failed[/] to connect to Context Broker at [blue3]{self.hostname}:{self.port}[/] | tenant=[blue3]{tenant}[/]"
 
     def _warn_spring_message(self) -> str:
         return "Java-Spring based Context Broker detected. [orange3]Info endpoint disabled."

tests/test_ngsildclient.py

@@ -13,4 +13,4 @@
 
 
 def test_version():
-    assert __version__ == "0.5.1"
+    assert __version__ == "0.5.2"