Blame view

src/core/pyros_django/obsconfig/configpyros.py 24.3 KB
dd54dc29   Alexis Koralewski   Updating schemas,...
1
#!/usr/bin/env python3
6686d675   Alexis Koralewski   new version of ob...
2
3
4
5
import pykwalify.core
import yaml,sys,logging,os
from pykwalify.errors import PyKwalifyException,SchemaError

a2f47fb6   Alexis Koralewski   updating display ...
6
class ConfigPyros:
6686d675   Alexis Koralewski   new version of ob...
7
    # (AKo) : Config file path is checked on the settings file, if the file isn't valid (i.e not found) the error will be launched by the settings file when starting the application 
ee2a5e47   Alexis Koralewski   New version of ob...
8
    # read_files is an history of which config files has been read, where the key is the source file which is linked to a list of files associated to this key
a2f47fb6   Alexis Koralewski   updating display ...
9
    devices_links = {}
ee2a5e47   Alexis Koralewski   New version of ob...
10
11
    current_file = None
    COMPONENT_PATH = "../../../../config/components/"
6686d675   Alexis Koralewski   new version of ob...
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

    def check_and_return_config(self,yaml_file:str,schema_file:str)->dict:
        """
        Check if yaml_file is valid for the schema_file and return an dictionary of the config file

        Args:
            yaml_file (str): Path to the config_file to be validated
            schema_file (str): Path to the schema file 

        Returns:
            dict: dictionary of the config file (with values)
        """
        # disable pykwalify error to clean the output
        logging.disable(logging.ERROR)
        try:
            c = pykwalify.core.Core(source_file=yaml_file, schema_files=[schema_file])
            return c.validate(raise_exception=True)
        except SchemaError:
            for error in c.errors:
                print("Error :",str(error).split(". Path")[0])
                print("Path to error :",error.path)
            return None

    def read_and_check_config_file(self,yaml_file:str)->dict:
        """
        Read the schema key of the config file to retrieve schema name and proceed to the checking of that config file
        Call check_and_return_config function and print its return.

        Args:
            yaml_file (str): path to the config file
        Returns:
            dict: Dictionary of the config file (with values)
        """
ee2a5e47   Alexis Koralewski   New version of ob...
45
        self.current_file = yaml_file
6686d675   Alexis Koralewski   new version of ob...
46
47
48
49
        try:
            with open(yaml_file, 'r') as stream:
                config_file = yaml.safe_load(stream)

dd54dc29   Alexis Koralewski   Updating schemas,...
50
51
                self.SCHEMA_PATH = os.path.join(os.path.abspath(os.path.dirname(yaml_file)),"../../../config/schemas/")
                self.CONFIG_PATH = os.path.dirname(yaml_file)+"/"
ee2a5e47   Alexis Koralewski   New version of ob...
52
                self.COMPONENT_PATH = os.path.join(os.path.abspath(os.path.dirname(yaml_file)),"../../../config/components/")
dd54dc29   Alexis Koralewski   Updating schemas,...
53
                result = self.check_and_return_config(yaml_file,self.SCHEMA_PATH+config_file["schema"])
6686d675   Alexis Koralewski   new version of ob...
54
55
                if result is None:
                    print("Error when reading and validating config file, please check the errors right above")
ee2a5e47   Alexis Koralewski   New version of ob...
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

                return result

        except yaml.YAMLError as exc:
            print(exc)
        except Exception as e:
            print(e)
            return None
    
    def read_component(self,component_name:str)->dict:
        file_path = self.COMPONENT_PATH + component_name + ".yml"
        try:
            with open(file_path, 'r') as stream:
                config_file = yaml.safe_load(stream)  
                
                attributes = {}
                for attribute in config_file:
                
                    attribute = attribute["attribute"]
                    attributes[attribute.pop("key")] = attribute
                return attributes
        except yaml.YAMLError as exc:
            print(exc)
        except Exception as e:
            print(e)
            return None
    
    def read_capability_of_device(self,capability:dict)->dict:
        """
        

        Args:
            dict ([type]): [description]

        Returns:
            dict: [description]
        """
        
        component_attributes = self.read_component(capability["component"])
        
        attributes = {}
        for attribute in capability["attributes"]:
            attribute = attribute["attribute"]
        
            attributes[attribute.pop("key")] = attribute
        
        for attribute_name in attributes.keys():
            # merging values from general component to specific values of component in config file
            if "is_Enum" in component_attributes[attribute_name].keys():
                # check if value of this attribute is in Enum of general component attribute definition
                enum_values = component_attributes[attribute_name]["value"]
                if attributes[attribute_name]["value"][0] in enum_values:
                    new_attributes = {**component_attributes[attribute_name],**attributes[attribute_name]}
                else:
                    print(f"Error in file {self.current_file} : attribute \"{attribute_name}\" isn't in enum. Accepted values for this attribute : \"{enum_values}\"")
                    exit(1)
            new_attributes = {**component_attributes[attribute_name],**attributes[attribute_name]}
            component_attributes[attribute_name] = new_attributes
        
        capability["attributes"] = component_attributes
        return capability



a2f47fb6   Alexis Koralewski   updating display ...
120
121
122
123
124
125
126
127
128
129
130
131
132
133
    def get_devices_names_and_file(self)->dict:
        """
        

        Returns:
            dict: [description]
        """
        devices_names_and_files = {}
        for device in self.content["OBSERVATORY"]["DEVICES"]:
            device = device["DEVICE"]
            
            devices_names_and_files[device["name"]] = device["file"]
        return devices_names_and_files

ee2a5e47   Alexis Koralewski   New version of ob...
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
    def read_device_config_file(self,config_file_name:str)->dict:
        """

        Args:
            config_file_name (str): [description]

        Returns:
            dict: [description]
        """
        self.current_file = config_file_name
        try:
            with open(config_file_name, 'r') as stream:
                config_file = yaml.safe_load(stream)

                self.SCHEMA_PATH = os.path.join(os.path.abspath(os.path.dirname(config_file_name)),"../../../config/schemas/")
                self.CONFIG_PATH = os.path.dirname(config_file_name)+"/"
                result = self.check_and_return_config(config_file_name,self.SCHEMA_PATH+config_file["schema"])
                if result is None:
                    print("Error when reading and validating config file, please check the errors right above")
                else:
                    device = result["DEVICE"]
                    
                    if "CAPABILITIES" in device:
                        capabilities = []
                        for capability in device["CAPABILITIES"]:
                            capability = capability["CAPABILITY"]
                            
                            capabilities.append(self.read_capability_of_device(capability))
                            
                            
                            
                        device["CAPABILITIES"] = capabilities
                    if "ATTACHED_DEVICES" in device.keys():
a2f47fb6   Alexis Koralewski   updating display ...
167
168
169
                        
                        devices_name_and_file = self.get_devices_names_and_file()
                        active_devices = self.get_active_devices()
ee2a5e47   Alexis Koralewski   New version of ob...
170
                        for attached_device in device["ATTACHED_DEVICES"]:
a2f47fb6   Alexis Koralewski   updating display ...
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
                            print(attached_device["file"])
                            is_attached_device_link_to_agent = False
                            for active_device in active_devices:
                                
                                print(devices_name_and_file[active_device])
                                print(devices_name_and_file[active_device] == attached_device["file"])
                                if devices_name_and_file[active_device] == attached_device["file"]:
                                    is_attached_device_link_to_agent = True
                                    break

                            if self.CONFIG_PATH+attached_device["file"] != config_file_name and not is_attached_device_link_to_agent:
                                config_of_attached_device = self.read_device_config_file(self.CONFIG_PATH+attached_device["file"])
                                
                                capabilities_of_attached_device = None
                                if "CAPABILITIES" in config_of_attached_device["DEVICE"].keys():
                                    capabilities_of_attached_device = config_of_attached_device["DEVICE"]["CAPABILITIES"]
                                if capabilities_of_attached_device is not None:
                                    # get name of device corresponding to the config file name
                                    parent_device_name = [device for device,file_name in devices_name_and_file.items() if file_name == config_file_name[len(self.CONFIG_PATH):] ][0]
                                    
                                    attached_device_name = [device for device,file_name in devices_name_and_file.items() if file_name == attached_device["file"]][0]
                                    print("parrent device name : ",parent_device_name)
                                    print("attached device name : ",attached_device_name)
                                    
                                    self.devices_links[attached_device_name] = parent_device_name
                                    for capability in capabilities_of_attached_device:
                                        result["DEVICE"]["CAPABILITIES"].append(capability)
6686d675   Alexis Koralewski   new version of ob...
198
199
200
                return result
        except yaml.YAMLError as exc:
            print(exc)
dd54dc29   Alexis Koralewski   Updating schemas,...
201
202
        except Exception as e:
            print(e)
6686d675   Alexis Koralewski   new version of ob...
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
            return None

    def __init__(self,config_file_name:str) -> None:
        """
        Initiate class with the config file
        set content attribute to a dictionary containing all values from the config file

        Args:
            config_file_name (str): path to the config file
        """
        obs_config = self.read_and_check_config_file(config_file_name)
        if obs_config is None:
            print(f"Error when trying to read config file (path of config file : {config_file_name}")

        self.content = obs_config
        
   
    def get_obs_name(self)->str:
        """
        Return name of the observatory

        Returns:
            str: Name of the observatory
        """
ee2a5e47   Alexis Koralewski   New version of ob...
227
        return self.content["OBSERVATORY"]["name"]
6686d675   Alexis Koralewski   new version of ob...
228
229
230
231
232
233
234
235
236
237
238
239

    def get_channels(self,unit)->dict:
        """
        return dictionary of channels

        Returns:
            dict: [description]
        """
        channels = {}
        
        for channel_id in range(len(unit["TOPOLOGY"]["CHANNELS"])):
            channel = unit["TOPOLOGY"]["CHANNELS"][channel_id]["CHANNEL"]
ee2a5e47   Alexis Koralewski   New version of ob...
240
            channels[channel["name"]] = channel
6686d675   Alexis Koralewski   new version of ob...
241
242
243
244
245
246
247
248
249
250
251
252
        return channels
    
    def get_computers(self)->dict:
        """
        return dictionary of computers

        Returns:
            dict: [description]
        """
        computers = {}
        for computer_id in range(len(self.content["OBSERVATORY"]["COMPUTERS"])):
            computer = self.content["OBSERVATORY"]["COMPUTERS"][computer_id]["COMPUTER"]
ee2a5e47   Alexis Koralewski   New version of ob...
253
254
255
            if( "file" in computer.keys() ):
                computer["computer_config"]= self.read_and_check_config_file(self.CONFIG_PATH+computer["file"])["COMPUTER"]
            computers[computer["name"]] = computer
6686d675   Alexis Koralewski   new version of ob...
256
257
258
259
260
261
262
263
264
265
266
267
        return computers
    
    def get_devices(self)->dict:
        """
        return dictionary of devices
        
        Returns:
            dict: [description]
        """
        devices = {}
        for device_id in range(len(self.content["OBSERVATORY"]["DEVICES"])):
            device = self.content["OBSERVATORY"]["DEVICES"][device_id]["DEVICE"]
ee2a5e47   Alexis Koralewski   New version of ob...
268
269
270
            if( "file" in device.keys() ):
                device["device_config"] = self.read_device_config_file(self.CONFIG_PATH+device["file"])["DEVICE"]
            devices[device["name"]] = device
6686d675   Alexis Koralewski   new version of ob...
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
        return devices

    def get_agents(self,unit)->dict:
        """
        return dictionary of agents 

        Returns:
            dict: dictionary of agents. For each agents tell the name, computer, device, protocole, etc...
        """
        agents = {}
        
        
        for agent_id in range(len(unit["AGENTS"])):
            # Agents is a list containing dictionary that have only one key
            key = list(unit["AGENTS"][agent_id].keys())[0]
            agent = unit["AGENTS"][agent_id][key]
ee2a5e47   Alexis Koralewski   New version of ob...
287
            agents[agent["name"]] = agent
6686d675   Alexis Koralewski   new version of ob...
288
289
290
291
292
293
294
295
296
297
298
299
        return agents

    def get_channel_groups(self,unit:dict)->dict:
        """
        Return dictionary of channel groups, tell the logic between groups of channels and within a group of channels

        Args:
            unit (dict): dictonary contaning all values of a unit
        Returns:
            dict: dictionary of channel groups (tell the logic and groups of channels)
        """
        info = {}
ee2a5e47   Alexis Koralewski   New version of ob...
300
        info["global_groups_logic"] = unit["TOPOLOGY"]["CHANNEL_GROUPS"]["logic"]
6686d675   Alexis Koralewski   new version of ob...
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
        info["groups"] = {}
        for group_id in range(len(unit["TOPOLOGY"]["CHANNEL_GROUPS"]["GROUPS"])):
            group = unit["TOPOLOGY"]["CHANNEL_GROUPS"]["GROUPS"][group_id]["GROUP"]
            info["groups"][group_id] = group
        return info

    def get_channel_information(self,unit:dict,channel_name:str)->dict:
        """
        Return information of the given channel name of a unit

        Args:
            unit (dict): dictionary representing the unit 
            channel_name (str): name of the channel

        Returns:
            dict: dictionary containing all values that define this channel
        """
        channels = self.get_channels(unit)
        return channels[channel_name]

    def get_topology(self,unit:dict)->dict:
        """
        Return dictionary of the topology of the observatory

        Args:
            unit (dict): dictionary representing the unit
        Returns:
            dict: dictionary representing the topology of an unit (security, mount, channels, channel_groups)
        """
        topology = {}
        for key in unit["TOPOLOGY"].keys():
            branch = unit["TOPOLOGY"][key]
            if key == "CHANNELS":
                topology[key] = self.get_channels(unit)
            elif key == "CHANNEL_GROUPS":
                topology[key] = self.get_channel_groups(unit)
            else:
                topology[key] = branch
        return topology

    def get_active_agents(self,unit:dict)->list:
        """
        Return the list of active agents (i.e. agents that have an association with a device)

        Args:
            unit (dict): dictionary representing the unit

        Returns:
            list: kist of the name of active agents
        """
        return list(self.get_agents(unit).keys())

    def get_units(self)->dict:
        """
        Return all units sort by name defined in the config file

        Returns:
            dict: dictionary giving for a unit_name, his content (name,database,topology,agents,...)
        """
        result = {}
        units = self.content["OBSERVATORY"]["UNITS"]
        for unit in units:
            unit = unit["UNIT"]
ee2a5e47   Alexis Koralewski   New version of ob...
364
            result[unit["name"]] = unit
6686d675   Alexis Koralewski   new version of ob...
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
        return result

    def get_components_agents(self,unit:dict)->dict:
        """
        Return dictionary of component_agents of the given unit

        Args:
            unit (dict): dictionary representing the unit

        Returns:
            dict: dictionary sort by component name giving the associated agent (agent name)
        """
        components_agents = {}
        topology = self.get_topology(unit)
        for element in topology:
            if element in ("SECURITY","MOUNT","CHANNELS"):
                if(element != "CHANNELS"):
                    for component_agent in topology[element]["COMPONENT_AGENTS"]:
                        component_name = list(component_agent.keys())[0]
                        components_agents[component_name] = component_agent[component_name]
                else:
                    for channel in topology[element]:
                        for component_agent in topology[element][channel]["COMPONENT_AGENTS"]:
                            component_name = list(component_agent.keys())[0]
                            components_agents[component_name] = component_agent[component_name]
        return components_agents

    def get_units_name(self)->list:
        """
        Return list of units names 

        Returns:
            [list]: names of units
        """
        return list(self.get_units().keys())

    def get_unit_by_name(self,name:str)->dict:
        """
        Return dictionary containing definition of the unit that match the given name

        Args:
            name (str): name of the unit

        Returns:
            dict: dictonary representing the unit
        """
        return self.get_units()[name]
    
    def get_agents_per_computer(self,unit:dict)->dict:
        """
        Return dictionary that give for each computer, what are the associated agents to it as a list

        Args:
            unit (dict): dictonary representing the unit

        Returns:
            dict:  dictionary that give for each computer, what are the associated agents to it as a list

        """
        agents_per_computer = {}
        agents = self.get_agents(unit)
        for agent in agents:
ee2a5e47   Alexis Koralewski   New version of ob...
427
428
            computer_name = agents[agent]["computer"]
            if(agents[agent]["computer"] not in agents_per_computer.keys()):
6686d675   Alexis Koralewski   new version of ob...
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
                agents_per_computer[computer_name] = [agent]
            else:
                agents_per_computer[computer_name].append(agent)
        return agents_per_computer


    def get_agents_per_device(self,unit:dict)->dict:
        """
        Return dictionary that give for each device, what are the associated agents to it as a list

        Args:
            unit (dict): dictonary representing the unit

        Returns:
            dict:  dictionary that give for each device, what are the associated agents to it as a list

        """
        agents_per_device = {}
        agents = self.get_agents(unit)
        for agent in agents:
ee2a5e47   Alexis Koralewski   New version of ob...
449
450
451
            if("device" in agents[agent].keys()):
                device_name = agents[agent]["device"]
                if(agents[agent]["device"] not in agents_per_device.keys()):
6686d675   Alexis Koralewski   new version of ob...
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
                    agents_per_device[device_name] = [agent]
                else:
                    agents_per_device[device_name].append(agent)
        return agents_per_device

    def get_active_devices(self)->list:
        """
        Return a list of active device names

        Returns:
            list: list of active device names
        """
        active_devices = []
        for unit_name in self.get_units():
            unit = self.get_unit_by_name(unit_name)
            for device in self.get_agents_per_device(unit):
                active_devices.append(device)
        return active_devices

    def get_active_computers(self)->list:
        """
        Return a list of active computer names

        Returns:
            list: list of active computer names
        """
        active_computers = []
        for unit_name in self.get_units():
            unit = self.get_unit_by_name(unit_name)
            for computer in self.get_agents_per_computer(unit):
                active_computers.append(computer)
        return active_computers

    def get_agent_information(self,unit:dict,agent_name:str)->dict:
        """
        Give the dictionary of attributes of the agent for an unit.

        Args:
            unit (dict): dictonary representing the unit
            agent_name (str): agent name

        Returns:
            dict: dictionary containing attributes of the agent
        """
        return self.get_agents(unit)[agent_name]

    def get_device_information(self,device_name:str)->dict:
        """
        Give the dictionary of the attributes of the device 

        Args:
            device_name (str): device name

        Returns:
            dict: dictionary containing attributes of the device
        """
        return self.get_devices()[device_name]

    def get_database_for_unit(self,unit_name:str)->dict:
        """
        Return dictionary of attributes of the database for an unit

        Args:
            unit_name (str): unit name

        Returns:
            dict: dictionary of attributes of the database for an unit
        """
        return self.get_unit_by_name(unit_name)["DATABASE"]

    def get_device_for_agent(self,unit:dict,agent_name:str)->str:
        """
        Return device name associated to the agent

        Args:
            unit (dict): dictonary representing the unit
            agent_name (str): agent name

        Returns:
            str: device name associated to this agent
        """
        agents_per_device = self.get_agents_per_device(unit)
        for device in agents_per_device:
            if agent_name in agents_per_device[device]:
                return self.get_device_information(device)
    def get_unit_of_computer(self,computer_name:str)->str:
        """
        Return the name of the unit where the computer is used

        Args:
            computer_name (str): computer name

        Returns:
            str: unit name
        """
        for unit_name in self.get_units():
            unit = self.get_unit_by_name(unit_name)
            if(computer_name in self.get_agents_per_computer(unit)):
                return unit_name

    def get_unit_of_device(self,device_name:str)->str:
        """
        Return the name of the unit where the device is used

        Args:
            device_name (str): device name

        Returns:
            str: unit name
        """
        for unit_name in self.get_units():
            unit = self.get_unit_by_name(unit_name)
            if(device_name in self.get_agents_per_device(unit)):
                return unit_name

    def get_device_power(self,device_name:str)->dict:
        """
        Return dictionary that contains informations about power if this information is present in the device config file

        Return None if this information isn't stored in device's config file
        Args:
            device_name (str): name of the device

        Returns:
            dict: informations about power of device
        """
ee2a5e47   Alexis Koralewski   New version of ob...
578
        return self.get_devices()[device_name]["device_config"].get("power")
6686d675   Alexis Koralewski   new version of ob...
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593


    def get_device_capabilities(self,device_name:str)->list:
        """
        Return dictionary that contains informations about capabilities if this information is present in the device config file

        Return empty list if this information isn't stored in device's config file
        Args:
            device_name (str): name of the device

        Returns:
            list: list of capabilities of device
        """
        list_of_capabilities = []
        capabilities = self.get_devices()[device_name]["device_config"].get("CAPABILITIES")
ee2a5e47   Alexis Koralewski   New version of ob...
594
        return capabilities
6686d675   Alexis Koralewski   new version of ob...
595
596
597
598
599
600
601
602
603
604
605
606

    def get_device_connector(self,device_name:str)->dict:
        """
        Return dictionary that contains informations about connector if this information is present in the device config file

        Return None if this information isn't stored in device's config file
        Args:
            device_name (str): name of the device

        Returns:
            dict: informations about connector of device
        """
ee2a5e47   Alexis Koralewski   New version of ob...
607
        return self.get_devices()[device_name]["device_config"].get("connector")
6686d675   Alexis Koralewski   new version of ob...
608
609
610
611
612
613
614
615
616
617
618
619

    def get_computer_power(self,computer_name:str)->dict:
        """
        Return dictionary that contains informations about power if this information is present in the device config file

        Return None if this information isn't stored in device's config file
        Args:
            device_name (str): name of the device

        Returns:
            dict: informations about connector of device
        """
ee2a5e47   Alexis Koralewski   New version of ob...
620
        return self.get_computers()[computer_name]["computer_config"].get("power")
dd54dc29   Alexis Koralewski   Updating schemas,...
621
622
623


def main():
a2f47fb6   Alexis Koralewski   updating display ...
624
    config = ConfigPyros("../../../../privatedev/config/guitalens/observatory_guitalens.yml")
ee2a5e47   Alexis Koralewski   New version of ob...
625
626
627
   # print(config.content)
    print(config.get_devices()["FLI-Kepler4040"]["device_config"]["CAPABILITIES"][1]["attributes"]["manufacturer"])
    print(config.get_devices()["FLI-Kepler4040"]["device_config"]["CAPABILITIES"])
dd54dc29   Alexis Koralewski   Updating schemas,...
628
629
630
if __name__ == "__main__": 

    main()