[DONE] Utilisation de l'adresse pod.localhost pour le développement (…

…EsupPortail#1134)

* chore: use pod.localhost in the dev env

This replaces the 'pod-back' hostname in the docker network,
and 'localhost' elsewhere.

This way the same hostname is used inside and outside docker,
this avoids confusions while developing.

* refactor: use .localhost domains for elasticserach and redis

CONFIGURATION_FR.md

@@ -340,7 +340,7 @@ Il faudra pour cela créer un fichier de langue et traduire chaque entrée.<br>
   >> d’encodage ou de flux RSS si la variable `CONTACT_US_EMAIL` n’est pas renseignée.<br><br>
   >> _ref : [docs.djangoproject.com](https://docs.djangoproject.com/fr/3.2/ref/settings/#admins)_<br>
 * `ALLOWED_HOSTS`
-  > valeur par défaut : `['localhost']`
+  > valeur par défaut : `['pod.localhost']`
   >> Une liste de chaînes représentant des noms de domaine/d’hôte que ce site Django peut servir.<br><br>
   >> C’est une mesure de sécurité pour empêcher les attaques d’en-tête Host HTTP,<br>
   >> qui sont possibles même avec bien des configurations de serveur Web apparemment sécurisées.<br><br>
@@ -359,15 +359,15 @@ Il faudra pour cela créer un fichier de langue et traduire chaque entrée.<br>
   >>     # },
   >>     "default": {
   >>         "BACKEND": "django_redis.cache.RedisCache",
-  >>         "LOCATION": "redis://127.0.0.1:6379/1",
+  >>         "LOCATION": "redis://redis.localhost:6379/1",
   >>         "OPTIONS": {
   >>             "CLIENT_CLASS": "django_redis.client.DefaultClient",
   >>         },
   >>     },
   >>     # Persistent cache setup for select2 (NOT DummyCache or LocMemCache).
   >>     "select2": {
   >>         "BACKEND": "django_redis.cache.RedisCache",
-  >>         "LOCATION": "redis://127.0.0.1:6379/2",
+  >>         "LOCATION": "redis://redis.localhost:6379/2",
   >>         "OPTIONS": {
   >>             "CLIENT_CLASS": "django_redis.client.DefaultClient",
   >>         },
@@ -1934,7 +1934,7 @@ Il est possible d’encoder en local ou en distant.<br>
 Attention, il faut configurer Celery pour l’envoi des instructions pour l’encodage distant.<br>
 
 * `CELERY_BROKER_URL`
-  > valeur par défaut : `redis://127.0.0.1:6379/5`
+  > valeur par défaut : `redis://redis.localhost:6379/5`
   >> URL du courtier de messages où Celery stocke les ordres d’encodage et de transcription.<br>
 * `CELERY_TO_ENCODE`
   > valeur par défaut : `False`
@@ -1976,7 +1976,7 @@ Attention, il faut configurer Celery pour l’envoi des instructions pour l’en
   >>
   >> Il faut renseigner l’url du redis sur lequel Celery<br>
   >> va chercher les ordres d’encodage et de transcription<br>
-  >> par exemple : "redis://redis:6379/7"<br>
+  >> par exemple : "redis://redis.localhost:6379/7"<br>
 * `FORMAT_CHOICES`
   > valeur par défaut : `()`
   >> Format d’encodage réalisé sur la plateforme.<br>
@@ -2057,7 +2057,7 @@ Attention, il faut configurer Celery pour l’envoi des instructions pour l’en
   > valeur par défaut : `30`
   >> Valeur de timeout pour ElasticSearch.<br>
 * `ES_URL`
-  > valeur par défaut : `["http://127.0.0.1:9200/"]`
+  > valeur par défaut : `["http://elasticsearch.localhost:9200/"]`
   >> Adresse du ou des instances d’Elasticsearch utilisées pour<br>
   >> l’indexation et la recherche de vidéo.<br>
 * `ES_VERSION`

Makefile

@@ -12,16 +12,16 @@ help:
 
 # Démarre le serveur de test
 start:
-	(sleep 15 ; open http://localhost:8000) &
-	python3 manage.py runserver localhost:8000 --insecure
+	(sleep 15 ; open http://pod.localhost:8000) &
+	python3 manage.py runserver pod.localhost:8000 --insecure
 	# --insecure let serve static files even when DEBUG=False
 
 # Démarre le serveur de test en https auto-signé
 starts:
 	# nécessite les django-extensions
 	# cf https://timonweb.com/django/https-django-development-server-ssl-certificate/
-	(sleep 15 ; open https://localhost:8000) &
-	python3 manage.py runserver_plus localhost:8000 --cert-file cert.pem --key-file key.pem
+	(sleep 15 ; open https://pod.localhost:8000) &
+	python3 manage.py runserver_plus pod.localhost:8000 --cert-file cert.pem --key-file key.pem
 
 # Première installation de pod (BDD SQLite intégrée)
 install:

docker-compose-dev-with-volumes.yml

@@ -9,6 +9,7 @@ version: '3.7'
 services:
   pod:
     container_name: pod-dev-with-volumes
+    hostname: pod.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod/Dockerfile
@@ -23,6 +24,7 @@ services:
 
   elasticsearch:
     container_name: elasticsearch-with-volumes
+    hostname: elasticsearch.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/elasticsearch/dockerfile-elasticsearch-dev
@@ -36,6 +38,7 @@ services:
 
   redis:
     container_name: redis-with-volumes
+    hostname: redis.localhost
     image: ${REDIS_TAG}
     env_file:
       - ./.env.dev
@@ -44,7 +47,7 @@ services:
 
 #  redis-commander:
 #    container_name: redis-commander
-#    hostname: redis-commander
+#    hostname: redis-commander.localhost
 #    image: rediscommander/redis-commander:latest
 #    restart: always
 #    environment:

docker-compose-full-dev-with-volumes-test.yml

@@ -9,6 +9,7 @@ version: '3.7'
 services:
   pod-back:
     container_name: pod-back-with-volumes
+    hostname: pod.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-back/Dockerfile
@@ -23,6 +24,7 @@ services:
 
   pod-encode:
     container_name: pod-encode-with-volumes
+    hostname: pod-encode.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-encode/Dockerfile
@@ -34,6 +36,7 @@ services:
 
   pod-transcript:
     container_name: pod-transcript-with-volumes
+    hostname: pod-transcript.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-transcript/Dockerfile
@@ -45,6 +48,7 @@ services:
 
   pod-xapi:
     container_name: pod-xapi-with-volumes
+    hostname: pod-xapi.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-xapi/Dockerfile
@@ -56,6 +60,7 @@ services:
 
   elasticsearch:
     container_name: elasticsearch-with-volumes
+    hostname: elasticsearch.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/elasticsearch/dockerfile-elasticsearch-dev
@@ -69,6 +74,7 @@ services:
 
   redis:
     container_name: redis-with-volumes
+    hostname: redis.localhost
     image: ${REDIS_TAG}
     env_file:
       - ./.env.dev
@@ -86,7 +92,7 @@ services:
 
 #  redis-commander:
 #    container_name: redis-commander
-#    hostname: redis-commander
+#    hostname: redis-commander.localhost
 #    image: rediscommander/redis-commander:latest
 #    restart: always
 #    environment:

docker-compose-full-dev-with-volumes.yml

@@ -24,6 +24,7 @@ services:
 
   pod-encode:
     container_name: pod-encode-with-volumes
+    hostname: pod-encode.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-encode/Dockerfile
@@ -35,6 +36,7 @@ services:
 
   pod-transcript:
     container_name: pod-transcript-with-volumes
+    hostname: pod-transcript.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-transcript/Dockerfile
@@ -46,6 +48,7 @@ services:
 
   pod-xapi:
     container_name: pod-xapi-with-volumes
+    hostname: pod-xapi.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/pod-xapi/Dockerfile
@@ -69,6 +72,7 @@ services:
 
   elasticsearch:
     container_name: elasticsearch-with-volumes
+    hostname: elasticsearch.localhost
     build:
       context: .
       dockerfile: dockerfile-dev-with-volumes/elasticsearch/dockerfile-elasticsearch-dev
@@ -82,6 +86,7 @@ services:
 
   redis:
     container_name: redis-with-volumes
+    hostname: redis.localhost
     image: ${REDIS_TAG}
     env_file:
       - ./.env.dev
@@ -118,7 +123,7 @@ services:
 
 #  redis-commander:
 #    container_name: redis-commander
-#    hostname: redis-commander
+#    hostname: redis-commander.localhost
 #    image: rediscommander/redis-commander:latest
 #    restart: always
 #    environment:

dockerfile-dev-with-volumes/README.adoc

@@ -8,7 +8,7 @@ v1.2, 2023-08-30
 == Docker / docker compose avec volumes sur la machine hôte
 
 === Conteneur ElasticSearch
-http://localhost:9200
+http://elasticsearch.localhost:9200
 
 ==== elasticsearch:8.8.1
 ===== OS/ARCH
@@ -68,29 +68,29 @@ SECRET_KEY = "A_CHANGER"
 DEBUG = True
 # on précise ici qu'on utilise ES version 8
 ES_VERSION = 8
-ES_URL = ['http://elasticsearch:9200/']
+ES_URL = ['http://elasticsearch.localhost:9200/']
 
 
 CACHES = {
     "default": {
         "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": "redis://redis:6379/3",
+        "LOCATION": "redis://redis.localhost:6379/3",
         "OPTIONS": {
             "CLIENT_CLASS": "django_redis.client.DefaultClient",
         },
         "KEY_PREFIX": "pod"
     },
     "select2": {
         "BACKEND": "django_redis.cache.RedisCache",
-        "LOCATION": "redis://redis:6379/2",
+        "LOCATION": "redis://redis.localhost:6379/2",
         "OPTIONS": {
             "CLIENT_CLASS": "django_redis.client.DefaultClient",
         },
     },
 }
 SESSION_ENGINE = "redis_sessions.session"
 SESSION_REDIS = {
-    "host": "redis",
+    "host": "redis.localhost",
     "port": 6379,
     "db": 4,
     "prefix": "session",
@@ -103,7 +103,7 @@ MIGRATION_MODULES = {'flatpages': 'pod.db_migrations'}
 
 # Si DOCKER_ENV = full il faut activer l'encodage et la transcription distante
 # USE_REMOTE_ENCODING_TRANSCODING = True
-# ENCODING_TRANSCODING_CELERY_BROKER_URL = "redis://redis:6379/7"
+# ENCODING_TRANSCODING_CELERY_BROKER_URL = "redis://redis.localhost:6379/7"
 
 # pour avoir le maximum de log sur la console
 LOGGING = {}

dockerfile-dev-with-volumes/pod-back/my-entrypoint-back.sh

@@ -3,14 +3,14 @@ echo "Launching commands into pod-dev"
 mkdir -p pod/node_modules
 mkdir -p pod/db_migrations && touch pod/db_migrations/__init__.py
 ln -fs /tmp/node_modules/* pod/node_modules
-until nc -z elasticsearch 9200; do echo waiting for elasticsearch; sleep 10; done;
+until nc -z elasticsearch.localhost 9200; do echo waiting for elasticsearch; sleep 10; done;
 # Mise en route
 # Base de données SQLite intégrée
 BDD_FILE=/usr/src/app/pod/db.sqlite3
 if test ! -f "$BDD_FILE"; then
     echo "$BDD_FILE does not exist."
     python3 manage.py create_pod_index
-    curl -XGET "elasticsearch:9200/pod/_search"
+    curl -XGET "elasticsearch.localhost:9200/pod/_search"
     # Deployez les fichiers statiques
     python3 manage.py collectstatic --no-input --clear
     # Lancez le script présent à la racine afin de créer les fichiers de migration, puis de les lancer pour créer la base de données SQLite intégrée.

dockerfile-dev-with-volumes/pod-encode/my-entrypoint-encode.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 echo "Launching commands into pod-dev"
-until nc -z pod-back 8000; do echo waiting for pod-back; sleep 10; done;
+until nc -z pod.localhost 8000; do echo waiting for pod-back; sleep 10; done;
 # Serveur d'encodage
 celery -A pod.video_encode_transcript.encoding_tasks worker -l INFO -Q encoding --concurrency 1 -n encode
 sleep infinity

dockerfile-dev-with-volumes/pod-transcript/my-entrypoint-transcript.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 echo "Launching commands into pod-dev"
-until nc -z pod-back 8000; do echo waiting for pod-back; sleep 10; done;
+until nc -z pod.localhost 8000; do echo waiting for pod-back; sleep 10; done;
 # Serveur d'encodage
 celery -A pod.video_encode_transcript.transcripting_tasks worker -l INFO -Q transcripting --concurrency 1 -n transcript
 sleep infinity

dockerfile-dev-with-volumes/pod-xapi/my-entrypoint-xapi.sh

@@ -1,6 +1,6 @@
 #!/bin/sh
 echo "Launching commands into pod-dev"
-until nc -z pod-back 8000; do echo waiting for pod-back; sleep 10; done;
+until nc -z pod.localhost 8000; do echo waiting for pod-back; sleep 10; done;
 # Serveur xAPI
 celery -A pod.xapi.xapi_tasks worker -l INFO -Q xapi --concurrency 1 -n xapi
 sleep infinity

dockerfile-dev-with-volumes/pod/my-entrypoint.sh

@@ -10,7 +10,7 @@ BDD_FILE=/usr/src/app/pod/db.sqlite3
 if test ! -f "$BDD_FILE"; then
     echo "$BDD_FILE does not exist."
     python3 manage.py create_pod_index
-    curl -XGET "elasticsearch:9200/pod/_search"
+    curl -XGET "elasticsearch.localhost:9200/pod/_search"
     # Deployez les fichiers statiques
     python3 manage.py collectstatic --no-input --clear
     # Lancez le script présent à la racine afin de créer les fichiers de migration, puis de les lancer pour créer la base de données SQLite intégrée.

pod/custom/settings_local_docker_full_test.py

@@ -26,27 +26,27 @@
 
 # We specify here that we're using ES version 7\n
 ES_VERSION = 7
-ES_URL = ['http://elasticsearch:9200/']
+ES_URL = ['http://elasticsearch.localhost:9200/']
 CACHES = {
     'default': {
         'BACKEND': 'django_redis.cache.RedisCache',
-        'LOCATION': 'redis://redis:6379/3',
+        'LOCATION': 'redis://redis.localhost:6379/3',
         'OPTIONS': {
             'CLIENT_CLASS': 'django_redis.client.DefaultClient',
         },
         'KEY_PREFIX': 'pod'
     },
     'select2': {
         'BACKEND': 'django_redis.cache.RedisCache',
-        'LOCATION': 'redis://redis:6379/2',
+        'LOCATION': 'redis://redis.localhost:6379/2',
         'OPTIONS': {
             'CLIENT_CLASS': 'django_redis.client.DefaultClient',
         },
     },
 }
 SESSION_ENGINE = 'redis_sessions.session'
 SESSION_REDIS = {
-    'host': 'redis',
+    'host': 'redis.localhost',
     'port': 6379,
     'db': 4,
     'prefix': 'session',
@@ -59,8 +59,8 @@
 
 # If DOCKER_ENV = full: activate encoding, transcription and remote xapi
 USE_REMOTE_ENCODING_TRANSCODING = True
-ENCODING_TRANSCODING_CELERY_BROKER_URL = 'redis://redis:6379/7'
-POD_API_URL = "http://pod-back:8000/rest"
+ENCODING_TRANSCODING_CELERY_BROKER_URL = 'redis://redis.localhost:6379/7'
+POD_API_URL = "http://pod.localhost:8000/rest"
 POD_API_TOKEN = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
 
 USE_TRANSCRIPTION = True
@@ -79,7 +79,7 @@
 }
 
 USE_XAPI_VIDEO = False
-XAPI_CELERY_BROKER_URL = "redis://redis:6379/6"
+XAPI_CELERY_BROKER_URL = "redis://redis.localhost:6379/6"
 
 # for maximum console logging\n
 LOGGING = {}

pod/live/tests/test_models.py

@@ -290,7 +290,7 @@ def test_attributs(self):
         event.id = None
         self.assertEqual(event.__str__(), "None")
         self.assertEqual(event.get_thumbnail_card(), "/static/img/default-event.svg")
-        self.assertEqual(event.get_full_url(), "//localhost:8000/live/event/0001-event1/")
+        self.assertEqual(event.get_full_url(), "//pod.localhost:8000/live/event/0001-event1/")
         print(" --->  test_attributs of EventTestCase: OK!")
 
     def test_add_thumbnail(self):