Merge pull request #5 from cloudblue/enh/LITE-24418

LITE-24418 Running tests on real MongoDB

Author: zzzevaka

.github/workflows/build.yml

@@ -15,6 +15,14 @@ jobs:
     strategy:
       matrix:
         python-version: ['3.8', '3.9', '3.10']
+    services:
+      mongo:
+        image: mongo:5
+        ports:
+          - 27017:27017
+        env:
+          MONGO_INITDB_ROOT_USERNAME: root
+          MONGO_INITDB_ROOT_PASSWORD: 1q2w3e
     steps:
       - name: Checkout project
         uses: actions/checkout@v2
@@ -35,6 +43,10 @@ jobs:
       - name: Testing
         run: |
           poetry run pytest
+        env:
+          MONGO_HOST: localhost
+          MONGO_USER: root
+          MONGO_PASSWORD: 1q2w3e
   sonar:
     name: Quality Analysis by sonar
     needs: [build]

Dockerfile

@@ -0,0 +1,9 @@
+ARG PYTHON_VERSION=3.10
+
+FROM python:${PYTHON_VERSION}
+
+WORKDIR /app
+
+ADD . /app
+
+RUN pip install poetry && poetry install

README.md

@@ -95,6 +95,7 @@ Due to implementation and Mongo engine features there may be some limitations in
 
 Check code style: `poetry run flake8`
 Run tests: `poetry run pytest`
+Run integration tests: `docker compose run app_test`
 
 Tests reports are generated in `tests/reports`.
 * `out.xml` - JUnit test results

docker-compose.yml

@@ -0,0 +1,25 @@
+version: "3"
+
+services:
+  mongo:
+    image: mongo:5
+    restart: on-failure
+    environment:
+      MONGO_INITDB_ROOT_USERNAME: root
+      MONGO_INITDB_ROOT_PASSWORD: 1q2w3e
+
+  app_test:
+    container_name: django_mongoengine_rql_test
+    image: django_mongoengine_rql_test
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: bash -c 'poetry run flake8 && poetry run pytest'
+    volumes:
+      - ./:/app
+    depends_on:
+      - mongo
+    environment:
+      MONGO_HOST: mongo
+      MONGO_USER: root
+      MONGO_PASSWORD: 1q2w3e

tests/conftest.py

@@ -0,0 +1,17 @@
+#
+#  Copyright © 2022 CloudBlue LLC. All rights reserved.
+#
+
+import pytest
+
+from tests.documents import Doc
+
+
+@pytest.fixture
+def is_real_mongo(settings):
+    is_real = bool(settings.MONGODB_DATABASES['default']['username'])
+
+    if is_real:
+        Doc.objects.all().delete()
+
+    yield is_real

tests/documents.py

@@ -0,0 +1,22 @@
+#
+#  Copyright © 2022 CloudBlue LLC. All rights reserved.
+#
+
+from django_mongoengine import Document, EmbeddedDocument, fields
+
+
+class EmbDoc(EmbeddedDocument):
+    str_f = fields.StringField()
+    int_f = fields.IntField(blank=True)
+
+
+class Doc(Document):
+    str_f = fields.StringField(max_length=255, blank=True)
+    bl = fields.BooleanField(default=True)
+    dt = fields.DateTimeField(blank=True)
+    d = fields.DateField(blank=True)
+    dec = fields.DecimalField(blank=True)
+    flt = fields.FloatField(blank=True)
+    int_f = fields.IntField(blank=True, db_field='other_int_f')
+
+    related_doc = fields.EmbeddedDocumentField('EmbDoc', blank=True)

tests/settings.py

@@ -1,8 +1,12 @@
+import os
+
 INSTALLED_APPS = [
     'django_mongoengine',
 ]
 
 MONGODB_DATABASES = {'default': {
     'name': 'mongoenginetest',
-    'host': 'mongomock://localhost',
+    'host': os.environ.get('MONGO_HOST', 'mongomock://localhost'),
+    'username': os.environ.get('MONGO_USER'),
+    'password': os.environ.get('MONGO_PASSWORD'),
 }}

tests/test_filter_cls.py

@@ -2,27 +2,10 @@
 #  Copyright © 2022 CloudBlue LLC. All rights reserved.
 #
 
-from django_mongoengine import Document, EmbeddedDocument, fields
 from py_rql.constants import FilterLookups
 
 from dj_mongoengine_rql.filter_cls import MongoengineRQLFilterClass
-
-
-class EmbDoc(EmbeddedDocument):
-    str_f = fields.StringField()
-    int_f = fields.IntField(blank=True)
-
-
-class Doc(Document):
-    str_f = fields.StringField(max_length=255, blank=True)
-    bl = fields.BooleanField(default=True)
-    dt = fields.DateTimeField(blank=True)
-    d = fields.DateField(blank=True)
-    dec = fields.DecimalField(blank=True)
-    flt = fields.FloatField(blank=True)
-    int_f = fields.IntField(blank=True, db_field='other_int_f')
-
-    related_doc = fields.EmbeddedDocumentField('EmbDoc', blank=True)
+from tests.documents import Doc
 
 
 class DocFilterClass(MongoengineRQLFilterClass):
@@ -76,3 +59,13 @@ def test_not():
     _, qs = DocFilterClass(Doc.objects.filter(int_f=1)).apply_filters('not(eq(int_f,120))')
 
     assert qs.query.q == {'$nor': [{'other_int_f': 120}], 'other_int_f': 1}
+
+
+def test_db_operation(is_real_mongo):
+    if is_real_mongo:
+        doc = Doc.objects.create(str_f='a')
+        Doc.objects.create(str_f='b')
+
+        _, qs = DocFilterClass(Doc.objects).apply_filters('str_f=a')
+
+        assert list(qs.all()) == [doc]