Improve dmod.client and update CLI

.gitignore

@@ -14,7 +14,7 @@ dist/
 build/
 *.egg-info/
 
-/.dmod_client_config.yml
+/.dmod_client_config.json
 
 /python/pydevd-pycharm.egg
 

docker/nwm_gui/app_server/Dockerfile

@@ -46,15 +46,36 @@ COPY ./python/gui/MaaS ./MaaS
 COPY ./docker/nwm_gui/app_server/entrypoint.sh ./
 COPY ./docker/nwm_gui/app_server/client_debug_helper.py ./
 
-RUN echo "request-service:" > .dmod_client_config.yml \
-    && echo "  hostname: 'request-service'" >> .dmod_client_config.yml \
-    && echo "  port: 3012" >> .dmod_client_config.yml \
-    && echo "  ssl-dir: '/usr/maas_portal/ssl'" >> .dmod_client_config.yml
+ARG PYCHARM_REMOTE_DEBUG_HOST
+ARG PYCHARM_REMOTE_DEBUG_PORT
+ARG REQUEST_SERVICE_PORT
+
+ENV PYCHARM_DEBUG_EGG=/pydevd-pycharm.egg
+ENV REQ_SRV_SSL_DIR=${WORKDIR}/request_service_ssl
+# TODO: needs to be fixed ... doesn't mesh with configurability of location
+COPY ./ssl/request-service ${REQ_SRV_SSL_DIR}
+
+# TODO: move to heredoc syntax once confirmed it's reasonable to expect all environments run sufficiently recent Docker
+RUN     echo '{'                                                            > .dmod_client_config.json \
+    &&  if [ -n "${PYCHARM_DEBUG_EGG:-}" ] && [ -n "${PYCHARM_REMOTE_DEBUG_PORT:-}" ] && [ -n "${PYCHARM_REMOTE_DEBUG_HOST:-}" ]; then \
+            echo '    "remote-debug": {'                                    >> .dmod_client_config.json ; \
+            echo "        \"egg-path\": \"${PYCHARM_DEBUG_EGG:?}\","        >> .dmod_client_config.json ; \
+            echo "        \"port\": ${PYCHARM_REMOTE_DEBUG_PORT:?},"        >> .dmod_client_config.json ; \
+            echo "        \"host\": \"${PYCHARM_REMOTE_DEBUG_HOST:?}\""     >> .dmod_client_config.json ; \
+            echo '    },'                                                   >> .dmod_client_config.json ; \
+        fi \
+    &&  echo '    "request-service": {'                                     >> .dmod_client_config.json \
+    &&  echo '        "protocol": "wss",'                                   >> .dmod_client_config.json \
+    &&  echo "        \"pem\": \"${REQ_SRV_SSL_DIR}/certificate.pem\","     >> .dmod_client_config.json \
+    &&  echo "        \"port\": ${REQUEST_SERVICE_PORT:?},"                 >> .dmod_client_config.json \
+    &&  echo '        "hostname": "request-service"'                        >> .dmod_client_config.json \
+    &&  echo '    }'                                                        >> .dmod_client_config.json \
+    &&  echo '}'                                                            >> .dmod_client_config.json
 
 # TODO: when image tagging/versioning is improved, look at keeping this in a "debug" image only
 # Copy this to have access to debugging pydevd egg
 COPY --from=sources /dmod /dmod_src
-RUN if [ -e /dmod_src/python/pydevd-pycharm.egg ]; then mv /dmod_src/python/pydevd-pycharm.egg /. ; fi \
+RUN if [ -e /dmod_src/python/pydevd-pycharm.egg ]; then mv /dmod_src/python/pydevd-pycharm.egg ${PYCHARM_DEBUG_EGG} ; fi \
     && rm -rf /dmod_src
 
 # Set the entry point so that it is run every time the container is started

docker/nwm_gui/docker-compose.yml

@@ -34,6 +34,10 @@ services:
       args:
         docker_internal_registry: ${DOCKER_INTERNAL_REGISTRY:?Missing DOCKER_INTERNAL_REGISTRY value (see 'Private Docker Registry ' section in example.env)}
         comms_package_name: ${PYTHON_PACKAGE_DIST_NAME_COMMS:?}
+        # Necessary to generate the CLI's ClientConfig to support remote debugging
+        PYCHARM_REMOTE_DEBUG_HOST: ${PYCHARM_REMOTE_DEBUG_SERVER_HOST:-host.docker.internal}
+        PYCHARM_REMOTE_DEBUG_PORT: ${PYCHARM_REMOTE_DEBUG_SERVER_PORT_GUI:-55875}
+        REQUEST_SERVICE_PORT: ${DOCKER_REQUESTS_CONTAINER_PORT:-3012}
     networks:
       - request-listener-net
     # Call this when starting the container

example.env

@@ -168,8 +168,19 @@ PYTHON_PACKAGE_NAME_DATA_SERVICE=dmod.dataservice
 ## server at the level of individual (supported) services.            ##
 ########################################################################
 PYCHARM_REMOTE_DEBUG_VERSION=~=211.7628.24
-## Right now there is only support for the GUI app service
+## Flag to indicate whether remote Pycharm debugging should be active
+## in the GUI image and service.
 PYCHARM_REMOTE_DEBUG_GUI_ACTIVE=false
+## Flag for whether remote Pycharm debugging is active for data service
+PYCHARM_REMOTE_DEBUG_DATA_SERVICE_ACTIVE=false
+## Flag for whether remote Pycharm debugging is active for evaluation service
+PYCHARM_REMOTE_DEBUG_EVALUATION_SERVICE_ACTIVE=false
+## Flag for whether remote Pycharm debugging is active for partitioner service
+PYCHARM_REMOTE_DEBUG_PARTITIONER_SERVICE_ACTIVE=false
+## Flag for whether remote Pycharm debugging is active for request service
+PYCHARM_REMOTE_DEBUG_REQUEST_SERVICE_ACTIVE=false
+## Flag for whether remote Pycharm debugging is active for scheduler service
+PYCHARM_REMOTE_DEBUG_SCHEDULER_SERVICE_ACTIVE=false
 ## The debug server host for the debugged Python processes to attach to
 PYCHARM_REMOTE_DEBUG_SERVER_HOST=host.docker.internal
 ## The remote debug server port to for debugging request-service