add Yaml editor for observatory configuration file

Alexis Koralewski
1 parent afe539cb
Showing 3 changed files with 174 additions and 11 deletions Show diff stats
src/core/pyros_django/obsconfig/configpyros.py
src/core/pyros_django/obsconfig/templates/obsconfig/edit_config.html
src/core/pyros_django/obsconfig/urls.py
@@ -15,7 +15,9 @@ class ConfigPyros:
     devices = None
     computers = None
     agents = None 
+    obs_config_file_content = None
     obs_config_path = os.environ["PATH_TO_OBSCONF_FOLDER"]
+    errors = None
     def verify_if_pickle_needs_to_be_updated(self,observatory_config_file)->bool:
         """[summary]
  
@@ -25,7 +27,8 @@ class ConfigPyros:
         Returns:
             bool: [description]
         """
-        self.CONFIG_PATH = os.path.dirname(observatory_config_file)+"/"
+        #self.CONFIG_PATH = os.path.dirname(observatory_config_file)+"/"
+        self.CONFIG_PATH = self.obs_config_path
         if os.path.isfile(self.CONFIG_PATH+self.pickle_file) == False:
             return True
         else:
@@ -35,7 +38,7 @@ class ConfigPyros:
             obs_config = self.read_and_check_config_file(observatory_config_file)
             if obs_config_mtime > pickle_file_mtime:
                 # create obs file (yaml) from pickle["obsconfig"] with date of pickle within history folder-> nom ficher + année + mois + jour + datetime (avec secondes) -> YYYY/MM/DD H:m:s
-                pickle_datetime = datetime.fromtimestamp(pickle_file_mtime).strftime("%Y%m%d_%H%M%S")
+                pickle_datetime = datetime.utcfromtimestamp(pickle_file_mtime).strftime("%Y%m%d_%H%M%S")
                 # Create history folder if doesn't exist
                 Path(self.obs_config_path+"/history/").mkdir(parents=True, exist_ok=True)
                 file_name = f"{self.obs_config_path}/history/observatory_{pickle_datetime}.yml"
@@ -62,6 +65,7 @@ class ConfigPyros:
  
     def load(self,observatory_config_file):
         does_pickle_needs_to_be_updated = self.verify_if_pickle_needs_to_be_updated(observatory_config_file)
+        print(f"OBS CONFIG FILE {observatory_config_file}")
         if os.path.isfile(self.CONFIG_PATH+self.pickle_file) and does_pickle_needs_to_be_updated == False:
             print("Reading pickle file")
             try:
@@ -79,6 +83,7 @@ class ConfigPyros:
             self.computers = pickle_dict["computers"]
             self.devices = pickle_dict["devices"]
             self.devices_links = pickle_dict["devices_links"]
+            self.obs_config_file_content = pickle_dict["obs_config_file_content"]
         else:
             print("Pickle file needs to be created or updated")
             pickle_dict = {}
@@ -88,6 +93,7 @@ class ConfigPyros:
             pickle_dict["devices"] = self.get_devices()
             pickle_dict["computers"] = self.get_computers()
             pickle_dict["devices_links"] = self.devices_links
+            pickle_dict["obs_config_file_content"] = self.read_and_check_config_file(observatory_config_file) 
             print("Writing pickle file")
             pickle.dump(pickle_dict,open(self.CONFIG_PATH+self.pickle_file,"wb"))
  
@@ -113,16 +119,52 @@ class ConfigPyros:
                     print(f"{yaml_file} can't be accessed, waiting for availability")
                     time.sleep(0.5)
  
-            c = pykwalify.core.Core(source_file=yaml_file, schema_files=[schema_file])
+            c = pykwalify.core.Core(source_file=yaml_file, schema_files=[self.SCHEMA_PATH+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)
+                self.errors = c.errors
             return None
         except IOError:
             print("Error when reading the observatory config file")
  
+    @staticmethod
+    def check_config(yaml_file:str,schema_file:str)->any:
+        """
+        Check if yaml_file is valid for the schema_file and return a boolean or list of errors according the schema
+
+        Args:
+            yaml_file (str): Path to the config_file to be validated
+            schema_file (str): Path to the schema file 
+
+        Returns:
+            any: boolean (True) if the configuration is valid according the schema or a list of error otherwise
+        """
+        # disable pykwalify error to clean the output
+        logging.disable(logging.ERROR)
+        try:
+            can_yaml_file_be_read = False
+            while can_yaml_file_be_read != True:
+                if os.access(yaml_file, os.R_OK):
+                    can_yaml_file_be_read = True
+                else:
+                    print(f"{yaml_file} can't be accessed, waiting for availability")
+                    time.sleep(0.5)
+        
+            c = pykwalify.core.Core(source_file=yaml_file, schema_files=[schema_file])
+            c.validate(raise_exception=True)
+            return True
+        except SchemaError:
+            for error in c.errors:
+                print("Error :",str(error).split(". Path")[0])
+                print("Path to error :",error.path)
+                
+            return c.errors
+        except IOError:
+            print("Error when reading the observatory config file")
+            
     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
@@ -148,10 +190,10 @@ class ConfigPyros:
                 config_file = yaml.safe_load(stream)
  
             self.SCHEMA_PATH = os.path.join(os.environ["DJANGO_PATH"],"../../../config/schemas/")
-            self.CONFIG_PATH = os.path.dirname(yaml_file)+"/"
+            self.CONFIG_PATH = self.obs_config_path
             #self.COMPONENT_PATH = os.path.join(os.path.abspath(os.path.dirname(yaml_file)),"../../../config/components/")
             #self.GENERIC_DEVICES_PATH = os.path.join(os.path.abspath(os.path.dirname(yaml_file)),"../../../config/devices/")
-            result = self.check_and_return_config(yaml_file,self.SCHEMA_PATH+config_file["schema"])
+            result = self.check_and_return_config(yaml_file,config_file["schema"])
             if result == None:
                 print("Error when reading and validating config file, please check the errors right above")
                 exit(1)
@@ -261,17 +303,14 @@ class ConfigPyros:
             with open(config_file_name, 'r') as stream:
                 config_file = yaml.safe_load(stream)
                 # if we're reading a generic device configuration, the path to get the schema is different than usual
-                if is_generic:
-                    self.SCHEMA_PATH =os.path.join(os.environ["DJANGO_PATH"],"../../../config/schemas/")
-                else:
-                    self.SCHEMA_PATH = os.path.join(os.environ["DJANGO_PATH"],"../../../config/schemas/")
+                self.SCHEMA_PATH =os.path.join(os.environ["DJANGO_PATH"],"../../../config/schemas/")
  
                 # read and verify that the device configuration match the schema
-                result = self.check_and_return_config(config_file_name,self.SCHEMA_PATH+config_file["schema"])
+                result = self.check_and_return_config(config_file_name,config_file["schema"])
                 # if the configuration didn't match the schema or had an error when reading the file
                 if result == None:
                     print("Error when reading and validating config file, please check the errors right above")
-                    exit(-1)
+                    exit(1)
                 else:
                     # the configuration is valid
                     # storing DEVICE key in device (DEVICE can contains : attributes of device, capabilities, attached devices)
@@ -0,0 +1,121 @@
+{% extends "base.html" %}
+{% load tags %}
+{% load static %}
+{% block content %}
+
+<style type="text/css" media="screen">
+    #editor { 
+        position: absolute;
+        top: 10vh;
+        right: 25vw;
+        bottom: 5vh;
+        left: 15vw;
+    }
+    #send_file{
+        position:absolute;
+        left:80vw;
+        top: 10vh;
+    }
+    #check_config{
+        position:absolute;
+        left:80vw;
+        top: 20vh;
+    }
+    #save{
+        position:absolute;
+        left:80vw;
+        top: 30vh;
+    }
+    #message{
+        position:absolute;
+        left:80vw;
+        top: 25vh;
+    }
+    .red{
+        color:red;
+    }
+</style>
+
+<div id="editor">
+{{ config_file }}
+</div>
+<div id="send_file">
+<h3>Import from file</h3>
+ <input type="file" name="inputfile"
+            id="inputfile">
+    
+</div>
+<div>
+{% csrf_token %}
+<button id="check_config">Check configuration</button>
+
+<p id="message"></p>
+</div>
+<div id="save" class="hidden">
+<label> File name: (without ".yml" extension)</label>
+    <input id="file_name"></input>
+    <button id="save_btn">Save</button>
+<p id="save_message"></p>
+</div>
+
+<script  src="{% static "/js/ace/src/ace.js" %}"></script>
+<script>
+    var editor = ace.edit("editor");
+    editor.setTheme("ace/theme/eclipse");
+    editor.session.setMode("ace/mode/yaml");
+
+    document.getElementById('inputfile')
+        .addEventListener('change', function() {
+            // loading default file (current observatory configuration file)
+            var fr=new FileReader();
+            fr.onload=function(){
+                editor.setValue(fr.result);
+            }
+                
+            fr.readAsText(this.files[0]);
+            editor.resize();
+            
+    });
+    document.querySelector("#check_config").addEventListener('click',function(){
+        //console.log(editor.getValue());
+        csrf_value = $("[name='csrfmiddlewaretoken']").val();
+        $.post('{% url 'verify_config' %}', { "config": editor.getValue(), csrfmiddlewaretoken: csrf_value }, function(data,status) {
+            console.log(data);
+            console.log(status);
+            if(data["is_valid"] == true){
+                $("#message").empty().attr('class', 'normal').append("Valid configuration, do you want to save it ?");
+                $("#save").toggleClass('hidden');
+            }
+            else{
+                $("#save").attr("class",'hidden')
+                $("#message").empty().attr('class', 'red').append("Invalid configruation, see the errors below:");
+                for(error of data["message"] ){
+                    for(message of error){
+                        $("#message").append("<p>"+message+"</p>");
+
+                    }
+
+                }
+            }
+        });
+    });
+    document.querySelector("#save_btn").addEventListener('click',function(){
+        /*
+        file_name = document.querySelector("#file_name").value;
+        if(file_name.length == 0){
+            $("#save_message").empty().append("<p>Please name your file</p>");
+            return -1
+        }*/
+        //$.post('{% url 'save_config' %}', { "config": editor.getValue(),"file_name":file_name, csrfmiddlewaretoken: csrf_value }, function(data,status) {
+        $.post('{% url 'save_config' %}', { "config": editor.getValue(), csrfmiddlewaretoken: csrf_value }, function(data,status) {
+            if(status == "success"){
+                $("#save_message").empty().append("<p>Configuration saved !</p>");
+            }
+            else{
+                $("#save_message").empty().append("<p class='red'>Error while trying to save the configuration file</p>");
+            }
+        });
+
+    });
+    </script>
+{% endblock %}
 \ No newline at end of file
@@ -9,4 +9,7 @@ urlpatterns = [
     path('unit_hardware_configuration/<str:unit_name>', views.unit_hardware_configuration, name='unit_hardware_configuration'),
     path('computer_details/<str:computer_name>', views.computer_details, name='computer_details'),
     path('device_details/<str:device_name>', views.device_details, name='device_details'),
+    path('edit_config',views.edit_config,name="edit_config"),
+    path('verify_config',views.verify_config,name="verify_config"),
+    path('save_config',views.save_config,name="save_config")
 ]
 \ No newline at end of file