Skip to content

Commit

Permalink
Update: Create custom 'User' model, wrotes tests for the 'User' model…
Browse files Browse the repository at this point in the history
…, Customized the 'Admin' page.
  • Loading branch information
PC-Ngumoha committed Mar 11, 2024
1 parent 49185f8 commit deba66b
Show file tree
Hide file tree
Showing 6 changed files with 220 additions and 4 deletions.
2 changes: 2 additions & 0 deletions app/app/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,5 @@
# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

AUTH_USER_MODEL = 'core.User'
46 changes: 44 additions & 2 deletions app/core/admin.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,45 @@
from django.contrib import admin # noqa
"""
Django admin customization
"""
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
from django.utils.translation import gettext_lazy as _

# Register your models here.
from core import models

# Configures the way the admin page appears.
class UserAdmin(BaseUserAdmin):
"""Define the admin pages for users"""
ordering = ('id',)
list_display = ('email', 'name')
fieldsets = (
(None, {'fields': ('email', 'password')}),
(
_('Permissions'),
{
'fields': (
'is_active',
'is_staff',
'is_superuser',
)
}
),
(_('Important dates'), {'fields': ('last_login',)}),
)
readonly_fields = ('last_login',)
add_fieldsets = (
(None, {
'classes': ('wide',),
'fields': (
'email',
'password1',
'password2',
'name',
'is_active',
'is_staff',
'is_superuser',
)
}),
)

admin.site.register(models.User, UserAdmin)
33 changes: 33 additions & 0 deletions app/core/migrations/0001_initial.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Generated by Django 3.2.25 on 2024-03-11 16:50

from django.db import migrations, models


class Migration(migrations.Migration):

initial = True

dependencies = [
('auth', '0012_alter_user_first_name_max_length'),
]

operations = [
migrations.CreateModel(
name='User',
fields=[
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
('password', models.CharField(max_length=128, verbose_name='password')),
('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
('email', models.EmailField(max_length=255, unique=True)),
('name', models.CharField(max_length=255)),
('is_active', models.BooleanField(default=True)),
('is_staff', models.BooleanField(default=False)),
('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.Group', verbose_name='groups')),
('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.Permission', verbose_name='user permissions')),
],
options={
'abstract': False,
},
),
]
47 changes: 45 additions & 2 deletions app/core/models.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,46 @@
from django.db import models # noqa
"""
DB models.
"""
from django.db import models
from django.contrib.auth.models import (
AbstractBaseUser,
BaseUserManager,
PermissionsMixin,
)

# Create your models here.

class UserManager(BaseUserManager):
"""Manager for the users"""
def create_user(self, email, password=None, **extra_fields):
"""Create, save & return a new user."""
if not email:
raise ValueError('User must have an email address')
user = self.model(
email=self.normalize_email(email),
**extra_fields
)
user.set_password(password)
user.save(using=self._db)

return user

def create_superuser(self, email, password):
"""Create and return a new superuser"""
user = self.create_user(email, password)
user.is_staff = True
user.is_superuser = True
user.save(using=self._db)

return user


class User(AbstractBaseUser, PermissionsMixin):
"""User in the system."""
email = models.EmailField(max_length=255, unique=True)
name = models.CharField(max_length=255)
is_active = models.BooleanField(default=True)
is_staff = models.BooleanField(default=False)

USERNAME_FIELD = 'email'

objects = UserManager()
47 changes: 47 additions & 0 deletions app/core/tests/test_admin.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
"""
Tests for the django admin modifications
"""
from django.test import TestCase
from django.contrib.auth import get_user_model
from django.urls import reverse
from django.test import Client


class AdminSiteTests(TestCase):
"""Tests for the Django admin."""

def setUp(self):
"""Create user and client"""
self.client = Client()
self.admin_user = get_user_model().objects.create_superuser(
email='admin@example.com',
password='testpass123',
)
self.client.force_login(self.admin_user)
self.user = get_user_model().objects.create_user(
email='user@example.com',
password='testpass123',
name='Test user'
)

def test_users_list(self):
"""Tests that the users are listed on page."""
url = reverse('admin:core_user_changelist')
res = self.client.get(url)

self.assertContains(res, self.user.name)
self.assertContains(res, self.user.email)

def test_edit_user_page(self):
"""Tests that the edit user page works."""
url = reverse('admin:core_user_change', args=[self.user.id])
res = self.client.get(url)

self.assertEqual(res.status_code, 200)

def test_create_user_page(self):
"""Tests that the create user page works."""
url = reverse('admin:core_user_add')
res = self.client.get(url)

self.assertEqual(res.status_code, 200)
49 changes: 49 additions & 0 deletions app/core/tests/test_models.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
"""
Tests for models.
"""
from django.test import TestCase
from django.contrib.auth import get_user_model


class ModelTests(TestCase):
"""Test models"""

def test_create_user_with_email_successful(self):
"""Test creating a user with an email is successful."""
email = 'test@example.com'
password = 'testing123#'
user = get_user_model().objects.create_user(
email=email,
password=password,
)

self.assertEqual(user.email, email)
self.assertTrue(user.check_password(password))

def test_new_user_email_normalized(self):
"""Test email is normalized for all new users"""
sample_emails = [
('test1@EXAMPLE.com', 'test1@example.com'),
('Test2@Example.com', 'Test2@example.com'),
('TEST3@EXAMPLE.COM', 'TEST3@example.com'),
('test4@example.com', 'test4@example.com'),
]

for email, expected in sample_emails:
user = get_user_model().objects.create_user(email, 'sample123')
self.assertEqual(user.email, expected)

def test_new_user_without_email_raises_error(self):
"""Test that creating the user without an email raises a ValueError"""
with self.assertRaises(ValueError):
get_user_model().objects.create_user('', 'sample123')

def test_create_superuser(self):
"""Test Creating a superuser"""
user = get_user_model().objects.create_superuser(
'test@example.com',
'test123'
)

self.assertTrue(user.is_superuser)
self.assertTrue(user.is_staff)

0 comments on commit deba66b

Please sign in to comment.