/docker-image

[Closed] Kahlan Docker image

Primary LanguageDockerfileMIT LicenseMIT

Kahlan Docker Image

Build Status Docker Pulls

Status

PROJECT IS CLOSED AND ARCHIVED. NO MAINTAINING WILL BE CONTINUED.

Supported tags and respective Dockerfile links

What is Kahlan?

Kahlan is a full-featured Unit & BDD test framework a la RSpec/JSpec which uses a describe-it syntax and moves testing in PHP one step forward.
Kahlan allows to stub or monkey patch your code directly like in Ruby or JavaScript without any required PECL-extentions.

kahlan.github.io

Kahlan Logo

How to use this image

Just map your working directory to /app inside container:

docker run --rm -v $(pwd):/app kahlan/kahlan

If you need to specify some options just do so:

docker run --rm -v $(pwd):/app kahlan/kahlan --help
docker run --rm -v $(pwd):/app kahlan/kahlan --config=my/kahlan-config.php

By default Kahlan is not running under Xdebug or phpdbg, so code coverage doesn't work.
If you require it, just use the wrapper you wish:

docker run --rm -v $(pwd):/app --entrypoint /kahlan-phpdbg kahlan/kahlan
docker run --rm -v $(pwd):/app --entrypoint /kahlan-xdebug kahlan/kahlan

Note, that /kahlan-phpdbg is not available in PHP5 image versions. See why.

Image versions

kahlan/kahlan:<version>

This is the defacto image. If you are unsure about what your needs are, you probably want to use this one. It's built on top of official PHP7 image.

kahlan/kahlan:<version>-php5

This is made to run Kahlan under PHP5, rather than the default PHP7. It might be useful if you application still requires PHP5.

Note, that phpdbg is not available in this type of images. See why.

kahlan/kahlan:<version>-alpine

This image is based on the popular Alpine Linux project, available in the alpine official image. Alpine Linux is much smaller than most distribution base images (~5MB), and thus leads to much slimmer images in general.

kahlan/kahlan:<version>-php5-alpine

This Alpine-based image is made to run Kahlan under PHP5.

Note, that phpdbg is not available in this type of images. See why.

License

Kahlan is licensed under MIT license.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

The sources for producing kahlan/kahlan Docker images are licensed under MIT license too.

Issues

We can't notice comments in the DockerHub so don't use them for reporting issue or asking question.

If you have any problems with or questions about this image, please contact us through a GitHub issue.