Updated the README

Author: dantleech

README.md

@@ -17,130 +17,75 @@ functional test suite:
 composer install --dev
 ````
 
-Bootstrapping
--------------
+PHPUnit configuration
+---------------------
 
-To generate a skeleton bootstrap:
+Copy the `phpunit.dist.xml` file from the testing component to the directory
+root of the bundle:
 
 ````
-$ php vendor/symfony-cmf/testing/bin/generate_functional.php
+cp vendor/symfony-cmf/testing/skeleton/phpunit.xml.dist .
 ````
 
-This generates the following files:
+Note that this file includes the bootstrap file `bootstrap/bootstrap.php`
+which initializes the autoloader and defines some useful PHP constants.
 
-````
-./
-./Tests/Functional/app/AppKernel.php
-./Tests/Functional/app/console
-./Tests/Functional/app/config
-./Tests/Functional/app/config/default.yml
-./Tests/Functional/app/config/parameters.yml.dist
-./Tests/Functional/app/config/dist
-./Tests/Functional/app/config/dist/monolog.yml
-./Tests/Functional/app/config/dist/framework.yml
-./Tests/Functional/app/config/dist/phpcrodm.yml
-./Tests/Functional/app/config/dist/routing.yml
-./Tests/Functional/app/config/dist/doctrine.yml
-./Tests/Functional/app/config/user
-````
-
-You will need to copy `parameters.yml.dist` to `parameters.yml` for the kernel
-to work, the distribution configuration should work out-of-the-box with
-doctrine dbal sqlite.
+Create your configuration class
+-------------------------------
 
-Pull in some other files
-------------------------
+You can include pre-defined configurations from the testing component as
+follows:
 
-The following files are also useful:
+````php
+// YourBundle/Tests/Functional/app/config/config.php
+<?php
 
+$loader->import(CMF_TEST_CONFIG_DIR.'/sonata_admin.php');
 ````
-cp vendor/symfony-cmf/testing/skeleton/.travis.yml .
-cp vendor/symfony-cmf/testing/skeleton/phpunit.dist.xml .
-````
-
-Writing Functional Test Cases
------------------------------
-
-Most of the functional test cases in the CMF currently use PHCR-ODM. This
-component provides a base test case which automatically purges and creates
-the node `/test`. You should place any documents your test will create under
-this node.
-
-Example:
 
-````
-<?php
+We have to use a PHP file to access the `CMF_TEST_CONFIG_DIR` constant
+which is defined in the bootstrap file. Have a look in the 
+`/skeleton/app/config` directory for all possible options.
 
-namespace ...
-use Symfony\Cmf\Component\Testing\Functional\PhpcrOdmTestCase;
+Create the test Kernel
+----------------------
 
-class MyTest extends PhpcrOdmTestCase
-{
-    public function testFooIsCreated()
-    {
-        $foo = new FooDocument;
-        $foo->id = '/test/foo';
-        $this->getDm()->persist($foo);
-        $this->getDm()->clear();
-        $foo = $this->getDm()->find(null, '/test/foo');
+Below is an example test kernel. Note that you extend `TestKernel` and need to
+implement the `configure` method to register any bundles that you need.
 
-        $this->assertNotNull($foo); // will pass
-    }
+You should use the `requireBundleSets` method to register pre-defined sets of
+bundles, e.g. `sonata_admin` will include all the bundles required for a
+standard CMF sonata admin interface.
 
-    public function testFooIsGone()
-    {
-        $foo = $this->getDm()->find(null, '/test/foo');
-        $this->assertNull($foo); // will pass
-    }
-}
-````
+For bundles specific to this test kernel or to the bundle as a whole, use the
+`addBundles` method.
 
-There is also a base test case which is storage layer agnostic:
-
-````
+````php
+// YourBundle/Tests/Functional/app/AppKernel.php
 <?php
 
-namespace ...
-use Symfony\Cmf\Component\Testing\Functional\BaseTestCase;
+use Symfony\Cmf\Component\Testing\HttpKernel\TestKernel;
+use Symfony\Component\Config\Loader\LoaderInterface;
 
-class MyTest extends PhpcrOdmTestCase
+class AppKernel extends TestKernel
 {
-    public function testWhatever()
+    public function configure()
     {
-        $myService = $this->getContainer()->get('foo');
-        $application = $this->getApplication();
+        $this->requireBundleSets(array(
+            'default', 'phpcr_odm', 'sonata_admin'
+        ));
+
+        $this->addBundles(array(
+            new \Knp\Bundle\MenuBundle\KnpMenuBundle(),
+            new \Symfony\Cmf\Bundle\MenuBundle\SymfonyCmfMenuBundle(),
+        ));
     }
-}
-````
-
 
-Changing the Kernel
--------------------
-
-You may want to have a test use a different kernel then the default
-`AppKernel` - for example, you might want to test optional dependencies such
-as SonataAdmin.
-
-To do this simply override `getKernelClassname`:
+    public function registerContainerConfiguration(LoaderInterface $loader)
+    {
+        // Load our configuration
+        $loader->load(__DIR__.'/config/config.php');
+    }
 
-````
-// mytest.php
-public static function getKernelClassname()
-{
-    return 'AlternativeKernel';
 }
 ````
-
-The kernel file `AlternativeKernel.php` must live inside the directory
-`Tests/Functional/app`. We avoid the use of the autoloader to avoid having
-to guess the bundles namespace.
-
-Using the test console
-----------------------
-
-The test console can be invaluable for debugging tests, you can use it as
-follows:
-
-````
-$ php Tests/Functional/app/console
-````

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "symfony-cmf/testing-bootstrap",
+    "name": "symfony-cmf/testing",
     "license": "MIT",
     "description": "Component for bootstraping functional tests for CMF bundles only.",
     "authors": [
@@ -18,9 +18,7 @@
         "doctrine/phpcr-bundle": "1.0.*",
         "doctrine/data-fixtures": "1.0.*",
 
-        "jackalope/jackalope-doctrine-dbal": "1.0.*",
-
-        "instaclick/base-test-bundle": "dev-master"
+        "jackalope/jackalope-doctrine-dbal": "1.0.*"
     },
     "autoload": {
         "psr-0": { "Symfony\\Cmf\\Component\\Testing": "src/" }