task: add better intellij support for local devlopment (#1937)

README.md

@@ -102,11 +102,14 @@ Save your configuration, and choose Debug from the Run menu. You will now hit br
 The easiest way to debug the back end is to use the auto-created debug profile in IntelliJ. However first you'll have to
 create a new run config to decrypt the application secrets and then modify the default run profile to include it.
 
-1) Create a new run profile named "Decrypt" which runs the `hmiServerDev decrypt` command:
-   ![Decrypt run config](docs/decrypt.png)
+1) Create a new run profile named "start-server-ide" which runs the `./hmiServerDev start-server-ide` command:
+   ![start-server-ide.png](docs%2Fstart-server-ide.png)
 2) Navigate now to the default created Spring Boot run profile. If you don't have one, create one and set the properties to what you see below.
-   * Add a "Before Launch" option of "Run Another Configuration" and select the "Decrypt" run config you just created. Slot it first.
-![springboot-config.png](docs%2Fspringboot-config.png)
+   * Add a "Before Launch > Add before launch task" option 
+![springboot-config-add-run-options.png](docs%2Fspringboot-config-add-run-options.png) 
+   * Select "Run Another Configuration" and select the `start-server-ide` run config you just created. **Slot it first.**
+   * In the _Active profiles_ field, enter `default,secrets`
+![springboot-config-active-profiles.png](docs%2Fspringboot-config-active-profiles.png)
 </details>
 
 

containers/docker-compose-base.yml

@@ -4,6 +4,7 @@ version: '3.8'
 services:
   redis:
     image: ghcr.io/darpa-askem/redis:7.0.12-alpine
+    container_name: redis
     networks:
       - terarium
     ports:

hmiServerDev.sh

@@ -1,9 +1,39 @@
+#!/usr/bin/env bash
+
+# Description: This script is used to start the server locally for development purposes.
+#              It will decrypt the secrets file, start the server, then remove the secrets file.
 
 SERVER_DIR="packages/server"
-ENCRYPTED_FILE="src/main/resources/application-secrets.properties.encrypted"
-DECRYPTED_FILE="src/main/resources/application-secrets.properties"
+ENCRYPTED_FILE="${SERVER_DIR}/src/main/resources/application-secrets.properties.encrypted"
+DECRYPTED_FILE="${SERVER_DIR}/src/main/resources/application-secrets.properties"
 VAULT_PASSWORD=""~/askem-vault-id.txt""
 
+function decrypt_secrets() {
+	echo "Decrypting local secrets vault"
+	ansible-vault decrypt --vault-password-file ${VAULT_PASSWORD} --output ${DECRYPTED_FILE} ${ENCRYPTED_FILE}
+}
+
+function encrypt_secrets() {
+	echo "Encrypting local secrets vault"
+	ansible-vault encrypt --vault-password-file ${VAULT_PASSWORD} --output ${ENCRYPTED_FILE} ${DECRYPTED_FILE}
+}
+
+function delete_secrets() {
+	echo "Deleting local secrets vault"
+	rm ${DECRYPTED_FILE}
+}
+
+function deploy_containers() {
+	echo "Deploying local containers"
+	docker compose --file containers/docker-compose-base.yml --project-name terarium up --detach --no-recreate --wait
+}
+
+function start_server() {
+	echo "Starting local server"
+	cd ${SERVER_DIR} || exit
+	gradle bootRun --args='--spring.profiles.active=default,secrets'
+	cd - || exit
+}
 
 case ${1} in
 	-h | --help)
@@ -12,6 +42,9 @@ case ${1} in
 	start)
 		COMMAND="start"
 		;;
+	start-server-ide)
+  	COMMAND="start-server-ide"
+  	;;
 	decrypt)
 		COMMAND="decrypt"
 		;;
@@ -25,29 +58,27 @@ COMMAND=${COMMAND:-"start"}
 
 case ${COMMAND} in
 	start)
-		cd ${SERVER_DIR} || exit
-		echo "Decrypting local secrets vault"
-		ansible-vault decrypt --vault-password-file ${VAULT_PASSWORD} --output ${DECRYPTED_FILE} ${ENCRYPTED_FILE}
-    echo "Deploying local containers"
-    docker compose -f ../../containers/docker-compose-base.yml up -d
-    echo "Starting local server"
-    gradle bootRun --args='--spring.profiles.active=default,secrets'
-    echo "Deleting local secrets vault"
-    rm ${DECRYPTED_FILE}
+		decrypt_secrets
+    deploy_containers
+    start_server
+    delete_secrets
     ;;
+	start-server-ide)
+  	decrypt_secrets
+  	deploy_containers
+  	;;
   decrypt)
-  	cd ${SERVER_DIR} || exit
-  	ansible-vault decrypt --vault-password-file ${VAULT_PASSWORD} --output ${DECRYPTED_FILE} ${ENCRYPTED_FILE}
+  	decrypt_secrets
   	;;
  	encrypt)
- 		cd ${SERVER_DIR} || exit
-   	ansible-vault encrypt --vault-password-file ${VAULT_PASSWORD} --output ${ENCRYPTED_FILE} ${DECRYPTED_FILE}
+ 		encrypt_secrets
    	;;
   help)
   	echo "
     	Usage:
-    			${0} start              Decrypts the secrets file, starts the application via 'gradle bootRun', then removes secrets after run
-    			${0} decrypt            Decrypt secrets (${ENCRYPTED_FILE}) to an unencrypted file (${DECRYPTED_FILE})
-    			${0} encrypt            Encrypts ${DECRYPTED_FILE} to the checked in secrets file, ${ENCRYPTED_FILE}"
+    			${0} start              		Decrypts the secrets file, starts the application via 'gradle bootRun', then removes secrets after run
+    			${0} start-server-ide  			Decrypts the secrets file, starts the application via IntelliJ, then removes secrets after run
+    			${0} decrypt            		Decrypt secrets (${ENCRYPTED_FILE}) to an unencrypted file (${DECRYPTED_FILE})
+    			${0} encrypt            		Encrypts ${DECRYPTED_FILE} to the checked in secrets file, ${ENCRYPTED_FILE}"
     ;;
 esac