Week 5

Makefile

@@ -0,0 +1,48 @@
+# -----------------------------
+# Variables
+# -----------------------------
+BACKEND_DIR = backend/python
+FRONTEND_DIR = frontend
+VENV = venv
+
+PYTHON = $(BACKEND_DIR)/$(VENV)/Scripts/python
+PIP = $(BACKEND_DIR)/$(VENV)/Scripts/pip
+
+# -----------------------------
+# Setup
+# -----------------------------
+
+venv:
+	cd $(BACKEND_DIR) && python -m venv $(VENV)
+
+install-backend: venv
+	$(PIP) install --upgrade pip
+	$(PIP) install -r $(BACKEND_DIR)/requirements.txt
+
+install-frontend:
+	cd $(FRONTEND_DIR) && yarn install
+
+setup: install-backend install-frontend
+
+# -----------------------------
+# Run servers
+# -----------------------------
+
+run-backend:
+	cd $(BACKEND_DIR) && $(VENV)/Scripts/python manage.py runserver
+
+run-frontend:
+	cd $(FRONTEND_DIR) && yarn start
+
+# -----------------------------
+# Testing
+# -----------------------------
+
+test:
+	cd $(BACKEND_DIR) && $(VENV)/Scripts/python -m pytest
+
+coverage:
+	cd $(BACKEND_DIR) && $(VENV)/Scripts/python -m pytest --cov
+
+html-coverage:
+	cd $(BACKEND_DIR) && $(VENV)/Scripts/python -m pytest --cov --cov-report=html

README.md

@@ -1,127 +1,157 @@
-# Interneers Lab
+# Product Service & Product Category API
 
-Welcome to the **Interneers Lab** repository! This serves as a minimal starter kit for learning and experimenting with:
-- **Django** (Python)
-- **Golang** (Go)
-- **React**  (with TypeScript)
-- **MongoDB** (via Docker Compose)
-- Development environment in **VSCode** (recommended)
+This repository contains backend services for managing **Products** and **Product Categories**.
+The project includes APIs, service layers, unit tests, integration tests, and automated development workflows using a **Makefile**.
 
-**Important:** Use the **same email** you shared during onboarding when configuring Git and related tools. That ensures consistency across all internal systems.
-
-### Project structure
+---
 
+## Project Structure
 ```
-backend/
-  go/          # Golang backend (see backend/go/README.md)
-  python/      # Django (Python) backend (see backend/python/README.md)
-frontend/      # React + TypeScript (see frontend/README.md)
+├── backend/
+│   ├── python/
+│   │   ├── django_app/
+│   │   ├── htmlcov/
+│   │   ├── product_service/
+│   │   ├── product_category/
+│   │   ├── warehouse/
+│   │   ├── docker-compose.yaml
+│   │   ├── pytest.ini
+│   │   └── requirements.txt
+|   |
+│   └── go/
+│
+├── frontend/
+│
+├── Makefile
+├── README.md
+└── CHANGELOG.md
 ```
+---
+
+## Features
+
+* Product CRUD APIs
+* Product Category APIs
+* Service layer abstraction
+* Unit and integration tests
+* Test coverage reporting
+* Automated development commands using Makefile
 
 ---
 
-## Table of Contents
+## Prerequisites
+
+Before running the project ensure the following are installed:
 
-1. [Getting Started with Git & Forking](#getting-started-with-git-and-forking)
-2. [Prerequisites & where to find them](#prerequisites--where-to-find-them)
-3. [Setting up & running](#setting-up--running)
-4. [Development Workflow](#development-workflow)
-   - [Pushing Your First Change](#pushing-your-first-change)
-5. [Making your first change](#making-your-first-change)
-6. [Running Tests](#running-tests)
-7. [Frontend Setup](#frontend-setup)
-8. [Further Reading](#further-reading)
+* Python 3.10+
+* pip
+* Node.js (for frontend)
+* Yarn
+* Make
 
 ---
 
-## Getting Started with Git and Forking
+## Setup Instructions
 
-### 1. Setting up Git and the Repo
+Clone the repository:
 
-1. **Install Git** (if not already):
-   - **macOS**: [Homebrew](https://brew.sh/) users can run `brew install git`.
-   - **Windows**: Use [Git for Windows](https://gitforwindows.org/).
-   - **Linux**: Install via your distro's package manager, e.g., `sudo apt-get install git` (Ubuntu/Debian).
+```bash
+git clone <repository-url>
+cd interneers-lab
+```
 
-2. **Configure Git** with your name and email:
-   ```bash
-   git config --global user.name "Your Name"
-   git config --global user.email "your.email@example.com" # Use the same email you shared during onboarding
-   ```
+Create virtual environment and install dependencies:
 
-3. **What is Forking?**
+```bash
+make setup
+```
 
-   Forking a repository on GitHub creates your own copy under your GitHub account, where you can make changes independently without affecting the original repo. Later, you can make pull requests to merge changes back if needed.
+This command will:
 
-4. Fork the Rippling/interneers-lab repository (ensure you're in the correct org or your personal GitHub account, as directed).
-5. **Clone** your forked repo:
-   ```bash
-   git clone git@github.com:<YourUsername>/interneers-lab.git
-   cd interneers-lab
-   ```
+* Create a Python virtual environment
+* Install backend dependencies
+* Install frontend dependencies
 
-## Prerequisites & where to find them
+---
 
-Prerequisites (Python, Go, Node, Docker, etc.) and how to verify your setup are documented in each part of the repo:
+## Running the Backend
 
-- **[backend/python/README.md](backend/python/README.md)** — Python/Django, virtualenv, MongoDB
-- **[backend/go/README.md](backend/go/README.md)** — Go, MongoDB
-- **[frontend/README.md](frontend/README.md)** — Node, Yarn, React
+Start the backend server:
 
-Use the README for the part you're working on.
+```bash
+make backend
+```
 
 ---
 
-## Setting up & running
+## Running the Frontend
 
-Setup and run instructions live in the domain READMEs:
+Start the frontend application:
 
-- **Python backend:** [backend/python/README.md](backend/python/README.md) — venv, dependencies, `runserver`, Docker Compose for MongoDB
-- **Go backend:** [backend/go/README.md](backend/go/README.md) — `make setup`, `make build-and-run`, Docker Compose
-- **Frontend:** [frontend/README.md](frontend/README.md)
+```bash
+make frontend
+```
 
 ---
 
-## Development Workflow
+## Running Tests
 
-### Making your first change
+Execute all tests:
 
-Step-by-step tutorials live in the domain READMEs:
+```bash
+make test
+```
 
-- **[backend/python/README.md](backend/python/README.md)** — Django starters (e.g. Hello World, Hello {name} API)
-- **[backend/go/README.md](backend/go/README.md)** — Go hello-world and APIs
-- **[frontend/README.md](frontend/README.md)** — React hello-world and APIs
+This will run **pytest test suites** including unit tests.
 
-### Pushing Your First Change
+---
 
-1. **Stage and commit**:
-   ```bash
-   git add .
-   git commit -m "Your descriptive commit message"
-   ```
-2. **Push to your forked repo (main branch by default):**
-   ```bash
-   git push origin main
-   ```
+## Running Tests with Coverage
+
+Generate test coverage:
+
+```bash
+make coverage
+```
+
+Example output:
+
+```
+---------- coverage ----------
+Name                              Stmts   Miss  Cover
+----------------------------------------------
+product_service/service.py         45      3    93%
+product_category/service.py        30      2    93%
+----------------------------------------------
+TOTAL                              75      5    93%
+```
 
 ---
 
-## Running Tests
+## Development Workflow
 
-See the domain READMEs for how to run tests in each stack:
+Typical development workflow:
 
-- [backend/python/README.md](backend/python/README.md)
-- [backend/go/README.md](backend/go/README.md)
-- [frontend/README.md](frontend/README.md)
+```bash
+make setup
+make test
+make coverage
+```
 
 ---
 
-## Further Reading
+## Testing Overview
+
+The project includes:
+
+### Unit Tests
+
+* Test service layer logic
+* Mock repository layers
+
+### Integration Tests
 
-Each domain has detailed README with links to relevant docs. In general:
+* Validate API endpoints
+* Test full request-response flow
 
-- **Django:** [docs.djangoproject.com](https://docs.djangoproject.com/)
-- **React:** [react.dev](https://react.dev/learn)
-- **Go:** [go.dev/doc](https://go.dev/doc/)
-- **MongoDB:** [docs.mongodb.com](https://docs.mongodb.com/)
-- **Docker Compose:** [docs.docker.com/compose](https://docs.docker.com/compose/)
+Integration tests may require additional services (e.g. MongoDB) and may be skipped if dependencies are unavailable.

backend/python/.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit =
+     warehouse/*

backend/python/README.md

@@ -455,3 +455,4 @@ docker compose down                          # Stop MongoDB
 docker compose ps                            # List running containers
 docker compose logs -f                       # View logs
 ```
+<!-- Starting Django -->

backend/python/conftest.py

@@ -0,0 +1,66 @@
+import pytest
+from pymongo import MongoClient
+from mongoengine import disconnect, connect
+
+@pytest.fixture(scope="session")
+def mongo_client():
+    client = MongoClient("mongodb://root:example@localhost:27019/?authSource=admin")
+    yield client
+    client.close()
+
+@pytest.fixture(scope="session", autouse=True)
+def setup_database():
+    disconnect()
+    connect(
+        db="test_db",
+        host="mongodb://root:example@localhost:27019/test_db?authSource=admin"
+    )
+    yield
+    disconnect()
+
+
+@pytest.fixture(scope="function")
+def test_db(mongo_client):
+    db = mongo_client["test_db"]
+
+    for collection in db.list_collection_names():
+        db[collection].delete_many({})
+
+    yield db
+
+    for collection in db.list_collection_names():
+        db[collection].delete_many({})
+
+@pytest.fixture
+def seeded_categories(test_db):
+    from products.models import Category
+
+    cat1 = Category(name="Fruits", description="Fresh fruits").save()
+    cat2 = Category(name="Vegetables", description="Fresh vegetables").save()
+
+    return [str(cat1.id), str(cat2.id)]
+
+from products.models import Product
+
+@pytest.fixture
+def seeded_products(seeded_categories):
+    p1 = Product(
+        name="Apple",
+        price=10,
+        category=str(seeded_categories[0]),
+        brand="Fruit Brand",
+        quantity=50
+    ).save()
+
+    p2 = Product(
+        name="Carrot",
+        price=8,
+        category=str(seeded_categories[1]),
+        brand="Veg Brand",
+        quantity=40
+    ).save()
+
+    return [p1.id, p2.id]
+
+
+

backend/python/django_app/settings.py

@@ -37,6 +37,8 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
+    "rest_framework",
+    "products",
 ]
 
 MIDDLEWARE = [
@@ -121,3 +123,12 @@
 # https://docs.djangoproject.com/en/6.0/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
+
+from mongoengine import connect
+
+from mongoengine import connect
+
+connect(
+    db="product_db",
+    host="mongodb://root:example@localhost:27019/product_db?authSource=admin"
+)