搜索jonathanbandeira / exemple
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。尽管在容器内使用是可能的，但需要配置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版本及以上版本中内置的Web服务器。它允许开发者快速启动本地开发服务器，无需安装和配置其他服务器，如Apache或Nginx。内置服务器仅应用于开发目的，不应用于生产环境。
要启动服务器，请通过终端访问公共目录并输入以下命令：
php -S localhost:8888
之后，在浏览器中访问URL。
注意：请使用任意高端口，不强制使用8888，避免使用8080，因为VS Code会使用它进行隧道。
使用Ngrok提供内置服务器访问
Ngrok是一个工具，允许创建一个安全的本地服务器，以测试本地托管的应用程序和服务。它创建一个隧道，将本地服务器暴露给公共互联网，使其在任何地方都可以访问，同时保持本地IP和端口私密。它用于开发、测试、演示和其他应用。
在网站https://ngrok.com/上注册，并在启动内置服务器后，在另一个终端中输入以下命令
ngrok http 8888
注意：终端将在Ngrok应用程序中锁定，Ngrok将提供一个公开链接以提供对您开发环境的访问。
Composer
什么是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的classpath自动加载
composer.json中存在的主要属性
- name: 使用[vendor/name]格式，指定供应商和项目名称
- description: 项目描述
- type: 项目类型，可以是library、project或metapackage
- version: 项目版本，使用数字格式，通常包含主版本和小版本
- autoload: 指定用于类或文件加载的classpath，仅使用Composer的自动加载
- require: 项目所有依赖项的列表
- scripts: 使用Composer通过函数、快捷方式和通用脚本列表
注意：自动加载和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目录包含所有已安装库的源代码，自动加载的classpath和二进制脚本。它是使用Composer的项目的基础。要使用它，只需在项目的任何文件中加载/vendor/autoload.php文件。
通常在版本控制中不保存这两个文件。为了简化此管理，请使用.gitignore文件指定项目根目录直到所有要排除在版本控制之外的路由。
创建用于Composer执行的脚本
在此示例中，我们将使用一个用于清理缓存和Composer文件的脚本
- 创建如下所示的script部分
"scripts": {
},
- 添加“clear”键并分配一个空数组
- 添加命令“rm -f composer.lock”，使用引号，并在最后加上逗号。（Composer接受任何Unix命令和通过标志-r的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 和手册页面的文档。
要生成文档，请使用以下命令
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 通过使用 @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”脚本，创建一个空文档目录，并使用这两个研究工具生成文档。
测试类型
单元测试
单元测试是验证单个代码单元的测试。它们被设计来检查特定代码单元是否正确运行。这些测试是在单个代码单元上执行的，这意味着它们是独立于其他代码执行的。
集成测试
集成测试用于检查不同的代码单元是否正确交互。这些测试用于检查代码单元是否能够很好地一起工作，并且能够产生预期的结果。
验收测试
验收测试用于检查系统是否满足用户的需求。这些测试用于检查系统是否按用户期望的方式运行。
代码覆盖率
代码覆盖率是一个用于衡量已测试代码量的指标。代码覆盖率用于检查是否已适当地测试了代码的所有部分。
断言
测试中的断言是声明，它们声称测试中获得的某个结果是或不是预期的。它们用于检查代码是否正确执行并产生预期的结果。断言通常用如“结果应该等于...”或“结果应该在...之间”这样的短语表示。
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'); } }
活动
实现一个使用任何在线表单和文档中可用的方法的表单测试