improvements to check validity of config file

Checks have been added to verify file name lenght and to check if it's really a .yaml file.

All tests are now green.

Author: Jonathan, Lutterbeck

examples/configloader.py

@@ -3,10 +3,14 @@
 import os.path
 import yaml
 
-#TODO: change active project
-project = "somthing-else"
 
 def which_path():
+    """
+
+    this checks the operation system of the user.
+    this is used to determine the standard save location for the global gridscale config file.
+
+    """
     #check if os is linux
     if(sys.platform in ("linux", "linux2")):
         path = "~/.config/gridscale"
@@ -31,23 +35,51 @@ def which_path():
     return path
 
 def create_config(path):
+    """
+    this will copy the currently used config file in the standard folder
+    """
     cwd = os.getcwd()
+    path = os.path.join(cwd, path)
     shutil.copyfile(path, syspath)
-    print(f"New config file created, edit config file at: {path}")
+    print(f"New config file created, edit config file at: {syspath}")
+
 
 def load_config(path):
 
-    if not os.path.exists(syspath):
-        create_config(path)
+    """
+    First checking "path" to match minimum length and other requirements.
+
+    Then it opens the specified config file and returns all keys ehich include token and UserId.
+    """
 
-    with open(f"{syspath}", 'r') as stream:
-        try:
-            data = yaml.safe_load(stream)
-            #return list of dictionaries for all projects
-            for value in data.values():
-                return(value)
+    #converts path into string to avoid errors if variable is not supported
+    path = str(path)
+    if(len(path)>2):
+        if (".yaml" in path):
+            #if standard directory is not available run create_config
+            if not os.path.exists(syspath):
+                print("creating new config")
+                create_config(path)
+            #opens specified file to retrieve config tokens
+            with open(f"{path}", 'r') as stream:
+                try:
+                    data = yaml.safe_load(stream)
+                    # return list of dictionaries for all projects
+                    for value in data.values():
+                        return (value)
+                except yaml.YAMLError as exc:
+                    print(exc)
 
-        except yaml.YAMLError as exc:
-            print(exc)
+                except FileNotFoundError:
+                    print("Configuration file is not found")
+
+        #it's not a yaml file. yaml error is raised.
+        else:
+            raise yaml.YAMLError
+
+    #filename is too short
+    else:
+        print("Not a valid file name!")
+        raise AssertionError
 
 syspath = which_path() + "/config.yaml"

examples/examples.py

@@ -10,8 +10,6 @@
 from gs_api_client import Configuration
 
 
-CURRENT_DIR = os.path.dirname(os.path.realpath(__file__))
-
 if __name__ == '__main__':
 
     # run `pip3 install index_by` before executing this file
@@ -20,9 +18,8 @@
     # api_config.debug = True
     api_config.host = 'https://api.gridscale.io'
 
-    #TODO: Change project
-    example_config = os.path.join(CURRENT_DIR, "config.yaml")
-    configfile = load_config(example_config)
+    #TODO: Change filename
+    configfile = load_config("config.yaml")
     api_config.api_key['X-Auth-Token'] = configfile[0].get("token")
     api_config.api_key['X-Auth-UserId'] = configfile[0].get("userId")
     api_config.debug = True