Merge branch 'develop-2.0.0' of https://github.com/FederatedAI/FATE-B…

…oard into develop-2.0.0

bin/service.sh

@@ -15,6 +15,45 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 #
+# --------------- Color Definitions ---------------
+esc_c="\033[0m"
+error_c="\033[31m"
+ok_c="\033[32m"
+#highlight_c="\033[43m"
+
+# --------------- Logging Functions ---------------
+print_info() {
+    local timestamp=$(date '+%Y-%m-%d %H:%M:%S')
+    local overwrite=$2
+
+    # Check if we need to overwrite the current line
+    if [ "$overwrite" == "overwrite" ]; then
+        echo -ne "\r${ok_c}[${timestamp}][INFO]${esc_c} $1"
+    else
+        echo -e "${ok_c}[${timestamp}][INFO]${esc_c} $1"
+    fi
+}
+print_ok() {
+    local overwrite=$2
+    local timestamp=$(date '+%Y-%m-%d %H:%M:%S')
+    if [ "$overwrite" == "overwrite" ]; then
+        echo -ne "\r${ok_c}[${timestamp}][ OK ]${esc_c} $1"
+    else
+        echo -e "${ok_c}[${timestamp}][ OK ]${esc_c} $1"
+    fi
+}
+print_error() {
+    local overwrite=$3
+    local timestamp=$(date '+%Y-%m-%d %H:%M:%S')
+    if [ "$overwrite" == "overwrite" ]; then
+        echo -ne "\r${error_c}[${timestamp}][ ER ]${esc_c} $1: $2"
+    else
+        echo -e "${error_c}[${timestamp}][ ER ]${esc_c} $1: $2"
+    fi
+}
+
+
+
 basepath=$(
   cd $(dirname $0)
   pwd
@@ -31,116 +70,263 @@ fatepath=$(
   cd $basepath/..
   pwd
 )
-
 cd $basepath
 
+export BOARD_HOME=`pwd`
+
+print_info "BOARD_HOME=${BOARD_HOME}"
+
+eval action=\$$#
+
 main_class=org.fedai.fate.board.bootstrap.Bootstrap
 module=fateboard
 version=2.0.0
 
-
-if test -f "${fatepath}/fate_flow/bin/init_env.sh";then
-  source ${fatepath}/fate_flow/bin/init_env.sh
-  echo "JAVA_HOME=$JAVA_HOME"
-else
-  echo "file not found:${fatepath}/fate_flow/bin/init_env.sh"
-  exit
+if [ $action = starting ];then
+	action=start
+elif [ $action = restarting ];then
+	action=restart
 fi
 
 
 
-
+# Get the PID of the process
 getpid() {
   pid=$(ps -ef | grep java | grep ${basepath}/fateboard-${version}.jar | grep -v grep | awk '{print $2}')
+	if [[ -n ${pid} ]]; then
+		return 0
+	else
+		return 1
+	fi
+}
 
+# Get the PID of the process using a specific port
+get_port_pid() {
+  pid=$(lsof -i:${port} | grep 'LISTEN' | awk 'NR==1 {print $2}')
   if [[ -n ${pid} ]]; then
-    return 1
+  	return 0
   else
-    return 0
+  	return 1
   fi
 }
 
+# --------------- Functions for stop---------------
+# Function to kill a process
+kill_process() {
+    local pid=$1
+    local signal=$2
+    kill ${signal} "${pid}" 2>/dev/null
+}
+
+get_property() {
+	property_value=`grep $1 ${BOARD_HOME}/conf/application.properties | cut -d= -f 2-`
+}
+
+
+main() {
+    get_property "server.port"
+    port=${property_value}
+}
+
+action() {
+	case "$action" in
+	  debug)
+	  stop
+	  sleep_time=${3:-2}
+    print_info "Waiting ${sleep_time} seconds"
+    sleep "$sleep_time"
+	  debug
+	  status
+	  ;;
+		start)
+			start
+			status
+			;;
+		stop)
+			stop
+			;;
+		status)
+			status
+			;;
+		restart)
+			stop
+			sleep_time=${3:-2}  # 默认 sleep_time 为 5，如果传入了参数，则使用传入的值
+			print_info "Waiting ${sleep_time} seconds"
+      sleep "$sleep_time"
+			start
+			status
+			;;
+		*)
+			usage
+			exit 1
+	esac
+}
+
+
+# --------------- Functions for info---------------
+# Print usage information for the script
+usage() {
+	    echo -e "${ok_c}board${esc_c}"
+      echo "------------------------------------"
+      echo -e "${ok_c}Usage:${esc_c}"
+      echo -e "  `basename ${0}` start          - Start the server application."
+      echo -e "  `basename ${0}` stop           - Stop the server application."
+      echo -e "  `basename ${0}` status         - Check and report the status of the server application."
+      echo -e "  `basename ${0}` restart [time] - Restart the server application. Optionally, specify a sleep time (in seconds) between stop and start."
+      echo -e "  `basename ${0}` debug          - Start the server application in debug mode."
+      echo -e "  The ${ok_c}component${esc_c} include: {fate_board} "
+      echo ""
+      echo -e "${ok_c}Examples:${esc_c}"
+      echo "  `basename ${0}` fateboard start"
+      echo "  `basename ${0}` fateboard restart 5"
+      echo ""
+      echo -e "${ok_c}Notes:${esc_c}"
+      echo "  - The restart command, if given an optional sleep time, will wait for the specified number of seconds between stopping and starting the service."
+      echo "    If not provided, it defaults to 2 seconds."
+      echo "  - Ensure that the required Java environment is correctly configured on the system."
+      echo ""
+      echo "For more detailed information, refer to the script's documentation or visit the official documentation website."
+}
+
+
+
 mklogsdir() {
-  if [[ ! -d "logs" ]]; then
-    mkdir logs
-  fi
+	if [[ ! -d "${BOARD_HOME}/logs" ]]; then
+		mkdir -p ${BOARD_HOME}/logs
+	fi
 }
 
+# --------------- Functions for status---------------
+# Check the status of the service
 status() {
+  print_info "---------------------------------status---------------------------------"
   getpid
-  if [[ -n ${pid} ]]; then
-    echo "status:
-        $(ps aux | grep ${pid} | grep -v grep)"
+	# check service is up and running
+	if [[ -n ${pid} ]]; then
+    print_ok "Check service ${module} is started: PID=${pid}${esc_c}"
+    print_info "The service status is:
+    `ps aux | grep ${pid} | grep ${main_class} | grep -v grep`"
     return 0
-  else
-    echo "service not running"
-    return 1
-  fi
+	else
+		print_error "The ${module} service is not running"
+		return 1
+	fi
+}
+# check java environment
+check_java_environment() {
+    #检查是否已经设置 JAVA_HOME 环境变量
+    if [ -n "$JAVA_HOME" ]; then
+        print_ok "JAVA_HOME is set to $JAVA_HOME"
+    else
+        print_error "JAVA_HOME is not set"
+        exit 1
+    fi
+    #检查 Java 可执行文件是否在系统 PATH 中
+    if command -v java &> /dev/null; then
+        print_ok "Java is installed and available in the system PATH"
+    else
+        print_error "Java is not found in the system PATH"
+        exit 1
+    fi
+
+    #检查 Java 版本
+    java_version=$(java -version 2>&1 | awk -F '"' '/version/ {print $2}')
+    if [ -n "$java_version" ]; then
+        print_ok "Java version is $java_version"
+    else
+        print_error "Java version information is not available"
+        exit 1
+    fi
 }
 
+# Start service
 start() {
+  print_info "--------------------------------starting--------------------------------"
+  print_info "Checking Java environment..."
+  # check the java environment
+  check_java_environment
   getpid
-  if [[ $? -eq 0 ]]; then
-    mklogsdir
-    if [[ $1 == "front" ]]; then
-      exec $JAVA_HOME/bin/java -Dspring.config.location=$configpath/application.properties -Dssh_config_file=$basepath/ssh/ -Xmx2048m -Xms2048m -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:gc.log -XX:+HeapDumpOnOutOfMemoryError -cp $libpath/*:$basepath/${module}-${version}.jar ${main_class} >/dev/null 2>&1
-    else
-     nohup $JAVA_HOME/bin/java -Dspring.config.location=$configpath/application.properties -Dssh_config_file=$basepath/ssh/ -Xmx2048m -Xms2048m -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:gc.log -XX:+HeapDumpOnOutOfMemoryError -cp $libpath/*:$basepath/${module}-${version}.jar ${main_class} >/dev/null 2>&1 &
+	if [[ $? -eq 1 ]]; then
+		mklogsdir
+		export module=${module}
+		cmd="$JAVA_HOME/bin/java -Dspring.config.location=$configpath/application.properties -Dssh_config_file=$basepath/ssh/ -Xmx2048m -Xms2048m -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:gc.log -XX:+HeapDumpOnOutOfMemoryError -cp $libpath/*:$basepath/${module}-${version}.jar ${main_class}"
+		print_info "The command is: $cmd"
 
+		if [[ $1 == "front" ]]; then
+		  exec $cmd >> ${BOARD_HOME}/logs/bootstrap.${module}.out 2>>${BOARD_HOME}/logs/bootstrap.${module}.err
+    else
+      exec $cmd >> ${BOARD_HOME}/logs/bootstrap.${module}.out 2>>${BOARD_HOME}/logs/bootstrap.${module}.err &
     fi
 
-    if [[ $? -eq 0 ]]; then
-      sleep 2
-      getpid
-      echo "service start sucessfully. pid: ${pid}"
+
+
+    # wait for connect DB
+    print_info "Waiting for start service..."
+    sleep 2
+    getpid
+		if [[ $? -eq 0 ]]; then
+      print_ok "The ${module} service start sucessfully. PID=${pid}"
+		else
+			print_error "The ${module} service start failed"
+		fi
+	else
+		print_info "The ${module} service already started. PID=${pid}"
+	fi
+}
+
+debug() {
+  print_info "--------------------------------debugging--------------------------------"
+  getpid
+	if [[ $? -eq 1 ]]; then
+		mklogsdir
+		export module=${module}
+		cmd="$JAVA_HOME/bin/java -server -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=7007 -Dspring.config.location=$configpath/application.properties -Dssh_config_file=$basepath/ssh/ -Xmx2048m -Xms2048m -XX:+PrintGCDetails -XX:+PrintGCDateStamps -Xloggc:gc.log -XX:+HeapDumpOnOutOfMemoryError -cp $libpath/*:$basepath/${module}-${version}.jar ${main_class}"
+		print_info "The command is: $cmd"
+		if [[ $1 == "front" ]]; then
+		  exec $cmd >> ${BOARD_HOME}/logs/bootstrap.${module}.out 2>>${BOARD_HOME}/logs/bootstrap.${module}.err
     else
-      echo "service start failed"
+      exec $cmd >> ${BOARD_HOME}/logs/bootstrap.${module}.out 2>>${BOARD_HOME}/logs/bootstrap.${module}.err &
     fi
-  else
-    echo "service already started. pid: ${pid}"
-  fi
+
+    getpid
+		if [[ $? -eq 0 ]]; then
+			print_ok "The ${module} service debug sucessfully. PID=${pid}"
+		else
+			print_error "The ${module} service debug failed"
+		fi
+	else
+		print_info "The ${module} service already started. PID=${pid}"
+	fi
 }
 
+# --------------- Functions for stop---------------
+# Stop service
 stop() {
+  print_info "--------------------------------stopping--------------------------------"
   getpid
-  if [[ -n ${pid} ]]; then
-    echo "killing:
-        $(ps aux | grep ${pid} | grep -v grep)"
-    kill -9 ${pid}
-    if [[ $? -eq 0 ]]; then
-      echo "killed"
-    else
-      echo "kill error"
-    fi
-  else
-    echo "service not running"
-  fi
+	if [[ -n ${pid} ]]; then
+		print_info "The system is stopping the ${module} service. PID=${pid}"
+		print_info "The more information:
+		`ps aux | grep ${pid} | grep ${main_class} | grep -v grep`"
+	  for _ in {1..100}; do
+        sleep 0.1
+        kill_process "${pid}"
+        getpid
+        if [ -z "${pid}" ]; then
+            print_ok "Stop ${port} success (SIGTERM)"
+            return
+        fi
+    done
+    kill_process "${pid}" -9 && print_ok "Stop the service ${module} success (SIGKILL)" || print_error "Stop service failed"
+	else
+		print_ok "The ${module} service is not running(NOT ACTIVE))"
+	fi
 }
 
-case "$1" in
-start)
-  start
-  status
-  ;;
-
-starting)
-  start front
-  ;;
-
-stop)
-  stop
-  ;;
-status)
-  status
-  ;;
-
-restart)
-  stop
-  start
-  status
-  ;;
-*)
-  echo "usage: $0 {start|stop|status|restart}"
-  exit -1
-  ;;
-esac
+# --------------- Main---------------
+# Main case for control
+main
+print_info "$module:${main_class}"
+print_info "Processing: ${module} ${action}"
+action "$1"
+

package.xml

@@ -68,5 +68,13 @@
             </includes>
         </fileSet>
 
+        <fileSet>
+            <outputDirectory>/ssh</outputDirectory>
+            <directory>src/main/resources</directory>
+            <includes>
+                <include>ssh.properties</include>
+            </includes>
+        </fileSet>
+
     </fileSets>
 </assembly>