Version 1
[yaffs-website] / vendor / drush / drush / tests / README.md
diff --git a/vendor/drush/drush/tests/README.md b/vendor/drush/drush/tests/README.md
new file mode 100644 (file)
index 0000000..b86e0da
--- /dev/null
@@ -0,0 +1,29 @@
+Drush's test suite is based on [PHPUnit](http://www.phpunit.de). In order to maintain
+high quality, our tests are run on every push by [Travis](https://travis-ci.org/drush-ops/drush)
+
+Usage
+--------
+1. Review the configuration settings in [tests/phpunit.xml.dist](phpunit.xml.dist). If customization is needed, copy to phpunit.xml and edit away.
+1. Run unit tests: `unish.sh`
+
+Advanced usage
+---------
+- Run only tests matching a regex: `unish.sh --filter=testVersionString`
+- Skip slow tests (usually those with network usage): `unish.sh --exclude-group slow`
+- XML results: `unish.sh --filter=testVersionString --log-junit results.xml`
+- Use an alternate version of Drupal: `UNISH_DRUPAL_MAJOR_VERSION=8 unish.sh ...`
+- Skip teardown (to examine test sites after a failure): `UNISH_DIRTY=1 unish.sh ...`
+
+Reuse by Drush Commandfiles
+-----------
+Drush commandfiles are encouraged to ship with PHPUnit test cases that
+extend UnitUnishTestCase and CommandUnishTestCase. In order to run
+the tests, you have to point to the phpunit.xml file that used by Drush.
+The devel project has a wrapper script which demonstrates this -
+http://drupalcode.org/project/devel.git/blob/refs/heads/8.x-1.x:/run-tests-drush.sh
+
+Cache
+-----------
+In order to speed up test runs, Unish (the Drush testing class) caches built Drupal sites
+and restores them as requested by tests. Once in while, you might need to clear this cache
+by deleting the <tmp>/drush-cache directory.