feat(dev-tools): updated various components for better UX/Debug

docs/source/install/custom-database-use.rst

@@ -26,10 +26,10 b' use the following steps:'
     #########################################################
 
     # Default SQLite config
-    sqlalchemy.db1.url = sqlite:////home/brian/.rccontrol/enterprise-1/rhodecode.db
+    sqlalchemy.db1.url = sqlite:////home/rhodecode/.rccontrol/enterprise-1/rhodecode.db
 
     # Use this example for a PostgreSQL
-    sqlalchemy.db1.url = postgresql://postgres:qwe@localhost/rhodecode
+    sqlalchemy.db1.url = postgresql://postgres:secret@localhost/rhodecode
 
     # see sqlalchemy docs for other advanced settings
     sqlalchemy.db1.echo = false

scripts/dev-tools/dev-tools

@@ -35,8 +35,8 b' dev_tools_usage() {'
   # :command.usage_commands
   printf "%s\n" "dev-env Commands:"
   printf "  %s   run bash console for vcsserver\n" "vcs                "
-  printf "  %s   run bash console for rhodecode-ee\n" "ee                 "
   printf "  %s   run bash console for rhodecode-ce\n" "ce                 "
+  printf "  %s   run bash console for rhodecode-ee\n" "ee                 "
   printf "  %s   run bash console for rhodecode-celery\n" "celery             "
   printf "  %s   run celery instance on top of mounted source code, e.g ./dev-tools celeryd&\n" "celeryd            "
   printf "  %s   run bash console for rhodecode-ssh\n" "ssh                "
@@ -99,7 +99,7 b' dev_tools_vcs_usage() {'
   echo
 
   printf "%s\n" "Usage:"
-  printf "  dev-tools vcs\n"
+  printf "  dev-tools vcs [OPTIONS]\n"
   printf "  dev-tools vcs --help | -h\n"
   echo
 
@@ -107,6 +107,19 b' dev_tools_vcs_usage() {'
   if [[ -n $long_usage ]]; then
     printf "%s\n" "Options:"
 
+    # :command.usage_flags
+    # :flag.usage
+    printf "  %s\n" "--workdir WORKDIR"
+    printf "    workdir to run the pip install -e on top of can be ce or ee only\n"
+    printf "    Default: /home/rhodecode/rhodecode-vcsserver\n"
+    echo
+
+    # :flag.usage
+    printf "  %s\n" "--cmd CMD"
+    printf "    cmd script to run, this is on host machine, relative to $WORKSPACE_HOME\n"
+    printf "    Default: .dev-env/cmd-vcs.sh\n"
+    echo
+
     # :command.usage_fixed_flags
     printf "  %s\n" "--help, -h"
     printf "    Show this help\n"
@@ -116,29 +129,42 b' dev_tools_vcs_usage() {'
 }
 
 # :command.usage
-dev_tools_ee_usage() {
+dev_tools_ce_usage() {
   if [[ -n $long_usage ]]; then
-    printf "dev-tools ee - run bash console for rhodecode-ee\n"
+    printf "dev-tools ce - run bash console for rhodecode-ce\n"
     echo
 
   else
-    printf "dev-tools ee - run bash console for rhodecode-ee\n"
+    printf "dev-tools ce - run bash console for rhodecode-ce\n"
     echo
 
   fi
 
-  printf "Alias: e\n"
+  printf "Alias: c\n"
   echo
 
   printf "%s\n" "Usage:"
-  printf "  dev-tools ee\n"
-  printf "  dev-tools ee --help | -h\n"
+  printf "  dev-tools ce [OPTIONS]\n"
+  printf "  dev-tools ce --help | -h\n"
   echo
 
   # :command.long_usage
   if [[ -n $long_usage ]]; then
     printf "%s\n" "Options:"
 
+    # :command.usage_flags
+    # :flag.usage
+    printf "  %s\n" "--workdir WORKDIR"
+    printf "    workdir to run the pip install -e on top of can be ce or ee only\n"
+    printf "    Default: /home/rhodecode/rhodecode-enterprise-ce\n"
+    echo
+
+    # :flag.usage
+    printf "  %s\n" "--cmd CMD"
+    printf "    cmd script to run, this is on host machine, relative to $WORKSPACE_HOME\n"
+    printf "    Default: .dev-env/cmd-ce.sh\n"
+    echo
+
     # :command.usage_fixed_flags
     printf "  %s\n" "--help, -h"
     printf "    Show this help\n"
@@ -148,23 +174,23 b' dev_tools_ee_usage() {'
 }
 
 # :command.usage
-dev_tools_ce_usage() {
+dev_tools_ee_usage() {
   if [[ -n $long_usage ]]; then
-    printf "dev-tools ce - run bash console for rhodecode-ce\n"
+    printf "dev-tools ee - run bash console for rhodecode-ee\n"
     echo
 
   else
-    printf "dev-tools ce - run bash console for rhodecode-ce\n"
+    printf "dev-tools ee - run bash console for rhodecode-ee\n"
     echo
 
   fi
 
-  printf "Alias: c\n"
+  printf "Alias: e\n"
   echo
 
   printf "%s\n" "Usage:"
-  printf "  dev-tools ce\n"
-  printf "  dev-tools ce --help | -h\n"
+  printf "  dev-tools ee\n"
+  printf "  dev-tools ee --help | -h\n"
   echo
 
   # :command.long_usage
@@ -967,95 +993,114 b' inspect_args() {'
 # :command.function
 dev_tools_vcs_command() {
   # src/vcs_command.sh
-  container_name=dev-vcsserver
-  dev_env_file="/home/rhodecode/rhodecode-vcsserver/.dev/dev-env.sh"
-  env_file=".custom/.dev.env"
-
-  docker_id=$(docker ps -q --filter "name=$container_name")
-
-  if [[ $docker_id ]]; then
-    echo $container_name FOUND, Killing old one !
-    docker kill -s 9 $docker_id
-    sleep 5
-    docker rm -fv $container_name
-    echo "done..."
-  else
-    echo $container_name not found
-  #  # bootstrap dev-env.sh
-  #  if [[ ! -f  $dev_env_file ]]; then
-  #    echo "bootstrap of new dev-env file under $dev_env_file"
-  #  fi
-  fi
-
   if [[ -v WORKSPACE_HOME ]];
   then
     DEFAULT_WORKSPACE_HOME=$WORKSPACE_HOME
+    echo "Using default WORKSPACE_HOME path: $DEFAULT_WORKSPACE_HOME"
   else
     echo "WORKSPACE_HOME env var is not set"
     exit 1
   fi
 
-  echo "Using default WORKSPACE_HOME path: $DEFAULT_WORKSPACE_HOME"
+  code_workdir=${args[--workdir]}
+  cmd_script=${args[--cmd]}
+
+  exec_script=$WORKSPACE_HOME/$cmd_script
+  container_name=dev-vcsserver
+  env_file=".custom/.dev.env"
+
+  echo "Using exec script: $exec_script"
+
+  RC_DEV_CMD_HELP="pserve --reload .dev/dev.ini"
+
+  if [[ ! -f $exec_script ]]; then
+    echo "Generating new $exec_script file..."
+    mkdir -p $(dirname $exec_script)
+
+    cat <<< "
+  # Generated dev-env script for rhodecode-vcsserver
+
+  echo \"Run vcsserver dev using the following command:\"
+  echo \"++++++++++++++++++++++++++++++++++++++++++++++++++\"
+  echo \"$RC_DEV_CMD_HELP\"
+  echo \"++++++++++++++++++++++++++++++++++++++++++++++++++\"
+  make sh
+  " > $exec_script
+    chmod +x $exec_script
+  fi
+
+  docker_exec_script="/var/opt/rhodecode_repo_store/$cmd_script"
 
   eval "
-  WORKSPACE_HOME=$DEFAULT_WORKSPACE_HOME \
+  WORKSPACE_HOME=$DEFAULT_WORKSPACE_HOME RC_DEV_CMD_HELP=\"$RC_DEV_CMD_HELP\" \
   ./rcstack stack --env-file-path $env_file rhodecode -f docker-compose-apps.dev.yaml \
-  run -e ENV_FILE= -e RC_ENV_FILE= -e RC_APP_TYPE=rhodecode_sh \
-  --publish 10010:10010 --rm --use-aliases \
-  --workdir=\"/home/rhodecode/rhodecode-vcsserver\" \
+  run -e RC_DEV_CMD_HELP=\"'$RC_DEV_CMD_HELP'\" -e ENV_FILE= -e RC_ENV_FILE= -e RC_APP_TYPE=rhodecode_$container_name --rm --use-aliases \
+  --workdir=\"$code_workdir\" \
+  --name=\"$container_name\" \
   --interactive --tty \
-  --name=\"$container_name\" vcsserver bash $dev_env_file"
+  --publish 10010:10010 \
+  vcsserver bash $docker_exec_script"
 
 }
 
 # :command.function
-dev_tools_ee_command() {
-  # src/ee_command.sh
-  container_name=dev-enterprise-ee
-  dev_env_file="/home/rhodecode/rhodecode-enterprise-ee/.dev/dev-env.sh"
-  env_file=".custom/.dev.env"
-
-  docker_id=$(docker ps -q --filter "name=$container_name")
-
-  if [[ $docker_id ]]; then
-    echo $container_name FOUND, Killing old one !
-    docker kill -s 9 $docker_id
-    sleep 5
-    docker rm -fv $container_name
-    echo "done..."
-  else
-    echo $container_name not found
-  #  # bootstrap dev-env.sh
-  #  if [[ ! -f  $dev_env_file ]]; then
-  #    echo "bootstrap of new dev-env file under $dev_env_file"
-  #  fi
-  fi
-
+dev_tools_ce_command() {
+  # src/ce_command.sh
   if [[ -v WORKSPACE_HOME ]];
   then
     DEFAULT_WORKSPACE_HOME=$WORKSPACE_HOME
+    echo "Using default WORKSPACE_HOME path: $DEFAULT_WORKSPACE_HOME"
   else
     echo "WORKSPACE_HOME env var is not set"
     exit 1
   fi
 
-  echo "Using default WORKSPACE_HOME path: $DEFAULT_WORKSPACE_HOME"
+  code_workdir=${args[--workdir]}
+  cmd_script=${args[--cmd]}
+
+  exec_script=$WORKSPACE_HOME/$cmd_script
+  container_name=dev-enterprise-ce
+  env_file=".custom/.dev.env"
+
+  echo "Using exec script: $exec_script"
+
+  RC_DEV_CMD_HELP="pserve --reload .dev/dev.ini"
+
+  if [[ ! -f $exec_script ]]; then
+    echo "Generating new $exec_script file..."
+    mkdir -p $(dirname $exec_script)
+
+    cat <<< "
+  # Generated dev-env script for rhodecode-enterprise-ce
+
+  echo \"Run rhodecode-enterprise-ce dev using the following command:\"
+  echo \"++++++++++++++++++++++++++++++++++++++++++++++++++\"
+  echo \"$RC_DEV_CMD_HELP\"
+  echo \"++++++++++++++++++++++++++++++++++++++++++++++++++\"
+  make sh
+  " > $exec_script
+    chmod +x $exec_script
+  fi
+
+  docker_exec_script="/var/opt/rhodecode_repo_store/$cmd_script"
 
   eval "
-  WORKSPACE_HOME=$DEFAULT_WORKSPACE_HOME \
+  WORKSPACE_HOME=$DEFAULT_WORKSPACE_HOME RC_DEV_CMD_HELP=\"$RC_DEV_CMD_HELP\" \
   ./rcstack stack --env-file-path $env_file rhodecode -f docker-compose-apps.dev.yaml \
-  run -e ENV_FILE= -e RC_ENV_FILE= -e RC_APP_TYPE=rhodecode_sh --rm --use-aliases \
-  --publish 10020:10020 --rm --use-aliases \
-  --workdir=\"/home/rhodecode/rhodecode-enterprise-ee\" \
+  run -e RC_DEV_CMD_HELP=\"'$RC_DEV_CMD_HELP'\" -e ENV_FILE= -e RC_ENV_FILE= -e RC_APP_TYPE=rhodecode_$container_name --rm --use-aliases \
+  --workdir=\"$code_workdir\" \
+  --name=\"$container_name\" \
   --interactive --tty \
-  --name=\"$container_name\" rhodecode bash $dev_env_file"
+  --publish 10020:10020 \
+  rhodecode bash $docker_exec_script"
+
 }
 
 # :command.function
-dev_tools_ce_command() {
-  # src/ce_command.sh
-  container_name=dev-enterprise-ce
-  dev_env_file="/home/rhodecode/rhodecode-enterprise-ce/.dev/dev-env.sh"
+dev_tools_ee_command() {
+  # src/ee_command.sh
+  container_name=dev-enterprise-ee
+  dev_env_file="/home/rhodecode/rhodecode-enterprise-ee/.dev/dev-env.sh"
   env_file=".custom/.dev.env"
 
   docker_id=$(docker ps -q --filter "name=$container_name")
@@ -1089,10 +1134,9 b' dev_tools_ce_command() {'
   ./rcstack stack --env-file-path $env_file rhodecode -f docker-compose-apps.dev.yaml \
   run -e ENV_FILE= -e RC_ENV_FILE= -e RC_APP_TYPE=rhodecode_sh --rm --use-aliases \
   --publish 10020:10020 --rm --use-aliases \
-  --workdir=\"/home/rhodecode/rhodecode-enterprise-ce\" \
+  --workdir=\"/home/rhodecode/rhodecode-enterprise-ee\" \
   --interactive --tty \
   --name=\"$container_name\" rhodecode bash $dev_env_file"
-
 }
 
 # :command.function
@@ -1669,14 +1713,17 b' dev_tools_get_build_source_command() {'
   echo "** download rhodecode source for build from $SERVER_URL using '$revision' hash **"
   mkdir -p $SOURCE_DIR
 
-  echo "getting $SERVER_URL/rhodecode-vcsserver/archive/$RHODECODE_VCS_HASH.tgz"
-  curl --fail --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $SERVER_URL/rhodecode-vcsserver/archive/$RHODECODE_VCS_HASH.tgz?with_hash=0 | tar -xz -C $SOURCE_DIR
+  dl_url="$SERVER_URL/rhodecode-vcsserver/archive/$RHODECODE_VCS_HASH.tgz?with_hash=0"
+  echo "getting $dl_url"
+  curl --fail --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $dl_url | tar -xz -C $SOURCE_DIR
 
+  dl_url="$SERVER_URL/rhodecode-enterprise-ce/archive/$RHODECODE_CE_HASH.tgz?with_hash=0"
   echo "getting $SERVER_URL/rhodecode-enterprise-ce/archive/$RHODECODE_CE_HASH.tgz"
-  curl --fail --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $SERVER_URL/rhodecode-enterprise-ce/archive/$RHODECODE_CE_HASH.tgz?with_hash=0 | tar -xz -C $SOURCE_DIR
+  curl --fail --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $dl_url | tar -xz -C $SOURCE_DIR
 
-  echo "getting $SERVER_URL/rhodecode-enterprise-ee/archive/$RHODECODE_EE_HASH.tgz"
-  curl --fail --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $SERVER_URL/rhodecode-enterprise-ee/archive/$RHODECODE_EE_HASH.tgz?with_hash=0 | tar -xz -C $SOURCE_DIR
+  dl_url="$SERVER_URL/rhodecode-enterprise-ee/archive/$RHODECODE_EE_HASH.tgz?with_hash=0"
+  echo "$dl_url"
+  curl --fail --header "X-Rc-Auth-Token: $AUTH_TOKEN" -L $dl_url | tar -xz -C $SOURCE_DIR
 
   rm -rf $SOURCE_DIR/rhodecode-vcsserver && \
   mv  $SOURCE_DIR/*rhodecode-vcsserver-*     $SOURCE_DIR/rhodecode-vcsserver
@@ -1790,17 +1837,17 b' parse_requirements() {'
       shift $#
       ;;
 
-    ee | e)
-      action="ee"
+    ce | c)
+      action="ce"
       shift
-      dev_tools_ee_parse_requirements "$@"
+      dev_tools_ce_parse_requirements "$@"
       shift $#
       ;;
 
-    ce | c)
-      action="ce"
+    ee | e)
+      action="ee"
       shift
-      dev_tools_ce_parse_requirements "$@"
+      dev_tools_ee_parse_requirements "$@"
       shift $#
       ;;
 
@@ -1998,6 +2045,35 b' dev_tools_vcs_parse_requirements() {'
   while [[ $# -gt 0 ]]; do
     key="$1"
     case "$key" in
+      # :flag.case
+      --workdir)
+
+        # :flag.case_arg
+        if [[ -n ${2+x} ]]; then
+
+          args['--workdir']="$2"
+          shift
+          shift
+        else
+          printf "%s\n" "--workdir requires an argument: --workdir WORKDIR" >&2
+          exit 1
+        fi
+        ;;
+
+      # :flag.case
+      --cmd)
+
+        # :flag.case_arg
+        if [[ -n ${2+x} ]]; then
+
+          args['--cmd']="$2"
+          shift
+          shift
+        else
+          printf "%s\n" "--cmd requires an argument: --cmd CMD" >&2
+          exit 1
+        fi
+        ;;
 
       -?*)
         printf "invalid option: %s\n" "$key" >&2
@@ -2015,16 +2091,20 b' dev_tools_vcs_parse_requirements() {'
     esac
   done
 
+  # :command.default_assignments
+  [[ -n ${args['--workdir']:-} ]] || args['--workdir']="/home/rhodecode/rhodecode-vcsserver"
+  [[ -n ${args['--cmd']:-} ]] || args['--cmd']=".dev-env/cmd-vcs.sh"
+
 }
 
 # :command.parse_requirements
-dev_tools_ee_parse_requirements() {
+dev_tools_ce_parse_requirements() {
   # :command.fixed_flags_filter
   while [[ $# -gt 0 ]]; do
     case "${1:-}" in
       --help | -h)
         long_usage=yes
-        dev_tools_ee_usage
+        dev_tools_ce_usage
         exit
         ;;
 
@@ -2036,12 +2116,41 b' dev_tools_ee_parse_requirements() {'
   done
 
   # :command.command_filter
-  action="ee"
+  action="ce"
 
   # :command.parse_requirements_while
   while [[ $# -gt 0 ]]; do
     key="$1"
     case "$key" in
+      # :flag.case
+      --workdir)
+
+        # :flag.case_arg
+        if [[ -n ${2+x} ]]; then
+
+          args['--workdir']="$2"
+          shift
+          shift
+        else
+          printf "%s\n" "--workdir requires an argument: --workdir WORKDIR" >&2
+          exit 1
+        fi
+        ;;
+
+      # :flag.case
+      --cmd)
+
+        # :flag.case_arg
+        if [[ -n ${2+x} ]]; then
+
+          args['--cmd']="$2"
+          shift
+          shift
+        else
+          printf "%s\n" "--cmd requires an argument: --cmd CMD" >&2
+          exit 1
+        fi
+        ;;
 
       -?*)
         printf "invalid option: %s\n" "$key" >&2
@@ -2059,16 +2168,20 b' dev_tools_ee_parse_requirements() {'
     esac
   done
 
+  # :command.default_assignments
+  [[ -n ${args['--workdir']:-} ]] || args['--workdir']="/home/rhodecode/rhodecode-enterprise-ce"
+  [[ -n ${args['--cmd']:-} ]] || args['--cmd']=".dev-env/cmd-ce.sh"
+
 }
 
 # :command.parse_requirements
-dev_tools_ce_parse_requirements() {
+dev_tools_ee_parse_requirements() {
   # :command.fixed_flags_filter
   while [[ $# -gt 0 ]]; do
     case "${1:-}" in
       --help | -h)
         long_usage=yes
-        dev_tools_ce_usage
+        dev_tools_ee_usage
         exit
         ;;
 
@@ -2080,7 +2193,7 b' dev_tools_ce_parse_requirements() {'
   done
 
   # :command.command_filter
-  action="ce"
+  action="ee"
 
   # :command.parse_requirements_while
   while [[ $# -gt 0 ]]; do
@@ -3364,7 +3477,7 b' dev_tools_build_source_parse_requirements() {'
 
 # :command.initialize
 initialize() {
-  version="1.0.0"
+  version="1.1.0"
   long_usage=''
   set -e
 
@@ -3384,8 +3497,8 b' run() {'
 
   case "$action" in
     "vcs") dev_tools_vcs_command ;;
-    "ee") dev_tools_ee_command ;;
     "ce") dev_tools_ce_command ;;
+    "ee") dev_tools_ee_command ;;
     "celery") dev_tools_celery_command ;;
     "celeryd") dev_tools_celeryd_command ;;
     "ssh") dev_tools_ssh_command ;;