From e4d6a15614af9f013722aee8c294ba36c9a5a2aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniele=20Vigan=C3=B2?= Date: Sat, 9 Sep 2023 11:35:06 +0200 Subject: [PATCH] Complete API renaming into DPS. Add sample local_settings --- bite/bite/local_settings.py.sample | 20 +++++++++++++++++++ bite/bite/settings.py | 2 +- bite/bite/urls.py | 4 ++-- bite/{api => dps}/__init__.py | 0 bite/{api => dps}/admin.py | 2 +- bite/{api => dps}/apps.py | 4 ++-- bite/{api => dps}/migrations/0001_initial.py | 4 ++-- bite/{api => dps}/migrations/__init__.py | 0 bite/{api => dps}/models.py | 0 bite/{api => dps}/serializers.py | 2 +- bite/{api => dps}/tests.py | 8 ++++---- bite/{api => dps}/tests/sample.json | 0 bite/{api => dps}/urls.py | 2 +- bite/{api => dps}/views.py | 4 ++-- .../management/commands/dispatcher.py | 2 +- bite/telemetry/management/commands/handler.py | 2 +- bite/telemetry/migrations/0001_initial.py | 4 ++-- bite/telemetry/models.py | 2 +- bite/telemetry/serializers.py | 2 +- bite/telemetry/tests.py | 2 +- docker/simulator/device_simulator.py | 2 +- 21 files changed, 44 insertions(+), 24 deletions(-) create mode 100644 bite/bite/local_settings.py.sample rename bite/{api => dps}/__init__.py (100%) rename bite/{api => dps}/admin.py (97%) rename bite/{api => dps}/apps.py (94%) rename bite/{api => dps}/migrations/0001_initial.py (94%) rename bite/{api => dps}/migrations/__init__.py (100%) rename bite/{api => dps}/models.py (100%) rename bite/{api => dps}/serializers.py (96%) rename bite/{api => dps}/tests.py (87%) rename bite/{api => dps}/tests/sample.json (100%) rename bite/{api => dps}/urls.py (98%) rename bite/{api => dps}/views.py (92%) diff --git a/bite/bite/local_settings.py.sample b/bite/bite/local_settings.py.sample new file mode 100644 index 0000000..1c573b2 --- /dev/null +++ b/bite/bite/local_settings.py.sample @@ -0,0 +1,20 @@ +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql', + 'NAME': 'bite', + 'USER': 'bite', + 'PASSWORD': 'password', + 'HOST': 'localhost', + 'PORT': '5432', + } +} + +MQTT_BROKER = { + 'HOST': 'localhost', + 'PORT': '1883', +} + +KAFKA_BROKER = { + 'HOST': 'localhost', + 'PORT': '29092', +} diff --git a/bite/bite/settings.py b/bite/bite/settings.py index 3d4ce91..8014f2c 100644 --- a/bite/bite/settings.py +++ b/bite/bite/settings.py @@ -61,7 +61,7 @@ INSTALLED_APPS = [ # 'health_check.storage', 'rest_framework', 'bite', - 'api', + 'dps', 'telemetry', ] diff --git a/bite/bite/urls.py b/bite/bite/urls.py index 878546a..b5ee9a7 100644 --- a/bite/bite/urls.py +++ b/bite/bite/urls.py @@ -37,13 +37,13 @@ from django.contrib import admin from django.conf import settings from django.urls import include, path -from api import urls as api_urls +from dps import urls as dps_urls from telemetry import urls as telemetry_urls urlpatterns = [ path('admin/', admin.site.urls), path('ht/', include('health_check.urls')), - path('api/', include(api_urls)), + path('dps/', include(dps_urls)), path('telemetry/', include(telemetry_urls)), ] diff --git a/bite/api/__init__.py b/bite/dps/__init__.py similarity index 100% rename from bite/api/__init__.py rename to bite/dps/__init__.py diff --git a/bite/api/admin.py b/bite/dps/admin.py similarity index 97% rename from bite/api/admin.py rename to bite/dps/admin.py index 9a83191..bd56cb9 100644 --- a/bite/api/admin.py +++ b/bite/dps/admin.py @@ -18,7 +18,7 @@ # along with this program. If not, see . from django.contrib import admin -from api.models import Device, WhiteList +from dps.models import Device, WhiteList @admin.register(Device) diff --git a/bite/api/apps.py b/bite/dps/apps.py similarity index 94% rename from bite/api/apps.py rename to bite/dps/apps.py index 63e4e00..5090321 100644 --- a/bite/api/apps.py +++ b/bite/dps/apps.py @@ -20,5 +20,5 @@ from django.apps import AppConfig -class ApiConfig(AppConfig): - name = 'api' +class DPSConfig(AppConfig): + name = 'dps' diff --git a/bite/api/migrations/0001_initial.py b/bite/dps/migrations/0001_initial.py similarity index 94% rename from bite/api/migrations/0001_initial.py rename to bite/dps/migrations/0001_initial.py index 0276db1..269131a 100644 --- a/bite/api/migrations/0001_initial.py +++ b/bite/dps/migrations/0001_initial.py @@ -1,6 +1,6 @@ # Generated by Django 3.1.3 on 2021-03-19 08:08 -import api.models +import dps.models from django.db import migrations, models import uuid @@ -16,7 +16,7 @@ class Migration(migrations.Migration): migrations.CreateModel( name='Device', fields=[ - ('serial', models.CharField(max_length=128, unique=True, validators=[api.models.device_validation])), + ('serial', models.CharField(max_length=128, unique=True, validators=[dps.models.device_validation])), ('uuid', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)), ('creation_time', models.DateTimeField(auto_now_add=True)), ('updated_time', models.DateTimeField(auto_now=True)), diff --git a/bite/api/migrations/__init__.py b/bite/dps/migrations/__init__.py similarity index 100% rename from bite/api/migrations/__init__.py rename to bite/dps/migrations/__init__.py diff --git a/bite/api/models.py b/bite/dps/models.py similarity index 100% rename from bite/api/models.py rename to bite/dps/models.py diff --git a/bite/api/serializers.py b/bite/dps/serializers.py similarity index 96% rename from bite/api/serializers.py rename to bite/dps/serializers.py index 876f195..91ad6d4 100644 --- a/bite/api/serializers.py +++ b/bite/dps/serializers.py @@ -18,7 +18,7 @@ # along with this program. If not, see . from rest_framework import serializers -from api.models import Device, device_validation +from dps.models import Device, device_validation class DeviceSerializer(serializers.ModelSerializer): diff --git a/bite/api/tests.py b/bite/dps/tests.py similarity index 87% rename from bite/api/tests.py rename to bite/dps/tests.py index 611a8c4..2a030e1 100644 --- a/bite/api/tests.py +++ b/bite/dps/tests.py @@ -18,7 +18,7 @@ # along with this program. If not, see . from django.test import TestCase, Client -from api.models import Device, WhiteList +from dps.models import Device, WhiteList class DPSTestCase(TestCase): @@ -29,17 +29,17 @@ class DPSTestCase(TestCase): Device.objects.create(serial='test1234') def test_no_whitelist(self): - response = self.c.post('/api/device/provision/', + response = self.c.post('/dps/device/provision/', {'serial': 'test12345'}) self.assertEqual(response.status_code, 400) def test_provision_post(self): WhiteList.objects.create(serial='test12345') - response = self.c.post('/api/device/provision/', + response = self.c.post('/dps/device/provision/', {'serial': 'test12345'}) self.assertEqual(response.status_code, 201) def test_provision_get(self): - response = self.c.get('/api/device/list/') + response = self.c.get('/dps/device/list/') self.assertEqual( response.json()[0]['serial'], 'test1234') diff --git a/bite/api/tests/sample.json b/bite/dps/tests/sample.json similarity index 100% rename from bite/api/tests/sample.json rename to bite/dps/tests/sample.json diff --git a/bite/api/urls.py b/bite/dps/urls.py similarity index 98% rename from bite/api/urls.py rename to bite/dps/urls.py index 543f974..6272de4 100644 --- a/bite/api/urls.py +++ b/bite/dps/urls.py @@ -33,7 +33,7 @@ Including another URLconf 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) """ from django.urls import path -from api.views import DPS +from dps.views import DPS urlpatterns = [ path('device/provision/', diff --git a/bite/api/views.py b/bite/dps/views.py similarity index 92% rename from bite/api/views.py rename to bite/dps/views.py index 554d081..3c31e7c 100644 --- a/bite/api/views.py +++ b/bite/dps/views.py @@ -19,8 +19,8 @@ from rest_framework.viewsets import ModelViewSet -from api.models import Device -from api.serializers import DeviceSerializer +from dps.models import Device +from dps.serializers import DeviceSerializer class DPS(ModelViewSet): diff --git a/bite/telemetry/management/commands/dispatcher.py b/bite/telemetry/management/commands/dispatcher.py index a97beb6..abed5ae 100644 --- a/bite/telemetry/management/commands/dispatcher.py +++ b/bite/telemetry/management/commands/dispatcher.py @@ -31,7 +31,7 @@ from django.conf import settings from django.core.management.base import BaseCommand from django.core.exceptions import ObjectDoesNotExist -from api.models import Device +from dps.models import Device class Command(BaseCommand): diff --git a/bite/telemetry/management/commands/handler.py b/bite/telemetry/management/commands/handler.py index f06a753..2502ee5 100644 --- a/bite/telemetry/management/commands/handler.py +++ b/bite/telemetry/management/commands/handler.py @@ -26,7 +26,7 @@ from django.conf import settings from django.core.management.base import BaseCommand from django.core.exceptions import ObjectDoesNotExist -from api.models import Device +from dps.models import Device from telemetry.models import Telemetry diff --git a/bite/telemetry/migrations/0001_initial.py b/bite/telemetry/migrations/0001_initial.py index 9a6222a..8d30fba 100644 --- a/bite/telemetry/migrations/0001_initial.py +++ b/bite/telemetry/migrations/0001_initial.py @@ -11,7 +11,7 @@ class Migration(migrations.Migration): initial = True dependencies = [ - ('api', '0001_initial'), + ('dps', '0001_initial'), ] operations = [ @@ -23,7 +23,7 @@ class Migration(migrations.Migration): ('transport', models.CharField(choices=[('http', 'http'), ('mqtt', 'mqtt')], default='http', max_length=4)), ('clock', models.IntegerField(null=True, validators=[django.core.validators.MinValueValidator(0)])), ('payload', models.JSONField(validators=[telemetry.models.telemetry_validation])), - ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api.device')), + ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dps.device')), ], options={ 'verbose_name_plural': 'Telemetry', diff --git a/bite/telemetry/models.py b/bite/telemetry/models.py index c7cafe9..3f7cec7 100644 --- a/bite/telemetry/models.py +++ b/bite/telemetry/models.py @@ -21,7 +21,7 @@ from django.db import models from django.core.validators import MinValueValidator from django.core.exceptions import ValidationError -from api.models import Device +from dps.models import Device def telemetry_validation(value): diff --git a/bite/telemetry/serializers.py b/bite/telemetry/serializers.py index d657682..251762e 100644 --- a/bite/telemetry/serializers.py +++ b/bite/telemetry/serializers.py @@ -18,7 +18,7 @@ # along with this program. If not, see . from rest_framework import serializers -from api.models import Device +from dps.models import Device from telemetry.models import Telemetry diff --git a/bite/telemetry/tests.py b/bite/telemetry/tests.py index f9f8034..468e50e 100644 --- a/bite/telemetry/tests.py +++ b/bite/telemetry/tests.py @@ -19,7 +19,7 @@ import json from django.test import TestCase, Client -from api.models import Device, WhiteList +from dps.models import Device, WhiteList class ApiTestCase(TestCase): diff --git a/docker/simulator/device_simulator.py b/docker/simulator/device_simulator.py index 209929f..822aade 100755 --- a/docker/simulator/device_simulator.py +++ b/docker/simulator/device_simulator.py @@ -114,7 +114,7 @@ def main(): ) args = parser.parse_args() - dps = "/api/device/provision/" + dps = "/dps/device/provision/" telemetry = "/telemetry/" if args.serial is None: