README.md

# Taisite-Platform

![](https://img.shields.io/badge/-%20marvelous-orange) ![](https://img.shields.io/badge/-%20gogeous-grey) ![](https://img.shields.io/badge/-%20elegant-blue)   

![泰斯特平台LOGO.png](https://github.com/amazingTest/Taisite-Platform/blob/master/images/泰斯特平台LOGO.png)

## Ⅰ. 泰斯特平台简介

### 背景


「泰斯特平台」是一个由「软件测试 & 机器学习爱好者」开发的接口自动化测试平台。

### 愿景

 平台致力于将人工智能技术与软件测试有效结合，让平台在保障测试精确性要求的同时更具智能化、泛化能力，
 同时尽可能 **最优化使用体验** ，目标是成为 **最贴心、最好用、颜值最高** 的开源测试平台。
 
### 技术栈

 平台遵循「前后端分离开发」思想，技术栈为：「Python + Vue + Mongodb」，后端开发使用的是轻量级 Web 框架 Flask，
前端 UI 框架则采用的是易上手的 ElementUi。
    
 
## Ⅱ. 泰斯特平台特点 （os：和其他测试平台有什么区别？）

 1. 平台遵循「小而精」的策略，最大化所有功能的开发、使用性价比，可帮助小型测试团队快速搭建起易于上手 / 维护的
 自动化测试体系。
 
 2. 平台遵循「零编码」原则，使用者不需要编程即可完成较为复杂的业务流程接口测试。
 
 3. 平台遵循「颜值即正义」原则，操作界面展示如下：
 
 ![操作界面展示](https://github.com/amazingTest/Taisite-Platform/blob/master/images/操作界面展示.png)
 
 4. 平台拥有极佳的定时任务体验，启动定时任务后可随时停用 / 任意编辑任务内容且立即生效，同时拥有丰富的告警策略，
 页面展示如下：
 
 ![定时任务配置](https://github.com/amazingTest/Taisite-Platform/blob/master/images/定时任务配置.png)
 
 5. 平台拥有导入 / 导出功能，支持测试人员 **"最喜爱的"** Excel 格式，易于批量生成 / 修改用例。
 
 ![数据导入展示](https://github.com/amazingTest/Taisite-Platform/blob/master/images/数据导入展示.png)
 
 6. 平台拥有较为丰富的测试结果校验体系，支持**文本相似度**校验，
 具体内容可参考[这篇博文](https://juejin.im/post/5cfe1dd96fb9a07ed7407321)
 
 7. ......
 
 ***（还有许许多多令人惊喜的小特色等着你去探索 & 挖掘）***
 

## Ⅲ .泰斯特平台功能图解
    
![泰斯特平台结构图_V1.0](https://github.com/amazingTest/Taisite-Platform/blob/master/images/泰斯特平台结构图_V1.0.png)


## IV . 泰斯特平台部署


### windows 环境下部署

***

#### 0. 克隆项目

    git clone https://github.com/amazingTest/Taisite-Platform.git

***

#### 1. 安装 python 3 环境

可参考[该教程](https://www.runoob.com/python3/python3-install.html)

***

#### 2. 部署自然语言模型

##### 2.1 [点击下载压缩包](https://storage.googleapis.com/bert_models/2018_11_03/chinese_L-12_H-768_A-12.zip)

##### 2.2 解压压缩包

##### 2.3 安装 python 依赖包

    pip install tensorflow==1.11  -i https://pypi.tuna.tsinghua.edu.cn/simple
    pip install bert-serving-server==1.9.2 -i https://pypi.tuna.tsinghua.edu.cn/simple
    
##### 2.4 启动模型
    
    // 当前目录切换至模型文件夹目录后执行
    bert-serving-start -model_dir ./chinese_L-12_H-768_A-12/ -num_worker=1
    
启动成功后输出如下：

![NLP模型启动成功输出](https://github.com/amazingTest/Taisite-Platform/blob/master/images/NLP模型启动成功输出.png)

***

#### 3. 部署 Mongo 数据库

可参考[该教程](https://www.runoob.com/mongodb/mongodb-window-install.html)

***

#### 4. 设置系统环境变量
    
    AUTOTEST_PLATFORM_ENV=production
    AUTOTEST_PLATFORM_NLP_SERVER=127.0.0.1
    AUTOTEST_PLATFORM_MONGO_HOST=${MONGO_HOST}
    AUTOTEST_PLATFORM_MONGO_PORT=${MONGO_PORT}
    AUTOTEST_PLATFORM_MONGO_USERNAME=${USERNAME}
    AUTOTEST_PLATFORM_MONGO_PASSWORD=${PASSWORD}
    AUTOTEST_PLATFORM_MONGO_DEFAULT_DBNAME=taisite

其中 **AUTOTEST_PLATFORM_ENV** 默认为 production （必填）

**AUTOTEST_PLATFORM_MONGO_HOST** 和 **AUTOTEST_PLATFORM_MONGO_PORT** 分别表示数据库的地址和端口（必填）

**AUTOTEST_PLATFORM_MONGO_USERNAME** 和 **AUTOTEST_PLATFORM_MONGO_PASSWORD** 分别表示数据库的帐号密码（若无可不填）

**AUTOTEST_PLATFORM_NLP_SERVER**（自然语言模型服务）默认为本机启动 （非必填）

**AUTOTEST_PLATFORM_MONGO_DEFAULT_DBNAME** 为默认的数据表名（必填）

设置完成后可通过下列命令进行测试（CMD切换至项目根目录下）

	python ./backend/config.py
	
若配置成功则可看见输入的配置数据

***

#### 5. 打包前端 dist 文件 （这一步我已为你们做好，若不需二次开发可跳过）

##### 5.1 安装 Vue 环境，下载 node.js 并配置环境，下载 npm 包管理器

##### 5.2 cmd 进入 frontend 目录下，配置 cnpm :
        
    npm install -g cnpm --registry=https://registry.npm.taobao.org    
        
##### 5.3 执行安装依赖包命令:

    cnpm install
    
##### 5.4 执行打包命令:

    cnpm run build

若成功打包则会在项目根目录下生成 dist 文件夹
   
***   
   
#### 6. 启动后端
    
    // 切换至项目根目录下执行
    pip install -r ./backend/requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
    
    // 启动后端 ( 默认5050端口 )
    python ./backend/run.py
    
    // 创建管理员帐号( 注意查看输出，记录下帐号密码 )
    python ./backend/createAdminUser.py
 
***

#### 7. 访问项目

现在就可以访问 [http://127.0.0.1:5050/#/login](http://127.0.0.1:5050/#/login) 使用创建的管理员帐号进行登录

![平台登录界面2.png](https://github.com/amazingTest/Taisite-Platform/blob/master/images/平台登录界面2.png)
    
### Linux 环境下 Docker 容器化部署 

***

[Docker 安装指南](https://www.runoob.com/docker/ubuntu-docker-install.html)

#### 0. 克隆项目

    git clone https://github.com/amazingTest/Taisite-Platform.git

***

#### 1. 自然语言模型部署

	sudo -i
	docker pull shaoyuyishiwo/bertserver
	docker run --name autotest-platform-bertserver -d shaoyuyishiwo/bertserver 
	
***

#### 2. Mongo 数据库部署 (若已有现成数据库可用则可跳过此步)

##### 2.1 启动数据库 & 数据挂载至宿主机
    
    sudo -i
    docker pull mongo 
    docker run  --name autotest-platform-mongo -p 27017:27017 -v /data/db:/data/db -v /data/configdb:/data/configdb ``-d mongo
  
##### 2.2 创建数据库帐号

	docker exec -it autotest-platform-mongo /bin/bash
	
    mongo
    
	> use admin
  
	switched to db admin
  
    > db.createUser({user:"${USERNAME}",pwd:"${PASSWORD}",roles:["root"]})
  
	Successfully added user: { "user" : "admin", "roles" : [ "root" ] }

##### 2.3 数据库内存扩容(建议)
  
    > db.adminCommand({setParameter:1, internalQueryExecMaxBlockingSortBytes:335544320})
    
    { "was" : 33554432, "ok" : 1 }
 
***

#### 3. 环境变量配置
  
    // 编辑 /etc/profile 文件
    sudo -i
    vi /etc/profile
  
  若出现警告则选择 (E)dit anyway (输入 E)
  
  ##### 3.1 文本末端插入下列数据 (输入 i 则变为 insert 状态)
  
    export AUTOTEST_PLATFORM_NLP_HOST=${BERT_IPADRESS}
    export AUTOTEST_PLATFORM_MONGO_HOST=${MONGO_HOST}
    export AUTOTEST_PLATFORM_MONGO_PORT=${MONGO_PORT}
    export AUTOTEST_PLATFORM_MONGO_USERNAME=${USERNAME}
    export AUTOTEST_PLATFORM_MONGO_PASSWORD=${PASSWORD}
    export AUTOTEST_PLATFORM_MONGO_DEFAULT_DBNAME=${DBNAME}
	
  变量为动态值，部署者自行根据实际情况输入，${DBNAME} 值可任意自定义（数据库表名），
  其中 ${BERT_IPADRESS} 和 ${MONGO_HOST} 值可通过下列命令查询：
  
    docker inspect autotest-platform-bertserver
    docker inspect autotest-platform-mongo // 若使用了上面的步骤部署数据库
  
  输出如下图所示：
  
  ![控制台输出1](https://github.com/amazingTest/Taisite-Platform/blob/master/images/控制台输出1.png)
  
  ##### 3.2 插入完毕后点击 ESC 按钮、输入 :wq 后单击回车保存
  
  ##### 3.3 执行下列命令后环境变量立即生效
 
    source /etc/profile
    
***

#### 4. 启动项目
    
    //在项目根目录下执行部署文件
    sh deploy ${PORT} 
    
  其中 ${PORT} 变量填写项目访问端口即可，项目启动的同时也创建了管理员帐号和随机密码，如下图所示：
  
  ![控制台输出2](https://github.com/amazingTest/Taisite-Platform/blob/master/images/控制台输出2.png)
  
***  
  
#### 5. 访问项目

浏览器访问部署服务器地址的 ${PORT} 端口后使用「4.启动项目」中创建的帐号密码登陆即可

![平台登录界面](https://github.com/amazingTest/Taisite-Platform/blob/master/images/平台登录界面.png)


## V . 泰斯特平台使用教程


平台主流程使用可参考 [这篇博文中的正文部分](https://juejin.im/post/5cd0117be51d456e537ef3bd) 

详细的使用教程后续补上 :)

## VI . 联系泰斯特

若有任何疑问、建议，或想关注更多关于平台的咨询， 欢迎扫描下方二维码关注我、联系我。

![2D-Code](https://github.com/amazingTest/Taisite-Platform/blob/master/images/微信公众号.jpg)

**开源不易** 热烈欢迎扫描下方二维码 **助力开源**。

![2D-Code](https://github.com/amazingTest/Taisite-Platform/blob/master/images/wechatDonation.jpg)