# SeeYou-Platform__Flask+Vue

**Repository Path**: zicmic/see-you-platform--flask--vue

## Basic Information

- **Project Name**: SeeYou-Platform__Flask+Vue
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-06
- **Last Updated**: 2021-08-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SeeYou-Platform

![Build](https://img.shields.io/badge/Build-passing-brightgreen.svg)
![Languages](https://img.shields.io/badge/Languages-Python3.6.5-blue)
![Contributions](https://img.shields.io/badge/Contributions-welcome-ff69b4.svg)

## Ⅰ. SeeYou平台简介

### 背景

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

### 愿景

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

 平台遵循「前后端分离开发」思想，技术栈为：「Python + Vue + Mongodb」，后端开发使用的是轻量级 Web 框架 Flask，
前端 UI 框架则采用的是易上手的 ElementUi。
 
 [（在这里感谢一下本开源项目给我带来的启发)](https://github.com/githublitao/api_automation_test) 

### 使用 & 展示

- 展示地址：http://111.229.74.215:5050/ 
- 测试账号: test  密码:test
- [平台使用教程](https://shimo.im/docs/jVxDXHYdh6KPqYTP)

---
## Ⅱ. SeeYou平台特点 & 展示
 
  **0.已经投入生产环境使用 1 年以上, 用起来轻松没负担~** 

 1.平台遵循「小而精」的策略，最大化所有功能的开发、使用性价比，可帮助测试团队快速搭建起易于上手 / 维护的接口
 自动化测试体系。
 
 2.平台遵循「零编码」原则，使用者不需要编程即可完成较为复杂的业务流程接口测试。
 
 3.平台遵循「颜值即正义」原则，操作界面展示如下：
 
 ![输入图片说明](./images/用例接口列表界面展示.jpg "用例接口列表界面展示.jpg")
 
 4.平台拥有极佳的定时任务体验，启动定时任务后可随时停用 / 任意编辑任务内容且立即生效，同时拥有丰富的告警策略，
 页面展示如下：
 
 ![输入图片说明](./images/定时任务配置.png "定时任务配置.png")
 
 5.平台拥有导入 / 导出功能，支持测试人员 **"最喜爱的"** Excel 格式，易于批量生成 / 修改用例。
 
 ![输入图片说明](./images/数据导入展示.png "数据导入展示.png")
 
 6.平台拥有较为丰富的测试结果校验体系，支持**文本相似度**校验。
 ([具体内容可SeeYou平台使用指南 & Ⅲ. NLP之文本相似度校验](https://shimo.im/docs/jVxDXHYdh6KPqYTP))
 
 7.平台对外提供测试任务调度接口，方便与开发项目集成。
 
 8. 待添加【web selenium】【app appium】UI自动化测试
 
 ***（还有许许多多令人惊喜的小特色等着你去探索 & 挖掘）***
 

## Ⅲ .SeeYou平台功能图解

## 思维导图

![输入图片说明](./images/SeeYou平台思维导图.jpg "SeeYou platform思维导图.png")

---
## IV . SeeYou平台部署

---
## Windows 环境下部署

### 0. 克隆项目
```
    git clone https://github.com/Valuebai/SeeYou-Platform.git
```

### 1. 安装 python 3 环境

[点击进入python教程](https://www.runoob.com/python3/python3-install.html)

[建议：Ptyhon项目单独创建虚拟环境](https://shimo.im/docs/yRjCrCkXq3xpydGg)


### 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.14.0  -i https://pypi.tuna.tsinghua.edu.cn/simple
    pip install bert-serving-server==1.10.1 -i https://pypi.tuna.tsinghua.edu.cn/simple
    pip install bert-serving-client==1.10.1 -i https://pypi.tuna.tsinghua.edu.cn/simple
```
  
#### 2.4 启动模型
```
    # 进入chinese_L-12_H-768_A-12同级目录执行下面命令
    bert-serving-start -model_dir ./chinese_L-12_H-768_A-12/ -num_worker=1
   
```
  
启动成功后输出如下：

![输入图片说明](./images/NLP模型启动成功输出.png "NLP模型启动成功输出.png")

### 3. 部署 Mongodb 数据库

- [windows点击进入教程](https://www.runoob.com/mongodb/mongodb-window-install.html)
- [linux点击进入教程](https://blog.csdn.net/luhuibo318/article/details/104851472)

### 4. 设置系统环境变量
```
    AUTOTEST_PLATFORM_ENV=production
    AUTOTEST_PLATFORM_NLP_SERVER_HOST=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_HOST（自然语言模型服务）默认为本机启动 （非必填）

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 文件夹。

```
TODO 部署时不需要可直接跳过
> one. 给项目添加 favicon.ico  https://www.jianshu.com/p/1f7a096b61c2
> two. vue项目中 favicon.ico不能正确显示的问题 https://www.jianshu.com/p/980cb1caf7a8
> three. 修改index.js的icon  http://www.fontawesome.com.cn/faicons/
```


### 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 使用创建的管理员帐号密码进行登录。



---
## Linux 环境下 Docker 容器化部署

[Linux 环境下 Docker 容器化部署](https://shimo.im/docs/P3gqCTX6DpGjXWy3)


#### linux启动bert-as-serving
1. 安装包
```
    pip install tensorflow==1.14.0  -i https://pypi.tuna.tsinghua.edu.cn/simple
    pip install bert-serving-server==1.9.1 -i https://pypi.tuna.tsinghua.edu.cn/simple（centos7装了运行报错）
    pip install bert-serving-client==1.9.1 -i https://pypi.tuna.tsinghua.edu.cn/simple（centos7装了运行报错）    
    pip install bert-serving-server==1.10.1（centos7装这个）
    pip install bert-serving-client==1.10.1（centos7装这个）
    
```
2. 进入chinese_L-12_H-768_A-12同级目录执行下面命令
```
    bert-serving-start -model_dir ./chinese_L-12_H-768_A-12/ -num_worker=1
```

3. 给linux服务器增加虚拟内存
```
运行项目报错，提醒内存不足
Centos/linux 服务器的内存不够了怎么办？centos用虚拟内存扩展内存：

输入：free -m查看内存状态
dd if=/dev/zero of=/opt/swap bs=2048 count=2048000 //在opt分区建立名为swap，大小为1G的虚拟内存文件
chmod 600 /opt/swap //注意更改swap文件的权限
mkswap /opt/swap //将swap文件设置为swap分区文件
swapon /opt/swap //激活swap,启用分区交换文件
free -m //看下结果
参考：https://blog.csdn.net/herobacking/article/details/80371242

【注意】重启后这个就会没了，需要重新设置
```
  
4. 其他
```
    P.S.最后重启reboot，执行312步骤
    
    linux 部署时需要开启这2个默认端口，参考文章https://baijiahao.baidu.com/s?id=1646263423663635431&wfr=spider&for=pc
    指定客户端向服务端push数据的端口号，通过-port，默认5555
    指定服务端向客户端发布结果的的端口号，通过-port_out，默认5556
```


---
## linux-CentOS7 直接部署，不使用docker


1. 将项目代码克隆到linux，git clone https://github.com/Valuebai/SeeYou-Platform.git
2. 安装python环境，本项目使用python3.6.5
3. 安装pip包，pip install -r requirements.txt
4. 安装mongodb，[CentOS7.4 安装mongodb](https://www.jianshu.com/p/994bc7b19b26) ，用里面不用授权的
5. 创建登录账号
- 使用脚本：进入./backend/，执行python createAdminUser.py
- 直接创建：在mongodb创建【待补充】
6. 运行项目看效果，进入./backend/，执行python run.py 
7. 项目运行正常，linux上可使用下面的命令让其在后台运行
- # linux 上需要先安装gunicorn -->> pip3 install gunicorn
 sh run.sh 或者 . run.sh 运行
```
run.sh内容
# shell杀死指定端口的进程，写到部署脚本里面
kill -9 $(netstat -nlp | grep :5050 | awk '{print $7}' | awk -F"/" '{ print $1 }')

# 另一个启动方式nohup python3 -u  run.py > nohup.log 2>&1 &
# 后台运行
nohup gunicorn -w 4 -b 0.0.0.0:5050 run:app > gunicorn.log 2>&1 &
```

开启服务器对应5050端口
firewall-cmd --zone=public --add-port=5050/tcp --permanent 永久开启5050端口
firewall-cmd --reload #重启firewall 每次新添加端口都要
> 参考：[【Linux】CentOS-常用命令&新购买云服务器安装必看](https://github.com/Valuebai/awesome-python-io/issues/1)

 
### 为Python项目创建独立的虚拟环境（可选）
[python在win/linux创建虚拟环境](https://blog.csdn.net/luhuibo318/article/details/94011917)


### 新购买的linux-CentOS7 云服务器部署指南
1. [【Linux】CentOS-常用命令&新购买云服务器安装必看](https://github.com/Valuebai/awesome-python-io/issues/1)
2. [总结python+flask项目在linux部署的五大方法](https://blog.csdn.net/luhuibo318/article/details/102688154)



---
## EXTRA. 常见问题

下列输出代表 **NLP模型** 启动失败

![输入图片说明](./images/NLP部署失败.png "NLP部署失败.png")

解决步骤：

1.删除 ./backend/app/init.py 中的这段代码：

![输入图片说明](./images/不使用NLP模型方法1.png "不使用NLP模型方法指南1.png")

2.将 ./backend/testframe/interfaceTest/tester.py 中的下列代码修改成 pass：

![输入图片说明](./images/不使用NLP模型方法2.png)

完成后再启动项目时，就不会依赖于自然语言模型了~