c3lf/c3lf-system-3
9
0
Fork 0
Code Issues 26 Pull requests Releases Wiki Activity

add /api url prefix in backend

Browse source
This commit is contained in:
j3d1 2023-11-19 00:13:29 +01:00
parent e5bec44164
commit 7369db8512
7 changed files with 55 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
core/core/settings.py
View file

@ -10,6 +10,8 @@ For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.2/ref/settings/ https://docs.djangoproject.com/en/4.2/ref/settings/
""" """
import os import os
import sys
import dotenv import dotenv
from pathlib import Path from pathlib import Path
@ -99,16 +101,24 @@ WSGI_APPLICATION = 'core.wsgi.application'
# Database # Database
# https://docs.djangoproject.com/en/4.2/ref/settings/#databases # https://docs.djangoproject.com/en/4.2/ref/settings/#databases
DATABASES = { if 'test' in sys.argv:
'default': { DATABASES = {
'ENGINE': 'django.db.backends.mysql', 'default': {
'HOST': os.getenv('DB_HOST', 'localhost'), 'ENGINE': 'django.db.backends.sqlite3',
'PORT': os.getenv('DB_PORT', '3306'), 'NAME': ':memory:',
'NAME': os.getenv('DB_NAME', 'system3'), }
'USER': os.getenv('DB_USER', 'system3'), }
'PASSWORD': os.getenv('DB_PASSWORD', 'system3'), else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'HOST': os.getenv('DB_HOST', 'localhost'),
'PORT': os.getenv('DB_PORT', '3306'),
'NAME': os.getenv('DB_NAME', 'system3'),
'USER': os.getenv('DB_USER', 'system3'),
'PASSWORD': os.getenv('DB_PASSWORD', 'system3'),
}
} }
}
# Password validation # Password validation
# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators # https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
@ -142,10 +152,10 @@ USE_TZ = True
# Static files (CSS, JavaScript, Images) # Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/4.2/howto/static-files/ # https://docs.djangoproject.com/en/4.2/howto/static-files/
STATIC_ROOT = os.getenv('STATIC_ROOT') STATIC_ROOT = os.getenv('STATIC_ROOT', 'staticfiles')
STATIC_URL = '/static/' STATIC_URL = '/static/'
MEDIA_ROOT = os.getenv('MEDIA_ROOT') MEDIA_ROOT = os.getenv('MEDIA_ROOT', 'userfiles')
MEDIA_URL = '/media/' MEDIA_URL = '/media/'
STORAGES = { STORAGES = {
@ -171,7 +181,6 @@ DATA_UPLOAD_MAX_MEMORY_SIZE = 1024 * 1024 * 128 # 128 MB
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
CHANNEL_LAYERS = { CHANNEL_LAYERS = {
'default': { 'default': {
'BACKEND': 'channels.layers.InMemoryChannelLayer', 'BACKEND': 'channels.layers.InMemoryChannelLayer',

6
core/core/urls.py
View file

@ -21,7 +21,7 @@ from .version import get_info
urlpatterns = [ urlpatterns = [
path('admin/', admin.site.urls), path('admin/', admin.site.urls),
path('1/', include('inventory.api_v1')), path('api/1/', include('inventory.api_v1')),
path('1/', include('files.api_v1')), path('api/1/', include('files.api_v1')),
path('', get_info), path('api/', get_info),
] ]

8
core/files/tests.py
View file

@ -16,7 +16,7 @@ class FileTestCase(TestCase):
def test_list_files(self): def test_list_files(self):
import base64 import base64
item = File.objects.create(data=base64.b64encode(b"foo").decode('utf-8')) item = File.objects.create(data=base64.b64encode(b"foo").decode('utf-8'))
response = client.get('/1/files/') response = client.get('/api/1/files/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()[0]['hash'], item.hash) self.assertEqual(response.json()[0]['hash'], item.hash)
self.assertEqual(len(response.json()[0]['hash']), 64) self.assertEqual(len(response.json()[0]['hash']), 64)
@ -24,7 +24,7 @@ class FileTestCase(TestCase):
def test_one_file(self): def test_one_file(self):
import base64 import base64
item = File.objects.create(data=base64.b64encode(b"foo").decode('utf-8')) item = File.objects.create(data=base64.b64encode(b"foo").decode('utf-8'))
response = client.get(f'/1/file/{item.hash}/') response = client.get(f'/api/1/file/{item.hash}/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()['hash'], item.hash) self.assertEqual(response.json()['hash'], item.hash)
self.assertEqual(len(response.json()['hash']), 64) self.assertEqual(len(response.json()['hash']), 64)
@ -33,7 +33,7 @@ class FileTestCase(TestCase):
import base64 import base64
Item.objects.create(container=self.box, event=self.event, description='1') Item.objects.create(container=self.box, event=self.event, description='1')
item = Item.objects.create(container=self.box, event=self.event, description='2') item = Item.objects.create(container=self.box, event=self.event, description='2')
response = client.post('/1/file/', {'data': base64.b64encode(b"foo").decode('utf-8')}, content_type='application/json') response = client.post('/api/1/file/', {'data': base64.b64encode(b"foo").decode('utf-8')}, content_type='application/json')
self.assertEqual(response.status_code, 201) self.assertEqual(response.status_code, 201)
self.assertEqual(len(response.json()['hash']), 64) self.assertEqual(len(response.json()['hash']), 64)
@ -43,5 +43,5 @@ class FileTestCase(TestCase):
File.objects.create(item=item, data=base64.b64encode(b"foo").decode('utf-8')) File.objects.create(item=item, data=base64.b64encode(b"foo").decode('utf-8'))
file = File.objects.create(item=item, data=base64.b64encode(b"bar").decode('utf-8')) file = File.objects.create(item=item, data=base64.b64encode(b"bar").decode('utf-8'))
self.assertEqual(len(File.objects.all()), 2) self.assertEqual(len(File.objects.all()), 2)
response = client.delete(f'/1/file/{file.hash}/') response = client.delete(f'/api/1/file/{file.hash}/')
self.assertEqual(response.status_code, 204) self.assertEqual(response.status_code, 204)

10
core/inventory/tests/test_api.py
View file

@ -7,28 +7,28 @@ class ApiTest(TestCase):
def test_root(self): def test_root(self):
from core.settings import SYSTEM3_VERSION from core.settings import SYSTEM3_VERSION
response = client.get('/') response = client.get('/api/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()["framework_version"], SYSTEM3_VERSION) self.assertEqual(response.json()["framework_version"], SYSTEM3_VERSION)
def test_events(self): def test_events(self):
response = client.get('/1/events/') response = client.get('/api/1/events/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), []) self.assertEqual(response.json(), [])
def test_containers(self): def test_containers(self):
response = client.get('/1/boxes/') response = client.get('/api/1/boxes/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), []) self.assertEqual(response.json(), [])
def test_files(self): def test_files(self):
response = client.get('/1/files/') response = client.get('/api/1/files/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), []) self.assertEqual(response.json(), [])
def test_items(self): def test_items(self):
from inventory.models import Event from inventory.models import Event
Event.objects.create(slug='TEST1', name='Event') Event.objects.create(slug='TEST1', name='Event')
response = client.get('/1/TEST1/items/') response = client.get('/api/1/TEST1/items/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), []) self.assertEqual(response.json(), [])

12
core/inventory/tests/test_containers.py
View file

@ -7,13 +7,13 @@ client = Client()
class ContainerTestCase(TestCase): class ContainerTestCase(TestCase):
def test_empty(self): def test_empty(self):
response = client.get('/1/boxes/') response = client.get('/api/1/boxes/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), []) self.assertEqual(response.json(), [])
def test_members(self): def test_members(self):
Container.objects.create(name='BOX') Container.objects.create(name='BOX')
response = client.get('/1/boxes/') response = client.get('/api/1/boxes/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()), 1) self.assertEqual(len(response.json()), 1)
self.assertEqual(response.json()[0]['cid'], 1) self.assertEqual(response.json()[0]['cid'], 1)
@ -24,12 +24,12 @@ class ContainerTestCase(TestCase):
Container.objects.create(name='BOX 1') Container.objects.create(name='BOX 1')
Container.objects.create(name='BOX 2') Container.objects.create(name='BOX 2')
Container.objects.create(name='BOX 3') Container.objects.create(name='BOX 3')
response = client.get('/1/boxes/') response = client.get('/api/1/boxes/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()), 3) self.assertEqual(len(response.json()), 3)
def test_create_container(self): def test_create_container(self):
response = client.post('/1/box/', {'name': 'BOX'}) response = client.post('/api/1/box/', {'name': 'BOX'})
self.assertEqual(response.status_code, 201) self.assertEqual(response.status_code, 201)
self.assertEqual(response.json()['cid'], 1) self.assertEqual(response.json()['cid'], 1)
self.assertEqual(response.json()['name'], 'BOX') self.assertEqual(response.json()['name'], 'BOX')
@ -41,7 +41,7 @@ class ContainerTestCase(TestCase):
def test_update_container(self): def test_update_container(self):
from rest_framework.test import APIClient from rest_framework.test import APIClient
box = Container.objects.create(name='BOX 1') box = Container.objects.create(name='BOX 1')
response = APIClient().put(f'/1/box/{box.cid}/', {'name': 'BOX 2'}) response = APIClient().put(f'/api/1/box/{box.cid}/', {'name': 'BOX 2'})
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()['cid'], 1) self.assertEqual(response.json()['cid'], 1)
self.assertEqual(response.json()['name'], 'BOX 2') self.assertEqual(response.json()['name'], 'BOX 2')
@ -54,6 +54,6 @@ class ContainerTestCase(TestCase):
box = Container.objects.create(name='BOX 1') box = Container.objects.create(name='BOX 1')
Container.objects.create(name='BOX 2') Container.objects.create(name='BOX 2')
self.assertEqual(len(Container.objects.all()), 2) self.assertEqual(len(Container.objects.all()), 2)
response = client.delete(f'/1/box/{box.cid}/') response = client.delete(f'/api/1/box/{box.cid}/')
self.assertEqual(response.status_code, 204) self.assertEqual(response.status_code, 204)
self.assertEqual(len(Container.objects.all()), 1) self.assertEqual(len(Container.objects.all()), 1)

12
core/inventory/tests/test_events.py
View file

@ -7,13 +7,13 @@ client = Client()
class EventTestCase(TestCase): class EventTestCase(TestCase):
def test_empty(self): def test_empty(self):
response = client.get('/1/events/') response = client.get('/api/1/events/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), []) self.assertEqual(response.json(), [])
def test_members(self): def test_members(self):
Event.objects.create(slug='EVENT', name='Event') Event.objects.create(slug='EVENT', name='Event')
response = client.get('/1/events/') response = client.get('/api/1/events/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()), 1) self.assertEqual(len(response.json()), 1)
self.assertEqual(response.json()[0]['slug'], 'EVENT') self.assertEqual(response.json()[0]['slug'], 'EVENT')
@ -23,12 +23,12 @@ class EventTestCase(TestCase):
Event.objects.create(slug='EVENT1', name='Event 1') Event.objects.create(slug='EVENT1', name='Event 1')
Event.objects.create(slug='EVENT2', name='Event 2') Event.objects.create(slug='EVENT2', name='Event 2')
Event.objects.create(slug='EVENT3', name='Event 3') Event.objects.create(slug='EVENT3', name='Event 3')
response = client.get('/1/events/') response = client.get('/api/1/events/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()), 3) self.assertEqual(len(response.json()), 3)
def test_create_event(self): def test_create_event(self):
response = client.post('/1/events/', {'slug': 'EVENT', 'name': 'Event'}) response = client.post('/api/1/events/', {'slug': 'EVENT', 'name': 'Event'})
self.assertEqual(response.status_code, 201) self.assertEqual(response.status_code, 201)
self.assertEqual(response.json()['slug'], 'EVENT') self.assertEqual(response.json()['slug'], 'EVENT')
self.assertEqual(response.json()['name'], 'Event') self.assertEqual(response.json()['name'], 'Event')
@ -39,7 +39,7 @@ class EventTestCase(TestCase):
def test_update_event(self): def test_update_event(self):
from rest_framework.test import APIClient from rest_framework.test import APIClient
event = Event.objects.create(slug='EVENT1', name='Event 1') event = Event.objects.create(slug='EVENT1', name='Event 1')
response = APIClient().put(f'/1/events/{event.eid}/', {'slug': 'EVENT2', 'name': 'Event 2 new'}) response = APIClient().put(f'/api/1/events/{event.eid}/', {'slug': 'EVENT2', 'name': 'Event 2 new'})
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json()['slug'], 'EVENT2') self.assertEqual(response.json()['slug'], 'EVENT2')
self.assertEqual(response.json()['name'], 'Event 2 new') self.assertEqual(response.json()['name'], 'Event 2 new')
@ -51,6 +51,6 @@ class EventTestCase(TestCase):
event = Event.objects.create(slug='EVENT1', name='Event 1') event = Event.objects.create(slug='EVENT1', name='Event 1')
Event.objects.create(slug='EVENT2', name='Event 2') Event.objects.create(slug='EVENT2', name='Event 2')
self.assertEqual(len(Event.objects.all()), 2) self.assertEqual(len(Event.objects.all()), 2)
response = client.delete(f'/1/events/{event.eid}/') response = client.delete(f'/api/1/events/{event.eid}/')
self.assertEqual(response.status_code, 204) self.assertEqual(response.status_code, 204)
self.assertEqual(len(Event.objects.all()), 1) self.assertEqual(len(Event.objects.all()), 1)

20
core/inventory/tests/test_items.py
View file

@ -14,13 +14,13 @@ class ItemTestCase(TestCase):
self.box = Container.objects.create(name='BOX') self.box = Container.objects.create(name='BOX')
def test_empty(self): def test_empty(self):
response = client.get(f'/1/{self.event.slug}/item/') response = client.get(f'/api/1/{self.event.slug}/item/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.content, b'[]') self.assertEqual(response.content, b'[]')
def test_members(self): def test_members(self):
item = Item.objects.create(container=self.box, event=self.event, description='1') item = Item.objects.create(container=self.box, event=self.event, description='1')
response = client.get(f'/1/{self.event.slug}/item/') response = client.get(f'/api/1/{self.event.slug}/item/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}]) self.assertEqual(response.json(), [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}])
@ -28,7 +28,7 @@ class ItemTestCase(TestCase):
import base64 import base64
item = Item.objects.create(container=self.box, event=self.event, description='1') item = Item.objects.create(container=self.box, event=self.event, description='1')
file = File.objects.create(item=item, data=base64.b64encode(b"foo").decode('utf-8')) file = File.objects.create(item=item, data=base64.b64encode(b"foo").decode('utf-8'))
response = client.get(f'/1/{self.event.slug}/item/') response = client.get(f'/api/1/{self.event.slug}/item/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), self.assertEqual(response.json(),
[{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash}]) [{'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': file.hash}])
@ -37,12 +37,12 @@ class ItemTestCase(TestCase):
Item.objects.create(container=self.box, event=self.event, description='1') Item.objects.create(container=self.box, event=self.event, description='1')
Item.objects.create(container=self.box, event=self.event, description='2') Item.objects.create(container=self.box, event=self.event, description='2')
Item.objects.create(container=self.box, event=self.event, description='3') Item.objects.create(container=self.box, event=self.event, description='3')
response = client.get(f'/1/{self.event.slug}/item/') response = client.get(f'/api/1/{self.event.slug}/item/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()), 3) self.assertEqual(len(response.json()), 3)
def test_create_item(self): def test_create_item(self):
response = client.post(f'/1/{self.event.slug}/item/', {'cid': self.box.cid, 'description': '1'}) response = client.post(f'/api/1/{self.event.slug}/item/', {'cid': self.box.cid, 'description': '1'})
self.assertEqual(response.status_code, 201) self.assertEqual(response.status_code, 201)
self.assertEqual(response.json(), {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None}) self.assertEqual(response.json(), {'uid': 1, 'description': '1', 'box': 'BOX', 'cid': self.box.cid, 'file': None})
self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(len(Item.objects.all()), 1)
@ -51,12 +51,12 @@ class ItemTestCase(TestCase):
self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid) self.assertEqual(Item.objects.all()[0].container.cid, self.box.cid)
#def test_create_item_fail(self): #def test_create_item_fail(self):
# response = client.post(f'/1/{self.event.slug}/item/', {'cid': self.box.cid}) # response = client.post(f'/api/1/{self.event.slug}/item/', {'cid': self.box.cid})
# self.assertEqual(response.status_code, 500) # self.assertEqual(response.status_code, 500)
def test_update_item(self): def test_update_item(self):
item = Item.objects.create(container=self.box, event=self.event, description='1') item = Item.objects.create(container=self.box, event=self.event, description='1')
response = client.put(f'/1/{self.event.slug}/item/{item.uid}/', {'description': '2'}, content_type='application/json') response = client.put(f'/api/1/{self.event.slug}/item/{item.uid}/', {'description': '2'}, content_type='application/json')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(response.json(), self.assertEqual(response.json(),
{'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None}) {'uid': 1, 'description': '2', 'box': 'BOX', 'cid': self.box.cid, 'file': None})
@ -69,7 +69,7 @@ class ItemTestCase(TestCase):
item = Item.objects.create(container=self.box, event=self.event, description='1') item = Item.objects.create(container=self.box, event=self.event, description='1')
Item.objects.create(container=self.box, event=self.event, description='2') Item.objects.create(container=self.box, event=self.event, description='2')
self.assertEqual(len(Item.objects.all()), 2) self.assertEqual(len(Item.objects.all()), 2)
response = client.delete(f'/1/{self.event.slug}/item/{item.uid}/') response = client.delete(f'/api/1/{self.event.slug}/item/{item.uid}/')
self.assertEqual(response.status_code, 204) self.assertEqual(response.status_code, 204)
self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(len(Item.objects.all()), 1)
@ -77,7 +77,7 @@ class ItemTestCase(TestCase):
Item.objects.create(container=self.box, event=self.event, description='1') Item.objects.create(container=self.box, event=self.event, description='1')
item2 = Item.objects.create(container=self.box, event=self.event, description='2') item2 = Item.objects.create(container=self.box, event=self.event, description='2')
self.assertEqual(len(Item.objects.all()), 2) self.assertEqual(len(Item.objects.all()), 2)
response = client.delete(f'/1/{self.event.slug}/item/{item2.uid}/') response = client.delete(f'/api/1/{self.event.slug}/item/{item2.uid}/')
self.assertEqual(response.status_code, 204) self.assertEqual(response.status_code, 204)
self.assertEqual(len(Item.objects.all()), 1) self.assertEqual(len(Item.objects.all()), 1)
item3 = Item.objects.create(container=self.box, event=self.event, description='3') item3 = Item.objects.create(container=self.box, event=self.event, description='3')
@ -87,7 +87,7 @@ class ItemTestCase(TestCase):
def test_item_count(self): def test_item_count(self):
Item.objects.create(container=self.box, event=self.event, description='1') Item.objects.create(container=self.box, event=self.event, description='1')
Item.objects.create(container=self.box, event=self.event, description='2') Item.objects.create(container=self.box, event=self.event, description='2')
response = client.get('/1/boxes/') response = client.get('/api/1/boxes/')
self.assertEqual(response.status_code, 200) self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()), 1) self.assertEqual(len(response.json()), 1)
self.assertEqual(response.json()[0]['itemCount'], 2) self.assertEqual(response.json()[0]['itemCount'], 2)