Pleasing pylint

Author: XaverStiensmeier

bibigrid/core/actions/create.py

@@ -82,7 +82,7 @@ def write_cluster_state(self, state):
         # all clusters
         cluster_info_path = os.path.normpath(os.path.join(CLUSTER_INFO_FOLDER, f"{self.cluster_id}.yaml"))
         if not cluster_info_path.startswith(os.path.normpath(CLUSTER_INFO_FOLDER)):
-            raise Exception("Invalid cluster_id resulting in path traversal")
+            raise ValueError("Invalid cluster_id resulting in path traversal")
         with open(cluster_info_path, mode="w+", encoding="UTF-8") as cluster_info_file:
             yaml.safe_dump(data=state, stream=cluster_info_file)
 

bibigrid/core/actions/terminate.py

@@ -22,7 +22,7 @@ def write_cluster_state(cluster_id, state):
     # all clusters
     cluster_info_path = os.path.normpath(os.path.join(CLUSTER_INFO_FOLDER, f"{cluster_id}.yaml"))
     if not cluster_info_path.startswith(CLUSTER_INFO_FOLDER):
-        raise Exception("Invalid cluster_id")
+        raise ValueError("Invalid cluster_id resulting in path traversal")
     with open(cluster_info_path, mode="w+", encoding="UTF-8") as cluster_info_file:
         yaml.safe_dump(data=state, stream=cluster_info_file)
 

bibigrid/core/rest/models.py

@@ -6,12 +6,18 @@
 
 
 class BootVolume(BaseModel):
+    """
+    Holds information about where the server boots from
+    """
     name: Optional[str]
     terminate: Optional[bool]
     size: Optional[int]
 
 
 class Volume(BaseModel):
+    """
+        Holds volume/attached storage information
+    """
     name: Optional[str]
     snapshot: Optional[str]
     permanent: Optional[bool]
@@ -24,6 +30,9 @@ class Volume(BaseModel):
 
 
 class Instance(BaseModel):
+    """
+        Holds instance/server information
+    """
     type: str
     image: str
     count: Optional[int]
@@ -35,19 +44,28 @@ class Instance(BaseModel):
 
 
 class UserRole(BaseModel):
+    """
+        Allows users to add custom ansible roles
+    """
     hosts: List[str]
     roles: List[dict]  # Replace 'dict' with more specific type if possible
     varsFiles: Optional[List[str]]
 
 
 class ElasticScheduling(BaseModel):
+    """
+        Holds info on Slurms scheduling
+    """
     SuspendTime: Optional[int]
     SuspendTimeout: Optional[int]
     ResumeTimeout: Optional[int]
     TreeWidth: Optional[int]
 
 
 class SlurmConf(BaseModel):
+    """
+    Holds info on basic Slurm settings
+    """
     db: Optional[str]
     db_user: Optional[str]
     db_password: Optional[str]
@@ -56,11 +74,17 @@ class SlurmConf(BaseModel):
 
 
 class Gateway(BaseModel):
+    """
+    Holds info regarding whether a gateway is used to connect to the master
+    """
     ip: str
     portFunction: str
 
 
 class ConfigModel(BaseModel):
+    """
+    Holds info regarding the configuration
+    """
     infrastructure: str
     cloud: str
     sshUser: str
@@ -95,6 +119,10 @@ class ConfigModel(BaseModel):
 
 
 class OtherConfigModel(ConfigModel):
+    """
+    Holds info about other configurations
+    TODO: Fill in the missing bits
+    """
     vpnInstance: Instance
 
 
@@ -142,6 +170,9 @@ class LogResponseModel(BaseModel):
 
 
 class ClusterStateResponseModel(BaseModel):
+    """
+    Response model for state
+    """
     cluster_id: str
     floating_ip: IPvAnyAddress
     message: str

bibigrid/core/startup_rest.py

@@ -248,7 +248,7 @@ async def get_log(cluster_id: str, lines: int = None):
         return JSONResponse(content={"error": str(exc)}, status_code=400)
 
 
-@app.get("/bibigrid/ready/", response_model=ReadyResponseModel)
+@app.get("/bibigrid/ready/", response_model=ClusterStateResponseModel)
 async def ready(cluster_id: str):
     """
     Expects a cluster id.

bibigrid/core/utility/paths/basic_path.py

@@ -19,4 +19,4 @@
 
 CLUSTER_MEMORY_FOLDER = KEY_FOLDER
 CLUSTER_MEMORY_FILE = ".bibigrid.mem"
-CLUSTER_MEMORY_PATH = os.path.join(CONFIG_FOLDER, CLUSTER_MEMORY_FILE)
+CLUSTER_MEMORY_PATH = os.path.join(CONFIG_FOLDER, CLUSTER_MEMORY_FILE)

bibigrid/core/utility/statics/create_statics.py

@@ -2,7 +2,6 @@
 Containg static variables for create.py to avoid cyclic imports
 """
 
-import os
 from functools import partial
 
 from bibigrid.core.utility.paths import ansible_resources_path as a_rp

bibigrid/core/utility/validate_schema.py

@@ -49,7 +49,8 @@
      Optional('sshPublicKeyFiles'): [str], Optional('sshTimeout'): int,
      Optional('cloudScheduling'): {Optional('sshTimeout'): int}, Optional('autoMount'): bool,
      Optional('nfsShares'): [str],
-     Optional('userRoles'): [{'hosts': [str], 'roles': [{'name': str, Optional('tags'): [str]}], Optional('varsFiles'): [str]}],
+     Optional('userRoles'): [
+         {'hosts': [str], 'roles': [{'name': str, Optional('tags'): [str]}], Optional('varsFiles'): [str]}],
      Optional('localFS'): bool, Optional('localDNSlookup'): bool, Optional('slurm'): bool,
      Optional('slurmConf'): {Optional('db'): str, Optional('db_user'): str, Optional('db_password'): str,
                              Optional('munge_key'): str, Optional('elastic_scheduling'): {Optional('SuspendTime'): int,