Merge pull request #3300 from JdeRobot/add-admin-buttons

Add admin buttons for db save

Author: javizqh

compose_cfg/dev_humble_cpu.yaml

@@ -2,6 +2,8 @@ services:
   my-postgres:
     image: jderobot/robotics-database:latest
     container_name: universe_db
+    networks:
+      - db_network
     environment:
       POSTGRES_DB: academy_db 
       POSTGRES_USER: user-dev 
@@ -22,6 +24,8 @@ services:
   robotics-academy:
     image: jderobot/robotics-academy:latest
     container_name: developer-container
+    networks:
+      - db_network
     command:  "-s"
     ports:
       - "7164:7164"
@@ -34,8 +38,12 @@ services:
       - type: bind
         source: ./src
         target: /RoboticsApplicationManager
+      - ./RoboticsInfrastructure/database/universes.sql:/universes.sql
     tty: true
     stdin_open: true
     depends_on: 
       my-postgres:
         condition: service_healthy
+
+networks:
+  db_network:

compose_cfg/dev_humble_gpu.yaml

@@ -2,6 +2,8 @@ services:
   my-postgres:
     image: jderobot/robotics-database:latest
     container_name: universe_db
+    networks:
+      - db_network
     environment:
       POSTGRES_DB: academy_db 
       POSTGRES_USER: user-dev 
@@ -22,6 +24,8 @@ services:
   robotics-academy:
     image: jderobot/robotics-academy:latest
     container_name: developer-container
+    networks:
+      - db_network
     command:  "-s"
     devices:
       - /dev/dri:/dev/dri
@@ -36,8 +40,12 @@ services:
       - type: bind
         source: ./src
         target: /RoboticsApplicationManager
+      - ./RoboticsInfrastructure/database/universes.sql:/universes.sql
     tty: true
     stdin_open: true
     depends_on: 
       my-postgres:
         condition: service_healthy
+
+networks:
+  db_network:

compose_cfg/dev_humble_nvidia.yaml

@@ -2,6 +2,8 @@ services:
     my-postgres:
         image: jderobot/robotics-database:latest
         container_name: universe_db
+        networks:
+            - db_network
         environment:
             POSTGRES_DB: academy_db
             POSTGRES_USER: user-dev
@@ -22,6 +24,8 @@ services:
     robotics-academy:
         image: jderobot/robotics-academy:latest
         container_name: developer-container
+        networks:
+            - db_network
         command: "-s"
         deploy:
             resources:
@@ -46,10 +50,14 @@ services:
             - type: bind
               source: ./src
               target: /RoboticsApplicationManager
+            - ./RoboticsInfrastructure/database/universes.sql:/universes.sql
         tty: true
         stdin_open: true
         depends_on:
             my-postgres:
                 condition: service_healthy
         links:
             - my-postgres
+
+networks:
+  db_network:

compose_cfg/dev_humble_nvidia_windows.yaml

@@ -2,6 +2,8 @@ services:
   my-postgres:
     image: jderobot/robotics-database:latest
     container_name: universe_db
+    networks:
+      - db_network
     environment:
       POSTGRES_DB: academy_db 
       POSTGRES_USER: user-dev 
@@ -22,6 +24,8 @@ services:
   robotics-academy:
     image: jderobot/robotics-academy:latest
     container_name: developer-container
+    networks:
+      - db_network
     command:  "-s"
     deploy:
       resources:
@@ -47,8 +51,12 @@ services:
         source: ./src
         target: /RoboticsApplicationManager
       - /usr/lib/wsl:/usr/lib/wsl
+      - ./RoboticsInfrastructure/database/universes.sql:/universes.sql
     tty: true
     stdin_open: true
     depends_on: 
       my-postgres:
         condition: service_healthy
+
+networks:
+  db_network:

docs/InstructionsForDevelopers.md

@@ -406,14 +406,11 @@ If there is need for additional resources such as images, you may add them insid
 
 ### Add the exercise to the database
 
-It is also necessary to add the template for the frontend in the folder exercises/templates/exercises.
-
-Then, create the entry in database/exercise/db.sql. This can be achieved in 2 ways, changing it directly on the database or using Django Web Admin:
+To add a exercise to the database you must use Django Web Admin:
 1)  Launch the docker as normal.
 2)  Access http://127.0.0.1:7164/admin/ on a browser and log in with "user" and "pass".
 3)  Click on "add exercise" and fill the required fields specified below.
-4)  Open a shell in the universe_db docker: ```docker exec -it universe_db bash```
-4)  Dump the changes using ```./scripts/saveDb.sh```
+4)  Save the exercise clicking on the "Local Save" button.
 
 An exercise entry in the database must include the following data:
 - ```exercise id```: unique exercise identifier, must match the folder name

exercises/admin.py

@@ -1,11 +1,18 @@
 from django.contrib import admin
 from .models import Exercise, Universe, World, Tool, Robot
 
+from django.contrib import admin
 
 # Register your models here.
 
-admin.site.register(Exercise)
-admin.site.register(Tool)
-admin.site.register(Universe)
-admin.site.register(World)
-admin.site.register(Robot)
+class SaveExAdmin(admin.ModelAdmin):
+    change_list_template = './admin/change_list_ex.html'
+
+class SaveUnivAdmin(admin.ModelAdmin):
+    change_list_template = './admin/change_list_univ.html'
+
+admin.site.register(Exercise, SaveExAdmin)
+admin.site.register(Tool, SaveUnivAdmin)
+admin.site.register(Universe, SaveUnivAdmin)
+admin.site.register(World, SaveUnivAdmin)
+admin.site.register(Robot, SaveUnivAdmin)

exercises/admin/change_list_ex.html

@@ -0,0 +1,24 @@
+{% extends "admin/change_list.html" %}
+{% load i18n static %}
+
+{% block object-tools-items %}
+{{ block.super }}
+<li>
+    <style>#save-db-button{
+    display: block;
+    float: left;
+  padding: 3px 12px;
+    padding-right: 12px;
+  background: var(--object-tools-bg);
+  color: var(--object-tools-fg);
+  font-weight: 400;
+  font-size: 0.6875rem;
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+  user-select: none;
+  &:hover {
+  background-color: var(--object-tools-hover-bg);
+}}</style>
+    <a id="save-db-button" onclick="fetch('/exercises/save_exercise_db')" >Local Save</a>
+</li>
+{% endblock %}

exercises/admin/change_list_univ.html

@@ -0,0 +1,24 @@
+{% extends "admin/change_list.html" %}
+{% load i18n static %}
+
+{% block object-tools-items %}
+{{ block.super }}
+<li>
+    <style>#save-db-button{
+    display: block;
+    float: left;
+  padding: 3px 12px;
+    padding-right: 12px;
+  background: var(--object-tools-bg);
+  color: var(--object-tools-fg);
+  font-weight: 400;
+  font-size: 0.6875rem;
+  text-transform: uppercase;
+  letter-spacing: 0.5px;
+  user-select: none;
+  &:hover {
+  background-color: var(--object-tools-hover-bg);
+}}</style>
+    <a id="save-db-button" onclick="fetch('/exercises/save_universe_db')" >Local Save</a>
+</li>
+{% endblock %}

exercises/urls.py

@@ -4,6 +4,8 @@
 
 urlpatterns = [
     path("exercises/<slug:exercise_id>/", views.load_exercise, name="load_exercise"),
+    path("save_exercise_db/", views.save_exercise_db, name="save_exercise_db"),
+    path("save_universe_db/", views.save_universe_db, name="save_universe_db"),
     path(
         "user_code_zip/",
         views.user_code_zip,

exercises/views.py

@@ -1,5 +1,7 @@
 import json
 import os
+import subprocess
+import sys
 from django.shortcuts import render
 from django.http import HttpResponse
 from django.conf import settings
@@ -59,6 +61,40 @@ def user_code_zip(request):
         )
 
 
+@csrf_exempt
+@api_view(["GET"])
+def save_exercise_db(request):
+
+    subprocess.Popen(
+        [
+            """PGPASSWORD="robotics-academy-dev" pg_dump -U user-dev -d academy_db -h universe_db --table public.exercises --table public.exercises_universes --table public.exercises_tools > RoboticsAcademy/database/exercises/db.sql""",
+        ],
+        shell=True,
+        stdout=sys.stdout,
+        stderr=subprocess.STDOUT,
+        bufsize=1024,
+        universal_newlines=True,
+    )
+
+    return Response({"success": True})
+
+@csrf_exempt
+@api_view(["GET"])
+def save_universe_db(request):
+
+    subprocess.Popen(
+        [
+            """PGPASSWORD="robotics-academy-dev" pg_dump -U user-dev -d academy_db -h universe_db --table public.universes --table public.worlds --table public.robots --table public.tools > /universes.sql""",
+        ],
+        shell=True,
+        stdout=sys.stdout,
+        stderr=subprocess.STDOUT,
+        bufsize=1024,
+        universal_newlines=True,
+    )
+
+    return Response({"success": True})
+
 @error_wrapper("GET", ["project"])
 def get_universes_list(request):
     project_name = request.GET.get("project")