Added documentation about testsuite

Fix #2415
This commit is contained in:
Nicolas Lœuillet 2016-10-10 09:15:53 +02:00
parent edc8bc0b2f
commit 84e3c36e02
No known key found for this signature in database
GPG key ID: 5656BE27E1E34D0A
8 changed files with 46 additions and 5 deletions

View file

@ -1,7 +1,9 @@
TMP_FOLDER=/tmp
RELEASE_FOLDER=wllbg-release
ENV=prod
ifndef ENV
ENV=prod
endif
help: ## Display this help menu
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
@ -15,14 +17,14 @@ install: ## Install wallabag with the latest version
update: ## Update the wallabag installation to the latest version
@sh scripts/update.sh $(ENV)
run: ## Run the wallabag server
php bin/console server:run --env=$(ENV)
run: ## Run the wallabag built-in server
@php bin/console server:run --env=$(ENV)
build: ## Run grunt
@grunt
test: ## Launch wallabag testsuite
@ant prepare && phpunit -v
@ant prepare && vendor/phpunit/phpunit/phpunit -v
release: ## Create a package. Need a VERSION parameter (eg: `make release VERSION=master`).
ifndef VERSION

View file

@ -0,0 +1,10 @@
Testsuite
=========
To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
Then, execute this command ``make test``.

View file

@ -6,6 +6,9 @@ Voraussetzungen
wallabag ist kompatibel mit PHP >= 5.5, inkl. PHP 7.
.. note::
Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
wallabag nutzt eine große Anzahl an Bibliotheken, um zu funktionieren. Diese Bibliotheken müssen mit einem Tool namens Composer installiert werden. Du musst es installieren sofern du es bisher noch nicht gemacht hast.
Composer installieren:

View file

@ -0,0 +1,10 @@
Testsuite
=========
To ensure wallabag development quality, we wrote tests with `PHPUnit <https://phpunit.de>`_.
If you contribute to the project (by translating the application, by fixing bugs or by adding a new feature), please write your own tests.
To launch wallabag testsuite, you need to install `ant <http://ant.apache.org>`_.
Then, execute this command ``make test``.

View file

@ -6,6 +6,9 @@ Requirements
wallabag is compatible with PHP >= 5.5, including PHP 7.
.. note::
To install wallabag easily, we create a ``Makefile``, so you need to have the ``make`` tool.
wallabag uses a large number of PHP libraries in order to function. These libraries must be installed with a tool called Composer. You need to install it if you have not already done so and be sure to use the 1.2 version (if you already have Composer, run a ``composer selfupdate``).
Install Composer:

View file

@ -0,0 +1,10 @@
Suite de tests
==============
Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit <https://phpunit.de>`_.
Si vous contribuez au projet (en traduisant l'application, en corrigeant des bugs ou en ajoutant une nouvelle fonctionnalité), merci d'écrire vos propres tests.
Pour lancer la suite de tests de wallabag, vous devez installer `ant <http://ant.apache.org>`_.
Ensuite, exécutez la commande ``make test``.

View file

@ -6,6 +6,9 @@ Pré-requis
wallabag est compatible avec PHP >= 5.5, PHP 7 inclus.
.. note::
Pour installer wallabag facilement, nous avons créé un ``Makefile``, vous avez donc besoin d'avoir installé l'outil ``make``.
wallabag utilise un grand nombre de bibliothèques PHP pour fonctionner. Ces bibliothèques doivent être installées à l'aide d'un outil nommé Composer. Vous devez l'installer si ce n'est déjà fait et vous assurer que vous utilisez bien la version 1.2 (si vous avez déjà Composer, faite un ``composer selfupdate``).
Installation de Composer :

View file

@ -6,6 +6,6 @@ TAG=$(git describe --tags $(git rev-list --tags --max-count=1))
rm -rf var/cache/*
git fetch origin
git fetch --tags
git checkout $TAG
git checkout $TAG --force
SYMFONY_ENV=$ENV composer install --no-dev -o --prefer-dist
php bin/console cache:clear --env=$ENV