jordimorillo/tdg-php

一个测试驱动生成开发工具，从测试开始编写代码

维护者

详细信息

github.com/jordimorillo/tdg-php

源代码

问题

安装: 18

依赖项: 0

建议者: 0

安全: 0

星星: 0

观察者: 1

分支: 0

开放问题: 0

类型：项目

v1.0.0-beta.1 2024-07-07 20:17 UTC

Requires

Requires (Dev)

MIT 5ceac4c55969b6aa78952ef4cc7af5276d3d214f

This package is auto-updated.

Last update: 2024-09-08 23:22:55 UTC

README

TDG-PHP是一个基于提供的测试生成和测试PHP代码的工具。它利用代码生成服务并运行测试以确保生成的代码符合测试中指定的要求。

安装

要在项目中安装TDG-PHP，请运行以下命令

composer require jordimorillo/tdg-php

用法

安装完成后，您可以使用tdg-php命令根据PHP测试文件生成和测试代码。命令执行方式如下

./vendor/bin/tdg-php path/to/test/file.php

参数

  • path/to/test/file.php：用于生成代码的PHP测试文件的路径。

示例用法

./vendor/bin/tdg-php tests/ExampleTest.php

配置

为确保工具正确工作，需要配置某些环境变量。以下是必要的变量及其用途

  • PROJECT_ROOT：项目的根路径。
  • PHPUNIT_XML_PATH：PHPUnit配置文件的路径。
  • BASE_NAMESPACE：项目的基命名空间。
  • TESTS_BASE_NAMESPACE：测试的基命名空间。
  • API_KEY：代码生成服务的API密钥。
  • MAX_ATTEMPTS：生成有效代码的最大尝试次数。
  • PERMANENT_ATTACHMENTS：在代码生成过程中始终附加的额外文件。

示例.env文件

PROJECT_ROOT=/path/to/project
PHPUNIT_XML_PATH=/path/to/phpunit.xml
BASE_NAMESPACE=App
TESTS_BASE_NAMESPACE=Tests
API_KEY=your_api_key
MAX_ATTEMPTS=5
PERMANENT_ATTACHMENTS=src/Helper.php,src/Utils.php

开发

要求

  • PHP 8.0或更高版本
  • Composer
  • PHP cURL扩展

运行测试

要运行测试，请使用以下命令

composer test

贡献

欢迎贡献。请打开问题或提交一个pull请求来为此项目做出贡献。

许可

本项目采用MIT许可证。有关更多详细信息，请参阅LICENSE文件。

其他要求

为此工具工作，需要本地安装Llama3。