Merge pull request #1 from toggle-corp/feature/aadd-ci

Add linting and docker build

Author: thenav56

.github/dependabot.yaml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    ignore:
+      - dependency-name: "*"
+        update-types: ["version-update:semver-major"]

.github/pull_request_template.md

@@ -0,0 +1,28 @@
+Addresses
+- #example-issue-number
+
+Depends on
+- #example-Issue/PR-number
+
+NOTE: **Mention related users here if any.**
+
+## Changes
+
+* Detailed list or prose of changes
+* Breaking changes
+* Changes to configurations
+
+## This PR doesn't introduce any:
+
+- [ ] temporary files, auto-generated files or secret keys
+- [ ] n+1 queries
+- [ ] flake8 issues
+- [ ] `print`
+- [ ] typos
+- [ ] unwanted comments
+
+## This PR contains valid:
+
+- [ ] tests
+- [ ] permission checks (tests here too)
+- [ ] translations

.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: Run test
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+
+jobs:
+  test:
+    name: 🚴 Test 🚴
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@main
+
+      - name: 🐳 Prepare Docker
+        id: prep
+        run: |
+          TAG=$(echo $GITHUB_SHA | head -c7)
+          IMAGE="backend"
+          echo "tagged_image=${IMAGE}:${TAG}" >> $GITHUB_OUTPUT
+          echo "tag=${TAG}" >> $GITHUB_OUTPUT
+      - name: 🐳 Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: 🐳 Cache Docker layers
+        uses: actions/cache@v3
+        with:
+          path: /tmp/.buildx-cache
+          key: ${{ runner.os }}-buildx-${{ github.ref }}
+          restore-keys: |
+            ${{ runner.os }}-buildx-refs/develop
+            ${{ runner.os }}-buildx-
+
+      - name: 🐳 Build image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          builder: ${{ steps.buildx.outputs.name }}
+          file: Dockerfile
+          push: false
+          load: true
+          tags: ${{ steps.prep.outputs.tagged_image }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
+
+      - name: 🕮 Validate latest graphql schema.
+        env:
+          DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
+        run: |
+          docker-compose -f ./gh-docker-compose.yml run --rm web bash -c 'wait-for-it db:5432 && ./manage.py graphql_schema --out /ci-share/schema-latest.graphql' &&
+          cmp --silent schema.graphql ./ci-share/schema-latest.graphql || {
+            echo 'The schema.graphql is not up to date with the latest changes. Please update and push latest';
+            diff schema.graphql ./ci-share/schema-latest.graphql;
+            exit 1;
+          }
+
+      - name: 🕮 Validate if there are no pending django migrations.
+        env:
+          DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
+        run: |
+          docker-compose -f ./gh-docker-compose.yml run --rm web bash -c 'wait-for-it db:5432 && ./manage.py makemigrations --check --dry-run' || {
+            echo 'There are some changes to be reflected in the migration. Make sure to run makemigrations';
+            exit 1;
+          }
+
+      # TODO: Run this for CI
+      # - name: 🤞 Run Test 🧪 & Publish coverage to code climate
+      #   env:
+      #     DOCKER_IMAGE_BACKEND: ${{ steps.prep.outputs.tagged_image }}
+      #   run: docker-compose -f gh-docker-compose.yml run --rm web /code/scripts/run_tests.sh
+
+        # Temp fix
+        # https://github.com/docker/build-push-action/blob/master/docs/advanced/cache.md#github-cache
+        # https://github.com/docker/build-push-action/issues/252
+        # https://github.com/moby/buildkit/issues/1896
+      - name: 🐳 Move docker cache (🧙 Hack fix)
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Python lint
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+
+
+jobs:
+  pre_commit_checks:
+    name: 🚴 Pre-Commit checks 🚴
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@main
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@main
+        with:
+          cache: 'poetry'
+      - run: poetry install
+      - uses: pre-commit/action@main
+

apps/journal/migrations/0001_initial.py

@@ -1,16 +1,13 @@
-# Generated by Django 4.2.13 on 2024-06-16 06:25
+# Generated by Django 4.2.13 on 2024-06-18 10:58
 
-from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
 
     initial = True
 
     dependencies = [
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
@@ -21,11 +18,6 @@ class Migration(migrations.Migration):
                 ('date', models.DateField()),
                 ('leave_type', models.PositiveSmallIntegerField(blank=True, choices=[(1, 'Full'), (2, 'First Half'), (3, 'Second Half')], null=True)),
                 ('journal_text', models.TextField(blank=True)),
-                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='+', to=settings.AUTH_USER_MODEL)),
             ],
-            options={
-                'indexes': [models.Index(fields=['date'], name='journal_jou_date_eb308c_idx')],
-                'unique_together': {('user', 'date')},
-            },
         ),
     ]

apps/journal/migrations/0002_initial.py

@@ -0,0 +1,31 @@
+# Generated by Django 4.2.13 on 2024-06-18 10:58
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('journal', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='journal',
+            name='user',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='+', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AddIndex(
+            model_name='journal',
+            index=models.Index(fields=['date'], name='journal_jou_date_eb308c_idx'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='journal',
+            unique_together={('user', 'date')},
+        ),
+    ]

apps/project/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.13 on 2024-06-14 17:50
+# Generated by Django 4.2.13 on 2024-06-18 10:58
 
 from django.db import migrations, models
 import django.db.models.deletion

apps/project/migrations/0002_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.13 on 2024-06-14 17:50
+# Generated by Django 4.2.13 on 2024-06-18 10:58
 
 from django.conf import settings
 from django.db import migrations, models

apps/track/admin.py

@@ -3,11 +3,11 @@
 from django.db import models
 from django.http import HttpRequest
 
-from .models import Milestone, Task, TimeTrack
+from .models import Contract, Task, TimeTrack
 
 
-@admin.register(Milestone)
-class MilestoneAdmin(admin.ModelAdmin):
+@admin.register(Contract)
+class ContractAdmin(admin.ModelAdmin):
     search_fields = ("name",)
     list_filter = (
         AutocompleteFilterFactory("Project", "project"),
@@ -17,7 +17,7 @@ class MilestoneAdmin(admin.ModelAdmin):
     autocomplete_fields = ("project",)
     list_display = ("name", "get_project", "is_archived")
 
-    def get_queryset(self, request: HttpRequest) -> models.QuerySet[Milestone]:
+    def get_queryset(self, request: HttpRequest) -> models.QuerySet[Contract]:
         return super().get_queryset(request).select_related("project")
 
     @admin.display(ordering="project__name", description="Project")
@@ -29,24 +29,24 @@ def get_project(self, obj):
 class TaskAdmin(admin.ModelAdmin):
     search_fields = ("name",)
     list_filter = (
-        AutocompleteFilterFactory("Project", "milestone__project"),
-        AutocompleteFilterFactory("Milestone", "milestone"),
+        AutocompleteFilterFactory("Project", "contract__project"),
+        AutocompleteFilterFactory("Contract", "contract"),
         AutocompleteFilterFactory("Created By", "created_by"),
         "is_archived",
     )
-    autocomplete_fields = ("milestone",)
-    list_display = ("name", "get_project", "get_milestone", "is_archived")
+    autocomplete_fields = ("contract",)
+    list_display = ("name", "get_project", "get_contract", "is_archived")
 
-    def get_queryset(self, request: HttpRequest) -> models.QuerySet[Milestone]:
-        return super().get_queryset(request).select_related("milestone", "milestone__project")
+    def get_queryset(self, request: HttpRequest) -> models.QuerySet[Contract]:
+        return super().get_queryset(request).select_related("contract", "contract__project")
 
     @admin.display(ordering="project__name", description="Project")
     def get_project(self, obj):
-        return obj.milestone.project.name
+        return obj.contract.project.name
 
-    @admin.display(ordering="milestone__name", description="Milestone")
-    def get_milestone(self, obj):
-        return obj.milestone.name
+    @admin.display(ordering="contract__name", description="Contract")
+    def get_contract(self, obj):
+        return obj.contract.name
 
 
 @admin.register(TimeTrack)
@@ -55,14 +55,14 @@ class TimeTrackAdmin(admin.ModelAdmin):
         "date",
         "task_type",
         "is_done",
-        AutocompleteFilterFactory("Project", "task__milestone__project"),
-        AutocompleteFilterFactory("Milestone", "task__milestone"),
+        AutocompleteFilterFactory("Project", "task__contract__project"),
+        AutocompleteFilterFactory("Contract", "task__contract"),
         AutocompleteFilterFactory("Task", "task"),
         AutocompleteFilterFactory("User", "user"),
     )
     autocomplete_fields = ("task",)
     list_display = (
-        "get_milestone",
+        "get_contract",
         "get_project",
         "get_task",
         "get_user",
@@ -72,16 +72,16 @@ class TimeTrackAdmin(admin.ModelAdmin):
         "is_done",
     )
 
-    def get_queryset(self, request: HttpRequest) -> models.QuerySet[Milestone]:
-        return super().get_queryset(request).select_related("user", "task", "task__milestone", "task__milestone__project")
+    def get_queryset(self, request: HttpRequest) -> models.QuerySet[Contract]:
+        return super().get_queryset(request).select_related("user", "task", "task__contract", "task__contract__project")
 
     @admin.display(ordering="project__name", description="Project")
     def get_project(self, obj):
-        return obj.task.milestone.project.name
+        return obj.task.contract.project.name
 
-    @admin.display(ordering="milestone__name", description="Milestone")
-    def get_milestone(self, obj):
-        return obj.task.milestone.name
+    @admin.display(ordering="contract__name", description="Contract")
+    def get_contract(self, obj):
+        return obj.task.contract.name
 
     @admin.display(ordering="task__name", description="Task")
     def get_task(self, obj):

apps/track/dataloaders.py

@@ -1,23 +1,40 @@
 import typing
 
 from asgiref.sync import sync_to_async
+from django.db import models
 from django.utils.functional import cached_property
 from strawberry.dataloader import DataLoader
 
 from apps.common.dataloaders import load_model_objects
 
-from .models import Milestone, Task
+from .models import Contract, Task
 
 if typing.TYPE_CHECKING:
-    from .types import MilestoneType, TaskType
+    from .types import ContractType, TaskType
 
 
 def load_task(keys: list[int]) -> list["TaskType"]:
     return load_model_objects(Task, keys)  # type: ignore[reportReturnType]
 
 
-def load_milestone(keys: list[int]) -> list["MilestoneType"]:
-    return load_model_objects(Milestone, keys)  # type: ignore[reportReturnType]
+def load_contract(keys: list[int]) -> list["ContractType"]:
+    return load_model_objects(Contract, keys)  # type: ignore[reportReturnType]
+
+
+def load_total_tasks_estimated_hours_by_contract(keys: list[int]) -> list[float]:
+    task_qs = (
+        Task.objects.filter(contract__in=keys)
+        .order_by()
+        .values("contract")
+        .annotate(
+            total_estimated_hours=models.Sum("estimated_hours"),
+        )
+    )
+    _map = {
+        contract_id: total_estimated_hours
+        for contract_id, total_estimated_hours in task_qs.values_list("contract", "total_estimated_hours")
+    }
+    return [_map.get(key, 0) for key in keys]
 
 
 class TrackDataLoader:
@@ -27,5 +44,9 @@ def load_task(self):
         return DataLoader(load_fn=sync_to_async(load_task))
 
     @cached_property
-    def load_milestone(self):
-        return DataLoader(load_fn=sync_to_async(load_milestone))
+    def load_contract(self):
+        return DataLoader(load_fn=sync_to_async(load_contract))
+
+    @cached_property
+    def load_total_tasks_estimated_hours_by_contract(self):
+        return DataLoader(load_fn=sync_to_async(load_total_tasks_estimated_hours_by_contract))