Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
luizcmarin committed Apr 19, 2024
1 parent bd91bee commit c6bb053
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 48 deletions.
38 changes: 2 additions & 36 deletions docs/guide/en/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For greater ease it is recommended to use docker containers, for this you can us

For running the docker containers you can use the following command:

```shell
```dockerfile
docker compose up -d
```

Expand All @@ -32,38 +32,4 @@ The following steps are required to run the tests:
vendor/bin/phpunit
```

### Mutation testing

The package tests are checked with [Infection](https://infection.github.io/) mutation framework with
[Infection Static Analysis Plugin](https://github.com/Roave/infection-static-analysis-plugin). To run it:

```shell
./vendor/bin/roave-infection-static-analysis-plugin
```

## Static analysis

The code is statically analyzed with [Psalm](https://psalm.dev/). To run static analysis:

```shell
./vendor/bin/psalm
```

## Rector

Use [Rector](https://github.com/rectorphp/rector) to make codebase follow some specific rules or
use either newest or any specific version of PHP:

```shell
./vendor/bin/rector
```

## Composer require checker

This package uses [composer-require-checker](https://github.com/maglnet/ComposerRequireChecker) to check if all dependencies are correctly defined in `composer.json`.

To run the checker, execute the following command:

```shell
./vendor/bin/composer-require-checker
```
- More information can be found in the [Internals.](docs/internals.md)
15 changes: 3 additions & 12 deletions docs/guide/pt-BR/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,22 @@

## Github actions

All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-mysql/blob/master/.github/CONTRIBUTING.md) in the cloud.
All our packages have github actions by default, so you can test your [contribution](https://github.com/yiisoft/db-oracle/blob/master/.github/CONTRIBUTING.md) in the cloud.

> Note: We recommend pull requesting in draft mode until all tests pass.
## Docker image

For greater ease it is recommended to use docker containers, for this you can use the [docker-compose.yml](https://docs.docker.com/compose/compose-file/) file that is in the docs folder.

1. [MySQL 8](../../../docker-compose.yml)
2. [MariaDB 10.11](../../../docker-compose-mariadb.yml)
1. [Oracle 21](/docker-compose.yml)

For running the docker containers you can use the following command:

MySQL 8.0.

```dockerfile
docker compose up -d
```

MariaDB 10.11.

```dockerfile
docker compose -f docker-compose-mariadb.yml up -d
```

## Unit testing

The package is tested with [PHPUnit](https://phpunit.de/).
Expand All @@ -41,4 +32,4 @@ The following steps are required to run the tests:
vendor/bin/phpunit
```

- More information can be found in the [Internals.](../../internals.md)
- More information can be found in the [Internals.](docs/internals.md)

0 comments on commit c6bb053

Please sign in to comment.