feat: OPTIC-1656: Factory boy and core factories (#7116)

Co-authored-by: mcanu <[email protected]>

Author: mcanu

Dockerfile

@@ -87,9 +87,17 @@ ENV PATH="$VENV_PATH/bin:$PATH"
 # Copy dependency files
 COPY pyproject.toml poetry.lock README.md ./
 
+# Set a default build argument for including dev dependencies
+ARG INCLUDE_DEV=false
+
 # Install dependencies without dev packages
 RUN --mount=type=cache,target=$POETRY_CACHE_DIR,sharing=locked \
-    poetry check --lock && poetry install --no-root --without test --extras uwsgi
+    poetry check --lock && \
+    if [ "$INCLUDE_DEV" = "true" ]; then \
+        poetry install --no-root --extras uwsgi --with test; \
+    else \
+        poetry install --no-root --without test --extras uwsgi; \
+    fi
 
 # Install LS
 COPY label_studio label_studio

docker-compose.override.example.yml

@@ -1,5 +1,13 @@
 version: "3.9"
 services:
   app:
+    build:
+      args:
+        - INCLUDE_DEV=true
     env_file:
       - .env
+
+  nginx:
+    build:
+      args:
+        - INCLUDE_DEV=true

label_studio/organizations/functions.py

@@ -4,13 +4,13 @@
 from projects.models import Project
 
 
-def create_organization(title, created_by):
+def create_organization(title, created_by, **kwargs):
     from core.feature_flags import flag_set
 
     JWT_ACCESS_TOKEN_ENABLED = flag_set('fflag__feature_develop__prompts__dia_1829_jwt_token_auth')
 
     with transaction.atomic():
-        org = Organization.objects.create(title=title, created_by=created_by)
+        org = Organization.objects.create(title=title, created_by=created_by, **kwargs)
         OrganizationMember.objects.create(user=created_by, organization=org)
         if JWT_ACCESS_TOKEN_ENABLED:
             # set auth tokens to new system for new users

label_studio/organizations/models.py

@@ -99,9 +99,9 @@ def __str__(self):
         return self.title + ', id=' + str(self.pk)
 
     @classmethod
-    def create_organization(cls, created_by=None, title='Your Organization'):
+    def create_organization(cls, created_by=None, title='Your Organization', **kwargs):
         _create_organization = load_func(settings.CREATE_ORGANIZATION)
-        return _create_organization(title=title, created_by=created_by)
+        return _create_organization(title=title, created_by=created_by, **kwargs)
 
     @classmethod
     def find_by_user(cls, user, check_deleted=False):

label_studio/organizations/tests/__init__.py

@@ -0,0 +1,21 @@
+import factory
+from organizations.models import Organization
+
+
+class OrganizationFactory(factory.django.DjangoModelFactory):
+    title = factory.Faker('company')
+    created_by = factory.SubFactory('users.tests.factories.UserFactory', active_organization=None)
+
+    class Meta:
+        model = Organization
+
+    @classmethod
+    def _create(cls, model_class, *args, **kwargs):
+        return Organization.create_organization(**kwargs)
+
+    @factory.post_generation
+    def created_by_active_organization(self, create, extracted, **kwargs):
+        if not create or not self.created_by:
+            return
+        self.created_by.active_organization = self
+        self.created_by.save(update_fields=['active_organization'])

label_studio/organizations/tests/factories.py

@@ -0,0 +1,18 @@
+import factory
+from projects.models import Project, ProjectMember
+
+
+class ProjectFactory(factory.django.DjangoModelFactory):
+    title = factory.Faker('bs')
+    description = factory.Faker('paragraph')
+    organization = factory.SubFactory('organizations.tests.factories.OrganizationFactory')
+    created_by = factory.SelfAttribute('organization.created_by')
+
+    class Meta:
+        model = Project
+
+    @factory.post_generation
+    def created_by_relationship(self, create, extracted, **kwargs):
+        if not create or not self.created_by:
+            return
+        ProjectMember.objects.create(user=self.created_by, project=self)

label_studio/projects/tests/__init__.py

@@ -0,0 +1,44 @@
+from django.test import TestCase
+from django.urls import reverse
+from django.utils.http import urlencode
+from rest_framework.test import APIClient
+from tasks.models import Task
+
+from .factories import ProjectFactory
+
+
+class TestProjectCountsListAPI(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.project_1 = ProjectFactory()
+        cls.project_2 = ProjectFactory(organization=cls.project_1.organization)
+        Task.objects.create(project=cls.project_1, data={'text': 'Task 1'})
+        Task.objects.create(project=cls.project_1, data={'text': 'Task 2'})
+        Task.objects.create(project=cls.project_2, data={'text': 'Task 3'})
+
+    def get_url(self, **params):
+        return f'{reverse("projects:api:project-counts-list")}?{urlencode(params)}'
+
+    def test_get_counts(self):
+        client = APIClient()
+        client.force_authenticate(user=self.project_1.created_by)
+        response = client.get(self.get_url(include='id,task_number,finished_task_number,total_predictions_number'))
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.json()['count'], 2)
+        self.assertEqual(
+            response.json()['results'],
+            [
+                {
+                    'id': self.project_1.id,
+                    'task_number': 2,
+                    'finished_task_number': 0,
+                    'total_predictions_number': 0,
+                },
+                {
+                    'id': self.project_2.id,
+                    'task_number': 1,
+                    'finished_task_number': 0,
+                    'total_predictions_number': 0,
+                },
+            ],
+        )

label_studio/projects/tests/factories.py

@@ -2,13 +2,6 @@
 
 import pytest
 from django.db.models.query import QuerySet
-from django.test import TestCase
-from django.urls import reverse
-from django.utils.http import urlencode
-from organizations.models import Organization
-from projects.models import Project
-from rest_framework.test import APIClient
-from tasks.models import Task
 from tests.utils import make_project
 from users.models import User
 
@@ -47,45 +40,3 @@ def test_project_all_members(business_client):
 
     assert isinstance(members, QuerySet)
     assert isinstance(members.first(), User)
-
-
-class TestProjectCountsListAPI(TestCase):
-    @classmethod
-    def setUpTestData(cls):
-        cls.user = User.objects.create_user(username='testuser', email='[email protected]', password='testpassword')
-        cls.organization = Organization.objects.create(title='testorganization')
-        cls.user.active_organization = cls.organization
-        cls.user.save()
-        cls.project_1 = Project.objects.create(title='Project 1', organization=cls.organization)
-        cls.project_2 = Project.objects.create(title='Project 2', organization=cls.organization)
-        Task.objects.create(project=cls.project_1, data={'text': 'Task 1'})
-        Task.objects.create(project=cls.project_1, data={'text': 'Task 2'})
-        Task.objects.create(project=cls.project_2, data={'text': 'Task 3'})
-
-    def get_url(self, **params):
-        return f'{reverse("projects:api:project-counts-list")}?{urlencode(params)}'
-
-    def test_get_counts(self):
-
-        client = APIClient()
-        client.force_authenticate(user=self.user)
-        response = client.get(self.get_url(include='id,task_number,finished_task_number,total_predictions_number'))
-        self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json()['count'], 2)
-        self.assertEqual(
-            response.json()['results'],
-            [
-                {
-                    'id': self.project_1.id,
-                    'task_number': 2,
-                    'finished_task_number': 0,
-                    'total_predictions_number': 0,
-                },
-                {
-                    'id': self.project_2.id,
-                    'task_number': 1,
-                    'finished_task_number': 0,
-                    'total_predictions_number': 0,
-                },
-            ],
-        )

label_studio/projects/tests/test_api.py

@@ -0,0 +1,22 @@
+import factory
+from organizations.models import OrganizationMember
+from users.models import User
+
+
+class UserFactory(factory.django.DjangoModelFactory):
+    email = factory.Faker('email')
+    first_name = factory.Faker('first_name')
+    last_name = factory.Faker('last_name')
+    username = factory.LazyAttribute(lambda u: u.email.split('@')[0])
+    password = factory.Faker('password')
+
+    class Meta:
+        model = User
+
+    @factory.post_generation
+    def active_organization(self, create, extracted, **kwargs):
+        if not create or not extracted:
+            return
+        self.active_organization = extracted
+        self.save(update_fields=['active_organization'])
+        OrganizationMember.objects.create(user=self, organization=extracted)

label_studio/tests/test_project.py

@@ -228,6 +228,7 @@ s3transfer = "0.7.0"
 mock = ">=5.1.0"
 moto = ">=4.2.6"
 requests-mock = "1.12.1"
+factory-boy = "^3.3.3"
 
 [tool.poetry.group.build.dependencies]
 twine = ">=6.1.0"