feat: Add OpenIM server, environment support for Docker Compose, and Kubernetes deployment. (#1559)

* feat: add openim server code Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim env Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim mongo and redis env Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add zk and redis mongo env Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add kafka and redis mongo env Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim docker Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim docker Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim docker Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim copyright Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * fix: docker compose Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * fix: remove openim chat config file Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim config set Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * feat: add openim config set Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * fix: fix Security vulnerability Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * fix: fix Security vulnerability Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * fix: docker compose Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> * Update kubernetes.go * Update discoveryregister.go * fix: copyright-add Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong (cubxxw) <3293172751nss@gmail.com>
2026-04-28 14:29:19 +08:00 · 2023-12-18 10:24:12 +08:00
parent c5c5b2fd8e
commit f1c9686ada
211 changed files with 3989 additions and 1239 deletions
@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package token

 import (
@@ -9,7 +23,7 @@ import (
 	"net/http"
 )

-// API endpoints and other constants
+// API endpoints and other constants.
 const (
 	APIHost         = "http://127.0.0.1:10002"
 	UserTokenURL    = APIHost + "/auth/user_token"
@@ -18,27 +32,27 @@ const (
 	OperationID     = "1646445464564"
 )

-// UserTokenRequest represents a request to get a user token
+// UserTokenRequest represents a request to get a user token.
 type UserTokenRequest struct {
 	Secret     string `json:"secret"`
 	PlatformID int    `json:"platformID"`
 	UserID     string `json:"userID"`
 }

-// UserTokenResponse represents a response containing a user token
+// UserTokenResponse represents a response containing a user token.
 type UserTokenResponse struct {
 	Token   string `json:"token"`
 	ErrCode int    `json:"errCode"`
 }

-// User represents user data for registration
+// User represents user data for registration.
 type User struct {
 	UserID   string `json:"userID"`
 	Nickname string `json:"nickname"`
 	FaceURL  string `json:"faceURL"`
 }

-// UserRegisterRequest represents a request to register a user
+// UserRegisterRequest represents a request to register a user.
 type UserRegisterRequest struct {
 	Secret string `json:"secret"`
 	Users  []User `json:"users"`
@@ -58,7 +72,7 @@ func main() {
 	}
 }

-// GetUserToken requests a user token from the API
+// GetUserToken requests a user token from the API.
 func GetUserToken(userID string) (string, error) {
 	reqBody := UserTokenRequest{
 		Secret:     SecretKey,
@@ -88,7 +102,7 @@ func GetUserToken(userID string) (string, error) {
 	return tokenResp.Token, nil
 }

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

 import (
@@ -7,18 +21,18 @@ import (
 	"github.com/openimsdk/open-im-server/v3/test/e2e/framework/config"
 )

-// UserInfoRequest represents a request to get or update user information
+// UserInfoRequest represents a request to get or update user information.
 type UserInfoRequest struct {
 	UserIDs  []string       `json:"userIDs,omitempty"`
 	UserInfo *gettoken.User `json:"userInfo,omitempty"`
 }

-// GetUsersOnlineStatusRequest represents a request to get users' online status
+// GetUsersOnlineStatusRequest represents a request to get users' online status.
 type GetUsersOnlineStatusRequest struct {
 	UserIDs []string `json:"userIDs"`
 }

-// GetUsersInfo retrieves detailed information for a list of user IDs
+// GetUsersInfo retrieves detailed information for a list of user IDs.
 func GetUsersInfo(token string, userIDs []string) error {

 	url := fmt.Sprintf("http://%s:%s/user/get_users_info", config.LoadConfig().APIHost, config.LoadConfig().APIPort)
@@ -29,7 +43,7 @@ func GetUsersInfo(token string, userIDs []string) error {
 	return sendPostRequestWithToken(url, token, requestBody)
 }

-// UpdateUserInfo updates the information for a user
+// UpdateUserInfo updates the information for a user.
 func UpdateUserInfo(token, userID, nickname, faceURL string) error {

 	url := fmt.Sprintf("http://%s:%s/user/update_user_info", config.LoadConfig().APIHost, config.LoadConfig().APIPort)
@@ -44,7 +58,7 @@ func UpdateUserInfo(token, userID, nickname, faceURL string) error {
 	return sendPostRequestWithToken(url, token, requestBody)
 }

-// GetUsersOnlineStatus retrieves the online status for a list of user IDs
+// GetUsersOnlineStatus retrieves the online status for a list of user IDs.
 func GetUsersOnlineStatus(token string, userIDs []string) error {

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

 import (
@@ -11,29 +25,29 @@ import (
 	"github.com/openimsdk/open-im-server/v3/test/e2e/framework/config"
 )

-// ForceLogoutRequest represents a request to force a user logout
+// ForceLogoutRequest represents a request to force a user logout.
 type ForceLogoutRequest struct {
 	PlatformID int    `json:"platformID"`
 	UserID     string `json:"userID"`
 }

-// CheckUserAccountRequest represents a request to check a user account
+// CheckUserAccountRequest represents a request to check a user account.
 type CheckUserAccountRequest struct {
 	CheckUserIDs []string `json:"checkUserIDs"`
 }

-// GetUsersRequest represents a request to get a list of users
+// GetUsersRequest represents a request to get a list of users.
 type GetUsersRequest struct {
 	Pagination Pagination `json:"pagination"`
 }

-// Pagination specifies the page number and number of items per page
+// Pagination specifies the page number and number of items per page.
 type Pagination struct {
 	PageNumber int `json:"pageNumber"`
 	ShowNumber int `json:"showNumber"`
 }

-// ForceLogout forces a user to log out
+// ForceLogout forces a user to log out.
 func ForceLogout(token, userID string, platformID int) error {

 	url := fmt.Sprintf("http://%s:%s/auth/force_logout", config.LoadConfig().APIHost, config.LoadConfig().APIPort)
@@ -45,7 +59,7 @@ func ForceLogout(token, userID string, platformID int) error {
 	return sendPostRequestWithToken(url, token, requestBody)
 }

-// CheckUserAccount checks if the user accounts exist
+// CheckUserAccount checks if the user accounts exist.
 func CheckUserAccount(token string, userIDs []string) error {

 	url := fmt.Sprintf("http://%s:%s/user/account_check", config.LoadConfig().APIHost, config.LoadConfig().APIPort)
@@ -56,7 +70,7 @@ func CheckUserAccount(token string, userIDs []string) error {
 	return sendPostRequestWithToken(url, token, requestBody)
 }

-// GetUsers retrieves a list of users with pagination
+// GetUsers retrieves a list of users with pagination.
 func GetUsers(token string, pageNumber, showNumber int) error {

 	url := fmt.Sprintf("http://%s:%s/user/account_check", config.LoadConfig().APIHost, config.LoadConfig().APIPort)
@@ -70,7 +84,7 @@ func GetUsers(token string, pageNumber, showNumber int) error {
 	return sendPostRequestWithToken(url, token, requestBody)
 }

-// sendPostRequestWithToken sends a POST request with a token in the header
+// sendPostRequestWithToken sends a POST request with a token in the header.
 func sendPostRequestWithToken(url, token string, body any) error {
 	reqBytes, err := json.Marshal(body)
 	if err != nil {
@@ -1,3 +1,17 @@
+// Copyright © 2023 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
 package e2e

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

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

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

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

 import (
@@ -10,7 +24,7 @@ import (
 )

 var (
-	// The default template version
+	// The default template version.
 	defaultTemplateVersion = "v1.3.0"
 )

@@ -84,7 +98,7 @@ func main() {
 	select {}
 }

-// getLatestVersion fetches the latest version number from a given URL
+// getLatestVersion fetches the latest version number from a given URL.
 func getLatestVersion(url string) (string, error) {
 	resp, err := http.Get(url)
 	if err != nil {
@@ -102,7 +116,7 @@ func getLatestVersion(url string) (string, error) {
 	return latestVersion, nil
 }

-// downloadAndExtract downloads a file from a URL and extracts it to a destination directory
+// downloadAndExtract downloads a file from a URL and extracts it to a destination directory.
 func downloadAndExtract(url, destDir string) error {
 	resp, err := http.Get(url)
 	if err != nil {
@@ -141,7 +155,7 @@ func downloadAndExtract(url, destDir string) error {
 	return cmd.Run()
 }

-// startProcess starts a process and prints any errors encountered
+// startProcess starts a process and prints any errors encountered.
 func startProcess(cmdPath string) {
 	cmd := exec.Command(cmdPath)
 	cmd.Stdout = os.Stdout