Merge pull request #12 from SoftwareAG/features/autocreate-profiles

vtymosh · web-flow · commit 21d41b842652 · 2021-11-04T08:31:39.000+01:00
- creates for every device one predefined profile if no profiles yet exist
 - use non-root user for Docker image
 - move OeeAPI to its own file
 - improve logging
 - fix minor issues
diff --git a/event-based-simulators/.dockerignore b/event-based-simulators/.dockerignore
@@ -1,2 +1,3 @@
 *.tar
-*.zip
+*.zip
+__pycache__
diff --git a/event-based-simulators/.vscode/launch.json b/event-based-simulators/.vscode/launch.json
@@ -4,32 +4,50 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+        {
+            "name": "Python: Current File",
+            "type": "python",
+            "request": "launch",
+            "program": "${file}",
+            "envFile": "${workspaceFolder}/.vscode/.env",
+            "cwd": "${workspaceFolder}/main/",
+            "console": "integratedTerminal"
+        },
         {
             "name": "create profiles",
             "type": "python",
             "request": "launch",
-            "program": "main/profile_generator.py",
+            "program": "profile_generator.py",
             "console": "integratedTerminal",
             "envFile": "${workspaceFolder}/.vscode/.env",
-            "args": ["--create-profiles"]
-        },        
+            "cwd": "${workspaceFolder}/main/",
+            "args": [
+                "--create-profiles"
+            ]
+        },
         {
             "name": "remove simulator profiles via OEE API",
             "type": "python",
             "request": "launch",
-            "program": "main/profile_generator.py",
+            "program": "profile_generator.py",
             "console": "integratedTerminal",
             "envFile": "${workspaceFolder}/.vscode/.env",
-            "args": ["--remove-simulator-profiles-via-oee"]
-        },        
+            "cwd": "${workspaceFolder}/main/",
+            "args": [
+                "--remove-simulator-profiles-via-oee"
+            ]
+        },
         {
             "name": "delete simulator profiles",
             "type": "python",
             "request": "launch",
-            "program": "main/profile_generator.py",
+            "program": "profile_generator.py",
             "console": "integratedTerminal",
             "envFile": "${workspaceFolder}/.vscode/.env",
-            "args": ["--delete-simulator-profiles"]
+            "cwd": "${workspaceFolder}/main/",
+            "args": [
+                "--delete-simulator-profiles"
+            ]
         }
     ]
 }
diff --git a/event-based-simulators/Dockerfile b/event-based-simulators/Dockerfile
@@ -1,7 +1,11 @@
 FROM python:3.8.11-alpine3.14
 
-ADD main /
+RUN pip install requests \
+    && addgroup -S appgroup \
+    && adduser -S appuser -G appgroup
 
-RUN pip install requests
+ADD --chown=appuser:appgroup main /home/appuser
+WORKDIR /home/appuser
 
+USER appuser
 CMD [ "python", "./event_based_simulators.py" ]
diff --git a/event-based-simulators/cumulocity.json b/event-based-simulators/cumulocity.json
@@ -1,6 +1,6 @@
 {
 	"apiVersion": "1",
-	"version": "1.0.8",
+	"version": "1.0.26",
 	"provider": {
   		"name": "Viktor Tymoshenko (event-based simulators)"
 	},
@@ -15,7 +15,8 @@
 		"ROLE_MEASUREMENT_READ",
 		"ROLE_EVENT_READ",
 		"ROLE_ALARM_READ",
-		"ROLE_IDENTITY_READ"
+		"ROLE_IDENTITY_READ",
+		"ROLE_OEECONFIGURATOR_ADMIN"
 	],
 	"roles":[]
 }
diff --git a/event-based-simulators/main/cumulocityAPI.py b/event-based-simulators/main/cumulocityAPI.py
@@ -23,6 +23,7 @@
 false = False
 true = True
 ######################
+log = logging.getLogger("C8yAPI")
 
 OEE_DATA_MODEL_FIELD_NAME = "@com_adamos_oee_datamodel_MachineOEEConfiguration"
 
@@ -33,11 +34,11 @@ class CumulocityAPI:
 
     def __init__(self) -> None:
         self.mocking = MOCK_REQUESTS.lower() == 'true'
-        logging.info(f'MOCK_REQUESTS: {self.mocking}')
+        log.info(f'MOCK_REQUESTS: {self.mocking}')
 
     def send_event(self, event):
         if self.mocking:
-            print("mock: send event ", json.dumps(event), ' to ', C8Y_BASE + '/event/events')
+            log.info(f"mock: send event {json.dumps(event)} to {C8Y_BASE}/event/events")
             return json.dumps({'response': 200})
         else:
             response = requests.post(C8Y_BASE + '/event/events', headers=C8Y_HEADERS, data=json.dumps(event))
@@ -49,19 +50,19 @@ def send_event(self, event):
 
     def log_warning_on_bad_repsonse(self, response):
         if not response.ok:
-            logging.warning(f'response status code is not ok: {response}, content: {response.text}')
+            log.warning(f'response status code is not ok: {response}, content: {response.text}')
 
     def get_or_create_device(self, sim_id, label):
         if self.mocking:
-            print("mock: get or create device with external id", sim_id)
+            log.info(f"mock: get or create device with external id {sim_id}")
             return sim_id
         
         # Check if device already created
         return self.get_device_by_external_id(sim_id) or self.__create_device(sim_id, label)
         
     def count_all_profiles(self):
         if self.mocking:
-            print(f'mock: count_profiles()')
+            log.info(f'mock: count_profiles()')
             return 5
 
         request_query = f'{C8Y_BASE}/inventory/managedObjects/count?type={self.OEE_CALCULATION_PROFILE_TYPE}'
@@ -73,23 +74,23 @@ def count_profiles(self, device_id):
         ''' count all profiles for the given device id.
         '''
         if self.mocking:
-            print(f'mock: count_profiles(${device_id})')
+            log.info(f'mock: count_profiles(${device_id})')
             return 10
         request_query = f'{C8Y_BASE}/inventory/managedObjects/count?type={self.OEE_CALCULATION_PROFILE_TYPE}&text={device_id}'
         response = requests.get(request_query, headers=C8Y_HEADERS)
         if response.ok:
             try:
                 return int(response.text)
             except Exception as e:
-                logging.warn(f'cannot convert "${response.text}" to number. exception: {e}')
+                log.warn(f'cannot convert "${response.text}" to number. exception: {e}')
                 return 0
         else:
             self.log_warning_on_bad_repsonse(response)
             return 0
     
     def create_managed_object(self, fragment: str):
         if self.mocking:
-            print(f'mock: create_managed_object()')
+            log.info(f'mock: create_managed_object()')
             return {'id': '0'}
         response = requests.post(C8Y_BASE + '/inventory/managedObjects', headers=C8Y_HEADERS, data=fragment)
         if response.ok:
@@ -100,7 +101,7 @@ def create_managed_object(self, fragment: str):
 
     def get_managed_object(self, id: str):
         if self.mocking:
-            print(f'mock: get_managed_object()')
+            log.info(f'mock: get_managed_object()')
             return {'id': '0'}
         response = requests.get(C8Y_BASE + f'/inventory/managedObjects/{id}', headers=C8Y_HEADERS)
         if response.ok:
@@ -111,7 +112,7 @@ def get_managed_object(self, id: str):
 
     def delete_managed_object(self, id: str):
         if self.mocking:
-            print(f'mock: delete_managed_object()')
+            log.info(f'mock: delete_managed_object()')
             return {'id': '0'}
         response = requests.delete(C8Y_BASE + f'/inventory/managedObjects/{id}', headers=C8Y_HEADERS)
         if response.ok:
@@ -122,7 +123,7 @@ def delete_managed_object(self, id: str):
 
     def update_managed_object(self, device_id, fragment):
         if self.mocking:
-            print(f'mock: update_managed_object()')
+            log.info(f'mock: update_managed_object()')
             return {'id': '0'}
 
         response = requests.put(f'{C8Y_BASE}/inventory/managedObjects/{device_id}', headers=C8Y_HEADERS, data=fragment)
@@ -133,7 +134,7 @@ def update_managed_object(self, device_id, fragment):
 
     def add_child_object(self, device_id: str, child_id: str):
         if self.mocking:
-            print(f'mock: add_child_device()')
+            log.info(f'mock: add_child_device()')
             return {'id': '0'}
 
         data = {"managedObject": {"id": child_id}}
@@ -146,13 +147,13 @@ def add_child_object(self, device_id: str, child_id: str):
 
     def find_simulators(self):
         if self.mocking:
-            print(f'mock: find_simulators()')
+            log.info(f'mock: find_simulators()')
             return []
         response = requests.get(f'{C8Y_BASE}/inventory/managedObjects?type={self.C8Y_SIMULATORS_GROUP}&fragmentType=c8y_IsDevice&pageSize=100', headers=C8Y_HEADERS)
         if response.ok:
             mangaged_objects = response.json()['managedObjects']
             return [mo['id'] for mo in mangaged_objects]
-        logging.warning(f'Cannot find simulators: {response}, content:{response.text}')
+        log.warning(f'Cannot find simulators: {response}, content:{response.text}')
         return []
 
     def get_external_ids(self, device_ids):
@@ -168,13 +169,13 @@ def get_device_by_external_id(self, external_id):
         response = requests.get(f'{C8Y_BASE}/identity/externalIds/{self.C8Y_SIMULATORS_GROUP}/{external_id}', headers=C8Y_HEADERS)
         if response.ok:
             device_id = response.json()['managedObject']['id']
-            logging.info(f'Device({device_id}) has been found by its external id "{self.C8Y_SIMULATORS_GROUP}/{external_id}".')
+            log.info(f'Device({device_id}) has been found by its external id "{self.C8Y_SIMULATORS_GROUP}/{external_id}".')
             return device_id
-        logging.warning(f'No device has been found for the external id "{self.C8Y_SIMULATORS_GROUP}/{external_id}".')
+        log.warning(f'No device has been found for the external id "{self.C8Y_SIMULATORS_GROUP}/{external_id}".')
         return None
     
     def __create_device(self, external_id, name):
-        logging.info(f'Creating a new device with following external id "{self.C8Y_SIMULATORS_GROUP}/{external_id}"')
+        log.info(f'Creating a new device with following external id "{self.C8Y_SIMULATORS_GROUP}/{external_id}"')
         device = {
             'name': name,
             'c8y_IsDevice': {},
@@ -183,7 +184,7 @@ def __create_device(self, external_id, name):
         device = self.create_managed_object(json.dumps(device))
         device_id = device['id']
         if device_id:
-            logging.info(f'new device created({device_id})')
+            log.info(f'new device created({device_id})')
             return self.__add_external_id(device_id, external_id)
         return device_id
 
diff --git a/event-based-simulators/main/event_based_simulators.py b/event-based-simulators/main/event_based_simulators.py
@@ -3,15 +3,16 @@
 from random import randint, uniform
 
 from cumulocityAPI import C8Y_BASE, C8Y_TENANT, C8Y_USER, C8Y_PASSWORD, CumulocityAPI
+from oeeAPI import OeeAPI, ProfileCreateMode
 
-VERSION = '1.0.8'
+VERSION = '1.0.26'
 def current_timestamp(format = "%Y-%m-%dT%H:%M:%S.%f"):
     return datetime.utcnow().strftime(format)[:-3] + 'Z'
 
-logging.basicConfig(level=logging.INFO)
-logging.info(os.environ)
-logging.info(f"version: {VERSION}")
-logging.info(f"started at {current_timestamp()}")
+logging.basicConfig(format='%(asctime)s %(name)s:%(message)s', level=logging.INFO)
+log = logging.getLogger("sims")
+log.info(f"version: {VERSION}")
+log.info(f"started at {current_timestamp()}")
 
 
 # JSON-PYTHON mapping, to get json.load() working
@@ -20,17 +21,18 @@ def current_timestamp(format = "%Y-%m-%dT%H:%M:%S.%f"):
 true = True
 ######################
 
-logging.info(C8Y_BASE)
-logging.info(C8Y_TENANT)
-logging.info(C8Y_USER)
-logging.info(C8Y_PASSWORD)
+log.info(C8Y_BASE)
+log.info(C8Y_TENANT)
+log.info(C8Y_USER)
+#log.info(C8Y_PASSWORD)
 
 def try_event(probability: float):
     ''' Returns True if event occurs.        
     '''
     return uniform(0.0, 1.0) <= probability
 
 cumulocityAPI = CumulocityAPI()
+oeeAPI = OeeAPI()
 
 class Task:
     def __init__(self, start_in_seconds: int, run_block) -> None:
@@ -247,14 +249,14 @@ def __on_shutdown_event(self, event_definition, task):
         min_duration = event_definition.get("minDuration") or 0
         max_duration = event_definition.get("maxDuration") or 5
         duration = int(uniform(min_duration, max_duration) * 60)
-        logging.info(f'shutdown {self.device_id} for the next {duration} seconds.')
+        log.info(f'shutdown {self.device_id} for the next {duration} seconds.')
         task = self.create_one_time_task({}, duration, MachineSimulator.__on_machine_up_event)
         self.tasks.append(task)
         
     def __on_machine_up_event(self, event_definition, task):
         self.__produce_pieces()
         self.shutdown = False
-        logging.info(f'Device({self.device_id}) is up now.')
+        log.info(f'Device({self.device_id}) is up now.')
 
     def __send_following_event(self, event_definition, timestamp = None, extra_params = {}):        
         if "followedBy" in event_definition:
@@ -268,9 +270,9 @@ def __send_following_event(self, event_definition, timestamp = None, extra_param
                 followed_by_task.extra["timestamp"] = timestamp
                 followed_by_task.extra.update(extra_params)
                 self.tasks.append(followed_by_task)                
-                logging.debug(f'{self.device_id} task({id(followed_by_task)}) added: {json.dumps(followed_by_definition)}, tasks: {len(self.tasks)}')      
+                log.debug(f'{self.device_id} task({id(followed_by_task)}) added: {json.dumps(followed_by_definition)}, tasks: {len(self.tasks)}')      
             else:
-                  logging.debug(f'{self.device_id} followedBy task missed. probability = {1 - followed_by_hits / this_hits} , def: {json.dumps(followed_by_definition)}')         
+                  log.debug(f'{self.device_id} followedBy task missed. probability = {1 - followed_by_hits / this_hits} , def: {json.dumps(followed_by_definition)}')         
 
     def create_one_time_task(self, event_definition, start_in_seconds = 2, event_callback = None):
         callback = event_callback or MachineSimulator.event_mapping[event_definition["type"]]
@@ -281,7 +283,7 @@ def __execute_callback_and_remove_task(self, callback, event_definition, task):
         callback(self, event_definition, task)
         if task in self.tasks:
             self.tasks.remove(task)
-            logging.debug(f'{self.device_id} task({id(task)}) removed: {json.dumps(event_definition)}, tasks: {len(self.tasks)}')        
+            log.debug(f'{self.device_id} task({id(task)}) removed: {json.dumps(event_definition)}, tasks: {len(self.tasks)}')        
     
     def tick(self):
         if not self.enabled: return
@@ -313,7 +315,7 @@ def __create_task(self, event_definition):
 
         task = PeriodicTask(min_interval_in_seconds, max_interval_in_seconds, event_callback)
         
-        logging.debug(f'create periodic task for {event_definition["type"]} ({min_hits_per_hour}, {max_hits_per_hour})')        
+        log.debug(f'create periodic task for {event_definition["type"]} ({min_hits_per_hour}, {max_hits_per_hour})')        
         # event_callback()
         return task
     
@@ -328,7 +330,7 @@ def __send_event(self, event_fragment, timestamp = None):
         base_event.update(event_fragment)
 
         if self.shutdown:
-            logging.info(f'{self.model["id"]} is down -> ignore event: {json.dumps(base_event)}')
+            log.info(f'{self.model["id"]} is down -> ignore event: {json.dumps(base_event)}')
             return None
         else:
             cumulocityAPI.send_event(base_event)
@@ -342,13 +344,17 @@ def load(filename):
         print(e, type(e))
         return {}
     
+log.info(f'cwd:{os.getcwd()}')
 SIMULATOR_MODELS = load("simulators.json")
 
 simulators = list(map(lambda model: MachineSimulator(model), SIMULATOR_MODELS))
 
 # create managed object for every simulator
 [item.get_or_create_device_id() for item in simulators]
 
+[oeeAPI.create_and_activate_profile(id, ProfileCreateMode.CREATE_IF_NOT_EXISTS) 
+    for id in oeeAPI.get_simulator_external_ids()]
+
 while True:
     for simulator in simulators:
         simulator.tick()        
diff --git a/event-based-simulators/main/oeeAPI.py b/event-based-simulators/main/oeeAPI.py
diff --git a/event-based-simulators/main/profile_generator.py b/event-based-simulators/main/profile_generator.py

-Original file line number
+Diff line change
 *.tar
 -*.zip
 +*.zip
 +__pycache__