Introduce tox, add more tests & fix bugs

.circleci/config.yml

@@ -20,7 +20,7 @@ jobs:
   build:
     docker:
       - image: circleci/python:3.6.1
-      
+
       - image: redislabs/redisgraph:edge
 
     working_directory: ~/repo
@@ -56,7 +56,7 @@ jobs:
           name: run tests
           command: |
             . venv/bin/activate
-            coverage run test.py
+            coverage run tests/functional/test_all.py
 
       - early_return_for_forked_pull_requests
 
@@ -69,7 +69,7 @@ jobs:
    #   - store_artifacts:
    #       path: test-reports
    #       destination: test-reports
-  
+
 workflows:
   version: 2
   commit:
@@ -84,4 +84,4 @@ workflows:
               only:
                 - master
     jobs:
-      - build  
+      - build

README.md

@@ -61,7 +61,7 @@ for record in result.result_set:
 	person_age = record[1]
 	visit_purpose = record[2]
 	country_name = record[3]
-	
+
 query = """MATCH p = (:person)-[:visited {purpose:"pleasure"}]->(:country) RETURN p"""
 
 result = redis_graph.query(query)
@@ -88,3 +88,10 @@ pip install redisgraph
 ```
 pip install git+https://github.com/RedisGraph/redisgraph-py.git@master
 ```
+
+### Install for development in env
+
+```
+tox -e env
+source ./tox/env/bin/activate
+```

redisgraph/__init__.py

@@ -1,4 +1,4 @@
-from .node import Node
-from .edge import Edge
-from .graph import Graph
-from .path import Path
+from .node import Node     # noqa
+from .edge import Edge     # noqa
+from .graph import Graph   # noqa
+from .path import Path     # noqa

redisgraph/edge.py

@@ -1,12 +1,14 @@
 from redisgraph import Node
 
-from .util import *
+from .util import quote_string
+
 
 class Edge:
     """
     An edge connecting two nodes.
     """
-    def __init__(self, src_node, relation, dest_node, edge_id=None, properties=None):
+    def __init__(self, src_node, relation, dest_node, edge_id=None,
+                 properties=None):
         """
         Create a new edge.
         """

redisgraph/exceptions.py

@@ -1,4 +1,4 @@
+
 class VersionMismatchException(Exception):
     def __init__(self, version):
         self.version = version
-

redisgraph/graph.py

@@ -1,7 +1,9 @@
-from .util import *
 import redis
-from .query_result import QueryResult
-from .exceptions import VersionMismatchException
+
+from redisgraph.util import random_string, quote_string
+from redisgraph.query_result import QueryResult
+from redisgraph.exceptions import VersionMismatchException
+
 
 class Graph:
     """
@@ -173,7 +175,7 @@ def query(self, q, params=None, timeout=None, read_only=False):
             return QueryResult(self, response)
         except redis.exceptions.ResponseError as e:
             if "wrong number of arguments" in str(e):
-                print ("Note: RedisGraph Python requires server version 2.2.8 or above")
+                print("Note: RedisGraph Python requires server version 2.2.8 or above")
             raise e
         except VersionMismatchException as e:
             # client view over the graph schema is out of sync

redisgraph/node.py

@@ -1,4 +1,5 @@
-from .util import *
+from .util import quote_string
+
 
 class Node:
     """
@@ -36,8 +37,8 @@ def __str__(self):
 
     def __eq__(self, rhs):
         # Quick positive check, if both IDs are set.
-        if self.id is not None and rhs.id is not None and self.id == rhs.id:
-            return True
+        if self.id is not None and rhs.id is not None and self.id != rhs.id:
+            return False
 
         # Label should match.
         if self.label != rhs.label:

redisgraph/path.py

@@ -1,10 +1,12 @@
 from .node import Node
 from .edge import Edge
 
-class Path:
 
+class Path:
     def __init__(self, nodes, edges):
-        assert(isinstance(nodes, list) and isinstance(edges, list))
+        if not (isinstance(nodes, list) and isinstance(edges, list)):
+            raise TypeError("nodes and edges must be list")
+
         self._nodes = nodes
         self._edges = edges
         self.append_type = Node
@@ -38,13 +40,15 @@ def nodes_count(self):
         return len(self._nodes)
 
     def add_node(self, node):
-        assert(type(node) == self.append_type)
+        if not isinstance(node, self.append_type):
+            raise AssertionError("Add Edge before adding Node")
         self._nodes.append(node)
         self.append_type = Edge
         return self
 
     def add_edge(self, edge):
-        assert(type(edge) == self.append_type)
+        if not isinstance(edge, self.append_type):
+            raise AssertionError("Add Node before adding Edge")
         self._edges.append(edge)
         self.append_type = Node
         return self

redisgraph/query_result.py

@@ -17,15 +17,17 @@
 INTERNAL_EXECUTION_TIME = 'internal execution time'
 
 STATS = [LABELS_ADDED, NODES_CREATED, PROPERTIES_SET, RELATIONSHIPS_CREATED,
-        NODES_DELETED, RELATIONSHIPS_DELETED, INDICES_CREATED, INDICES_DELETED,
-        CACHED_EXECUTION, INTERNAL_EXECUTION_TIME]
+         NODES_DELETED, RELATIONSHIPS_DELETED, INDICES_CREATED, INDICES_DELETED,
+         CACHED_EXECUTION, INTERNAL_EXECUTION_TIME]
+
 
 class ResultSetColumnTypes:
     COLUMN_UNKNOWN = 0
     COLUMN_SCALAR = 1
     COLUMN_NODE = 2       # Unused as of RedisGraph v2.1.0, retained for backwards compatibility.
     COLUMN_RELATION = 3   # Unused as of RedisGraph v2.1.0, retained for backwards compatibility.
 
+
 class ResultSetScalarTypes:
     VALUE_UNKNOWN = 0
     VALUE_NULL = 1
@@ -38,6 +40,7 @@ class ResultSetScalarTypes:
     VALUE_NODE = 8
     VALUE_PATH = 9
 
+
 class QueryResult:
 
     def __init__(self, graph, response):
@@ -288,4 +291,3 @@ def cached_execution(self):
     @property
     def run_time_ms(self):
         return self._get_stat(INTERNAL_EXECUTION_TIME)
-

redisgraph/util.py

@@ -3,12 +3,14 @@
 
 __all__ = ['random_string', 'quote_string']
 
+
 def random_string(length=10):
     """
     Returns a random N character long string.
     """
     return ''.join(random.choice(string.ascii_lowercase) for x in range(length))
 
+
 def quote_string(v):
     """
     RedisGraph strings must be quoted,
@@ -23,6 +25,8 @@ def quote_string(v):
     if len(v) == 0:
         return '""'
 
+    v = v.replace('"', '\\"')
+
     if v[0] != '"':
         v = '"' + v
 

test-requirements.txt

@@ -0,0 +1,8 @@
+flake8
+
+pytest
+pytest-cov
+pytest-html
+
+testtools>=1.4.0
+mock

tests/README.md

@@ -0,0 +1,51 @@
+# All Redis Graph client tests
+
+To keep code working properly and looking good it's critical to cover
+all functionality with unit and functional tests and use automated code style
+checks.
+
+Unit tests are tests that focus is to test line by line all code of library
+where any of external dependencies need in runtime (like redisgraph) are mocked
+
+Functional tests on other hand act like black box testing, where we make sure
+that client when used with real redisgraph is working properly
+
+Code style checks are analyzing code style, to make sure code looks like
+written by one person.
+
+Combination of these 3 approaches will ensure high quality of the code.
+
+
+To launch test please use: ```tox -e func```
+
+## Requirements to run tests locally
+
+Redisgraph is using tox, highly popular tool that aims to automate and
+standardize testing in Python.
+
+For more details https://tox.readthedocs.io/en/latest/
+
+To install it locally run ```pip install tox```
+
+
+## Running tests locally
+
+```bash
+
+# To run all tests
+tox
+
+# To run py3 tests
+tox -e py3
+
+# To run code style checks
+tox -e pep8
+
+# To run unittests with coverage
+tox -e cover
+
+# To run functional test use
+# Make sure that redis is running locally on standard port 6379
+tox -e func
+
+```