Add test docs and fis some docs problem. (#828)

src/content/docs/next/_sidebar.json

@@ -146,6 +146,13 @@
         },
         "autogenerate": { "directory": "plugin" }
     },
+    {
+        "label": "测试手册",
+        "translations": {
+            "en": "Test Manual"
+        },
+        "autogenerate": { "directory": "manual/test" }
+    },
     {
         "label": "生态融合",
         "translations": {
@@ -174,6 +181,13 @@
         },
         "collapsed": true,
         "items": [
+            {
+                "label": "什么是 Nacos",
+                "translations": {
+                    "en": "What is Nacos"
+                },
+                "link": "docs/what-is-nacos"
+            },
             {
                 "label": "升级",
                 "translations": {

src/content/docs/next/en/manual/admin/console.md

@@ -133,7 +133,7 @@ Nacos支持简单登录功能，在开启[鉴权](./auth.mdx)功能后启用，
 
 ### 3.2. 关闭登录功能
 
-Nacos默认控制台在`2.2.2`版本前，无论是否开启[鉴权](../../guide/user/auth.md)功能，默认控制台都会跳转到登录页，导致用户被误导认为控制台存在鉴权功能，实际没有开启鉴权，存在安全隐患。
+Nacos默认控制台在`2.2.2`版本前，无论是否开启[鉴权](../../manual/admin/auth.mdx)功能，默认控制台都会跳转到登录页，导致用户被误导认为控制台存在鉴权功能，实际没有开启鉴权，存在安全隐患。
 
 经过社区和安全工程师协商讨论，需要在使用Nacos默认控制台时，鉴权开关关闭时将会自动关闭控制台登录功能。
 

src/content/docs/next/en/manual/test/nacos-e2e.md

@@ -0,0 +1,163 @@
+---
+title: Nacos E2E Tests
+keywords: [Nacos,Tests,E2E]
+description: The end-to-end testing project for Nacos is designed to verify the functional correctness of Nacos in various scenarios.
+sidebar:
+    order: 2
+---
+
+# Nacos E2E 测试
+
+[`nacos-group/nacos-e2e`](https://github.com/nacos-group/nacos-e2e) 项目是 Nacos 的端到端测试项目，用于验证 Nacos 在不同场景下的功能正确性。如果你想要向这个项目中新增测试用例，可以按照以下步骤进行：
+
+## 1. 准备工作
+
++ **Fork 仓库**：首先你需要在 GitHub 上 Fork `nacos-group/nacos-e2e` 仓库到你自己的账号下。
++ **克隆仓库**：将 Fork 后的仓库克隆到本地。
+
+```shell
+git clone https://github.com/your-username/nacos-e2e.git
+cd nacos-e2e
+```
+
++**设置上游仓库**：为了能够拉取官方最新的更新，建议设置上游仓库。
+
+```shell
+git remote add upstream https://github.com/nacos-group/nacos-e2e.git
+```
+
+## 2. 理解现有结构
+
+查看项目的目录结构，目前主要按客户端测试语言类型和CI部署Nacos的依赖区分，其中java按客户端版本范围和鉴权用例区分
+
++ cicd，build目录包含docker相关文件、构建脚本和Nacos部署的配置文件；helm目录包含Kubernetes 的包管理器，它简化了在 Kubernetes 集群上部署应用程序的过程
++ cpp，用C++语言编写的用例，测试C++客户端
++ csharp，用csharp语言编写的用例，测试csharp客户端
++ golang，用golang语言编写的用例，测试go客户端
++ java，用java语言编写的用例，测试java客户端，其中4个目录分别验证：
+    - auth，部署单例模式的Nacos，验证开启鉴权后的场景
+    - nacos-1X，1.X客户端在1.3版本以上及2.0版本以下时的测试场景
+    - nacos-1X-1.3down，1.X客户端在1.3及以下版本时的测试场景
+    - nacos-2X，2.X客户在2.0及以上版本时的测试场景
++ nodejs，用nodejs语言编写的用例，测试nodejs客户端
++ python，用python语言编写的用例，测试python客户端
+
+## 3. 新增测试用例
+
+下面以在`java/nacos-2X`目录下新增一个配置中心相关用例举例：
+
++ **选择合适的包**：根据你要测试的客户端语言和客户端版本，选择或创建一个合适的包（例如 `/nacos-e2e/java/nacos-2X/src/test/java/com/alibaba/nacos/config`）。
++ **编写测试类**：在选定的包下创建一个新的测试类，例如 `YourFeatureTest.java`。
+    - 每个目录下会继承一个测试基类，如此配置继承ConfigBase基类，此基类进行配置测试用到的常量声明以及在@BeforeAll  @AfterAll 中定义在所有测试方法执行之前或之后运行的方法
+    - ConfigBase基类继承BaseOperate，定义一些通用的操作，比如配置中心和服务中心初始化连接时用到的Properties
+    - BaseOperate继承ResourceInit，定义初始化时用到的变量（从环境变量或者本地文件中获取到的变量）、所有用例启动前服务端的数据写入，初始化一些必要数据（比如命名空间），获取当前服务端客户端的数据（服务端版本、客户端版本等）
++ **配置依赖**：如果需要引入新的依赖，请修改 `pom.xml` 或其他构建文件。
++ **测试类规范**：
+    - @BeforeEach 注解的方法中对每个用例数据进行随机初始化和配置
+    - @AfterEach 注解的方法中对每个用例写入数据进行删除等操作清理
+    - @Test 注解的方法中进行用例逻辑编写，在@DisplayName 中描述当前用例测试的场景
+
+示例代码：
+
+```java
+package com.alibaba.nacos.config;
+
+import com.alibaba.nacos.util.RandomUtils;
+import org.junit.jupiter.api.*;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+public class YourFeatureTest extends ConfigBase{
+    private static final Logger log = LoggerFactory.getLogger(ConfigNormalTest.class);
+    private String dataId;
+    private String group;
+    private String content;
+    private Map<String ,String> cleanConfigMap = new HashMap<>();
+
+    @BeforeEach
+    public void setUp() throws Exception{
+        dataId = "config.test." + RandomUtils.getStringWithCharacter(10);
+        group = DEFAULT_GROUP;
+    }
+
+    @AfterEach
+    public void tearDown() throws Exception {
+        Iterator<Map.Entry<String, String>> iterator = cleanConfigMap.entrySet().iterator();
+        while (iterator.hasNext()) {
+            Map.Entry<String, String> entry = iterator.next();
+            Boolean result = config.removeConfig(entry.getKey(), entry.getValue());
+            if (result) {
+                iterator.remove();
+            }
+        }
+    }
+
+    @Test
+    @DisplayName("Publish normal character and sleep 3000ms to get config, expect get correct config content.")
+    public void testPublishAndGetConfig_normalCharacter() throws Exception{
+        content = RandomUtils.getStringWithCharacter(20);
+        boolean result = config.publishConfig(dataId, group, content);
+        log.info("publishConfig dataId:{}, group:{}, result:{}", dataId, group, result);
+        Assertions.assertTrue(result, "publishConfig check fail");
+        cleanConfigMap.put(dataId, group);
+        Thread.sleep(TIME_OUT);
+
+        String value = config.getConfig(dataId, group, TIME_OUT);
+        log.info("getConfig dataId:{}, group:{}, value:{}", dataId, group, value);
+        Assertions.assertEquals(content, value, "getConfig value is not expect one");
+    }
+
+}
+
+```
+
+## 4. 运行测试
+
+java目录下的用例，修改每个module的daily.conf文件中serverList变量为指定服务端IP:Port，或者在执行命令中传入，亦或本地编译器中执行
+
++ **用例执行命令：**
+
+```shell
+mvn clean test -B -Dtest=YourFeatureTest -DserverList=127.0.0.1
+```
+
+其他语言下的用例执行，可以参考每种语言的module下bin目录的run.sh文件，在语言环境具备情况下，安装必要的包和设置环境变量后执行，亦或安装相应的编译器本地执行
+
+## 5. 提交更改
+
++ **提交代码**：将你的更改提交到本地仓库。
+
+```shell
+git add .
+git commit -m "Add new e2e test for your feature"
+```
+
++ **推送到远程仓库**：将更改推送到你的 GitHub 仓库。
+
+```shell
+git push origin main
+```
+
+## 6. 创建 Pull Request
+
++ **创建 PR**：回到 GitHub 页面，点击 "New pull request" 按钮，选择你的分支与 `nacos-group/nacos-e2e` 的主分支进行比较，然后创建 Pull Request。
++ **等待审查**：项目维护者会对你的 PR 进行审查，可能会提出一些修改意见。根据反馈进行相应的调整。
+
+## 7. 合并 PR
+
++ **合并**：一旦 PR 被批准，它会被合并到主分支中。
+
+通过以上步骤，你就可以成功地向 `nacos-group/nacos-e2e` 项目中新增测试用例了。
+
+## 8. Nacos主仓库CI能力
+
+1. 成功地向 `nacos-group/nacos-e2e` 项目中新增测试用例后，用例最终在`alibaba/nacos` 仓库的actions中触发运行。
+2. CI通过使用阿里云ASK能力为每次PUSH和PR提供一个独立的Nacos环境进行E2E测试，部署使用nacos-group/nacos-e2e仓库中的helm chart(nacos-e2e/cicd)，镜像为当次提交的代码。
+3. 由于安全性考虑，将PR和PUSH动作的CI分离为两个流水线。PR触发E2E测试后回写评论至PR中，可以关联跳转到对应的测试报告。
+4. 测试报告可视化，每次E2E测试的报告在CI当次执行页面上可视化展示，无需查看日志，方便排查。
+5. 支持兼容性测试，并发执行多OS和JDK版本的测试。
+

src/content/docs/next/en/manual/test/nacos-unit-test.md

@@ -0,0 +1,139 @@
+---
+title: Nacos Unit Tests
+keywords: [Nacos,Tests,Unit Tests]
+description: Describe the Nacos unit testing specifications and the steps to run unit tests, helping developers quickly understand and contribute test code.
+sidebar:
+    order: 1
+---
+
+# Nacos 单元测试
+
+Nacos 单元测试主要指的是Nacos 核心仓库[`alibaba/nacos`](https://github.com/alibaba/nacos)中的最基本的单元测试，用于测试各个最小测试单元（一般是Class）的逻辑正确性及改动正确性。
+
+该文档将介绍Nacos 单元测试的规范，以及运行单元测试的步骤，帮助开发者快速了解在修改功能代码后如何撰写并贡献对应的单元测试代码。
+
+## 1. Nacos 单元测试准备工作
+
+- 可参考[Nacos 贡献流程](../../contribution/contributing-flow.md)的前3个步骤，进行仓库克隆、和本地Git的设置。
+- 安装JDK1.8+ 以上版本
+- 安装Maven3.2.5 以上版本。
+
+## 2. 新增Nacos 单元测试用例
+
+Nacos 的单元测试基于`junit5`,`mockito`两个测试框架，详细使用方法请参考[JUnit5](https://junit.org/junit5/docs/current/user-guide/)和[Mockito](https://site.mockito.org/#features)。
+
+新建的单元测试用例类需尽量与所测试类的模块、包名一致；若已经存在单元测试类，请尽量在原有测试类中添加测试用例，不要新建测试类，部分情况为避免用例互相干扰，可以新增单元测试类，但需要在新类名中进行说明和表达。
+
+新增的单元测试类需要遵循如下规范：
+
+### 2.1. Nacos 单元测试规范
+
+1. 单元测试类必须以`Test`结尾，前面的类名必须与测试类名一致；如：类名为`NacosNamingService`，则单元测试类名为`NacosNamingServiceTest`。
+2. 单元测试的用例必须以`test`开头，后接需要测试的方法名，以驼峰命名法命名测试用例，如：`testRegisterInstance`。
+3. 单元测试用例中必须存在断言。
+4. 单元测试中不允许依赖外部资源，如：数据库, 若有需要，请使用Mockito进行模拟。
+5. 单元测试的用例若遇到所测试方法存在多个分支和测试用例的情况，请创建多个用例，且通过`For`,`With`,`Without`等描述测试用例场景，如：`DefaultParamCheckerTest`的`testCheckParamInfoForNamespaceShowName`、`testCheckParamInfoForNamespaceId`等。
+6. 单元测试用例中如果存在设置 static 变量，请使用 `@AfterAll` 或 `@AfterEach` 注解在用例结束后进行回滚，避免影响其他测试用例。
+7. 单元测试用例中所需要的依赖尽量使用`@Mock`注解进行模拟，需要用到的前置设置和初始化，尽量在`@BeforeAll` 和 `@BeforeEach`注解中完成，避免大量重复初始化代码。
+8. 单元测试若需要测试异步方法，尽量使用mock的线程池进行，若无法使用mock线程池，可以尝试控制线程池的启动时间和间隔周期，避免单元测试运行时间过长。
+9. 单元测试代码同样需要遵循[Nacos代码规范](https://github.com/alibaba/nacos/blob/develop/style/codeStyle.md)。
+
+### 2.2. Nacos 单元测试示例
+
+```java
+
+public class YourClass {
+
+    public boolean demo(String serviceName) {
+        if (null == serviceName) {
+            return false;
+        }
+        return doDemo(serviceName);
+    }
+
+    private boolean doDemo(String serviceName) {
+        if (!ServiceManager.containService(serviceName)) {
+            SecurityManager.newService(serviceName);
+            return true;
+        } else {
+            throw new Exception();
+        }
+    }
+}
+
+public class YourClassTest {
+
+    private YourClass yourClass;
+
+    private String serviceName;
+
+    @BeforeEach
+    public void setUp() throws Exception{
+        // do initial for each test cases;
+        yourClass = new YourClass();
+        serviceName = "test"; 
+    }
+
+    @AfterEach
+    public void tearDown() throws Exception {
+        // do clean data.
+        ServiceManager.cleanService(serviceName);
+    }
+
+    @Test
+    public void testDemoForNullService() {
+        assertFalse(yourClass.demo(null));
+    }
+
+    @Test
+    public void testDemoForExistService() {
+        ServiceManager.newService(serviceName);
+        assertThrows(Exception.class, () -> yourClass.demo(serviceName));
+    }
+
+    @Test
+    public void testDemoForNotExistService() {
+        assertFalse(ServiceManager.containService(serviceName));
+        assertTrue(yourClass.demo(serviceName));
+        assertTrue(ServiceManager.containService(serviceName));
+        assertNotNull(ServiceManager.getService(serviceName));
+    }
+}
+```
+
+## 3. 运行Nacos 单元测试
+
+在Nacos 仓库根目录下执行`mvn -Prelease-nacos clean test -DtrimStackTrace=false -e -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn`命令即可运行单元测试。
+
+测试运行完成后，终端中会显示测试结果，同时在各自模块下，会通过`jacoco`插件生成当前模块的测试覆盖率文件，如`api/target/site/jacoco/jacoco.xml`。
+
+## 4. 提交Nacos 单元测试
+
++ **提交代码**：将你的更改提交到本地仓库。
+
+```shell
+git add .
+git commit -m "Add new unit test for class/packages/modules"
+```
+
++ **推送到远程仓库**：将更改推送到你的 GitHub 仓库。
+
+```shell
+git push origin $your_branch_name
+```
+
+## 5. 创建 Pull Request
+
++ **创建 PR**：回到 GitHub 页面，点击 "New pull request" 按钮，选择你的分支与 `alibaba/nacos` 的主分支(一般为`develop`)进行比较，然后创建 Pull Request。
++ **等待审查**：PR中会通过`Github Action`对您提交的单元测试及其他修改进行一系列的检查工作，同时项目维护者会对你的 PR 进行审查，可能会提出一些修改意见。根据运行结果和反馈进行相应的调整。
++ **合并**：一旦 PR 被批准，它会被合并到主分支中。
+
+通过以上步骤，你就可以成功地向 `alibaba/nacos` 项目中新增测试用例了。
+
+## 6. 测试报告
+
+在PR中以及PR被合并后的`Github Action`中，会对运行之后的单元测试报告，提交到[CodeCov](https://app.codecov.io/gh/alibaba/nacos/)上进行统计和分析，可以查看到测试覆盖率情况。
+
+同时在PR中, 会有`Coverage`的简略报告，评论在PR中，原则上在测试覆盖率出现降低时，社区维护人员可能会选择不进行PR的合并，并在评论中提醒您补充单元测试。
+
+> 当前部分模块的测试覆盖率还有待提高，欢迎社区同学贡献测试代码。

src/content/docs/next/en/overview.md

@@ -1,12 +1,10 @@
 ---
-title: 概览
+title: Nacos 概览
 keywords: [nacos]
 description: 什么是 Nacos？
 ---
 
-# 概览
-
-> 文档优化中......
+# Nacos 概览
 
 欢迎来到 Nacos 的世界！
 

src/content/docs/next/en/plugin/auth-plugin.md

@@ -93,7 +93,7 @@ Restart nacos cluster, and after any request, some logs can be saw in `${nacos-s
 
 ### Use the default Nacos authentication plugin
 
-Nacos provides a simple authentication plugin. It is a weak authentication system to prevent business misuse, not a strong authentication system to prevent malicious attacks. The usage detail see [User Guide-Authentication](../guide/user/auth.md).
+Nacos provides a simple authentication plugin. It is a weak authentication system to prevent business misuse, not a strong authentication system to prevent malicious attacks. The usage detail see [Admin Manual-Authentication](../manual/admin/auth.mdx).
 
 ## Client Plugin
 

src/content/docs/next/en/what-is-nacos.md

@@ -6,7 +6,7 @@ description: What is Nacos
 
 # What is Nacos
 
-> Document optimizing...
+> This document will be deprecated soon. It is recommended to refer to [Nacos Overview](./overview.md).
 
 ## Overview
 

src/content/docs/next/zh-cn/manual/admin/console.md

@@ -133,7 +133,7 @@ Nacos支持简单登录功能，在开启[鉴权](./auth.mdx)功能后启用，
 
 ### 3.2. 关闭登录功能
 
-Nacos默认控制台在`2.2.2`版本前，无论是否开启[鉴权](../../guide/user/auth.md)功能，默认控制台都会跳转到登录页，导致用户被误导认为控制台存在鉴权功能，实际没有开启鉴权，存在安全隐患。
+Nacos默认控制台在`2.2.2`版本前，无论是否开启[鉴权](../../manual/admin/auth.mdx)功能，默认控制台都会跳转到登录页，导致用户被误导认为控制台存在鉴权功能，实际没有开启鉴权，存在安全隐患。
 
 经过社区和安全工程师协商讨论，需要在使用Nacos默认控制台时，鉴权开关关闭时将会自动关闭控制台登录功能。