test: sf-mock: apply a few fixes, corrections and improvements

This commit applies some fixes in response to PR review.  It fixes a few type
hints, removes a piece of redundant code, corrects the query_all return type,
and particularly clarifies the exceptions returned to the user.

Author: chrisarridge

registry/tests/mock_simple_salesforce/core.py

@@ -90,7 +90,6 @@ def add_custom_table(
             + [rel + "__r" for rel in related]
         )
         sql += ");"
-        cur = self.con.cursor()
         cur.execute(sql)
         self.con.commit()
 
@@ -111,12 +110,14 @@ def create_record(self, sobject: str, data: dict[str, Any]) -> str:
 
         Raises
         ------
-        Exception
+        ValueError
             If the caller provides an Id, rather than letting this method create a random id.
         """
 
         if "Id" in data:
-            raise Exception
+            raise ValueError(
+                "Record ids should be created automatically rather than set by the caller"
+            )
 
         field_names = ["Id"] + list(data.keys())
 
@@ -237,4 +238,6 @@ def query_all(self, soql_query: str) -> OrderedDict:
 
             records.append(record)
 
-        return {"records": records, "totalSize": len(records), "done": True}
+        return OrderedDict(
+            {"records": records, "totalSize": len(records), "done": True}
+        )

registry/tests/mock_simple_salesforce/soql.py

@@ -88,7 +88,7 @@ def parse_field_name(field_name_from_query: str, sobject: str) -> ParsedFieldNam
 ConvertedQuery = namedtuple("ConvertedQuery", ["sql", "sobject", "joins", "fields"])
 
 
-def convert_soql_to_sqlite(soql_query: str) -> str:
+def convert_soql_to_sqlite(soql_query: str) -> ConvertedQuery:
     """Parse Salesforce Object Query Language query and convert into an SQLite query
 
     Only select queries are supported.
@@ -100,17 +100,20 @@ def convert_soql_to_sqlite(soql_query: str) -> str:
 
     Returns
     -------
-    str
+    ConvertedQuery
 
     Raises
     ------
-    Exception
+    ValueError
+        If a non-SELECT query is passed.
     """
 
     # Parse the query and check we can convert it.
     parsed_query = python_soql_parser.parse(soql_query)
     if parsed_query[0] != "select":
-        raise Exception()
+        raise ValueError(
+            "Only SELECT queries can be parsed by the SimpleSalesforce mock"
+        )
 
     # We need to do three things: find all the tables we need to JOIN, sort out
     # join ids, correct the field names by adding/changing table prefixes.