/setup-kata-php

1 minute setup to start practicing a kata

Primary LanguageMakefile

PHP and PHPUnit Kata Bootstrap

1 minute setup to start practicing a kata

TL;DR

git clone https://github.com/CodiumTeam/php-kata-bootstrap
cd php-kata-bootstrap

First option: I already have installed PHP 7.4 and composer

make dependencies
make tests
make coverage

Second option: I already have installed docker

make docker-build
make docker-tests
make docker-coverage

Goal

  • Simplify the setup of a PHP environment for katas
  • Tests running in seconds
  • Setup with or without docker
  • Tutorial to run the tests inside PhpStorm

Content

  • PHP 7.4
  • PHPUnit 9 (Compatible with PHP 7.3 and 7.4)
  • First PHPUnit test
  • Phpstorm settings

0. Prerequisites

1. Prepare the setup

1.1. With docker

make docker-build

1.2. Without docker

make dependencies

2. Tests

2.1. Command line with docker

make docker-tests

2.2. Command line without docker

make tests

2.3. PHPStorm with docker

2.3.1. Configure docker

Follow the instructions according your operating system

In linux is:

Open: Preferences
Click: Build, execution, deployment | Docker
Click: +
Write: API Url: unix:///var/run/docker.sock
Write: Docker compose executable: /usr/local/bin/docker-compose

In Mac is:

Open: Preferences
Click: Build, execution, deployment | Docker
Click: +
Click: Docker for Mac

2.3.2. Configure Interpreter

Click: Languages & Frameworks | PHP 
Click: CLI Interpreter | ...
Click: + | From Docker, Vagrant...
Select: Remote | Docker
Write: Image name: php-docker-bootstrap
Write: Php interpreter: php
Write: Name: Docker PHP 7.4

2.3.3. Configure PHPUnit

Click: Languages & Frameworks | PHP | Test Frameworks 
Click: + | By Remote Interpreter
Select: Cli interpreter: Docker PHP 7.4
Click: PHP Unit library: Use composer autoloader
Write: Path to script: vendor/autoloader.php

2.3.4. Run

Right click: tests folder | Run 'tests'

3. Code coverage

3.1. Command line with docker

make docker-coverage

3.2. Command line without docker

make coverage

3.3. PHPStorm

Right click: tests folder | Run 'tests with Coverage'

4. Use another PHP Version

If you want to use other version of PHP it's as easy as follow the steps:

  • Edit Dockerfile
  • Select a valid version of PHP from Docker Hub
  • Follow the "Prepare setup" steps
  • Validate the composer.json to verify all the requisites are satisfied.