From: Nicolas Lœuillet Date: Mon, 10 Oct 2016 07:15:53 +0000 (+0200) Subject: Added documentation about testsuite X-Git-Tag: 2.1.2~21^2~8 X-Git-Url: https://git.immae.eu/?p=github%2Fwallabag%2Fwallabag.git;a=commitdiff_plain;h=84e3c36e02e4ffb4611f6e1eca37c97a0ffb4660 Added documentation about testsuite Fix #2415 --- diff --git a/Makefile b/Makefile index 2a749718..e99367f6 100755 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/docs/de/developer/testsuite.rst b/docs/de/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/de/developer/testsuite.rst @@ -0,0 +1,10 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +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 `_. + +Then, execute this command ``make test``. diff --git a/docs/de/user/installation.rst b/docs/de/user/installation.rst index dc2b8b4d..bee3249b 100644 --- a/docs/de/user/installation.rst +++ b/docs/de/user/installation.rst @@ -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: diff --git a/docs/en/developer/testsuite.rst b/docs/en/developer/testsuite.rst new file mode 100644 index 00000000..b2b16cdc --- /dev/null +++ b/docs/en/developer/testsuite.rst @@ -0,0 +1,10 @@ +Testsuite +========= + +To ensure wallabag development quality, we wrote tests with `PHPUnit `_. + +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 `_. + +Then, execute this command ``make test``. diff --git a/docs/en/user/installation.rst b/docs/en/user/installation.rst index a2f0d07b..0920b976 100644 --- a/docs/en/user/installation.rst +++ b/docs/en/user/installation.rst @@ -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: diff --git a/docs/fr/developer/testsuite.rst b/docs/fr/developer/testsuite.rst new file mode 100644 index 00000000..bd5c68c6 --- /dev/null +++ b/docs/fr/developer/testsuite.rst @@ -0,0 +1,10 @@ +Suite de tests +============== + +Pour assurer la qualité du développement de wallabag, nous avons écrit des tests avec `PHPUnit `_. + +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 `_. + +Ensuite, exécutez la commande ``make test``. diff --git a/docs/fr/user/installation.rst b/docs/fr/user/installation.rst index b47813be..55614d72 100644 --- a/docs/fr/user/installation.rst +++ b/docs/fr/user/installation.rst @@ -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 : diff --git a/scripts/update.sh b/scripts/update.sh index 167e84e1..48281210 100644 --- a/scripts/update.sh +++ b/scripts/update.sh @@ -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