mkrykunov / test-task-app
Yii 2 基础项目模板
Requires
- php: >=5.4.0
- yiisoft/yii2: ~2.0.5
- yiisoft/yii2-bootstrap: ~2.0.0
- yiisoft/yii2-swiftmailer: ~2.0.0
Requires (Dev)
- codeception/base: ^2.2.3
- codeception/specify: ~0.4.3
- codeception/verify: ~0.3.1
- yiisoft/yii2-debug: ~2.0.0
- yiisoft/yii2-faker: ~2.0.0
- yiisoft/yii2-gii: ~2.0.0
This package is not auto-updated.
Last update: 2024-09-23 13:16:14 UTC
README
Yii 2 基础项目模板是一个用于快速创建小型项目的 Yii 2 应用程序骨架。
该模板包含基本功能,包括用户登录/注销和联系页面。它包含所有常用的配置,让您能够专注于添加新功能到您的应用程序。
目录结构
assets/ contains assets definition
commands/ contains console commands (controllers)
config/ contains application configurations
controllers/ contains Web controller classes
mail/ contains view files for e-mails
models/ contains model classes
runtime/ contains files generated during runtime
tests/ contains various tests for the basic application
vendor/ contains dependent 3rd-party packages
views/ contains view files for the Web application
web/ contains the entry script and Web resources
需求
该项目模板的最小要求是您的 Web 服务器支持 PHP 5.4.0。
安装
通过 Composer 安装
如果您没有 Composer,可以按照 getcomposer.org 上的说明进行安装。
然后可以使用以下命令安装此项目模板:
php composer.phar global require "fxp/composer-asset-plugin:^1.2.0"
php composer.phar create-project --prefer-dist --stability=dev mkrykunov/test-task-app basic
现在您应该可以通过以下 URL 访问应用程序,假设 basic
是 Web 根目录下的目录。
https:///basic/web/
从存档文件安装
将从 yiiframework.com 下载的存档文件提取到 Web 根目录下的名为 basic
的目录中。
在 config/web.php
文件中将 cookie 验证密钥设置为某个随机密钥字符串
'request' => [ // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation 'cookieValidationKey' => '<secret random string goes here>', ],
然后您可以通过以下 URL 访问应用程序:
https:///basic/web/
配置
数据库
使用真实数据编辑 config/db.php
文件,例如
return [ 'class' => 'yii\db\Connection', 'dsn' => 'mysql:host=localhost;dbname=yii2basic', 'username' => 'root', 'password' => '1234', 'charset' => 'utf8', ];
注意
- Yii 不会为您创建数据库,您必须在能够访问它之前手动创建。
- 检查并编辑
config/
目录中的其他文件,以根据需要自定义您的应用程序。 - 有关基本应用程序测试的特定信息,请参阅
tests
目录中的 README 文件。
测试
测试位于 tests
目录中。它们是用 Codeception PHP 测试框架 开发的。默认情况下,有三个测试套件:
单元测试
功能测试
验收测试
可以通过运行以下命令来执行测试:
composer exec codecept run
上面的命令将执行单元测试和功能测试。单元测试用于测试系统组件,而功能测试用于测试用户交互。默认情况下,验收测试是禁用的,因为它们需要额外的设置,因为它们在真实浏览器中执行测试。
运行验收测试
要执行验收测试,请执行以下操作:
-
将
tests/acceptance.suite.yml.example
重命名为tests/acceptance.suite.yml
以启用套件配置 -
在
composer.json
中将codeception/base
包替换为codeception/codeception
以安装功能更全面的 Codeception 版本 -
使用 Composer 更新依赖
composer update
-
下载 Selenium Server 并启动它
java -jar ~/selenium-server-standalone-x.xx.x.jar
-
(可选)创建
yii2_basic_tests
数据库,并根据需要应用迁移。tests/bin/yii migrate
数据库配置可以在
config/test_db.php
中找到。 -
启动 Web 服务器
tests/bin/yii serve
-
现在您可以运行所有可用的测试
# run all available tests composer exec codecept run # run acceptance tests composer exec codecept run acceptance # run only unit and functional tests composer exec codecept run unit,functional
代码覆盖率支持
默认情况下,在 codeception.yml
配置文件中禁用了代码覆盖率,您应该取消注释所需的行以便能够收集代码覆盖率。您可以使用以下命令运行测试并收集覆盖率:
#collect coverage for all tests
composer exec codecept run -- --coverage-html --coverage-xml
#collect coverage only for unit tests
composer exec codecept run unit -- --coverage-html --coverage-xml
#collect coverage for unit and functional tests
composer exec codecept run functional,unit -- --coverage-html --coverage-xml
您可以在 tests/_output
目录下查看代码覆盖率输出。