{"id":19272398,"url":"https://github.com/albreis/phptest","last_synced_at":"2026-05-08T16:44:00.198Z","repository":{"id":43465882,"uuid":"464035046","full_name":"albreis/phptest","owner":"albreis","description":"PHPTest é uma alternativa ao já conhecido PHPUnit pra criar testes unitários na sua aplicação","archived":false,"fork":false,"pushed_at":"2022-03-02T04:39:55.000Z","size":149,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-05T16:49:28.508Z","etag":null,"topics":["php","phptest","phpunit","tdd"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/albreis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"custom":["https://www.ersolucoesweb.com.br","https://youtube.com/UmaTagPorDia","https://facebook.com/everaldo.programador.fullstack","https://www.instagram.com/programador.fullstack/"]}},"created_at":"2022-02-27T04:16:45.000Z","updated_at":"2022-04-05T22:58:06.000Z","dependencies_parsed_at":"2022-08-21T02:10:21.255Z","dependency_job_id":null,"html_url":"https://github.com/albreis/phptest","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albreis%2Fphptest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albreis%2Fphptest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albreis%2Fphptest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/albreis%2Fphptest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/albreis","download_url":"https://codeload.github.com/albreis/phptest/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240374086,"owners_count":19791334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","phptest","phpunit","tdd"],"created_at":"2024-11-09T20:36:42.628Z","updated_at":"2026-05-08T16:43:55.143Z","avatar_url":"https://github.com/albreis.png","language":"PHP","funding_links":["https://www.ersolucoesweb.com.br","https://youtube.com/UmaTagPorDia","https://facebook.com/everaldo.programador.fullstack","https://www.instagram.com/programador.fullstack/"],"categories":[],"sub_categories":[],"readme":"![img](./assets/phptest-cover-v2.png)\n\n# PHPTest\n\nUma alternativa ao PHPUnit\n\n## Como funciona\nEste pacote serve para gerar teste a partir de comentários no código.\nUma alternativa mais simplista ao PHPUnit.\n\nA idéia é diminuir o trabalho por trás da tarefa massante que é criar testes.\n\n## Como usar\n\nVocê pode clonar o repositorio ou então instalar utilizando o composer:\n\n```bash\ncomposer require albreis/phptest\n```\n\nPara utilizar está suite de teste basta utilizar o padrão:\n\n@test [codigo php para executar contendo um \"return\"]\n\nou \n\n@test [codigo php para executar contendo um \"return\"]\n@expect return [retorno esperado do teste anterior]\n\nEm caso de testes para exceptions não é necessário fazer o return, pois o retorno é feito automaticamente com a mensagem da exception.\n\nExemplo de teste de exception:\n\n```php\n\u003c?php namespace Albreis\\Kurin;\n\nuse Albreis\\Kurin\\Interfaces\\IEvent;\n\n/** @package Albreis\\Kurin */\n\n/**\n * @test new Albreis\\Kurin\\Event\n * @expect return 'Cannot instantiate abstract class Albreis\\Kurin\\Event';\n */\nabstract class Event implements IEvent {\n\n  private ?array $callbacks = [];\n  private $message;\n  ...\n```\n\nExectando o teste acima o retorno será, pois uma classe abstrata não pode ser instanciada, logo, esperamos essa mensagem de retorno:\n\n```bash\nFile: /home/webprodutora/everhost.net.br/kurin/src/Event.php\nLine: 8\nTest: new Albreis\\Kurin\\Event\nReturn: string(53) \"Cannot instantiate abstract class Albreis\\Kurin\\Event\"\nExpect: Cannot instantiate abstract class Albreis\\Kurin\\Event\nStatus: Success\n\nCongratulations! All tests are passed.\n```\n\nO valor retornado precisa ser true ou false\n\nVeja abaixo algums exemplos de utilização da ferramenta\n\n### Exemplo 1\n\n```php\n\u003c?php namespace Albreis;\n\nclass Calculadora {\n    /**\n     * @test return (new Albreis\\Calculadora)-\u003esoma(1, 2) == 3\n     * @test return (new Albreis\\Calculadora)-\u003esoma(1, 2) == 4\n     */\n    public function soma($num1, $num2) {\n        return ($num1 + $num2);\n    }\n}\n```\n\nSalve o arquivo acima em uma pasta e rode o comando abaixo, indicando a pasta onde existem os arquivos para teste\n\n```bash\nphp vendor/bin/phptest {diretorio}\n```\n\nou\n\n```bash\nphp vendor/albreis/test/phptest {diretorio}\n```\n\n### Exemplo 2\n\n```php\n\u003c?php namespace Albreis;\n\nclass Anime {\n    /**\n     * @test return isset(json_decode((new Albreis\\Anime)-\u003egetRandom())-\u003eanime)\n     * @test return !isset(json_decode((new Albreis\\Anime)-\u003egetRandom())-\u003eanime)\n     */\n    public function getRandom() {\n        return file_get_contents('https://animechan.vercel.app/api/random');\n    }\n}\n```\n\n```bash\nphp vendor/albreis/test/phptest {diretorio}\n```\n\n## Escrevendo testes em arquivos externos\n\nQuando o teste for muito complexo é precisa de várias linhas o ideal é escrever em um arquivo externo.\n\nBasta utilizar o padrão: @test_using [caminho relativo do arquivo externo]\n\nArquivo de teste: SomaTest.php\n```php\n\u003c?php \nreturn (new Albreis\\Soma)-\u003esoma(2, 3) == 5;\n```\n\nClasse para testar:\n\n```php\n\u003c?php namespace Albreis;\n\nclass Soma {\n    /**\n     * @test return (new Albreis\\Soma)-\u003esoma(9,9) == 89\n     * @test_using SomaTest.php\n     */\n    public function soma($num1, $num2) {\n        return ($num1 + $num2);\n    }\n}\n```\n\n### Testando um bloco de código\n```php\n/**\n * @test return ($num1 + $num2) == 4\n */\n$num1 = 1;\n$num2 = 3;\n```\n\nRetornará:\n```bash\nFile: /home/public_html/bin/examples/tests.php\nLine: 4\nTest: return ($num1 + $num2) == 4\nReturn: bool(true)\nStatus: Success\n\nCongratulations! All tests are passed.\n```\n\n### Testando uma função\n```php\n/**\n * @test return soma(1, 1) == 2\n */\nfunction soma($n, $n2) {\n    return ($n + $n2);\n}\n```\n\nRetornará:\n```bash\nFile: /home/public_html/bin/examples/tests.php\nLine: 10\nTest: return soma(1, 1) ==2\nReturn: bool(true)\nStatus: Success\n\nCongratulations! All tests are passed.\n```\n\n## Excluir um arquivo ou diretório dos testes\n\nCaso você não queira testar alguns arquivos ou diretórios específicos você pode utilizar a opção --exclude ou --exclude_regex, veja um exemplo:\n\n**Ignorar o diretório vendor**\n\n```bash\nphp vendor/bin/phptest --exclude-regex=vendor/* .\n```\n\n**Ignorar o arquivo index.php**\n\n```bash\nphp vendor/bin/phptest --exclude-regex=vendor/* .\n```\n\n**Ignorar o arquivo index.php e o diretório vendor**\n\n```bash\nphp vendor/bin/phptest --exclude-regex=vendor/* --exclude=index.php .\n```\n\n\n\n## Logs\n\nApós os testes serem executados será salvo um arquivo de logs na raiz do projeto chamado phptest.logs, contendo um feedback completo de todos os testes.\n\n## Helpers\n\nO PHPTest possui algumas funções para auxiliar na execução de alguns testes.\n\n```php\nget_http_status_code(string $url)\n```\n\nRetorna o código de status HTTP\n\n## Contribuições\n\nClone a branch Develop, crie uma nova branch com sua feature, faça suas alterações e depois crie um PR (pull request) que irei avaliar o que foi feito e se aprovado farei o merge na Main.\n\n## **Doações**\n\nNo momento estou mantendo o projeto totalmente sozinho, então, doações são bem vindas! :) Podem ser feitas atravez do PIX 12454995727 ou via paypal contato@everaldoreis.com.br\n\n## Suporte\n\nWhatsApp: https://wa.me/554898523084\n\n![img](./assets/frase.jpg)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbreis%2Fphptest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falbreis%2Fphptest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falbreis%2Fphptest/lists"}