Add to assist users

Author: Bryan Sieber

Makefile

@@ -18,6 +18,8 @@ help:
 	@echo "  shell       - open a shell in the web container"
 	@echo "  test-shell  - open a shell in test environment"
 	@echo ""
+	@echo "  generate    - create json file from TEMPLATE"
+	@echo ""
 	@echo "  help    - see this text"
 
 
@@ -50,5 +52,10 @@ ifneq (1, ${MK_KEEP_DOCKER_UP})
 endif
 
 .PHONY: test-shell
-test-shell: .env
+test-shell:
 	docker-compose -f ./docker-compose.yaml -f ./tests/infra/docker-compose.test.yaml run web
+
+
+.PHONY: generate
+generate:
+	./generate-helper.sh

generate-helper.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+default_action="default_action"
+enabled="true"
+read -p "Enter the jira_project_key (required):" JIRA_PROJECT_KEY
+read -p "Enter the whiteboard_tag (required):" WHITEBOARD_TAG
+read -p "Enter the action (blank=default_action):" ACTION && [[ -z "$ACTION" ]] && ACTION="$default_action"
+read -p "Start enabled? (blank=true):" ENABLED && [[ -z "$ENABLED" ]] && ENABLED="$enabled"
+
+echo "Generate file: src/jbi/whiteboard_tags/${WHITEBOARD_TAG}.json"
+sed -e "s|@ENABLED@|$ENABLED|g" -e "s|@ACTION@|$ACTION|g" -e "s|@JIRA_PROJECT_KEY@|$JIRA_PROJECT_KEY|g" -e "s|@WHITEBOARD_TAG@|$WHITEBOARD_TAG|g" src/jbi/whiteboard_tags/TEMPLATE > src/jbi/whiteboard_tags/${WHITEBOARD_TAG}.json

src/core/configurator.py

@@ -49,6 +49,8 @@ def process_all_files_in_path(
 
     for filename in glob.glob(os.path.join(folder_path, "*.json")):
         try:
+            if "TEMPLATE" in filename:
+                continue
             key, value = process(filename)
             if key:
                 config_map[key] = value

src/jbi/whiteboard_tags/TEMPLATE

@@ -0,0 +1,6 @@
+{
+    "whiteboard_tag": "@WHITEBOARD_TAG@",
+    "jira_project_key": "@JIRA_PROJECT_KEY@",
+    "action": "@ACTION@",
+    "enabled": "@ENABLED@"
+}