feat: add more test

Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>

.env

@@ -15,5 +15,5 @@
 USER=root
 PASSWORD=openIM123
 MINIO_ENDPOINT=http://127.0.0.1:10005
-API_URL=http://14.153.17.42:10002
-DATA_DIR=/root/workspaces/openim/openim-server
+API_URL=http://127.0.0.1:10002
+DATA_DIR=./

.github/sync-release.yml

@@ -1,3 +1,17 @@
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 OpenIMSDK/openim-docker:
   - source: ./config
     dest: ./openim-server/release/config

Dockerfile

@@ -10,8 +10,8 @@ ENV GOPROXY=$GOPROXY
 # Set up the working directory
 WORKDIR /openim/openim-server
 
-COPY go.mod go.sum go.work ./
-#RUN go mod download
+COPY go.mod go.sum ./
+RUN go mod download
 
 # Copy all files to the container
 ADD . .

Makefile

@@ -58,6 +58,16 @@ export USAGE_OPTIONS
 init:
 	@$(MAKE) gen.init
 
+## init-githooks: Initialize git hooks ✨
+.PHONY: init-githooks
+init-githooks:
+	@$(MAKE) gen.init-githooks
+
+## gen: Generate all necessary files. ✨
+.PHONY: gen
+gen:
+	@$(MAKE) gen.run
+
 ## demo: Run demo get started with Makefiles quickly ✨
 .PHONY: demo
 demo:
@@ -190,11 +200,6 @@ push.multiarch:
 tools:
 	@$(MAKE) tools.install
 
-## gen: Generate all necessary files. ✨
-.PHONY: gen
-gen:
-	@$(MAKE) gen.run
-
 ## swagger: Generate swagger document. ✨
 .PHONY: swagger
 swagger:

build/images/openim-api/Dockerfile

@@ -46,4 +46,8 @@ ENV PORT 10002
 
 EXPOSE ${PORT}
 
+RUN cp ${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-api /usr/bin/openim-api
+
+ENTRYPOINT ["/usr/bin/openim-api","-c" ${SERVER_WORKDIR}/config"]
+
 CMD ["bash", "-c","${OPENIM_SERVER_BINDIR}/platforms/$(get_os)/$(get_arch)/openim-api --port ${PORT} -c ${SERVER_WORKDIR}/config"]

build/images/openim-api/Dockerfile.release

@@ -0,0 +1,8 @@
+FROM ghcr.io/openim-sigs/openim-bash-image:latest
+
+COPY openim-api /usr/bin/
+
+# nosemgrep: dockerfile.security.missing-user.missing-user
+ENTRYPOINT ["/usr/bin/openim-api"]
+# nosemgrep: dockerfile.security.missing-user.missing-user
+CMD ["--help"]

config/config.yaml

@@ -29,8 +29,8 @@
 zookeeper:
   schema: openim
   address: [ 127.0.0.1:2181 ]
-  username: ''
-  password: ''
+  username:
+  password:
 
 ###################### Mysql ######################
 # MySQL configuration
@@ -60,7 +60,7 @@ mysql:
 # Default MongoDB database name
 # Maximum connection pool size
 mongo:
-  uri: ''
+  uri:
   address: [ 127.0.0.1:37017 ]
   database: openIM_v3
   username: root
@@ -73,7 +73,7 @@ mongo:
 # Username is required only for Redis version 6.0+
 redis:
   address: [ 127.0.0.1:16379 ]
-  username: ''
+  username:
   password: openIM123
 
 ###################### Kafka configuration information ######################
@@ -84,8 +84,8 @@ redis:
 # It's not recommended to modify this topic name
 # Consumer group ID, it's not recommended to modify
 kafka:
-  username: ''
-  password: ''
+  username:
+  password:
   addr: [ 127.0.0.1:9092 ]
   latestMsgToRedis:
     topic: "latestMsgToRedis"
@@ -105,7 +105,7 @@ kafka:
 # IP address to register with zookeeper when starting RPC, the IP and corresponding rpcPort should be accessible by api/gateway
 # Default listen IP is 0.0.0.0
 rpc:
-  registerIP: ''
+  registerIP:
   listenIP: 0.0.0.0
 
 ###################### API configuration information ######################
@@ -132,27 +132,26 @@ api:
 # minio.signEndpoint is minio public network address
 object:
   enable: "minio"
-  apiURL: "http://14.153.17.42:10002"
+  apiURL: "http://127.0.0.1:10002"
   minio:
     bucket: "openim"
     endpoint: "http://127.0.0.1:10005"
     accessKeyID: "root"
     secretAccessKey: "openIM123"
-    sessionToken: ''
-    signEndpoint: "http://14.153.17.42:10005"
+    sessionToken: ""
+    signEndpoint: "http://127.0.0.1:10005"
   cos:
-    bucketURL: https://temp-1252357374.cos.ap-chengdu.myqcloud.com
-    secretID: ''
-    secretKey: ''
-    sessionToken: ''
+    bucketURL: "https://temp-1252357374.cos.ap-chengdu.myqcloud.com"
+    secretID: ""
+    secretKey: ""
+    sessionToken: ""
   oss:
     endpoint: "https://oss-cn-chengdu.aliyuncs.com"
     bucket: "demo-9999999"
     bucketURL: "https://demo-9999999.oss-cn-chengdu.aliyuncs.com"
-    accessKeyID: ''
-    accessKeySecret: ''
-    sessionToken: ''
-
+    accessKeyID: ""
+    accessKeySecret: ""
+    sessionToken: ""
 
 ###################### RPC Port Configuration ######################
 # RPC service ports
@@ -194,11 +193,11 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: /root/workspaces/openim/openim-server/logs/
+  storageLocation: ../../../../../logs/
   rotationTime: 24
   remainRotationCount: 2
   remainLogLevel: 6
-  isStdout: false
+  isStdout: false 
   isJson: false
   withStack: false
 

docker-compose.yml

@@ -103,8 +103,11 @@ services:
     # image: registry.cn-hangzhou.aliyuncs.com/openimsdk/openim-server:main
     # image: openim/openim-server:main
     container_name: openim-server
+    ports:
+      - 10001:10001
+      - 10002:10002
     healthcheck:
-      test: ["CMD-SHELL", "./scripts/check-all.sh"]
+      test: ["CMD", "./scripts/check-all.sh"]
       interval: 30s
       timeout: 10s
       retries: 5

go.work

@@ -1,4 +1,4 @@
-go 1.20.0
+go 1.18
 
 use (
 	.

pkg/common/kafka/util.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package kafka
 
 import (

pkg/common/tls/tls.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package tls
 
 import (

scripts/build-all-service.sh

@@ -20,7 +20,7 @@
 #     package, the build will produce executable files under $(OUT_DIR)/bin/platforms OR $(OUT_DIR)/bin—tools/platforms.
 #     If not specified, "everything" will be built.
 # Usage: `scripts/build-all-service.sh`.
-# Example: `hack/build-go.sh WHAT=cmd/kubelet`.
+# Example: `scripts/build-go.sh WHAT=cmd/kubelet`.
 
 set -o errexit
 set -o nounset

scripts/check-all.sh

@@ -28,6 +28,8 @@ source "${OPENIM_ROOT}/scripts/install/common.sh"
 
 OPENIM_VERBOSE=4
 
+openim::log::info "\n# Begin to check all openim service"
+
 # OpenIM status
 # Elegant printing function
 print_services_and_ports() {
@@ -55,7 +57,7 @@ print_services_and_ports OPENIM_DEPENDENCY_TARGETS OPENIM_DEPENDENCY_PORT_TARGET
 
 # OpenIM check
 echo "++ The port being checked: ${OPENIM_SERVER_PORT_LISTARIES[@]}"
-echo "## Check all dependent service ports"
+openim::log::info "\n## Check all dependent service ports"
 echo "+++ The port being checked: ${OPENIM_DEPENDENCY_PORT_LISTARIES[@]}"
 
 set +e
@@ -69,10 +71,10 @@ else
 fi
 set -e
 
-echo -e "\n## Check OpenIM service name"
+openim::log::info "\n## Check OpenIM service name"
 . $(dirname ${BASH_SOURCE})/install/openim-msgtransfer.sh openim::msgtransfer::check
 
-echo -e "\n## Check all OpenIM service ports"
+openim::log::info "\n## Check all OpenIM service ports"
 echo "+++ The port being checked: ${OPENIM_SERVER_PORT_LISTARIES[@]}"
 openim::util::check_ports ${OPENIM_SERVER_PORT_LISTARIES[@]}
 if [[ $? -ne 0 ]]; then

scripts/docker-start-all.sh

@@ -24,9 +24,14 @@ set -o pipefail
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${OPENIM_ROOT}/scripts/install/common.sh"
 
+openim::log::info "\n# Use Docker to start all openim service"
+
 trap 'openim::util::onCtrlC' INT
 
 "${OPENIM_ROOT}"/scripts/start-all.sh
+
+sleep 5
+
 "${OPENIM_ROOT}"/scripts/check-all.sh
 
 tail -f ${LOG_FILE}

scripts/init-env.sh

@@ -22,6 +22,8 @@ set -o pipefail
 OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd -P)
 source "${OPENIM_ROOT}/scripts/install/common.sh"
 
+openim::log::info "\n# Begin Install OpenIM Config"
+
 for file in "${OPENIM_SERVER_TARGETS[@]}"; do
     VARNAME="$(echo $file | tr '[:lower:]' '[:upper:]' | tr '.' '_' | tr '-' '_')"
     VARVALUE="$OPENIM_OUTPUT_HOSTBIN/$file"

scripts/init-githooks.sh

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+# Copyright © 2023 OpenIM. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# -----------------------------------------------------------------------------
+# init-githooks.sh
+#
+# This script assists in managing Git hooks for the OpenIM project.
+# When executed:
+# 1. It prompts the user to enable git hooks.
+# 2. If the user accepts, it copies predefined hook scripts to the appropriate
+#    Git directory, making them executable.
+# 3. If requested, it can delete the added hooks.
+#
+# This script equal runs `make init-githooks` command.
+# Usage:
+# ./init-githooks.sh              Prompt to enable git hooks.
+# ./init-githooks.sh --delete     Delete previously added git hooks.
+# ./init-githooks.sh --help       Show the help message.
+#
+# Example: `scripts/build-go.sh --help`.
+# Documentation & related context can be found at:
+# https://gist.github.com/cubxxw/126b72104ac0b0ca484c9db09c3e5694
+#
+# -----------------------------------------------------------------------------
+
+OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
+HOOKS_DIR=".git/hooks"
+
+help_info() {
+    echo "Usage: $0 [options]"
+    echo
+    echo "This script helps to manage git hooks."
+    echo
+    echo "Options:"
+    echo "  -h, --help       Show this help message and exit."
+    echo "  -d, --delete     Delete the hooks that have been added."
+    echo "  By default, it will prompt to enable git hooks."
+}
+
+delete_hooks() {
+    for file in scripts/githooks/*.sh; do
+        hook_name=$(basename "$file" .sh)
+        rm -f "$HOOKS_DIR/$hook_name"
+    done
+    echo "Git hooks have been deleted."
+}
+
+enable_hooks() {
+    echo "Would you like to enable git hooks mode? [y/n]"
+    read -r choice
+
+    if [[ $choice == "y" || $choice == "Y" ]]; then
+        for file in scripts/githooks/*.sh; do
+            cp -f "$file" "$HOOKS_DIR/$(basename "$file" .sh)"
+        done
+
+        chmod +x $HOOKS_DIR/*
+        
+        echo "Git hooks mode has been enabled."
+        echo "With git hooks enabled, every time you perform a git action (e.g. git commit), the corresponding hooks script will be triggered automatically."
+        echo "This means that if the size of the file you're committing exceeds the set limit (e.g. 42MB), the commit will be rejected."
+    else
+        echo "Git hooks mode remains disabled."
+    fi
+}
+
+case "$1" in
+    -h|--help)
+        help_info
+        ;;
+    -d|--delete)
+        delete_hooks
+        ;;
+    *)
+        enable_hooks
+        ;;
+esac

scripts/install/openim-rpc.sh

@@ -135,10 +135,11 @@ function openim::rpc::start() {
         for ((j = 0; j < ${#OPENIM_RPC_SERVICE_PORTS_ARRAY[@]}; j++)); do
             openim::log::info "Starting ${OPENIM_RPC_SERVICE_LISTARIES[$i]} service, port: ${OPENIM_RPC_SERVICE_PORTS[j]}, prometheus port: ${OPENIM_RPC_PROM_PORTS[j]}, binary root: ${OPENIM_OUTPUT_HOSTBIN}/${OPENIM_RPC_SERVICE_LISTARIES[$i]}"
             openim::rpc::start_service "${OPENIM_RPC_SERVICE_LISTARIES[$i]}" "${OPENIM_RPC_SERVICE_PORTS[j]}" "${OPENIM_RPC_PROM_PORTS[j]}"
-            sleep 0.5
         done
     done
 
+    sleep 0.5
+
     openim::util::check_ports ${OPENIM_RPC_PORT_TARGETS[@]}
     # openim::util::check_ports ${OPENIM_RPC_PROM_PORT_TARGETS[@]}
 

scripts/install/openim-tools.sh

@@ -71,6 +71,7 @@ readonly OPENIM_TOOLS_PRE_START_NAME_LISTARIES=("${OPENIM_TOOLS_PRE_START_NAME_T
 openim::tools::post_start_name() {
   local targets=(
     infra
+    versionchecker
   )
   echo "${targets[@]}"
 }

scripts/lib/util.sh

@@ -267,25 +267,29 @@ openim::util::check_ports() {
     openim::log::info "Checking ports: $*"
     # Iterate over each given port.
     for port in "$@"; do
-        # Use the `lsof` command to find process information related to the given port.
-        local info=$(lsof -i :$port -n -P | grep LISTEN || true)
+        # Use the `ss` command to find process information related to the given port.
+        local info=$(ss -ltnp | grep -w ":$port" || true)
         
         # If there's no process information, it means the process associated with the port is not running.
         if [[ -z $info ]]; then
             not_started+=($port)
         else
-            # If there's process information, extract relevant details:
-            # Process ID, Command Name, and Start Time.
-            local pid=$(echo $info | awk '{print $2}')
-            local command=$(echo $info | awk '{print $1}')
-            local start_time=$(ps -o lstart= -p $pid)
-            started+=("Port $port - Command: $command, PID: $pid, Start time: $start_time")
+            # Extract relevant details: Process Name, PID, and FD.
+            local details=$(echo $info | sed -n 's/.*users:(("\([^"]*\)",pid=\([^,]*\),fd=\([^)]*\))).*/\1 \2 \3/p')
+            local command=$(echo $details | awk '{print $1}')
+            local pid=$(echo $details | awk '{print $2}')
+            local fd=$(echo $details | awk '{print $3}')
+            
+            # Get the start time of the process using the PID
+            local start_time=$(ps -p $pid -o lstart=)
+            
+            started+=("Port $port - Command: $command, PID: $pid, FD: $fd, Started: $start_time")
         fi
     done
-    echo 
+
     # Print information about ports whose processes are not running.
     if [[ ${#not_started[@]} -ne 0 ]]; then
-        openim::log::info "### Not started ports:"
+        openim::log::info "\n### Not started ports:"
         for port in "${not_started[@]}"; do
             openim::log::error "Port $port is not started."
         done
@@ -293,8 +297,7 @@ openim::util::check_ports() {
 
     # Print information about ports whose processes are running.
     if [[ ${#started[@]} -ne 0 ]]; then
-        echo
-        openim::log::info "### Started ports:"
+        openim::log::info "\n### Started ports:"
         for info in "${started[@]}"; do
             openim::log::info "$info"
         done
@@ -305,11 +308,14 @@ openim::util::check_ports() {
         echo "++++ OpenIM Log >> cat ${LOG_FILE}"
         return 1
     else
-        openim::log::success "started[@] processes are running."
+        openim::log::success "All specified processes are running."
         return 0
     fi
 }
-# openim::util::check_ports 10002 1004
+# set +o errexit
+# Sample call for testing:
+# openim::util::check_ports 10002 1004 12345 13306
+# set -o errexit
 
 # The `openim::util::check_process_names` function analyzes the state of processes based on given names.
 # It accepts multiple process names as arguments and prints:

scripts/make-rules/common.mk

@@ -140,10 +140,6 @@ ifndef V
 MAKEFLAGS += --no-print-directory
 endif
 
-# Copy githook scripts when execute makefile
-# TODO! GIT_FILE_SIZE_LIMIT=42000000 git commit -m "This commit is allowed file sizes up to 42MB"
-COPY_GITHOOK:=$(shell cp -f scripts/githooks/* .git/hooks/; chmod +x .git/hooks/*)
-
 # COMMA: Concatenate multiple strings to form a list of strings
 COMMA := ,
 # SPACE: Used to separate strings

scripts/make-rules/gen.mk

@@ -28,6 +28,12 @@ gen.init:
 	@echo "===========> Initializing openim server project"
 	@${ROOT_DIR}/scripts/init-config.sh
 
+## gen.init-githooks: Initialize git hooks ✨
+.PHONY: gen.init-githooks
+gen.init-githooks:
+	@echo "===========> Initializing git hooks"
+	@${ROOT_DIR}/scripts/init-githooks.sh
+
 ## gen.run: Generate necessary files and docs ✨
 .PHONY: gen.run
 #gen.run: gen.errcode gen.docgo

scripts/start-all.sh

@@ -22,6 +22,8 @@ set -o pipefail
 OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 source "${OPENIM_ROOT}/scripts/install/common.sh"
 
+openim::log::info "\n# Begin to start all openim service scripts"
+
 set +o errexit
 openim::golang::check_openim_binaries
 if [[ $? -ne 0 ]]; then
@@ -62,16 +64,20 @@ function execute_scripts() {
             openim::log::errexit "Script ${script_path##*/} is missing or not executable."
         fi
     done
+    sleep 0.5
 }
 
-sleep 0.5
 
 # TODO Prelaunch tools, simple for now, can abstract functions later
 TOOLS_START_SCRIPTS_PATH=${START_SCRIPTS_PATH}/openim-tools.sh
+
+openim::log::info "\n## Pre Starting OpenIM services"
 ${TOOLS_START_SCRIPTS_PATH} openim::tools::pre-start
 
+openim::log::info "\n## Starting OpenIM services"
 execute_scripts
 
+openim::log::info "\n## Post Starting OpenIM services"
 ${TOOLS_START_SCRIPTS_PATH} openim::tools::post-start
 
 openim::log::success "✨  All OpenIM services have been successfully started!"

scripts/stop-all.sh

@@ -26,6 +26,8 @@ OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 
 source "${OPENIM_ROOT}/scripts/install/common.sh"
 
+openim::log::info "\n# Begin to stop all openim service"
+
 echo "++ Ready to stop port: ${OPENIM_SERVER_PORT_LISTARIES[@]}"
 
 openim::util::stop_services_on_ports ${OPENIM_SERVER_PORT_LISTARIES[@]}

test/typecheck/go.mod

@@ -1,6 +1,6 @@
 module github.com/OpenIMSDK/Open-IM-Server/test/typecheck
 
-go 1.20
+go 1.18
 
 require golang.org/x/tools v0.12.0
 

tools/changelog/go.mod

@@ -1,3 +1,3 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/changelog
 
-go 1.20
+go 1.18

tools/component/go.mod

@@ -1,3 +1,3 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/component
 
-go 1.19
+go 1.18

tools/imctl/go.mod

@@ -1,6 +1,6 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/imctl
 
-go 1.20
+go 1.18
 
 require (
 	github.com/MakeNowJust/heredoc/v2 v2.0.1

tools/infra/go.mod

@@ -1,3 +1,3 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/infra
 
-go 1.20
+go 1.18

tools/ncpu/go.mod

@@ -1,5 +1,5 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/ncpu
 
-go 1.20
+go 1.18
 
 require go.uber.org/automaxprocs v1.5.3

tools/versionchecker/go.mod

@@ -1,3 +1,3 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/versionchecker
 
-go 1.20.0
+go 1.18

tools/versionchecker/versionchecker.go

@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package main
 
 import (

tools/yamlfmt/go.mod

@@ -1,6 +1,6 @@
 module github.com/OpenIMSDK/Open-IM-Server/tools/yamlfmt
 
-go 1.20
+go 1.18
 
 require (
 	github.com/likexian/gokit v0.25.13