搜索评估器 / teste
README
Docker
Docker是一个开源的虚拟化平台，它允许使用容器创建、部署和执行应用程序。容器允许您将软件及其所有依赖项（包括库、操作系统和其他依赖项）打包在一起。这意味着您可以确保您的应用程序在任何执行环境中都能以完全相同的方式运行。
有关更多信息或要访问下载链接，请查看Docker官方网站https://dockerd.com.cn/。
在VS Code中使用Docker
- 在VS Code中安装Dev Container扩展
- 创建一个包含Dockerfile和devcontainer.json文件的.devcontainer文件夹
- 在VS Code的侧边栏中，有Dev Container扩展的图标，可以用来打开或管理（创建、暂停、打开）容器和容器中的目录。可选地，当您打开一个包含预先配置好.devcontainer文件夹的项目目录时，VS Code会建议在容器中重新打开它。
- 通过VS Code的终端访问文件
注意：第一次访问容器时，将进行安装和配置过程，这可能需要几分钟。
注意：请在容器外使用git。虽然您可以在容器内使用git，但您可能需要配置ssh密钥，但由于项目是版本化的，可以在多个工作站上克隆，因此不建议保存git凭证。
Docker配置文件
- devcontainer.json文件配置VS Code内的容器，启用/禁用其他扩展的使用，并在容器虚拟化的卷内封装目录
{
"name": "PHP",
"build": {
"dockerfile": "Dockerfile",
"args": {
"VARIANT": "8.1",
"NODE_VERSION": "none"
}
},
"customizations": {
"vscode": {
"settings": {
"php.validate.executablePath": "/usr/local/bin/php"
},
"extensions": [
"xdebug.php-debug",
"bmewburn.vscode-intelephense-client",
"mrmlnc.vscode-apache"
]
}
},
"forwardPorts": [8080],
"remoteUser": "vscode"
}
- Dockerfile文件包含容器的规范，可以在任何配置了docker的环境中使用，包括生产服务器。
ARG VARIANT="8.1-apache-bullseye"
FROM mcr.microsoft.com/vscode/devcontainers/php:0-${VARIANT}
ARG NODE_VERSION="none"
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
&& apt-get -y install --no-install-recommends wget graphviz \
&& wget https://phpdoc.org/phpDocumentor.phar \
&& chmod +x phpDocumentor.phar \
&& mv phpDocumentor.phar /usr/local/bin/phpDocumentor \
&& echo xdebug.mode=coverage >> /usr/local/etc/php/conf.d/xdebug.ini
注意：上述容器由Microsoft提供，包括一个带有PHP和Node安装的Linux环境，以及通过unix命令安装依赖项的额外配置，包括PHP Documentor和Xdebug的覆盖模式配置。
PHP内置服务器
PHP内置服务器是从PHP 5.4版本开始嵌入到PHP特定版本中的Web服务器。它允许开发人员快速启动本地开发服务器，无需安装和配置Apache或Nginx等其他服务器。内置服务器仅应用于开发目的，不应用于生产环境。
要启动服务器，请通过终端访问公开目录并输入以下命令：
php -S localhost:8888
然后通过浏览器访问该URL。
注意：请使用任何高端口，不一定要使用8888端口，并避免使用8080端口，因为VS Code会使用它进行隧道。
使用Ngrok提供内置服务器的访问
Ngrok是一个工具，它允许创建一个安全的本地服务器以测试您在本地托管的网络应用程序和服务。它创建一个隧道，将您的本地服务器暴露给公共互联网，同时保持您的本地IP和端口私有。它用于开发、测试、演示和其他应用。
在网站 https://ngrok.com/ 上注册账户，并在打开内置服务器后，在另一个终端中输入以下命令
ngrok http 8888
注意：终端将锁定在Ngrok应用程序中，该应用程序将提供一个公共链接以供访问您的开发环境。
Composer
什么是？
Composer是PHP的一个依赖管理器。它用于管理项目的依赖项，如库、框架和其他工具。Composer允许您轻松快速地创建项目，同时保持代码始终更新和可访问。
访问文档
https://getcomposer.org.cn/doc/
安装
https://getcomposer.org.cn/download/
在哪里找到通过Composer安装的PHP包
- 官方下载仓库网站 - https://packagist.org.cn/
- GitHub上的仓库，维护着多个领域中最优秀和最常用的库列表 - https://gist.github.com/llbbl/7607016
如何使用Composer开始一个项目？
composer init
然后回答问题并配置composer.json。
您也可以手动创建composer.json文件。
主要命令
- init - 使用Composer初始化项目
- install 或 i - 安装所有依赖项
- update 或 u - 更新所有依赖项
- clear-cache - 清除Composer缓存
- dumpautoload -o - 更新PSR-0和PSR-4的autoload classpath
composer.json中存在的主要属性
- name: 使用[vendor/name]格式，指定供应商名称和项目名称
- description: 项目的描述
- type: 项目的类型，可以是library、project或metapackage
- version: 项目的版本，使用数字格式，通常包含主版本和小版本
- autoload: 指定用于仅使用Composer的autoload的classpath或文件
- require: 项目所有依赖项的列表
- scripts: 使用Composer的通用功能、快捷方式和脚本列表
注意：autoload和require具有与dev后缀相似的性质，其中存储仅适用于开发环境的定义。要安装依赖项而不加载开发资源，请使用以下命令
composer install --no-dev
完整的composer.json文件示例
{
"name": "senaces/sig-integration",
"type": "project",
"description": "SENAC | ES",
"authors": [
{
"name": "Felipe Gaspar"
}
],
"autoload": {
"psr-4": {
"Senac\\Cron\\": "scripts/",
"Senac\\Services\\": "src/integration/",
"WebApp\\Platform\\Core\\Utils\\": "src/utils",
"WebApp\\Platform\\Core\\Database\\": "src/database",
"WebApp\\Platform\\OpenApi\\Senac\\": "src/api/"
}
},
"autoload-dev": {
"psr-4": {
"Test\\UnitTest\\": "tests/unit"
}
},
"require": {
"php": "^8",
"symfony/yaml": "^5.3",
"guzzlehttp/guzzle": "^7.0",
"monolog/monolog": "^3.2",
"symfony/mailer": "^6.1",
"symfony/mime": "^6.1",
"phuml/phuml": "^6.1",
"code-simplify/ciesta-project": "^0.0.1"
},
"require-dev": {
"phpunit/phpunit": "^9",
"codeception/codeception": "^5.0",
"codeception/module-asserts": "^3.0",
"phpmetrics/phpmetrics": "^2.8",
"phpunit/php-code-coverage": "^9",
"rregeer/phpunit-coverage-check": "^0.3.1"
},
"scripts": {
"clear": [
"rm -f composer.lock",
"@composer clear-cache"
],
"code-coverage": "codecept run --coverage",
"code-coverage-details": [
"codecept run --coverage --coverage-html",
"mv reports/coverage docs"
],
"unit-test": "codecept run unit",
"test-application": [
"@code-coverage"
],
"build-application": [
"@clear",
"@composer install",
"@test-application"
],
"doc": [
"rm -rf docs",
"mkdir docs",
"mkdir docs/metrics",
"mkdir docs/code",
"mkdir docs/class",
"mkdir docs/coverage",
"vendor/bin/phpmetrics --report-html=docs/metrics src",
"phpdoc -d src/ -t docs/code",
"vendor/bin/phuml phuml:diagram -r -a -i -o -e php -p dot src/ docs/class/diagram.png",
"@code-coverage-details"
]
},
"scripts-descriptions": {
"clear": "Limpa o cache de dependências e o arquivo composer.lock",
"code-coverage": "Executa o teste de cobertura de código com saida pelo console",
"code-coverage-details": "Gera um relatório completo do teste de cobertura de código em formato HTML",
"code-coverage-test": "Verifica o sucesso da cobertura de código com base em um parâmetro numérico especificado",
"unit-test": "Executa os testes unitários utilizando o framework PHPUnit",
"test-application": "Executa todas as rotinas de testes configuradas. OBS.: Habilite apenas as rotinas implementadas",
"build-application": "Limpa o cache e instala as dependências, e em seguida executa todas as rotinas de testes configuradas",
"doc": "Gera a documentação completa do projeto"
}
}
composer.lock和vendor
composer.lock文件包含了对环境中所有安装的引用，包括每个库安装的版本信息，作为Composer保留指定版本的参考。
而vendor目录包含所有已安装库的源代码、autoload classpath和二进制脚本。它是使用Composer的项目的基础。要使用它，只需在项目中的任何文件中加载/vendor/autoload.php即可。
通常在版本控制中不会保存这两个文件。为了简化此管理，请使用.gitignore文件，指定项目根目录到所有要保留在版本控制之外的路由和文件。
创建用于Composer执行的脚本
在此示例中，我们将使用一个用于清除缓存和composer文件的脚本
- 如以下示例所示创建script部分
"scripts": {
},
- 添加键"clear"并将它设置为空数组
- 添加命令"rm -f composer.lock"，使用引号并在末尾加上逗号。（Composer接受通过标志-r执行的任何Unix命令和PHP命令。例如：php -r "echo 'teste';";）
- 添加命令"@composer clear-cache"。要在脚本中使用Composer命令，只需在关键字composer前加上@即可。
- 使用以下命令测试您的脚本
composer clear
活动
现在创建一个名为 "build-app" 的命令，该命令清除您的环境并安装所有依赖项
使用 composer 创建第一个库
- 使用 composer init 创建 composer.json
- 在 /src 文件夹内创建一个名为 Conexao.php 的文件
- 将以下代码复制到该文件中
<?php namespace Treinamento\Teste; final class Conexao { private array $data = []; public function __construct() { $this->data = [ (object)[ 'titulo' => 'Exemplo 01', 'autor' => 'Fulano', 'corpo' => 'Foo' ], (object)[ 'titulo' => 'Exemplo 02', 'autor' => 'Beltrano', 'corpo' => 'Bar' ], (object)[ 'titulo' => 'Exemplo 03', 'autor' => 'Cicrano', 'corpo' => 'Baz' ] ]; } public function lerNoticiasDoBanco() : array { return $this->data; } }
- 为连接类创建 PSR-4 的自动加载
"autoload": {
"psr-4": {
"Treinamento\\Teste\\": "src/"
}
}
- 在您的 GitHub 上创建一个公共仓库。（将 vendor 名称更改为您的 GitHub 账户名称）
- 将代码上传到您的 GitHub
- 为您的项目创建一个版本和一个标签 1.0
- 访问并登录到网站 https://packagist.org.cn/
- 点击提交菜单并为您提供 GitHub 仓库的链接以发布您的仓库
- 在 Packagist 上发布仓库后，您可以将它作为依赖项插入到您的项目中。为此，关闭当前文件夹，创建一个新的项目使用 .devcontainer，并将 Packagist 中的您的库安装命令复制到项目中。
文档生成器
PHUML
PHUML（处理和操作 UML 模型）是一个基于 UML（统一建模语言）的建模工具，允许用户创建软件和系统模型。PHUML 允许用户查看、分析和操作这些模型，并提供从创建的模型自动生成代码的资源。
在上一活动创建的新项目中，添加以下开发依赖项
composer require --dev phuml/phuml ^6.1
使用以下命令生成类图。
vendor/bin/phuml phuml:diagram -r -a -o -e php -p dot examples/ docs/class/diagram.png
您可以根据需要更改源目录和目标目录。有关 PHUML 配置的更多信息，请访问 https://montealegreluis.com/phuml/docs/class-diagram.html。您可以通过仅生成方法和属性、包含或不包含关联、选择绘图工具（dot 和 neato）等选项来生成文档版本。上述建议的命令已经包含 phuml 生成器的完整版本，该生成器使用已安装在 .devcontainer 中的 graphviz dot。
活动
为新闻类别添加一个新类并更新类图
PHP Documentor
PHP Documentor 是一个开源代码文档工具，用于生成结构化和易于阅读的 PHP 代码文档。PHP Documentor 用于提高生产力和简化维护，因为它有助于创建内容丰富、结构化和更新的文档。PHP Documentor 允许开发人员从源代码生成 HTML、PDF、DocBook 和 man 页面文档。
要生成文档，请使用以下命令
phpDocumentor -d examples -t docs
请注意，文档不完整，仅提供类和文件的基本信息。
使用 docblocks，这些是附加在文件、类、函数和变量定义上的属性集合，以改进生成文档的质量，不仅限于生成的文件，而且通过代码中的注释进行明确。
DocBlocks
- 文件
通常通过指定包（命名空间）和文件的目的来记录文件。
/** * Breve descrição sobre o seu arquivo * @package Exemplo\Treinamento * @author Felipe Gaspar <felipesouzalimagaspar@gmail.com> */
- 类或接口
使用一个简短的描述以及 @final 或 @abstract（如果这些是抽象或最终类）来记录类。
/** * Classe de exemplo Foo que não serve para nada * @abstract */ abstract class Foo {
- 函数
在函数的文档中，通常使用 @access 定义函数的隐私级别，使用 @param 使用参数列表，使用 @return 定义返回值，如果函数可以引发可预见的异常，则使用 @throws。
/** * Função de demonstração de docblocks * @access public * @param string $foo Parâmetro de exemplo * @param array $bar Outro parâmetro * @throws TypeError Minha função pode disparar exceptions da classe TypeError * @return int Minha função sempre retornará um inteiro */ public function minhaFuncao(string $foo, array $bar) : int {
- 属性
在属性的情况下，使用 @var 伴随类型和描述。
/** * @access private * @var bool Minha váriavel que não serve para nada além de demonstração */ private bool $exemplo;
如果您有一个可以是多种类型或您不知道类型的变量、参数或返回值，请使用 mixed。mixed 是 PHP 的基本类型，从最初版本开始允许变量改变类型。
访问PHP Documentor网站以查看可用的完整docblocks列表及其使用方法。
https://docs.phpdoc.org/3.0/guide/guides/docblocks.html#more-on-docblocks
活动
现在您已经了解了docblocks和PHP Documentor，请将docblocks添加到示例目录中的类，并重新生成文档。
活动
使用Composer脚本、PHP Documentor和PHUML的知识，创建一个“composer doc”脚本，该脚本创建一个空内容的docs文件夹，并使用这两个学习过的工具生成文档。
测试类型
单元测试
单元测试是验证单个代码单元的测试。它们旨在检查特定的代码单元是否正在正确运行。这些测试是在单个代码单元上同时执行的，这意味着它们是独立于其他代码执行的。
集成测试
集成测试用于检查不同的代码单元是否正确交互。这些测试用于检查代码单元是否能够良好地协同工作，并且能够产生预期的结果。
验收测试
验收测试用于检查系统是否满足用户的请求。这些测试用于检查系统是否按用户期望的方式运行。
代码覆盖率
代码覆盖率是一种衡量已测试代码量的指标。代码覆盖率用于检查是否所有代码部分都得到了适当的测试。
断言
测试中的断言是声明一个测试获得的結果是否为预期的。它们用于检查代码是否正确执行并产生预期的结果。断言通常以“结果应该等于...”或“结果应该介于...”之类的短语表示。
PHPUnit
PHPUnit是PHP编程语言的单元测试框架。它提供了测试PHP应用程序以确保其质量和可靠性的工具。PHPUnit允许开发者为PHP应用程序和库编写和执行自动化的单元测试。PHPUnit基于xUnit构建并遵循敏捷开发原则。它是PHP中最流行的单元测试框架。
要安装PHPUnit，只需在composer.json中添加以下依赖项
composer require --dev phpunit/phpunit ^9
配置测试套件
测试套件是一组在预定义环境中执行的单元测试。
- 在项目根目录下创建一个名为phpunix.xml的文件，并添加以下行
<?xml version="1.0" encoding="UTF-8"?> <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./src/vendor/phpunit/phpunit/phpunit.xsd" bootstrap="./tests/bootstrap.php" colors="true" > <testsuites> <testsuite name="Unit Test Suite"> <directory> ./tests/unit/</directory> </testsuite> </testsuites> </phpunit>
- 创建一个名为tests的目录，并在其中创建一个名为bootstrap.php的文件，内容如下
<?php require_once __DIR__ . '/../vendor/autoload.php'; /** * @todo acrescente aqui outras definições base para execução dos testes */
- 在composer.json中添加以下部分
"autoload-dev": { "psr-4": { "Test\\UnitTest\\": "tests/unit" } },
- 在tests目录中创建一个名为unit的目录，并开始创建测试。
使用PHPUnit创建单元测试
在此示例中，我们将使用基本的数学运算来了解PHPUnit的功能。
所有使用PHPUnit执行的测试都应具有带有后缀Test的文件名和带有前缀test的测试方法名。
- 创建一个名为MathTest.php的文件，并添加以下代码
<?php namespace Test\UnitTest; final class MathTest extends \PHPUnit\Framework\TestCase { public function testTaFuncionandoOPHPUnit(): void { $this->assertTrue(true); } }
-
创建您的第一个测试。为此，添加一个名为testSoma的函数。测试2 + 2的和是否等于4。为此，使用接收两个参数并比较它们的assertEquals断言。
-
让我们将之前创建的测试更改为动态测试。为此，将两个数字2和数字4替换为变量$n1、$n2和$n3作为函数的参数。
在运行测试之前，创建一个名为NumerosProvider的函数，内容如下
public function NumerosProvider() : array { return [ '2+2' => [2,2,4], '3+3' => [3,3,6], '2+3' => [2,3,5] ]; }
在testSoma函数之前添加以下docblock
/** * @dataProvider NumerosProvider */
数据提供者是一组测试实例，可用于通过提供多个参数和预期结果来扩展测试的精确度。
- 在其班级中添加以下功能
public static function setUpBeforeClass(): void { echo "Imagine que isso seja muito importante e tenha de ser executado antes dos testes"; } public static function tearDownAfterClass(): void { echo "Imagine que isso seja muito importante e tenha de ser executado após os testes"; }
活动
研究和实现使用PHPUnit官方文档中的一些断言的测试，网址为https://docs.phpunit.de/en/9.Para 这，请使用PHP的基本操作。
活动
使用composer的autoload功能加载examples目录中的类，并对每个类进行单元测试。
活动
加载您创建的库，并对Conexão类进行单元测试。
活动
实现一个集成测试，使用Conexão、Autor和Notícia类。
Codeception
Codeception是一个用于PHP web应用的自动化测试框架。它提供了一系列工具来帮助测试web应用，从单元测试到用户验收测试。它还包含一套库和资源，以帮助自动化测试执行。
创建覆盖率测试
- 在composer.json中添加以下依赖项
"codeception/codeception": "^5.0", "codeception/module-asserts": "^3.0", "phpunit/php-code-coverage": "^9"
- 在项目根目录创建一个名为codeception.yml的文件，并将以下代码粘贴进去
paths: tests: tests output: reports data: reports support: tests/.codeception envs: tests/_envs bootstrap: bootstrap.php settings: suite_class: \PHPUnit_Framework_TestSuite memory_limit: 1024M log: true colors: true actor_suffix: Tester extensions: enabled: - Codeception\Extension\RunFailed coverage: enabled: true include: - examples/* exclude: - examples/*log low_limit: 50 high_limit: 90 show_only_summary: false show_uncovered: true
- 将codeception.zip文件解压到tests目录下
- 执行以下命令以运行覆盖率测试
vendor/bin/codecept run --coverage
如果您想以图形模式生成报告，请使用以下命令
vendor/bin/codecept run --coverage --coverage-html
创建验收测试
- 使用PHP内置服务器，在端口8888上提供view文件夹的内容。
- 在/tests目录下创建一个名为acceptance的文件夹
- 安装以下依赖项
"codeception/module-phpbrowser": "^3.0"
- 将以下代码复制到您将在acceptance目录下创建的FirstCest.php文件中
<?php class FirstCest { public function frontpageWorks(AcceptanceTester $I) { $I->amOnPage('/'); $I->see('Exemplo'); } public function viewpageWorks(AcceptanceTester $I) { $I->amOnPage('/view.php?url=exemplo-01'); $I->see('Foo'); } }
活动
实现一个使用任何在线表单和文档中提供的方法的表单测试