[#28] fixed getRelatedModelsByCode

Author: Castronova

odm2api/ODM2/services/readService.py

@@ -1,6 +1,6 @@
 __author__ = 'jmeline'
 
-from sqlalchemy import func
+from sqlalchemy import func, exc
 import pandas as pd
 
 from odm2api.ODM2 import serviceBase
@@ -938,17 +938,29 @@ def getSimulationByActionID(self, actionID):
             return None
 
     def getRelatedModelsByID(self, modelid):
+        """
+        queries the ODM2 for any models that have a relationship with the provided model id
+        :param modelid: id of the model to search
+        :return: all models related to the specified id
+        """
         try:
             return self._session.query(RelatedModels).filter_by(RelatedModelID=modelid).all()
-        except:
-            return None
+        except Exception, e:
+            print e
+        return None
 
     def getRelatedModelsByCode(self, modelcode):
+        """
+        queries the ODM2 for any models that have a relationship with the provided model id
+        :param modelcode: the code of the model to search
+        :return: all models related to the provided model code
+        """
         try:
-            return self._session.query(Relatedmodel).join(Relatedmodel.ModelID == Model.ModelID) \
-                .filter(Model.ModelCode == modelcode)
-        except:
-            return None
+            return self._session.query(RelatedModels).join(Models, RelatedModels.RelatedModelID == Models.ModelID) \
+                .filter(Models.ModelCode == modelcode).all()
+        except Exception, e:
+            print e
+        return None
 
     def getResultsBySimulationID(self, simulationID):
         try:

tests/test_odm2/test_readservice.py

@@ -145,7 +145,17 @@ def test_getRelatedModelsByCode(self):
         resapi = self.reader.getRelatedModelsByCode('swmm')
 
         assert resapi is not None
-        assert resapi[0].RelatedModelObj.ModelCode == 'swat'
+        assert len(resapi) > 0
+        assert resapi[0].ModelObj.ModelCode == 'swat'
+
+        # test model code that doesn't exist
+        resapi = self.reader.getRelatedModelsByCode('None')
+        assert resapi is not None
+        assert len(resapi) == 0
+
+        # test invalid argument
+        resapi = self.reader.getRelatedModelsByCode(models.ActionBy)
+        assert resapi is None
 
 
 # ################################################################################