feat: add openim info test

feat: add prom address
Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>
2026-04-28 22:39:18 +08:00 · 2023-11-09 18:14:59 +08:00 · 2023-11-09 17:55:15 +08:00 · 2023-11-09 17:54:15 +08:00 · 2023-11-09 17:54:15 +08:00 · 2023-11-09 17:54:15 +08:00
89 changed files with 2149 additions and 664 deletions
@@ -29,8 +29,8 @@ PASSWORD=openIM123
 MINIO_ENDPOINT=http://172.28.0.1:10005

 # Base URL for the application programming interface (API).
-# Default: API_URL=http://172.28.0.1:10002
-API_URL=http://172.28.0.1:10002
+# Default: API_URL=http://172.0.0.1:10002
+API_URL=http://172.0.0.1:10002

 # Directory path for storing data files or related information.
 # Default: DATA_DIR=./
@@ -0,0 +1,90 @@
+# 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.
+
+name: OpenIM API TEST
+
+on: 
+  push:
+    branches:
+        - main
+    paths-ignore:
+        - "docs/**"
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+  pull_request:
+    branches:
+        - main
+    paths-ignore:
+        - "README.md"
+        - "README_zh-CN.md"
+        - "CONTRIBUTING.md"
+        - "docs/**"
+
+env:
+  GO_VERSION: "1.19"
+  GOLANGCI_VERSION: "v1.50.1"
+
+jobs:
+  execute-linux-systemd-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker Operations
+      run: |
+        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        sudo docker compose up -d
+        sudo sleep 60
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start, Check Services and Print Logs
+      run: |
+        sudo ./scripts/install/install.sh -i && \
+        sudo ./scripts/install/install.sh -s && \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+
+    - name: Run Test
+      run: |
+        sudo make test-api && \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
+
+    - name: Stop Services
+      run: |
+        sudo ./scripts/install/install.sh -u && \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
@@ -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.
+
 name: Create Branch on Tag

 on:
@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.

-name: OpenIM E2E Test
+name: OpenIM Linux System E2E Test

 on:
  workflow_dispatch:
@@ -41,4 +41,48 @@ jobs:

      - name: Create e2e test
        run: |
-          echo "...test e2e"
+          echo "...test e2e"
+
+  execute-linux-systemd-scripts:
+    name: Execute OpenIM script on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    environment:
+      name: openim
+    strategy:
+      matrix:
+        go_version: ["1.20"]
+        os: ["ubuntu-latest"]
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go ${{ matrix.go_version }}
+      uses: actions/setup-go@v4
+      with:
+        go-version: ${{ matrix.go_version }}
+      id: go
+
+    - name: Install Task
+      uses: arduino/setup-task@v1
+      with:
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Docker Operations
+      run: |
+        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
+        sudo docker compose up -d
+        sudo sleep 60
+
+    - name: Module Operations
+      run: |
+        sudo make tidy
+        sudo make tools.verify.go-gitlint
+
+    - name: Build, Start, Test, Check Services and Print Logs
+      run: |
+        sudo ./scripts/install/install.sh -i && \
+        sudo make test-api && \
+        sudo ./scripts/install/install.sh -s && \
+        sudo ./scripts/install/install.sh -u || \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)
@@ -64,7 +64,8 @@ jobs:
    - name: Install Task
      uses: arduino/setup-task@v1
      with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}

    - name: Module Operations
      run: |
@@ -122,7 +123,8 @@ jobs:
    - name: Install Task
      uses: arduino/setup-task@v1
      with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
    - name: Run OpenIM make install start
      run: |
        sudo make install
@@ -145,10 +147,13 @@ jobs:
      with:
        go-version: ${{ matrix.go_version }}
      id: go
+
    - name: Install Task
      uses: arduino/setup-task@v1
      with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
    - name: Docker Operations
      run: |
        curl -o docker-compose.yml https://raw.githubusercontent.com/OpenIMSDK/openim-docker/main/example/basic-openim-server-dependency.yml
@@ -160,18 +165,15 @@ jobs:
        sudo make tidy
        sudo make tools.verify.go-gitlint

-    - name: Build, Start and Check Services
+    - name: Build, Start, Check Services and Print Logs
      run: |
-        sudo make init
-        sudo make build
-        sudo make start
-        sudo make check
+        sudo make init && \
+        sudo make build && \
+        sudo make start && \
+        sudo make check || \
+        (echo "An error occurred, printing logs:" && sudo cat ./_output/logs/* 2>/dev/null)

-    - name: Print OpenIM Logs
-      run: sudo cat ./_output/logs/* 2>/dev/null
-      continue-on-error: true
-
-  openim-build-image:
+  openim-test-build-image:
    name: Build OpenIM Docker Image
    runs-on: ubuntu-latest
    environment:
@@ -184,10 +186,13 @@ jobs:
      with:
        go-version: ${{ matrix.go_version }}
      id: go
+
    - name: Install Task
      uses: arduino/setup-task@v1
      with:
-        version: 2.x
+        version: '3.x' # If available, use the latest major version that's compatible
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+
    - name: Test Docker Build
      run: |
        sudo make image
@@ -20,7 +20,7 @@ All notable changes to this project will be documented in this file.

 ## OpenIM versioning policy

-+ [OpenIM Version](../docs/conversions/version.md)
+ [OpenIM Version](../docs/contrib/version.md)

 ## command

@@ -42,6 +42,12 @@ If you are familiar with [Makefile](./Makefile) , you can easily see the clever

 The [Makefile](./Makefile) is for every developer, even if you don't know how to use the Makefile tool, don't worry, we provide two great commands to get you up to speed with the Makefile architecture, `make help` and `make help-all`, it can reduce problems of the developing environment.

+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth: 
+
+ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md
+ https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md
+
+
 ## Code of ConductCode of Conduct

 #### Code and doc contribution
@@ -270,7 +276,7 @@ You can find some very formal PR in [RFC](https://github.com/openimsdk/open-im-s
 **🈴 Reviewing PRs:**

 + Be respectful and constructive 
-+ Assign yourself to the PR 
+ Assign yourself to the PR (comment `/assign`)
 + Check if all checks are passing
 + Suggest changes instead of simply commenting on found issues
 + If you are unsure about something, ask the author
@@ -6,7 +6,7 @@

 ## all: Run tidy, gen, add-copyright, format, lint, cover, build ✨
 .PHONY: all
-all: tidy gen add-copyright verify lint cover restart
+all: tidy gen add-copyright verify test-api lint cover restart

 # ==============================================================================
 # Build set
@@ -166,6 +166,11 @@ test:
 cover:
 	@$(MAKE) go.test.cover

+## test-api: Run api test. ✨
+.PHONY: test-api
+test-api:
+	@$(MAKE) go.test.api
+
 ## updates: Check for updates to go.mod dependencies. ✨
 .PHONY: updates
 	@$(MAKE) go.updates
@@ -86,22 +86,22 @@ OpenIM 我们的目标是建立一个顶级的开源社区。我们有一套标

 在开始之前，请确保你的更改是有需求的。最好的方法是创建一个[新的讨论](https://github.com/openimsdk/open-im-server/discussions/new/choose) 或 [Slack 通信](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)，或者如果你发现一个问题，首先[报告它](https://github.com/openimsdk/open-im-server/issues/new/choose)。

-+ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
+ [代码标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md)

-+ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+ [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)

-+ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
+ [目录标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md)

-+ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
+ [提交标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md)

-+ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
+ [版本控制标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)

-+ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/interface.md)
+ [接口标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/interface.md)

 + [OpenIM配置和环境变量设置](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)

 > **Note**
-> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。
+> 针对中国的用户，阅读我们的 [Docker 镜像标准](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) 以便使用国内 aliyun 的镜像地址。OpenIM 也有针对中国的 gitee 同步仓库，你可以在 [gitee.com](https://gitee.com/openimsdk) 上找到它。

 ## :link: 链接

@@ -4,30 +4,27 @@
    </a>
 </p>

-<h3 align="center" style="border-bottom: none">
-    ⭐️  Open source Instant Messaging Server ⭐️ <br>
-<h3>
+<div align="center">

+[![Stars](https://img.shields.io/github/stars/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=ff69b4)](https://github.com/openimsdk/open-im-server/stargazers)
+[![Forks](https://img.shields.io/github/forks/openimsdk/open-im-server?style=for-the-badge&logo=github&colorB=blue)](https://github.com/openimsdk/open-im-server/network/members)
+[![Codecov](https://img.shields.io/codecov/c/github/openimsdk/open-im-server?style=for-the-badge&logo=codecov&colorB=orange)](https://app.codecov.io/gh/openimsdk/open-im-server)
+[![Go Report Card](https://goreportcard.com/badge/github.com/openimsdk/open-im-server?style=for-the-badge)](https://goreportcard.com/report/github.com/openimsdk/open-im-server)
+[![Go Reference](https://img.shields.io/badge/Go%20Reference-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://pkg.go.dev/github.com/openimsdk/open-im-server/v3)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green?style=for-the-badge)](https://github.com/openimsdk/open-im-server/blob/main/LICENSE)
+[![Slack](https://img.shields.io/badge/Slack-500%2B-blueviolet?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q)
+[![Best Practices](https://img.shields.io/badge/Best%20Practices-purple?style=for-the-badge)](https://www.bestpractices.dev/projects/8045)
+[![Good First Issues](https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?style=for-the-badge&logo=github)](https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22)
+[![Language](https://img.shields.io/badge/Language-Go-blue.svg?style=for-the-badge&logo=go&logoColor=white)](https://golang.org/)

-<p align=center>
-<a href="https://goreportcard.com/report/github.com/openimsdk/open-im-server"><img src="https://goreportcard.com/badge/github.com/openimsdk/open-im-server" alt="A+"></a>
-<a href="https://github.com/openimsdk/open-im-server/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22"><img src="https://img.shields.io/github/issues/openimsdk/open-im-server/good%20first%20issue?logo=%22github%22" alt="good first"></a>
-<a href="https://github.com/openimsdk/open-im-server"><img src="https://img.shields.io/github/stars/openimsdk/open-im-server.svg?style=flat&logo=github&colorB=deeppink&label=stars"></a>
-<a href="https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q"><img src="https://img.shields.io/badge/Slack-300%2B-blueviolet?logo=slack&amp;logoColor=white"></a>
-<a href="https://github.com/openimsdk/open-im-server/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
-<a href="https://golang.org/"><img src="https://img.shields.io/badge/Language-Go-blue.svg"></a>
-<a href="https://pkg.go.dev/github.com/openimsdk/open-im-server/v3"><img src="https://pkg.go.dev/badge/github.com/openimsdk/open-im-server/v3.svg" alt="Go Reference"></a>
-</p>
+[**English**](./README.md) •
+[**简体中文**](./README-zh_CN.md) •
+[**Docs**](https://openim.io/en)
+
+</div>

 </p>

-<p align="center">
-    <a href="./README.md"><b> English </b></a> •
-    <a href="./README-zh_CN.md"><b> 简体中文 </b></a> •
-<a href="https://openim.io/en"><b> Docs </b></a>
-</p>
-
-</p>

 ## Ⓜ️ About OpenIM

@@ -118,7 +115,7 @@ It is recommended to use Docker Compose for deployment, which can easily and qui

 > **Note**
 >
-> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
+> If you don't know OpenIM's versioning policy, 📚Read our release policy: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md


 </details> 
@@ -133,7 +130,7 @@ Ur need `Go 1.20` or higher version, and `make`.
 go version && make --version || echo "Error: One of the commands failed."
 ```

-Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md
+Version Details: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md

 You can get the version number from the command below or from [github releases](https://github.com/openimsdk/open-im-server/tags).

@@ -141,7 +138,7 @@ You can get the version number from the command below or from [github releases](
 $ curl --silent "https://api.github.com/repos/openimsdk/open-im-server/releases" | jq -r '.[].tag_name'
 ```

-We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.
+We have our own version management policy, if you are interested in our version management, I recommend reading [📚 OpenIM Version](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md), We recommend using stable versions such as `v3.3.0` and `v3.2.0` whenever possible. `v3.1.1-alpha.3` as well as `v3.3.0-beta.0` and `v3.2.0-rc.0` are pre-release or beta versions and are not recommended.

 Set `OPENIM_VERSION` environment variables for the latest `OPENIM_VERSION` number, or replace the `OPENIM_VERSION` for you to install the OpenIM-Server `OPENIM_VERSION`:

@@ -199,21 +196,41 @@ Delve into the heart of Open-IM-Server's functionality with our architecture dia

 ## :hammer_and_wrench: To start developing OpenIM

+[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Container&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/github/openimsdk/open-im-server)
+
 OpenIM Our goal is to build a top-level open source community. We have a set of standards, in the [Community repository](https://github.com/OpenIMSDK/community).

 If you'd like to contribute to this Open-IM-Server repository, please read our [contributor documentation](https://github.com/openimsdk/open-im-server/blob/main/CONTRIBUTING.md).

 Before you start, please make sure your changes are in demand. The best for that is to create a [new discussion](https://github.com/openimsdk/open-im-server/discussions/new/choose) OR [Slack Communication](https://join.slack.com/t/openimsdk/shared_invite/zt-22720d66b-o_FvKxMTGXtcnnnHiMqe9Q), or if you find an issue, [report it](https://github.com/openimsdk/open-im-server/issues/new/choose) first.

- [Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md)
- [Docker Images Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
- [Directory Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md)
- [Commit Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md)
- [Versioning Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
- [Interface Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md)
- [Log Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md)
- [Error Code Standards](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md)
- [OpenIM configuration and environment variable Settings](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md)
+- [OpenIM API Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/api.md)
+- [OpenIM Bash Logging](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/bash-log.md)
+- [OpenIM CI/CD Actions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/cicd-actions.md)
+- [OpenIM Code Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/code-conventions.md)
+- [OpenIM Commit Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/commit.md)
+- [OpenIM Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/development.md)
+- [OpenIM Directory Structure](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/directory.md)
+- [OpenIM Environment Setup](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/environment.md)
+- [OpenIM Error Code Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/error-code.md)
+- [OpenIM Git Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git-workflow.md)
+- [OpenIM Git Cherry Pick Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/gitcherry-pick.md)
+- [OpenIM GitHub Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/github-workflow.md)
+- [OpenIM Go Code Standards](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/go-code.md)
+- [OpenIM Image Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/images.md)
+- [OpenIM Initial Configuration](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/init-config.md)
+- [OpenIM Docker Installation Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-docker.md)
+- [OpenIM OpenIM Linux System Installation](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-openim-linux-system.md)
+- [OpenIM Linux Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/linux-development.md)
+- [OpenIM Local Actions Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/local-actions.md)
+- [OpenIM Logging Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/logging.md)
+- [OpenIM Offline Deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/offline-deployment.md)
+- [OpenIM Protoc Tools](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/protoc-tools.md)
+- [OpenIM Testing Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/test.md)
+- [OpenIM Utility Go](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-go.md)
+- [OpenIM Makefile Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-makefile.md)
+- [OpenIM Script Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-scripts.md)
+- [OpenIM Versioning](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/version.md)


 ## :busts_in_silhouette: Community
@@ -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.
+
 FROM BASE_IMAGE

 WORKDIR ${SERVER_WORKDIR}
@@ -198,7 +198,7 @@ rpcRegisterName:
 # Whether to output in json format
 # Whether to include stack trace in logs
 log:
-  storageLocation: ../logs/
+  storageLocation: ./logs/
  rotationTime: 24
  remainRotationCount: 2
  remainLogLevel: 6
@@ -106,7 +106,7 @@ $ helm repo add brigade https://openimsdk.github.io/openim-charts

 ### OpenIM Image Strategy

-Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+Automated offerings include aliyun, ghcr, docker hub: [Image Documentation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)

 **Local Test Build Method:**

@@ -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.
+
 apiVersion: apps/v1
 kind: Deployment
 metadata:
@@ -89,11 +89,11 @@ services:
    ports:
    - "${KAFKA_PORT}:9094"
    volumes:
-      - ./scripts/create_topic.sh:/opt/bitnami/kafka/create_topic.sh
+      - ./scripts/create-topic.sh:/opt/bitnami/kafka/create-topic.sh
      - ${DATA_DIR}/components/kafka:/bitnami/kafka
    command: >
      bash -c "
-      /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create_topic.sh; wait
+      /opt/bitnami/scripts/kafka/run.sh & sleep 5; /opt/bitnami/kafka/create-topic.sh; wait
      "
    environment:
       - TZ=Asia/Shanghai
@@ -5,7 +5,7 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra
 ## Table of Contents

 1. [Contrib](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Guidance on contributing and configurations for developers
-2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions) - Coding conventions, logging policies, and other transformation tools
+2. [Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib) - Coding conventions, logging policies, and other transformation tools

 ------

@@ -13,34 +13,34 @@ Welcome to the OpenIM Documentation hub! This center provides a comprehensive ra

 This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes.

- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) - Rules and conventions for writing code in OpenIM.
+- [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md) - Rules and conventions for writing code in OpenIM.
 - [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) - A guide on how to carry out development within OpenIM.
- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_cherry-pick.md) - Guidelines on cherry-picking operations.
- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) - The git workflow in OpenIM.
- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md) - Guidance on setting up and initializing OpenIM.
- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - How to install Docker on your machine.
- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux_development.md) - Guide to set up the development environment on Linux.
- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local_actions.md) - Guidelines on how to carry out certain common actions locally.
+- [Git Cherry Pick](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/gitcherry-pick.md) - Guidelines on cherry-picking operations.
+- [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git-workflow.md) - The git workflow in OpenIM.
+- [Initialization Configurations](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init-config.md) - Guidance on setting up and initializing OpenIM.
+- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-docker.md) - How to install Docker on your machine.
+- [Linux Development Environment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/linux-development.md) - Guide to set up the development environment on Linux.
+- [Local Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/local-actions.md) - Guidelines on how to carry out certain common actions locally.
 - [Offline Deployment](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/offline-deployment.md) - Methods of deploying OpenIM offline.
- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc_tools.md) - Guide on using protoc tools.
- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_go.md) - Tools and libraries in OpenIM for Go.
- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md) - Best practices and tools for Makefile.
- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_scripts.md) - Best practices and tools for scripts.
+- [Protoc Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/protoc-tools.md) - Guide on using protoc tools.
+- [Go Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-go.md) - Tools and libraries in OpenIM for Go.
+- [Makefile Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-makefile.md) - Best practices and tools for Makefile.
+- [Script Tools](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-scripts.md) - Best practices and tools for scripts.

 ## Conversions

 This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more.

- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/api.md) - Guidelines and methods for API conversions.
- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) - Logging policies and conventions in OpenIM.
- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/cicd_actions.md) - Procedures and conventions for CI/CD.
- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/commit.md) - Conventions for code commits in OpenIM.
- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/directory.md) - Directory structure and conventions within OpenIM.
- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) - List and descriptions of error codes.
- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/go_code.md) - Conventions and conversions for Go code.
- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/logging.md) - Further detailed conventions on logging.
- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md) - Naming and management strategies for OpenIM versions.
+- [API Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/api.md) - Guidelines and methods for API conversions.
+- [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md) - Logging policies and conventions in OpenIM.
+- [CI/CD Actions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/cicd-actions.md) - Procedures and conventions for CI/CD.
+- [Commit Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/commit.md) - Conventions for code commits in OpenIM.
+- [Directory Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/directory.md) - Directory structure and conventions within OpenIM.
+- [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md) - List and descriptions of error codes.
+- [Go Code Conversions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/go-code.md) - Conventions and conversions for Go code.
+- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
+- [Logging Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/logging.md) - Further detailed conventions on logging.
+- [Version Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md) - Naming and management strategies for OpenIM versions.


 ## For Developers, Contributors, and Community Maintainers
@@ -49,7 +49,7 @@ This section introduces various conventions and policies within OpenIM, encompas

 If you're a developer or someone keen on contributing:

- Familiarize yourself with our [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code_conventions.md) and [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git_workflow.md) to ensure smooth contributions.
+- Familiarize yourself with our [Code Conventions](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/code-conventions.md) and [Git Workflow](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/git-workflow.md) to ensure smooth contributions.
 - Dive into the [Development Guide](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/development.md) to get a hang of the development practices in OpenIM.

 ### Community Maintainers
@@ -57,11 +57,11 @@ If you're a developer or someone keen on contributing:
 As a community maintainer:

 - Ensure that contributions align with the standards outlined in our documentation.
- Regularly review the [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/bash_log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/error_code.md) to stay updated.
+- Regularly review the [Logging Policy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/bash-log.md) and [Error Codes](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/error-code.md) to stay updated.

 ## For Users

 Users should pay particular attention to:

- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install_docker.md) - Necessary if you're planning to use Docker images of OpenIM.
- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md) - To understand the different images available and how to choose the right one for your architecture.
+- [Docker Installation](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/install-docker.md) - Necessary if you're planning to use Docker images of OpenIM.
+- [Docker Image Strategy](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md) - To understand the different images available and how to choose the right one for your architecture.
@@ -0,0 +1,42 @@
+# Contrib Documentation Index
+
+## 📚 General Information
+- [📄 README](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/README.md) - General introduction to the contribution documentation.
+- [📑 Development Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/development.md) - Guidelines for setting up a development environment.
+
+## 🛠 Setup and Installation
+- [🌍 Environment Setup](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/environment.md) - Instructions on setting up the development environment.
+- [🐳 Docker Installation Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-docker.md) - Steps to install Docker for container management.
+- [🔧 OpenIM Linux System Installation](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/install-openim-linux-system.md) - Guide for installing OpenIM on a Linux system.
+
+## 💻 Development Practices
+- [👨‍💻 Code Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/code-conventions.md) - Coding standards to follow for consistency.
+- [📐 Directory Structure](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/directory.md) - Explanation of the repository's directory layout.
+- [🔀 Git Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git-workflow.md) - The workflow for using Git in this project (note the file extension error).
+- [💾 GitHub Workflow](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/github-workflow.md) - Workflow guidelines for GitHub.
+
+## 🧪 Testing and Deployment
+- [⚙️ CI/CD Actions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/cicd-actions.md) - Continuous integration and deployment configurations.
+- [🚀 Offline Deployment](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/offline-deployment.md) - How to deploy the application offline.
+
+## 🔧 Utilities and Tools
+- [📦 Protoc Tools](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/protoc-tools.md) - Protobuf compiler-related utilities.
+- [🔨 Utility Go](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-go.md) - Go utilities and helper functions.
+- [🛠 Makefile Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-makefile.md) - Makefile scripts for automation.
+- [📜 Script Utilities](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/util-scripts.md) - Utility scripts for development.
+
+## 📋 Standards and Conventions
+- [🚦 Commit Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/commit.md) - Standards for writing commit messages.
+- [✅ Testing Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/test.md) - Guidelines and conventions for writing tests.
+- [📈 Versioning](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/version.md) - Version management for the project.
+
+## 🖼 Additional Resources
+- [🌐 API Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/api.md) - Detailed API documentation.
+- [📚 Go Code Standards](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/go-code.md) - Go programming language standards.
+- [🖼 Image Guidelines](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/images.md) - Guidelines for image assets.
+
+## 🐛 Troubleshooting
+- [🔍 Error Code Reference](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/error-code.md) - List of error codes and their meanings.
+- [🐚 Bash Logging](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/bash-log.md) - Logging standards for bash scripts.
+- [📈 Logging Conventions](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/logging.md) - Conventions for application logging.
+- [🛠 Local Actions Guide](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/local-actions.md) - How to perform local actions for troubleshooting.
@@ -24,7 +24,48 @@
  - Do not use uppercase characters, underscores, or dashes in package names.
  - Please consider parent directory name when choosing a package name. For example, `pkg/controllers/autoscaler/foo.go` should say `package autoscaler` not `package autoscalercontroller`.
    - Unless there's a good reason, the `package foo` line should match the name of the directory in which the `.go` file exists.
-    - Importers can use a different name if they need to disambiguate.
+    - Importers can use a different name if they need to disambiguate.Ⓜ️
+
+## OpenIM Naming Conventions Guide
+
+Welcome to the OpenIM Naming Conventions Guide. This document outlines the best practices and standardized naming conventions that our project follows to maintain clarity, consistency, and alignment with industry standards, specifically taking cues from the Google Naming Conventions.
+
+### 1. General File Naming
+
+Files within the OpenIM project should adhere to the following rules:
+
+ Both hyphens (`-`) and underscores (`_`) are acceptable in file names.
+ Underscores (`_`) are preferred for general files to enhance readability and compatibility.
+ For example: `data_processor.py`, `user_profile_generator.go`
+
+### 2. Special File Types
+
+#### a. Script and Markdown Files
+
+ Bash scripts and Markdown files should use hyphens (`-`) to facilitate better searchability and compatibility in web browsers.
+ For example: `deploy-script.sh`, `project-overview.md`
+
+#### b. Uppercase Markdown Documentation
+
+ Markdown files with uppercase names, such as `README`, may include underscores (`_`) to separate words if necessary.
+ For example: `README_SETUP.md`, `CONTRIBUTING_GUIDELINES.md`
+
+### 3. Directory Naming
+
+ Directories must use hyphens (`-`) exclusively to maintain a clean and organized file structure.
+ For example: `image-assets`, `user-data`
+
+### 4. Configuration Files
+
+ Configuration files, including but not limited to `.yaml` files, should use hyphens (`-`).
+ For example: `app-config.yaml`, `logging-config.yaml`
+
+### Best Practices
+
+ Keep names concise but descriptive enough to convey the file's purpose or contents at a glance.
+ Avoid using spaces in names; use hyphens or underscores instead to improve compatibility across different operating systems and environments.
+ Stick to lowercase naming where possible for consistency and to prevent issues with case-sensitive systems.
+ Include version numbers or dates in file names if the file is subject to updates, following the format: `project-plan-v1.2.md` or `backup-2023-03-15.sql`.

 ## Directory and file conventions

@@ -136,13 +136,13 @@ For convenience, configuration through modifying environment variables is recomm
  export PASSWORD="openIM123"
  ```

-+ USER
+ OPENIM_USER

  + **Description**: Username for mysql, mongodb, redis, and minio.
  + **Default**: `root`

  ```bash
-  export USER="root"
+  export OPENIM_USER="root"
  ```

 + API_URL
@@ -83,7 +83,7 @@ You may now edit files on the `myfeature` branch.

 ### Building open-im-server

-This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util_makefile.md)
+This workflow is process-specific. For quick-start build instructions for [openimsdk/open-im-server](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/util-makefile.md)

 ## 4. Keep your branch in sync

@@ -312,6 +312,18 @@ The naming convention is a very important part of the code specification. A unif
 - The function name is in camel case, and the first letter is uppercase or lowercase according to the access control decision,For example: `MixedCaps` or `mixedCaps`.
 - Code automatically generated by code generation tools (such as `xxxx.pb.go`) and underscores used to group related test cases (such as `TestMyFunction_WhatIsBeingTested`) exclude this rule.

+In accordance with the naming conventions adopted by OpenIM and drawing reference from the Google Naming Conventions as per the guidelines available at https://google.github.io/styleguide/go/, the following expectations for naming practices within the project are set forth:
+
+1. **File Names:**
+   + Both hyphens (`-`) and underscores (`_`) are permitted when naming files.
+   + A preference is established for the use of underscores (`_`), suggesting it as the best practice in general scenarios.
+2. **Script and Markdown Files:**
+   + For shell scripts (bash files) and Markdown (`.md`) documents, the use of hyphens (`-`) is recommended.
+   + This recommendation is based on the improved searchability and compatibility in web browsers when hyphens are used in names.
+3. **Directories:**
+   + A consistent approach is mandated for naming directories, exclusively using hyphens (`-`) to separate words within directory names.
+
+
 ### 2.3 File Naming

 - Keep the filename short and meaningful.
@@ -26,11 +26,11 @@ docker pull minio/minio

 ## 2. OpenIM & Chat Images

-**For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/version.md)
+**For detailed understanding of version management and storage of OpenIM and Chat**: [version.md](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/version.md)

 ### OpenIM Image

- Get image version info: [images.md](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md)
+- Get image version info: [images.md](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md)
 - Depending on the required version, execute the following command:

 ```bash
@@ -0,0 +1,183 @@
+# OpenIM RPC Service Test Control Script Documentation
+
+This document serves as a comprehensive guide to understanding and utilizing the `test.sh` script for testing OpenIM RPC services. The `test.sh` script is a collection of bash functions designed to test various aspects of the OpenIM RPC services, ensuring that each part of the API is functioning as expected.
+
+ Scripts：https://github.com/OpenIMSDK/Open-IM-Server/tree/main/scripts/install/test.sh
+
+For some complex, bulky functional tests, performance tests, and various e2e tests, We are all in the current warehouse to https://github.com/OpenIMSDK/Open-IM-Server/tree/main/test or https://github.com/openim-sigs/test-infra directory In the.
+
+ About OpenIM Feature [Test Docs](https://docs.google.com/spreadsheets/d/1zELWkwxgOOZ7u5pmYCqqaFnvZy2SVajv/edit?usp=sharing&ouid=103266350914914783293&rtpof=true&sd=true)
+
+
+## Usage
+
+The `test.sh` script is located within the `./scripts/install/` directory of the OpenIM service's codebase. To use the script, navigate to this directory from your terminal:
+
+```bash
+cd ./scripts/install/
+chmod +x test.sh
+```
+
+### Running the Entire Test Suite
+
+To execute all available tests, you can either call the script directly or use the `make` command:
+
+```
+./test.sh openim::test::test
+```
+
+Or, if you have a `Makefile` that defines the `test-api` target:
+
+```bash
+make test-api
+```
+
+Alternatively, you can invoke specific test functions by passing them as arguments:
+
+```
+./test.sh openim::test::<function_name>
+```
+
+This `make` command should be equivalent to running `./test.sh openim::test::test`, provided that the `Makefile` is configured accordingly.
+
+
+
+### Executing Individual Test Functions
+
+If you wish to run a specific set of tests, you can call the relevant function by passing it as an argument to the script. Here are some examples:
+
+**Message Tests:**
+
+```bash
+./test.sh openim::test::msg
+```
+
+**Authentication Tests:**
+
+```bash
+./test.sh openim::test::auth
+```
+
+**User Tests:**
+
+```bash
+./test.sh openim::test::user
+```
+
+**Friend Tests:**
+
+```bash
+./test.sh openim::test::friend
+```
+
+**Group Tests:**
+
+```bash
+./test.sh openim::test::group
+```
+
+Each of these commands will run the test suite associated with the specific functionality of the OpenIM service.
+
+
+
+### Detailed Function Test Examples
+
+T**esting Message Sending and Receiving:**
+
+To test message functionality, the `openim::test::msg` function is called. It will register a user, send a message, and clear messages to ensure that the messaging service is operational.
+
+```bash
+./test.sh openim::test::msg
+```
+
+**Testing User Registration and Account Checks:**
+
+The `openim::test::user` function will create new user accounts and perform a series of checks on these accounts to verify that user registration and account queries are functioning properly.
+
+```bash
+./test.sh openim::test::user
+```
+
+**Testing Friend Management:**
+
+By invoking `openim::test::friend`, the script will test adding friends, checking friendship status, managing friend requests, and handling blacklisting.
+
+```bash
+./test.sh openim::test::friend
+```
+
+**Testing Group Operations:**
+
+The `openim::test::group` function tests group creation, member addition, information retrieval, and member management within groups.
+
+```bash
+./test.sh openim::test::group
+```
+
+### Log Output
+
+Each test function will output logs to the terminal to confirm the success or failure of the tests. These logs are crucial for identifying issues and verifying that each part of the service is tested thoroughly.
+
+Each function logs its success upon completion, which aids in debugging and understanding the test flow. The success message is standardized across functions:
+
+```
+openim::log::success "<Test suite name> completed successfully."
+```
+
+By following the guidelines and instructions outlined in this document, you can effectively utilize the `test.sh` script to test and verify the OpenIM RPC services' functionality.
+
+
+
+## Function feature
+
+| Function Name                                        | Corresponding API/Action                      | Function Purpose                                             |
+| ---------------------------------------------------- | --------------------------------------------- | ------------------------------------------------------------ |
+| `openim::test::msg`                                  | Messaging Operations                          | Tests all aspects of messaging, including sending, receiving, and managing messages. |
+| `openim::test::auth`                                 | Authentication Operations                     | Validates the authentication process and session management, including token handling and forced logout. |
+| `openim::test::user`                                 | User Account Operations                       | Covers testing for user account creation, retrieval, updating, and overall management. |
+| `openim::test::friend`                               | Friend Relationship Operations                | Ensures friend management functions correctly, including requests, listing, and blacklisting. |
+| `openim::test::group`                                | Group Management Operations                   | Checks group-related functionalities like creation, invitation, information retrieval, and member management. |
+| `openim::test::send_msg`                             | Send Message API                              | Simulates sending a message from one user to another or within a group. |
+| `openim::test::revoke_msg`                           | Revoke Message API (TODO)                     | (Planned) Will test the revocation of a previously sent message. |
+| `openim::test::user_register`                        | User Registration API                         | Registers a new user in the system to validate the registration process. |
+| `openim::test::check_account`                        | Account Check API                             | Checks if an account exists for a given user ID.             |
+| `openim::test::user_clear_all_msg`                   | Clear All Messages API                        | Clears all messages for a given user to validate message history management. |
+| `openim::test::get_token`                            | Token Retrieval API                           | Retrieves an authentication token to validate token management. |
+| `openim::test::force_logout`                         | Force Logout API                              | Forces a logout for a test user to validate session control. |
+| `openim::test::check_user_account`                   | User Account Existence Check API              | Confirms the existence of a test user's account.             |
+| `openim::test::get_users`                            | Get Users API                                 | Retrieves a list of users to validate user query functionality. |
+| `openim::test::get_users_info`                       | Get User Information API                      | Obtains detailed information for a given user.               |
+| `openim::test::get_users_online_status`              | Get User Online Status API                    | Checks the online status of a user to validate presence functionality. |
+| `openim::test::update_user_info`                     | Update User Information API                   | Updates a user's information to validate account update capabilities. |
+| `openim::test::get_subscribe_users_status`           | Get Subscribed Users' Status API              | Retrieves the status of users that a test user has subscribed to. |
+| `openim::test::subscribe_users_status`               | Subscribe to Users' Status API                | Subscribes a test user to a set of user statuses.            |
+| `openim::test::set_global_msg_recv_opt`              | Set Global Message Receiving Option API       | Sets the message receiving option for a test user.           |
+| `openim::test::is_friend`                            | Check Friendship Status API                   | Verifies if two users are friends within the system.         |
+| `openim::test::add_friend`                           | Send Friend Request API                       | Sends a friend request from one user to another.             |
+| `openim::test::get_friend_list`                      | Get Friend List API                           | Retrieves the friend list of a test user.                    |
+| `openim::test::get_friend_apply_list`                | Get Friend Application List API               | Retrieves friend applications for a test user.               |
+| `openim::test::get_self_friend_apply_list`           | Get Self-Friend Application List API          | Retrieves the friend applications that the user has applied for. |
+| `openim::test::add_black`                            | Add User to Blacklist API                     | Adds a user to the test user's blacklist to validate blacklist functionality. |
+| `openim::test::remove_black`                         | Remove User from Blacklist API                | Removes a user from the test user's blacklist.               |
+| `openim::test::get_black_list`                       | Get Blacklist API                             | Retrieves the blacklist for a test user.                     |
+| `openim::test::create_group`                         | Group Creation API                            | Creates a new group with test users to validate group creation. |
+| `openim::test::invite_user_to_group`                 | Invite User to Group API                      | Invites a user to join a group to test invitation functionality. |
+| `openim::test::transfer_group`                       | Group Ownership Transfer API                  | Tests the transfer of group ownership from one member to another. |
+| `openim::test::get_groups_info`                      | Get Group Information API                     | Retrieves information for specified groups to validate group query functionality. |
+| `openim::test::kick_group`                           | Kick User from Group API                      | Simulates kicking a user from a group to test group membership management. |
+| `openim::test::get_group_members_info`               | Get Group Members Information API             | Obtains detailed information for members of a specified group. |
+| `openim::test::get_group_member_list`                | Get Group Member List API                     | Retrieves a list of members for a given group to ensure member listing is functional. |
+| `openim::test::get_joined_group_list`                | Get Joined Group List API                     | Retrieves a list of groups that a user has joined to validate user's group memberships. |
+| `openim::test::set_group_member_info`                | Set Group Member Information API              | Updates the information for a group member to test the update functionality. |
+| `openim::test::mute_group`                           | Mute Group API                                | Tests the ability to mute a group, disabling message notifications for its members. |
+| `openim::test::cancel_mute_group`                    | Cancel Mute Group API                         | Tests the ability to cancel the mute status of a group, re-enabling message notifications. |
+| `openim::test::dismiss_group`                        | Dismiss Group API                             | Tests the ability to dismiss and delete a group from the system. |
+| `openim::test::cancel_mute_group_member`             | Cancel Mute Group Member API                  | Tests the ability to cancel mute status for a specific group member. |
+| `openim::test::join_group`                           | Join Group API (TODO)                         | (Planned) Will test the functionality for a user to join a specified group. |
+| `openim::test::set_group_info`                       | Set Group Information API                     | Tests the ability to update the group information, such as the name or description. |
+| `openim::test::quit_group`                           | Quit Group API                                | Tests the functionality for a user to leave a specified group. |
+| `openim::test::get_recv_group_applicationList`       | Get Received Group Application List API       | Retrieves the list of group applications received by a user to validate application management. |
+| `openim::test::group_application_response`           | Group Application Response API (TODO)         | (Planned) Will test the functionality to respond to a group join request. |
+| `openim::test::get_user_req_group_applicationList`   | Get User Requested Group Application List API | Retrieves the list of group applications requested by a user to validate tracking of user's applications. |
+| `openim::test::mute_group_member`                    | Mute Group Member API                         | Tests the ability to mute a specific member within a group, disabling their ability to send messages. |
+| `openim::test::get_group_users_req_application_list` | Get Group Users Request Application List API  | Retrieves a list of user requests for group applications to validate group request management. |
@@ -212,4 +212,4 @@ Throughout this process, active communication within the team is pivotal to main

 ## Docker Images Version Management

-For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md).
+For more details on managing Docker image versions, visit [OpenIM Docker Images Administration](https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md).
@@ -1,10 +0,0 @@
-##  OpenIM Project Development Standards
-
- [Code Standards](./go_code.md)
- [Docker Images Standards](./images.md)
- [Directory Standards](./directory.md)
- [Commit Standards](./commit.md)
- [Versioning Standards](./version.md)
- [Interface Standards](./api.md)
- [Log Standards](./log.md)
- [Error Code Standards](./error_code.md)
@@ -45,6 +45,7 @@ require (
 	github.com/redis/go-redis/v9 v9.2.1
 	github.com/tencentyun/cos-go-sdk-v5 v0.7.45
 	gopkg.in/src-d/go-git.v4 v4.13.1
+	gotest.tools v2.2.0+incompatible
 )

 require (
@@ -73,6 +74,7 @@ require (
 	github.com/go-zookeeper/zk v1.0.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/snappy v0.0.4 // indirect
+	github.com/google/go-cmp v0.6.0 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
 	github.com/google/s2a-go v0.1.7 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.1 // indirect
@@ -116,6 +118,7 @@ require (
 	github.com/sergi/go-diff v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/src-d/gcfg v1.4.0 // indirect
+	github.com/stretchr/objx v0.5.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/xanzy/ssh-agent v0.2.1 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
@@ -144,6 +144,7 @@ github.com/google/go-cmp v0.5.2/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.3/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
@@ -311,6 +312,7 @@ github.com/src-d/gcfg v1.4.0/go.mod h1:p/UMsR43ujA89BJY9duynAwIpvqEujIH/jFlfL7jW
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.2.0/go.mod h1:qt09Ya8vawLte6SNmTgCsAVtYtaKzEcn8ATUoHMkEqE=
 github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
@@ -531,6 +533,8 @@ gorm.io/driver/mysql v1.5.2/go.mod h1:pQLhh1Ut/WUAySdTHwBpBv6+JKcj+ua4ZFx1QQTBzb
 gorm.io/gorm v1.25.2-0.20230530020048-26663ab9bf55/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
 gorm.io/gorm v1.25.5 h1:zR9lOiiYf09VNh5Q1gphfyia1JpiClIWG9hQaxB/mls=
 gorm.io/gorm v1.25.5/go.mod h1:hbnx/Oo0ChWMn1BIhpy1oYozzpM15i4YPuHDmfYtwg8=
+gotest.tools v2.2.0+incompatible h1:VsBPFP1AI068pPrMxtb/S8Zkgf9xEmTLJjfM+P5UIEo=
+gotest.tools v2.2.0+incompatible/go.mod h1:DsYFclhRJ6vuDpmuTbkuFWG+y2sxOXAzmJt81HFBacw=
 honnef.co/go/tools v0.0.0-20190102054323-c2f93a96b099/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 honnef.co/go/tools v0.0.0-20190523083050-ea95bdfd59fc/go.mod h1:rf3lG4BRIbNafJWhAfAdb/ePZxsR/4RtNHQocxwk9r4=
 rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=
@@ -458,25 +458,20 @@ function openim_color() {
 }

 # --- helper functions for logs ---
-info()
-{
+info() {
    echo -e "[${GREEN_PREFIX}INFO${COLOR_SUFFIX}] " "$@"
 }
-warn()
-{
+warn() {
    echo -e "[${YELLOW_PREFIX}WARN${COLOR_SUFFIX}] " "$@" >&2
 }
-fatal()
-{
+fatal() {
    echo -e "[${RED_PREFIX}ERROR${COLOR_SUFFIX}] " "$@" >&2
    exit 1
 }
-debug()
-{
+debug() {
    echo -e "[${BLUE_PREFIX}DEBUG${COLOR_SUFFIX}]===> " "$@"
 }
-success()
-{
+success() {
    echo -e "${BRIGHT_GREEN_PREFIX}=== [SUCCESS] ===${COLOR_SUFFIX}\n=> " "$@"
 }

@@ -147,7 +147,7 @@ EOF
    
    cd scripts;
    chmod +x *.sh;
-    ./init_pwd.sh;
+    ./init-pwd.sh;
    ./env_check.sh;
    cd ..;
    docker-compose up -d;
@@ -16,12 +16,14 @@ package tools

 import (
 	"context"
+	"math/rand"
+	"time"
+
 	"github.com/OpenIMSDK/tools/log"
 	"github.com/OpenIMSDK/tools/mcontext"
 	"github.com/OpenIMSDK/tools/utils"
+
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
-	"math/rand"
-	"time"
 )

 //func (c *MsgTool) ConversationsDestructMsgs() {
@@ -54,7 +56,8 @@ import (
 //			continue
 //		}
 //		if len(seqs) > 0 {
-//			if err := c.conversationDatabase.UpdateUsersConversationFiled(ctx, []string{conversation.OwnerUserID}, conversation.ConversationID, map[string]interface{}{"latest_msg_destruct_time": now}); err != nil {
+// 			if err := c.conversationDatabase.UpdateUsersConversationFiled(ctx, []string{conversation.OwnerUserID}, conversation.ConversationID, map[string]interface{}{"latest_msg_destruct_time": now}); err
+// != nil {
 //				log.ZError(ctx, "updateUsersConversationFiled failed", err, "conversationID", conversation.ConversationID, "ownerUserID", conversation.OwnerUserID)
 //				continue
 //			}
@@ -104,7 +107,8 @@ func (c *MsgTool) ConversationsDestructMsgs() {
 		}
 		temp := make([]*relation.ConversationModel, 0, len(conversations))
 		for i, conversation := range conversations {
-			if conversation.IsMsgDestruct && conversation.MsgDestructTime != 0 && (time.Now().Unix() > (conversation.MsgDestructTime+conversation.LatestMsgDestructTime.Unix()+8*60*60)) || conversation.LatestMsgDestructTime.IsZero() {
+			if conversation.IsMsgDestruct && conversation.MsgDestructTime != 0 && (time.Now().Unix() > (conversation.MsgDestructTime+conversation.LatestMsgDestructTime.Unix()+8*60*60)) ||
+				conversation.LatestMsgDestructTime.IsZero() {
 				temp = append(temp, conversations[i])
 			}
 		}
@@ -17,11 +17,15 @@ package tools
 import (
 	"context"
 	"fmt"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
+	"math"
+
 	"github.com/redis/go-redis/v9"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
-	"math"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/discovery_register"
+
+	"math/rand"

 	"github.com/OpenIMSDK/tools/errs"
 	"github.com/OpenIMSDK/tools/log"
@@ -29,7 +33,6 @@ import (
 	"github.com/OpenIMSDK/tools/mw"
 	"github.com/OpenIMSDK/tools/tx"
 	"github.com/OpenIMSDK/tools/utils"
-	"math/rand"

 	"github.com/openimsdk/open-im-server/v3/pkg/common/config"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
@@ -18,40 +18,83 @@ import (
 	sdkws "github.com/OpenIMSDK/protocol/sdkws"
 )

+// SendMsg defines the structure for sending messages with various metadata.
 type SendMsg struct {
-	SendID           string                 `json:"sendID"           binding:"required"`
-	GroupID          string                 `json:"groupID"          binding:"required_if=SessionType 2|required_if=SessionType 3"`
-	SenderNickname   string                 `json:"senderNickname"`
-	SenderFaceURL    string                 `json:"senderFaceURL"`
-	SenderPlatformID int32                  `json:"senderPlatformID"`
-	Content          map[string]interface{} `json:"content"          binding:"required"                                            swaggerignore:"true"`
-	ContentType      int32                  `json:"contentType"      binding:"required"`
-	SessionType      int32                  `json:"sessionType"      binding:"required"`
-	IsOnlineOnly     bool                   `json:"isOnlineOnly"`
-	NotOfflinePush   bool                   `json:"notOfflinePush"`
-	SendTime         int64                  `json:"sendTime"`
-	OfflinePushInfo  *sdkws.OfflinePushInfo `json:"offlinePushInfo"`
+	// SendID uniquely identifies the sender.
+	SendID string `json:"sendID" binding:"required"`
+	
+	// GroupID is the identifier for the group, required if SessionType is 2 or 3.
+	GroupID string `json:"groupID" binding:"required_if=SessionType 2|required_if=SessionType 3"`
+	
+	// SenderNickname is the nickname of the sender.
+	SenderNickname string `json:"senderNickname"`
+	
+	// SenderFaceURL is the URL to the sender's avatar.
+	SenderFaceURL string `json:"senderFaceURL"`
+	
+	// SenderPlatformID is an integer identifier for the sender's platform.
+	SenderPlatformID int32 `json:"senderPlatformID"`
+	
+	// Content is the actual content of the message, required and excluded from Swagger documentation.
+	Content map[string]interface{} `json:"content" binding:"required" swaggerignore:"true"`
+	
+	// ContentType is an integer that represents the type of the content.
+	ContentType int32 `json:"contentType" binding:"required"`
+	
+	// SessionType is an integer that represents the type of session for the message.
+	SessionType int32 `json:"sessionType" binding:"required"`
+	
+	// IsOnlineOnly specifies if the message is only sent when the receiver is online.
+	IsOnlineOnly bool `json:"isOnlineOnly"`
+	
+	// NotOfflinePush specifies if the message should not trigger offline push notifications.
+	NotOfflinePush bool `json:"notOfflinePush"`
+	
+	// SendTime is a timestamp indicating when the message was sent.
+	SendTime int64 `json:"sendTime"`
+	
+	// OfflinePushInfo contains information for offline push notifications.
+	OfflinePushInfo *sdkws.OfflinePushInfo `json:"offlinePushInfo"`
 }

+// SendMsgReq extends SendMsg with the requirement of RecvID when SessionType indicates a one-on-one or notification chat.
 type SendMsgReq struct {
+	// RecvID uniquely identifies the receiver and is required for one-on-one or notification chat types.
 	RecvID string `json:"recvID" binding:"required_if" message:"recvID is required if sessionType is SingleChatType or NotificationChatType"`
 	SendMsg
 }

+// BatchSendMsgReq defines the structure for sending a message to multiple recipients.
 type BatchSendMsgReq struct {
 	SendMsg
-	IsSendAll bool     `json:"isSendAll"`
-	RecvIDs   []string `json:"recvIDs"   binding:"required"`
+	
+	// IsSendAll indicates whether the message should be sent to all users.
+	IsSendAll bool `json:"isSendAll"`
+	
+	// RecvIDs is a slice of receiver identifiers to whom the message will be sent, required field.
+	RecvIDs []string `json:"recvIDs" binding:"required"`
 }

+// BatchSendMsgResp contains the results of a batch message send operation.
 type BatchSendMsgResp struct {
-	Results   []*SingleReturnResult `json:"results"`
-	FailedIDs []string              `json:"failedUserIDs"`
+	// Results is a slice of SingleReturnResult, representing the outcome of each message sent.
+	Results []*SingleReturnResult `json:"results"`
+	
+	// FailedIDs is a slice of user IDs for whom the message send failed.
+	FailedIDs []string `json:"failedUserIDs"`
 }

+// SingleReturnResult encapsulates the result of a single message send attempt.
 type SingleReturnResult struct {
+	// ServerMsgID is the message identifier on the server-side.
 	ServerMsgID string `json:"serverMsgID"`
+	
+	// ClientMsgID is the message identifier on the client-side.
 	ClientMsgID string `json:"clientMsgID"`
-	SendTime    int64  `json:"sendTime"`
-	RecvID      string `json:"recvID"`
+	
+	// SendTime is the timestamp of when the message was sent.
+	SendTime int64 `json:"sendTime"`
+	
+	// RecvID uniquely identifies the receiver of the message.
+	RecvID string `json:"recvID"`
 }
@@ -0,0 +1,51 @@
+// 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 cmd
+
+import (
+	"testing"
+
+	"github.com/OpenIMSDK/protocol/constant"
+	"github.com/stretchr/testify/mock"
+	"gotest.tools/assert"
+)
+
+// MockRootCmd is a mock type for the RootCmd type
+type MockRootCmd struct {
+	mock.Mock
+}
+
+func (m *MockRootCmd) Execute() error {
+	args := m.Called()
+	return args.Error(0)
+}
+
+func TestMsgGatewayCmd_GetPortFromConfig(t *testing.T) {
+	msgGatewayCmd := &MsgGatewayCmd{RootCmd: &RootCmd{}}
+	tests := []struct {
+		portType string
+		want     int
+	}{
+		{constant.FlagWsPort, 8080}, // Replace 8080 with the expected port from the config
+		{constant.FlagPort, 8081},   // Replace 8081 with the expected port from the config
+		{"invalid", 0},
+	}
+	for _, tt := range tests {
+		t.Run(tt.portType, func(t *testing.T) {
+			got := msgGatewayCmd.GetPortFromConfig(tt.portType)
+			assert.Equal(t, tt.want, got)
+		})
+	}
+}
@@ -49,7 +49,7 @@ func GetDefaultConfigPath() string {
 func GetProjectRoot() string {
 	b, _ := filepath.Abs(os.Args[0])

-	return filepath.Join(filepath.Dir(b), "../../..")
+	return filepath.Join(filepath.Dir(b), "../../../../..")
 }

 func GetOptionsByNotification(cfg NotificationConf) msgprocessor.Options {
@@ -67,6 +67,7 @@ func GetOptionsByNotification(cfg NotificationConf) msgprocessor.Options {
 		opts = msgprocessor.WithOptions(opts, msgprocessor.WithHistory(true), msgprocessor.WithPersistent())
 	}
 	opts = msgprocessor.WithOptions(opts, msgprocessor.WithSendMsg(cfg.IsSendMsg))
+
 	return opts
 }

@@ -89,6 +90,7 @@ func initConfig(config interface{}, configName, configFolderPath string) error {
 		return fmt.Errorf("unmarshal yaml error: %w", err)
 	}
 	fmt.Println("use config", configFolderPath)
+
 	return nil
 }

@@ -0,0 +1,117 @@
+// 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 config
+
+import (
+	_ "embed"
+	"reflect"
+	"testing"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/msgprocessor"
+)
+
+func TestGetDefaultConfigPath(t *testing.T) {
+	tests := []struct {
+		name string
+		want string
+	}{
+		// TODO: Add test cases.
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := GetDefaultConfigPath(); got != tt.want {
+				t.Errorf("GetDefaultConfigPath() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestGetProjectRoot(t *testing.T) {
+	tests := []struct {
+		name string
+		want string
+	}{
+		// TODO: Add test cases.
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := GetProjectRoot(); got != tt.want {
+				t.Errorf("GetProjectRoot() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func TestGetOptionsByNotification(t *testing.T) {
+	type args struct {
+		cfg NotificationConf
+	}
+	tests := []struct {
+		name string
+		args args
+		want msgprocessor.Options
+	}{
+		// TODO: Add test cases.
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := GetOptionsByNotification(tt.args.cfg); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("GetOptionsByNotification() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func Test_initConfig(t *testing.T) {
+	type args struct {
+		config           interface{}
+		configName       string
+		configFolderPath string
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		// TODO: Add test cases.
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if err := initConfig(tt.args.config, tt.args.configName, tt.args.configFolderPath); (err != nil) != tt.wantErr {
+				t.Errorf("initConfig() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}
+
+func TestInitConfig(t *testing.T) {
+	type args struct {
+		configFolderPath string
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		// TODO: Add test cases.
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if err := InitConfig(tt.args.configFolderPath); (err != nil) != tt.wantErr {
+				t.Errorf("InitConfig() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}
@@ -18,9 +18,10 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
-	"github.com/OpenIMSDK/tools/mw/specialerror"
 	"time"

+	"github.com/OpenIMSDK/tools/mw/specialerror"
+
 	"github.com/dtm-labs/rockscache"

 	"github.com/OpenIMSDK/tools/errs"
@@ -2,12 +2,14 @@ package cache

 import (
 	"context"
-	"github.com/dtm-labs/rockscache"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
-	relationtb "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
-	"github.com/redis/go-redis/v9"
 	"strconv"
 	"time"
+
+	"github.com/dtm-labs/rockscache"
+	"github.com/redis/go-redis/v9"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
+	relationtb "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
 )

 type ObjectCache interface {
@@ -16,13 +16,15 @@ package controller

 import (
 	"context"
+	"path/filepath"
+	"time"
+
+	"github.com/redis/go-redis/v9"
+
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/cont"
 	"github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"
-	"github.com/redis/go-redis/v9"
-	"path/filepath"
-	"time"
 )

 type S3Database interface {
@@ -16,6 +16,7 @@ package relation

 import (
 	"context"
+
 	"github.com/OpenIMSDK/tools/errs"
 	"gorm.io/gorm"

@@ -20,11 +20,12 @@ import (
 	"encoding/hex"
 	"errors"
 	"fmt"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
 	"path"
 	"strings"
 	"time"

+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
+
 	"github.com/google/uuid"

 	"github.com/OpenIMSDK/tools/errs"
@@ -18,7 +18,6 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
 	"io"
 	"net/http"
 	"net/url"
@@ -30,6 +29,8 @@ import (
 	"time"
 	"unsafe"

+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
+
 	"github.com/OpenIMSDK/tools/log"
 	"github.com/minio/minio-go/v7"
 	"github.com/minio/minio-go/v7/pkg/credentials"
@@ -5,11 +5,6 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/OpenIMSDK/tools/errs"
-	"github.com/OpenIMSDK/tools/log"
-	"github.com/minio/minio-go/v7"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
-	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
 	"image"
 	"image/gif"
 	"image/jpeg"
@@ -18,6 +13,13 @@ import (
 	"path/filepath"
 	"strings"
 	"time"
+
+	"github.com/OpenIMSDK/tools/errs"
+	"github.com/OpenIMSDK/tools/log"
+	"github.com/minio/minio-go/v7"
+
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/cache"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/db/s3"
 )

 func (m *Minio) getImageThumbnailURL(ctx context.Context, name string, expire time.Duration, opt *s3.Image) (string, error) {
@@ -51,7 +51,7 @@ scripts/
 ├── golangci.yml                        # Configuration for GolangCI linting.
 ├── init-config.sh                      # Initialize configurations.
 ├── init-env.sh                         # Initialize the environment.
-├── init_pwd.sh                         # Initialize or set password.
+├── init-pwd.sh                         # Initialize or set password.
 ├── install                             # Installation scripts directory.
 │   ├── README.md                       # Installation documentation.
 │   ├── common.sh                       # Common utilities for installation.
@@ -123,7 +123,7 @@ Each directory and script in the structure should be understood as a part of a l

 **PATH:** `scripts/lib/logging.sh`

-+ [log details](../docs/conversions/bash_log.md)
+ [log details](../docs/contrib/bash-log.md)

 ## Supported platforms

@@ -154,7 +154,7 @@ $ make demo

 More about `make` read:

-+ [makefile](../docs/conversions/go_code.md)
+ [makefile](../docs/contrib/go-code.md)

 Instructions for producing the demo movie:

@@ -1,84 +0,0 @@
-#!/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.
-
-#fixme This scripts is the total startup scripts
-#fixme The full name of the shell scripts that needs to be started is placed in the need_to_start_server_shell array
-
-set -o errexit
-set -o nounset
-set -o pipefail
-
-OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
-source "${OPENIM_ROOT}/scripts/lib/init.sh"
-
-trap 'openim::util::onCtrlC' INT
-
-need_to_start_server_shell=(
-  "oepnim-api.sh"
-  "openim-rpc.sh"
-  "openim-msggateway.sh"
-  "openim-push.sh"
-  "openim-msgtransfer.sh"
-)
-
-time=$(date +"%Y-%m-%d %H:%M:%S")
-
-for _ in {1..3}; do
-  echo "==========================================================" >> $OPENIM_ROOT/logs/openIM.log 2>&1
-done
-
-echo "==========server start time:${time}===========" >> $OPENIM_ROOT/logs/openIM.log 2>&1
-
-for _ in {1..3}; do
-  echo "==========================================================" >> $OPENIM_ROOT/logs/openIM.log 2>&1
-done
-
-build_pid_array=()
-idx=0
-for i in ${need_to_start_server_shell[*]}; do
-  chmod +x $i
-  ./$i &
-  build_pid=$!
-  echo "build_pid " $build_pid
-  build_pid_array[idx]=$build_pid
-  let idx=idx+1
-done
-
-echo "wait all start finish....."
-
-exit 0
-
-success_num=0
-for ((i = 0; i < ${#need_to_start_server_shell[*]}; i++)); do
-  echo "wait pid: " ${build_pid_array[i]} ${need_to_start_server_shell[$i]}
-  wait ${build_pid_array[i]}
-  stat=$?
-  echo ${build_pid_array[i]}  " " $stat
- if [ $stat == 0 ]
- then
-     # echo -e "${GREEN_PREFIX}${need_to_start_server_shell[$i]} successfully be built ${COLOR_SUFFIX}\n"
-      let success_num=$success_num+1
-
- else
-      #echo -e "${RED_PREFIX}${need_to_start_server_shell[$i]} build failed ${COLOR_SUFFIX}\n"
-      exit -1
- fi
-done
-
-echo "success_num" $success_num  "service num:" ${#need_to_start_server_shell[*]}
-if [ $success_num == ${#need_to_start_server_shell[*]} ]
-then
-  echo -e ${BACKGROUND_GREEN}"all services build success"${COLOR_SUFFIX}
-fi
@@ -1,13 +0,0 @@
-@echo off
-set output_dir=%~dp0..\_output\bin\platforms\windows
-
-set "rpc_apps=auth conversation friend group msg third user"
-set "other_apps=api push msgtransfer msggateway"
-
-for %%a in (%rpc_apps%) do (
-    go build -o %output_dir%\%%a.exe ../cmd/openim-rpc/openim-rpc-%%a/main.go
-)
-
-for %%a in (%other_apps%) do (
-    go build -o %output_dir%\%%a.exe ../cmd/openim-%%a/main.go
-)
@@ -14,7 +14,7 @@
 # limitations under the License.


-# Usage Instructions: https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git_cherry-pick.md
+# Usage Instructions: https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/gitcherry-pick.md

 # Checkout a PR from GitHub. (Yes, this is sitting in a Git tree. How
 # meta.) Assumes you care about pulls from remote "upstream" and
@@ -68,7 +68,7 @@ if [[ "$#" -lt 2 ]]; then
  echo "  Set UPSTREAM_REMOTE (default: upstream) and FORK_REMOTE (default: origin)"
  echo "  to override the default remote names to what you have locally."
  echo
-  echo "  For merge process info, see https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git_cherry-pick.md"
+  echo "  For merge process info, see https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/gitcherry-pick.md"
  exit 2
 fi

@@ -145,7 +145,7 @@ Cherry pick of ${PULLSUBJ} on ${rel}.

 ${numandtitle}

-For details on the cherry pick process, see the [cherry pick requests](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/git_cherry-pick.md) page.
+For details on the cherry pick process, see the [cherry pick requests](https://github.com/openimsdk/open-im-server/tree/main/docs/contrib/gitcherry-pick.md) page.

 \`\`\`release-note

@@ -15,7 +15,7 @@

 # 本脚本功能：根据 scripts/environment.sh 配置，生成 OPENIM 组件 YAML 配置文件。
 # 示例：./scripts/genconfig.sh scripts/install/environment.sh scripts/template/config.yaml
-# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md
+# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init-config.md

 env_file="$1"
 template_file="$2"
@@ -29,6 +29,9 @@ if [ $# -ne 2 ];then
    exit 1
 fi

+# Check if the required commands exist
+openim::util::require-dig
+
 source "${env_file}"

 declare -A envs
@@ -14,7 +14,7 @@
 # limitations under the License.

 # This script automatically initializes the various configuration files
-# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md
+# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init-config.md

 set -o errexit
 set -o nounset
@@ -43,10 +43,10 @@ docker run -d \
    -v "./scripts/mongo-init.sh:/docker-entrypoint-initdb.d/mongo-init.sh:ro" \
    -e TZ=Asia/Shanghai \
    -e wiredTigerCacheSizeGB=1 \
-    -e MONGO_INITDB_ROOT_USERNAME=${USER} \
+    -e MONGO_INITDB_ROOT_USERNAME=${OPENIM_USER} \
    -e MONGO_INITDB_ROOT_PASSWORD=${PASSWORD} \
    -e MONGO_INITDB_DATABASE=openIM \
-    -e MONGO_USERNAME=${USER} \
+    -e MONGO_USERNAME=${OPENIM_USER} \
    -e MONGO_PASSWORD=${PASSWORD} \
    --restart always \
    mongo:6.0.2 --wiredTigerCacheSizeGB 1 --auth
@@ -94,7 +94,7 @@ docker run -d \
    -p 9090:9090 \
    -v "/mnt/data:/data" \
    -v "/mnt/config:/root/.minio" \
-    -e MINIO_ROOT_USER=${USER} \
+    -e MINIO_ROOT_USER=${OPENIM_USER} \
    -e MINIO_ROOT_PASSWORD=${PASSWORD} \
    --restart always \
    minio/minio server /data --console-address ':9090'
@@ -15,7 +15,7 @@

 # This is a file that initializes variables for the automation script that initializes the config file
 # You need to supplement the script according to the specification.
-# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init_config.md
+# Read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/init-config.md
 # 格式化 bash 注释：https://tool.lu/shell/
 # 配置中心文档：https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/environment.md

@@ -46,7 +46,7 @@ function def() {
 def "DATA_DIR" "${OPENIM_ROOT}"

 # 设置统一的用户名，方便记忆
-def "USER" "root"
+def "OPENIM_USER" "root"

 # 设置统一的密码，方便记忆
 readonly PASSWORD=${PASSWORD:-'openIM123'}
@@ -166,7 +166,7 @@ def "ZOOKEEPER_PASSWORD" ""                        # Zookeeper的密码
 ###################### MySQL 配置信息 ######################
 def "MYSQL_PORT" "13306"                       # MySQL的端口
 def "MYSQL_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # MySQL的地址
-def "MYSQL_USERNAME" "${USER}"                 # MySQL的用户名
+def "MYSQL_USERNAME" "${OPENIM_USER}"                 # MySQL的用户名
 # MySQL的密码
 readonly MYSQL_PASSWORD=${MYSQL_PASSWORD:-"${PASSWORD}"}
 def "MYSQL_DATABASE" "${DATABASE_NAME}"        # MySQL的数据库名
@@ -181,7 +181,7 @@ def "MONGO_URI"                                # MongoDB的URI
 def "MONGO_PORT" "37017"                       # MongoDB的端口
 def "MONGO_ADDRESS" "${DOCKER_BRIDGE_GATEWAY}" # MongoDB的地址
 def "MONGO_DATABASE" "${DATABASE_NAME}"        # MongoDB的数据库名
-def "MONGO_USERNAME" "${USER}"                 # MongoDB的用户名
+def "MONGO_USERNAME" "${OPENIM_USER}"                 # MongoDB的用户名
 # MongoDB的密码
 readonly MONGO_PASSWORD=${MONGO_PASSWORD:-"${PASSWORD}"}
 def "MONGO_MAX_POOL_SIZE" "100"                # 最大连接池大小
@@ -198,7 +198,7 @@ def "MINIO_PORT" "10005"    # MinIO的端口
 # MinIO的端点URL
 def MINIO_ADDRESS "${DOCKER_BRIDGE_GATEWAY}"
 readonly MINIO_ENDPOINT=${MINIO_ENDPOINT:-"http://${MINIO_ADDRESS}:${MINIO_PORT}"}
-def "MINIO_ACCESS_KEY" "${USER}"                                                  # MinIO的访问密钥ID
+def "MINIO_ACCESS_KEY" "${OPENIM_USER}"                                                  # MinIO的访问密钥ID
 readonly MINIO_SECRET_KEY=${MINIO_SECRET_KEY:-"${PASSWORD}"}
 def "MINIO_SESSION_TOKEN"                                                         # MinIO的会话令牌
 readonly MINIO_SIGN_ENDPOINT=${MINIO_SIGN_ENDPOINT:-"http://${OPENIM_IP}:${MINIO_PORT}"} # signEndpoint为minio公网地址
@@ -71,8 +71,7 @@ function openim::install::show_help() {
    echo "  $0 --install  Same as above."
 }

-function openim::install::install_openim()
-{
+function openim::install::install_openim() {
    openim::common::sudo "mkdir -p ${OPENIM_DATA_DIR} ${OPENIM_INSTALL_DIR} ${OPENIM_CONFIG_DIR} ${OPENIM_LOG_DIR}"
    openim::log::info "check openim dependency"
    openim::common::sudo "cp -r ${OPENIM_ROOT}/config/* ${OPENIM_CONFIG_DIR}/"
@@ -96,8 +95,7 @@ function openim::install::install_openim()
    openim::log::success "openim install success"
 }

-function openim::uninstall::uninstall_openim()
-{
+function openim::uninstall::uninstall_openim() {
    openim::log::info "uninstall openim"

    ${OPENIM_ROOT}/scripts/install/openim-msggateway.sh openim::msggateway::uninstall || return 1
@@ -115,8 +113,7 @@ function openim::uninstall::uninstall_openim()
    openim::log::success "openim uninstall success"
 }

-function openim::install::status()
-{
+function openim::install::status() {
    openim::log::info "check openim status"

    ${OPENIM_ROOT}/scripts/install/openim-msggateway.sh openim::msggateway::status || return 1
@@ -33,8 +33,7 @@ readonly OPENIM_API_SERVICE_TARGETS=(
 )
 readonly OPENIM_API_SERVICE_LISTARIES=("${OPENIM_API_SERVICE_TARGETS[@]##*/}")

-function openim::api::start()
-{
+function openim::api::start() {
    echo "++ OPENIM_API_SERVICE_LISTARIES: ${OPENIM_API_SERVICE_LISTARIES[@]}"
    echo "++ OPENIM_API_PORT_LISTARIES: ${OPENIM_API_PORT_LISTARIES[@]}"
    echo "++ OpenIM API config path: ${OPENIM_API_CONFIG}"
@@ -43,8 +43,7 @@ OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P)

 SERVER_NAME="openim-crontask"

-function openim::crontask::start()
-{
+function openim::crontask::start() {
    openim::log::info "Start OpenIM Cron, binary root: ${SERVER_NAME}"
    openim::log::status "Start OpenIM Cron, path: ${OPENIM_CRONTASK_BINARY}"

@@ -66,8 +65,7 @@ EOF
 }

 # install openim-crontask
-function openim::crontask::install()
-{
+function openim::crontask::install() {
  pushd "${OPENIM_ROOT}"

  # 1. Build openim-crontask
@@ -97,8 +95,7 @@ function openim::crontask::install()


 # Unload
-function openim::crontask::uninstall()
-{
+function openim::crontask::uninstall() {
  set +o errexit
  openim::common::sudo "systemctl stop ${SERVER_NAME}"
  openim::common::sudo "systemctl disable ${SERVER_NAME}"
@@ -110,8 +107,7 @@ function openim::crontask::uninstall()
 }

 # Status Check
-function openim::crontask::status()
-{
+function openim::crontask::status() {
  # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
  if systemctl is-active --quiet "${SERVER_NAME}"; then
    openim::log::info "${SERVER_NAME} is running successfully."
@@ -25,8 +25,7 @@ openim::util::set_max_fd 200000

 SERVER_NAME="openim-msggateway"

-function openim::msggateway::start()
-{
+function openim::msggateway::start() {
    openim::log::info "Start OpenIM Msggateway, binary root: ${SERVER_NAME}"
    openim::log::status "Start OpenIM Msggateway, path: ${OPENIM_MSGGATEWAY_BINARY}"

@@ -79,8 +78,7 @@ EOF
 }

 # install openim-msggateway
-function openim::msggateway::install()
-{
+function openim::msggateway::install() {
  pushd "${OPENIM_ROOT}"

  # 1. Build openim-msggateway
@@ -109,8 +107,7 @@ function openim::msggateway::install()


 # Unload
-function openim::msggateway::uninstall()
-{
+function openim::msggateway::uninstall() {
  set +o errexit
  openim::common::sudo "systemctl stop ${SERVER_NAME}"
  openim::common::sudo "systemctl disable ${SERVER_NAME}"
@@ -122,8 +119,7 @@ function openim::msggateway::uninstall()
 }

 # Status Check
-function openim::msggateway::status()
-{
+function openim::msggateway::status() {
  # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
  systemctl status ${SERVER_NAME}|grep -q 'active' || {
    openim::log::error "${SERVER_NAME} failed to start, maybe not installed properly"
@@ -25,8 +25,7 @@ openim::util::set_max_fd 200000

 SERVER_NAME="openim-msgtransfer"

-function openim::msgtransfer::start()
-{
+function openim::msgtransfer::start() {
    openim::log::info "Start OpenIM Msggateway, binary root: ${SERVER_NAME}"
    openim::log::status "Start OpenIM Msggateway, path: ${OPENIM_MSGTRANSFER_BINARY}"

@@ -61,8 +60,7 @@ function openim::msgtransfer::start()
    openim::util::check_process_names  "${OPENIM_OUTPUT_HOSTBIN}/${SERVER_NAME}"
 }

-function openim::msgtransfer::check()
-{
+function openim::msgtransfer::check() {
    PIDS=$(pgrep -f "${OPENIM_OUTPUT_HOSTBIN}/openim-msgtransfer")

    NUM_PROCESSES=$(echo "$PIDS" | wc -l)
@@ -89,8 +87,7 @@ EOF
 }

 # install openim-msgtransfer
-function openim::msgtransfer::install()
-{
+function openim::msgtransfer::install() {
  pushd "${OPENIM_ROOT}"

  # 1. Build openim-msgtransfer
@@ -122,8 +119,7 @@ function openim::msgtransfer::install()


 # Unload
-function openim::msgtransfer::uninstall()
-{
+function openim::msgtransfer::uninstall() {
  set +o errexit
  openim::common::sudo "systemctl stop ${SERVER_NAME}"
  openim::common::sudo "systemctl disable ${SERVER_NAME}"
@@ -135,8 +131,7 @@ function openim::msgtransfer::uninstall()
 }

 # Status Check
-function openim::msgtransfer::status()
-{
+function openim::msgtransfer::status() {
  # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
  if systemctl is-active --quiet "${SERVER_NAME}"; then
    openim::log::info "${SERVER_NAME} is running successfully."
@@ -49,8 +49,7 @@ OPENIM_ROOT=$(cd "$(dirname "${BASH_SOURCE[0]}")"/../.. && pwd -P)

 SERVER_NAME="openim-push"

-function openim::push::start()
-{
+function openim::push::start() {
    openim::log::status "Start OpenIM Push, binary root: ${SERVER_NAME}"
    openim::log::info "Start OpenIM Push, path: ${OPENIM_PUSH_BINARY}"

@@ -88,8 +87,7 @@ EOF
 }

 # install openim-push
-function openim::push::install()
-{
+function openim::push::install() {
  pushd "${OPENIM_ROOT}"

  # 1. Build openim-push
@@ -117,8 +115,7 @@ function openim::push::install()
 }

 # Unload
-function openim::push::uninstall()
-{
+function openim::push::uninstall() {
  set +o errexit
  openim::common::sudo "systemctl stop ${SERVER_NAME}"
  openim::common::sudo "systemctl disable ${SERVER_NAME}"
@@ -130,8 +127,7 @@ function openim::push::uninstall()
 }

 # Status Check
-function openim::push::status()
-{
+function openim::push::status() {
  # Check the running status of the ${SERVER_NAME}. If active (running) is displayed, the ${SERVER_NAME} is started successfully.
  systemctl status ${SERVER_NAME}|grep -q 'active' || {
    openim::log::error "${SERVER_NAME} failed to start, maybe not installed properly"
@@ -173,8 +173,7 @@ function openim::rpc::info() {
 }

 # install openim-rpc
-function openim::rpc::install()
-{
+function openim::rpc::install() {
    pushd "${OPENIM_ROOT}"

    # 1. Build openim-rpc
@@ -208,8 +207,7 @@ function openim::rpc::install()
 }

 # Unload
-function openim::rpc::uninstall()
-{
+function openim::rpc::uninstall() {
    set +o errexit
    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
        openim::common::sudo "systemctl stop ${service}"
@@ -223,8 +221,7 @@ function openim::rpc::uninstall()
 }

 # Status Check
-function openim::rpc::status()
-{
+function openim::rpc::status() {
    for service in "${OPENIM_RPC_SERVICE_LISTARIES[@]}"; do
        # Check the running status of the ${service}. If active (running) is displayed, the ${service} is started successfully.
        systemctl status ${service}|grep -q 'active' || {
@@ -1,66 +0,0 @@
-#!/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.
-
-
-OPENIM_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
-source "${OPENIM_ROOT}/scripts/lib/init.sh"
-source "${OPENIM_ROOT}/scripts/install/environment.sh"
-
-openim::util::onCtrlC
-
-docker_compose_file_name="docker-compose.yaml"
-
-# Load environment variables from .env file
-load_env() {
-    source "${OPENIM_ROOT}"/.env
-}
-
-# Replace local IP with public IP in .env
-replace_ip() {
-    if [ "$API_URL" == "http://127.0.0.1:10002/object/" ]; then
-        sed -i "s/127.0.0.1/${internet_ip}/" "${OPENIM_ROOT}"/.env
-    fi
-
-    if [ "$MINIO_ENDPOINT" == "http://127.0.0.1:10005" ]; then
-        sed -i "s/127.0.0.1/${internet_ip}/" "${OPENIM_ROOT}"/.env
-    fi 
-
-    openim::log::info "Your minio endpoint is ${MINIO_ENDPOINT}"
-}
-
-# Execute necessary scripts
-execute_scripts() {
-    chmod +x "${OPENIM_ROOT}"/scripts/*.sh
-    openim::log::info "Executing init_pwd.sh"
-    "${OPENIM_ROOT}"/scripts/init_pwd.sh
-
-    openim::log::info "Executing env_check.sh"
-    "${OPENIM_ROOT}"/scripts/env_check.sh
-}
-
-openim::util::check_docker_and_compose_versions
-
-main() {
-    load_env
-    openim::util::get_server_ip
-    replace_ip
-    execute_scripts
-    start_docker_compose
-    openim::log::success "Script executed successfully"
-}
-
-# Run the main function
-main
@@ -70,8 +70,7 @@ ITALIC_PREFIX="\033[3m"     # Italic prefix
 CYAN_PREFIX="\033[0;36m"     # Cyan prefix

 # Print colors you can use
-openim::color::print_color()
-{
+openim::color::print_color() {
  echo
  echo -e ${bmagenta}--back-color:${normal}
  echo "bblack; bgreen; bblue; bcyan; bred; byellow; bmagenta; bwhite"
@@ -200,8 +200,7 @@ openim::log::status() {
  done
 }

-openim::log::success()
-{
+openim::log::success() {
  local V="${V:-0}"
  if [[ ${OPENIM_VERBOSE} < ${V} ]]; then
      return
@@ -1126,6 +1126,21 @@ function openim::util::require-jq {
  fi
 }

+# openim::util::require-dig
+# Checks whether dig is installed and provides installation instructions if it is not.
+function openim::util::require-dig {
+  if ! command -v dig &>/dev/null; then
+    echo "dig command not found."
+    echo "Please install 'dig' to use this feature."
+    echo "Installation instructions:"
+    echo "  For Ubuntu/Debian: sudo apt-get install dnsutils"
+    echo "  For CentOS/RedHat: sudo yum install bind-utils"
+    echo "  For macOS: 'dig' should be preinstalled. If missing, try: brew install bind"
+    echo "  For Windows: Install BIND9 tools from https://www.isc.org/download/"
+    return 1
+  fi
+}
+
 # outputs md5 hash of $1, works on macOS and Linux
 function openim::util::md5() {
  if which md5 >/dev/null 2>&1; then
@@ -193,6 +193,12 @@ go.lint: tools.verify.golangci-lint
 go.test:
 	@$(GO) test ./...

+## go.test.api: Run api test
+.PHONY: go.test.api
+go.test.api:
+	@echo "===========> Run api test"
+	@$(ROOT_DIR)/scripts/install/test.sh openim::test::test
+
 ## go.demo: Run demo
 .PHONY: go.demo
 go.demo:
@@ -22,7 +22,7 @@

 DOCKER := docker

-# read: https://github.com/openimsdk/open-im-server/blob/main/docs/conversions/images.md
+# read: https://github.com/openimsdk/open-im-server/blob/main/docs/contrib/images.md
 REGISTRY_PREFIX ?= registry.cn-hangzhou.aliyuncs.com/openimsdk
 # REGISTRY_PREFIX ?= ghcr.io/openimsdk

@@ -1,12 +0,0 @@
-cd %~p0../_output/bin/platforms/windows
-start api.exe -p 10002
-start auth.exe -p 10060
-start conversation.exe -p 10080
-start friend.exe -p 10020
-start group.exe -p 10050
-start msg.exe -p 10030
-start msggateway.exe -p 10040 -w 10001
-start msgtransfer.exe
-start third.exe -p 10090
-start push.exe -p 10070
-start user.exe -p 10010
@@ -6,9 +6,9 @@ Learn more about versions of OpenIM:

 + We release logs are recorded on [✨CHANGELOG](https://github.com/{{ .Env.USERNAME }}/{{ .ProjectName }}/blob/main/CHANGELOG/CHANGELOG.md)

-+ For information on versions of OpenIM and how to maintain branches, read [📚this article](https://github.com/{{ .Env.USERNAME }}/{{ .ProjectName }}/blob/main/docs/conversions/version.md)
+ For information on versions of OpenIM and how to maintain branches, read [📚this article](https://github.com/{{ .Env.USERNAME }}/{{ .ProjectName }}/blob/main/docs/contrib/version.md)

-+ If you wish to use mirroring, read OpenIM's [🤲image management policy](https://github.com/{{ .Env.USERNAME }}/{{ .ProjectName }}/blob/main/docs/conversions/images.md)
+ If you wish to use mirroring, read OpenIM's [🤲image management policy](https://github.com/{{ .Env.USERNAME }}/{{ .ProjectName }}/blob/main/docs/contrib/images.md)

 **Want to be one of them 😘?**

@@ -17,8 +17,7 @@ WAITFORIT_cmdname=${0##*/}

 echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }

-usage()
-{
+usage() {
    cat << USAGE >&2
 Usage:
    $WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
@@ -34,8 +33,7 @@ USAGE
    exit 1
 }

-wait_for()
-{
+wait_for() {
    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
        echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
    else
@@ -61,8 +59,7 @@ wait_for()
    return $WAITFORIT_result
 }

-wait_for_wrapper()
-{
+wait_for_wrapper() {
    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
    if [[ $WAITFORIT_QUIET -eq 1 ]]; then
        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
@@ -1,5 +1,7 @@
 ## Run the Tests

+read: [Test Docs](./docs/contrib/test.md)
+
 To run a single test or set of tests, you'll need the [Ginkgo](https://github.com/onsi/ginkgo) tool installed on your
 machine:

@@ -46,8 +46,7 @@ openim::wrk::setup() {
 }

 # Print usage infomation
-openim::wrk::usage()
-{
+openim::wrk::usage() {
  cat << EOF

 Usage: $0 [OPTION] [diff] URL
@@ -66,8 +65,7 @@ EOF
 }

 # Convert plot data to useable data
-function openim::wrk::convert_plot_data()
-{
+function openim::wrk::convert_plot_data() {
  echo "$1" | awk -v datfile="${wrkdir}/${datfile}" ' {
  if ($0 ~ "Running") {
    common_time=$2
@@ -123,8 +121,7 @@ if (s ~ "s") {
 }

 # Remove existing data file
-function openim::wrk::prepare()
-{
+function openim::wrk::prepare() {
  rm -f ${wrkdir}/${datfile}
 }

@@ -167,8 +164,7 @@ EOF
 }

 # Plot diff graphic
-function openim::wrk::plot_diff()
-{
+function openim::wrk::plot_diff() {
  gnuplot <<  EOF
 set terminal png enhanced #输出格式为png文件
 set xlabel 'Concurrent'
Author	SHA1	Message	Date
Xinwei Xiong(cubxxw)	1b3c69d709	feat: add openim info test	2023-11-09 18:14:59 +08:00
Xinwei Xiong(cubxxw)	88dcbc5c31	feat: add prom address Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:55:15 +08:00
Xinwei Xiong(cubxxw)	4786e2ce43	docs: optimize openim docs Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:54:15 +08:00
Xinwei Xiong(cubxxw)	98e7c77d28	fix: Fixed some unused scripts and some names Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:54:15 +08:00
Xinwei Xiong(cubxxw)	7be38d332f	feat: add openim e2e test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:54:15 +08:00
Xinwei Xiong(cubxxw)	238969e78c	feat: add openim e2e test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:54:15 +08:00
Xinwei Xiong(cubxxw)	3e4fa66f93	feat: add api test make file Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:54:15 +08:00
Xinwei Xiong(cubxxw)	4d2332f1e3	feat: add api test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com>	2023-11-09 17:54:15 +08:00
cubxxw	762ff65225	cicd: robot automated Change	2023-11-09 17:54:15 +08:00