Websauna项目开发环境搭建指南

前言

Websauna是一个基于Python的全栈Web开发框架，本文将详细介绍如何搭建Websauna的开发环境，包括系统依赖安装、项目配置、文档构建以及测试运行等方面的内容。

开发环境准备

系统要求

在开始开发Websauna之前，需要确保系统满足以下基本要求：

1. 编译工具链：GCC、make等基础编译工具
2. Python环境：Python 3.5及以上版本，包含开发头文件
3. 虚拟环境工具：virtualenv
4. 包管理工具：pip
5. 版本控制工具：git
6. 浏览器环境：Google Chrome及对应chromedriver
7. 数据库：PostgreSQL
8. 缓存系统：Redis

Ubuntu系统安装示例

对于Ubuntu/Debian系Linux发行版，可以通过以下命令安装大部分依赖：

sudo apt-get update
sudo apt-get install -y \
    build-essential \
    python-dev \
    python-virtualenv \
    python-pip \
    git \
    redis-server \
    postgresql

项目初始化

获取源代码

建议创建一个专门的工作目录来存放Websauna相关项目：

mkdir -p ~/Projects/Websauna
cd ~/Projects/Websauna

创建虚拟环境

使用Python 3.5创建独立的虚拟环境：

python3.5 -m venv venv
source venv/bin/activate

安装开发依赖

在虚拟环境中安装Websauna及其开发依赖：

pip install -e ".[test, dev, celery, utils, notebook]"

文档构建

Websauna使用Sphinx生成文档，构建步骤如下：

1. 进入文档目录
2. 执行构建命令

cd docs
make all

构建完成后，文档会生成在build/html目录下，可以通过浏览器直接打开查看。

测试环境配置

测试密钥设置

创建测试用的密钥配置文件setup-test-secrets.bash：

cat > setup-test-secrets.bash << 'EOF'
RANDOM_VALUE="x"
FACEBOOK_CONSUMER_KEY="x"
FACEBOOK_CONSUMER_SECRET="x"
FACEBOOK_USER="x"
FACEBOOK_PASSWORD="x"

export RANDOM_VALUE
export FACEBOOK_CONSUMER_KEY
export FACEBOOK_CONSUMER_SECRET
export FACEBOOK_USER
export FACEBOOK_PASSWORD
EOF

加载配置文件：

source setup-test-secrets.bash

启动Redis服务

确保Redis服务已启动：

redis-server

运行测试

Websauna使用PyTest作为测试框架，支持多种运行方式：

基本测试运行

使用Chrome浏览器运行所有测试（无头模式）：

py.test --ini=websauna/conf/test.ini --splinter-webdriver=chrome --splinter-headless=true

使用Tox进行多版本测试

Tox可以测试不同Python版本的兼容性：

tox -- --ini=websauna/conf/test.ini

指定Python 3.5和Chrome浏览器：

tox -e py35 -- --ini=websauna/conf/test.ini -x --splinter-webdriver=chrome

调试单个测试用例

带调试支持运行单个测试：

py.test -s --ini=test.ini --splinter-webdriver=phantomjs -k test_login_inactive

使用不同浏览器测试

使用Firefox运行功能测试：

py.test --ini=websauna/conf/test.ini --splinter-webdriver=firefox websauna/tests/test_frontpage.py

结语

通过本文的指导，您应该已经成功搭建了Websauna的开发环境，并能够运行测试和构建文档。Websauna提供了完善的测试框架和开发工具链，为开发者提供了良好的开发体验。在实际开发过程中，可以根据项目需求灵活选择不同的测试运行方式和浏览器环境。