Fixed application packaging (missing util); Improved sample application testing. (#35)

Author: chsou

samples/Dockerfile

@@ -1,8 +1,9 @@
-FROM python:3-slim
+FROM python:3.8-slim
 
 RUN apt-get update
 
 COPY requirements.txt /
+COPY util.py /
 COPY {SAMPLE}.py /
 COPY c8y_api /c8y_api
 

samples/build.sh

@@ -35,6 +35,7 @@ mkdir -p "$DIST_DIR"
 
 # copy & render sources
 cp ./requirements.txt "$BUILD_DIR"
+cp ./samples/util.py "$BUILD_DIR"
 cp "./samples/$NAME.py" "$BUILD_DIR"
 cp -r "./c8y_api" "$BUILD_DIR"
 sed -e "s/{VERSION}/$VERSION/g" ./samples/cumulocity.json > "$BUILD_DIR/cumulocity.json"

samples/cumulocity-tenant_options.json

@@ -0,0 +1,7 @@
+{
+  "isolation": "PER_TENANT",
+  "requiredRoles": [
+    "ROLE_OPTION_MANAGEMENT_READ",
+    "ROLE_OPTION_MANAGEMENT_ADMIN"
+  ]
+}

samples/tenant_options.py

@@ -4,10 +4,9 @@
 # Use, reproduction, transfer, publication or disclosure is prohibited except
 # as specifically provided for in your License Agreement with Software AG.
 
-from dotenv import load_dotenv
-
 from c8y_api.app import SimpleCumulocityApp
 
+from util import load_dotenv
 
 load_dotenv()
 c8y = SimpleCumulocityApp()

samples/util.py

@@ -30,4 +30,4 @@ def load_dotenv(sample_name: str | None = None):
     if os.path.exists(sample_env):
         print(f"Found custom .env extension: {sample_env}")
         with open(sample_env, 'r', encoding='UTF-8') as f:
-            dotenv.load_dotenv(stream=f)
+            dotenv.load_dotenv(stream=f, override=True)

tasks.py

@@ -14,7 +14,7 @@
 def show_version(_):
     """Print the module version.
 
-    This version string is infered from the last Git tag. A tagged HEAD
+    This version string is inferred from the last Git tag. A tagged HEAD
     should resolve to a clean x.y.z version string.
     """
     print(get_version())
@@ -61,37 +61,39 @@ def build_ms(c, sample, version='1.0.0'):
 @task(help={
     'sample': "Which sample to register."
 })
-def register_ms(c, sample):
+def register_ms(_, sample):
     """Register a sample as microservice at Cumulocity."""
     ms_util.register_microservice(ms_util.format_sample_name(sample))
 
 
 @task(help={
     'sample': "Which sample to unregister."
 })
-def unregister_ms(c, sample):
+def unregister_ms(_, sample):
     """Unregister a sample microservice from Cumulocity."""
     ms_util.unregister_microservice(ms_util.format_sample_name(sample))
 
 
 @task(help={
     'sample': "Which sample to register."
 })
-def get_credentials(c, sample):
+def get_credentials(_, sample):
     """Unregister a sample microservice from Cumulocity."""
-    user, password = ms_util.get_credentials(ms_util.format_sample_name(sample))
-    print(f"Username:  {user}\n"
+    tenant, user, password = ms_util.get_credentials(ms_util.format_sample_name(sample))
+    print(f"Tenant:    {tenant}\n"
+          f"Username:  {user}\n"
           f"Password:  {password}")
 
 
 @task(help={
     'sample': "Which sample to create a .env file for."
 })
-def create_env(c, sample):
+def create_env(_, sample):
     """Create a sample specific .env-{sample_name} file using the
     credentials of a corresponding microservice registered at Cumulocity."""
     sample_name = ms_util.format_sample_name(sample)
-    user, password = ms_util.get_credentials(sample_name)
-    with open(f'.env-{sample_name}', 'w') as f:
-        f.write(f"C8Y_USER={user}\n"
-                f"C8Y_PASSWORD={password}\n")
+    tenant, user, password = ms_util.get_credentials(sample_name)
+    with open(f'.env-{sample_name}', 'w', encoding='UTF-8') as f:
+        f.write(f'C8Y_TENANT={tenant}\n'
+                f'C8Y_USER={user}\n'
+                f'C8Y_PASSWORD={password}\n')

util/microservice_util.py

@@ -8,7 +8,9 @@
 import zipfile
 
 from dotenv import load_dotenv
+from requests.auth import HTTPBasicAuth
 
+from c8y_api import CumulocityApi
 from c8y_api.app import SimpleCumulocityApp
 from c8y_api.model import Application
 
@@ -46,8 +48,8 @@ def register_microservice(sample_name: str):
 
     # Read prepared binary .zip, extract manifest and parse
     zip_path = f'{_DIST_DIR}/samples/{sample_name}/{application_name}.zip'
-    zip_file = zipfile.ZipFile(zip_path, 'r')
-    manifest_json = json.loads(zip_file.read('cumulocity.json'))
+    with zipfile.ZipFile(zip_path, 'r') as zip_file:
+        manifest_json = json.loads(zip_file.read('cumulocity.json'))
 
     # Create application stub in Cumulocity
     required_roles = manifest_json['requiredRoles']
@@ -57,7 +59,11 @@ def register_microservice(sample_name: str):
                       required_roles=required_roles)
     app = app.create()
 
-    print(f"Microservice application '{application_name}' created. (ID {app.id})")
+    # Subscribe to newly created microservice
+    subscription_json = {'application': {'self': f'{c8y.base_url}/application/applications/{app.id}'}}
+    c8y.post(f'/tenant/tenants/{c8y.tenant_id}/applications', json=subscription_json)
+
+    print(f"Microservice application '{application_name}' (ID {app.id}) created. Tenant '{c8y.tenant_id}' subscribed.")
 
 
 def unregister_microservice(sample_name: str):
@@ -82,8 +88,8 @@ def unregister_microservice(sample_name: str):
         app = c8y.applications.get_all(name=application_name)[0]
         # delete by ID
         app.delete()
-    except IndexError:
-        raise LookupError(f"Cannot retrieve information for an application named '{application_name}'.")
+    except IndexError as e:
+        raise LookupError(f"Cannot retrieve information for an application named '{application_name}'.") from e
 
     print(f"Microservice application '{application_name}' (ID {app.id}) deleted.")
 
@@ -107,12 +113,22 @@ def get_credentials(sample_name: str) -> (str, str):
     application_name = format_application_name(sample_name)
     load_dotenv()
 
+    c8y = SimpleCumulocityApp()
     try:
-        c8y = SimpleCumulocityApp()
         # read applications by name, will throw IndexError if there is none
         app = c8y.applications.get_all(name=application_name)[0]
-        # read bootstrap user details, parse and print
-        user_json = c8y.get(f'/application/applications/{app.id}/bootstrapUser')
-        return user_json['name'], user_json['password']
-    except IndexError:
-        raise LookupError(f"Cannot retrieve information for an application named '{application_name}'.")
+    except IndexError as e:
+        raise LookupError(f"Cannot retrieve information for an application named '{application_name}'.") from e
+
+    # read bootstrap user details
+    bootstrap_user_json = c8y.get(f'/application/applications/{app.id}/bootstrapUser')
+    # create bootstrap instance
+    bootstrap_c8y = CumulocityApi(base_url=c8y.base_url,
+                                  tenant_id=bootstrap_user_json['tenant'],
+                                  auth=HTTPBasicAuth(bootstrap_user_json['name'], bootstrap_user_json['password']))
+    # read all subscribed tenants, print first
+    users_json = bootstrap_c8y.get('/application/currentApplication/subscriptions')['users']
+    if not users_json:  # empty users element?
+        raise LookupError(f"Cannot retrieve subscribed tenants for application named '{application_name}'.")
+
+    return users_json[0]['tenant'], users_json[0]['name'], users_json[0]['password']