Prototyped behat end-to-end testing

.travis.yml

@@ -14,16 +14,35 @@ cache:
     - $HOME/.composer/cache/files
 
 env:
-  matrix:
-    - TARGET="phpspec"
-    - TARGET="codestyle"
+  global:
+    - EZPLATFORM_REPO="https://github.com/ezsystems/ezplatform.git"
+    - SYMFONY_ENV=behat
+    - SYMFONY_DEBUG=1
+
+matrix:
+  include:
+    - name: "Unit tests with PhpSpec"
+      env:
+        - TARGET="phpspec"
+    - name: "Code style"
+      env:
+        - TARGET="codestyle"
+    - name: "Behat"
+      env:
+        - TARGET="behat"
+        - COMPOSE_FILE="doc/docker/base-dev.yml"
+        - BEHAT_OPTS="--mode=behat --profile=graphql --suite=graphql"
+
+install:
+  - if [ $TARGET == "behat" ]; then ./.travis/prepare_ezplatform.sh ${INSTALL_EZ_INSTALL_TYPE}; fi
 
 before_script:
-  - COMPOSER_MEMORY_LIMIT=-1 composer install
+  - if [ "$TARGET" != "behat" ]; then COMPOSER_MEMORY_LIMIT=-1 composer install; fi
 
 script:
   - if [ "$TARGET" == "phpspec" ] ; then ./vendor/bin/phpspec run --format=pretty; fi
   - if [ "$TARGET" == "codestyle" ] ; then ./vendor/bin/php-cs-fixer fix --dry-run -v --show-progress=estimating; fi
+  - if [ "$TARGET" == "behat" ]; then cd "$HOME/build/ezplatform"; docker-compose exec --user www-data app sh -c "bin/ezbehat ${BEHAT_OPTS}" ; fi
 
 notification:
   email: false

.travis/prepare_ezplatform.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+EZPLATFORM_BRANCH=`php -r 'echo json_decode(file_get_contents("./composer.json"))->extra->_ezplatform_branch_for_behat_tests;'`
+EZPLATFORM_BRANCH="${EZPLATFORM_BRANCH:-master}"
+PACKAGE_BUILD_DIR=$PWD
+EZPLATFORM_BUILD_DIR=${HOME}/build/ezplatform
+
+echo "> Cloning ezsystems/ezplatform:${EZPLATFORM_BRANCH}"
+git clone --depth 1 --single-branch --branch "${EZPLATFORM_BRANCH}" ${EZPLATFORM_REPO} ${EZPLATFORM_BUILD_DIR}
+cd ${EZPLATFORM_BUILD_DIR}
+
+/bin/bash ./bin/.travis/trusty/setup_ezplatform.sh "${COMPOSE_FILE}" '' "${PACKAGE_BUILD_DIR}"

behat_suites.yml

@@ -0,0 +1,17 @@
+# This file is meant to be imported from ezplatform's behat.yml.dist.
+# All path are relative to the root ezplatform directory.
+default:
+    autoload:
+        - '%paths.base%/vendor/ezsystems/ezplatform-graphql/features/bootstrap/'
+
+graphql:
+    suites:
+        graphql:
+            autoload:
+                - '%paths.base%/vendor/ezsystems/ezplatform-graphql/features/bootstrap/'
+            paths:
+                - '%paths.base%/vendor/ezsystems/ezplatform-graphql/features/Generator.feature'
+            contexts:
+                - GeneratorContext
+                - ConfigurationContext
+                - CacheContext

composer.json

@@ -22,7 +22,8 @@
         "overblog/graphiql-bundle": "^0.1",
         "phpspec/phpspec": "^5.1",
         "friendsofphp/php-cs-fixer": "~2.15.1",
-        "mikey179/vfsstream": "^1.6"
+        "mikey179/vfsstream": "^1.6",
+        "behat/behat": "^3.0"
     },
     "autoload": {
         "psr-4": {
@@ -37,8 +38,10 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0.x-dev"
-        }
+            "dev-master": "1.0.x-dev",
+            "dev-tmp_ci_branch": "1.0.x-dev"
+        },
+        "_ezplatform_branch_for_behat_tests": "behat_graphql"
     },
     "scripts": {
         "fix-cs": "@php ./vendor/bin/php-cs-fixer fix -v --show-progress=estimating"

features/Generator.feature

@@ -0,0 +1,11 @@
+Feature: Schema generation
+  In order to use GraphQL
+  As an application maintainer
+  I need to generate the schema
+
+Scenario: An application maintainer generates the schema
+ Given the schema has not been generated
+  When I run the command "ezplatform:graphql:generate-schema"
+  When I clear the cache
+  Then the schema files are generated in "app/config/graphql/ezplatform"
+   And the GraphQL extension is configured to use that schema

features/bootstrap/CacheContext.php

@@ -0,0 +1,51 @@
+<?php
+
+use PHPUnit\Framework\Assert;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\Process\PhpExecutableFinder;
+use Symfony\Component\Process\Process;
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+
+class CacheContext implements \Behat\Symfony2Extension\Context\KernelAwareContext
+{
+    /**
+     * @var \Symfony\Component\HttpKernel\KernelInterface
+     */
+    private $kernel;
+
+    /**
+     * Sets Kernel instance.
+     *
+     * @param \Symfony\Component\HttpKernel\KernelInterface $kernel
+     */
+    public function setKernel(KernelInterface $kernel)
+    {
+        $this->kernel = $kernel;
+    }
+
+    /**
+     * @Given /^I clear the cache$/
+     */
+    public function iClearTheCache()
+    {
+        $application = new \Symfony\Bundle\FrameworkBundle\Console\Application($this->kernel);
+        $application->setAutoExit(false);
+
+        $input = new ArrayInput(['command' => 'cache:clear', '--env' => 'behat']);
+
+        // You can use NullOutput() if you don't need the output
+        $output = new BufferedOutput();
+        Assert::assertEquals(0, $application->run($input, $output));
+        $content = $output->fetch();
+        $this->kernel->shutdown();
+        $this->kernel->boot();
+    }
+}

features/bootstrap/ConfigurationContext.php

@@ -0,0 +1,46 @@
+<?php
+
+use PHPUnit\Framework\Assert;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\Process\PhpExecutableFinder;
+use Symfony\Component\Process\Process;
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+
+class ConfigurationContext implements \Behat\Symfony2Extension\Context\KernelAwareContext
+{
+    /**
+     * @var \Symfony\Component\HttpKernel\KernelInterface
+     */
+    private $kernel;
+
+    /**
+     * Sets Kernel instance.
+     *
+     * @param \Symfony\Component\HttpKernel\KernelInterface $kernel
+     */
+    public function setKernel(KernelInterface $kernel)
+    {
+        $this->kernel = $kernel;
+    }
+
+    /**
+     * @Given /^the GraphQL extension is configured to use that schema$/
+     */
+    public function theGraphQLExtensionIsConfiguredToUseThatSchema()
+    {
+        $container = $this->kernel->getContainer();
+        $executor = $container->get('overblog_graphql.request_executor');
+        $schema = $executor->getSchema('default');
+        Assert::assertEquals('Domain', (string)$schema->getQueryType());
+        Assert::assertEquals('DomainContentMutation', (string)$schema->getMutationType());
+    }
+
+}

features/bootstrap/GeneratorContext.php

@@ -0,0 +1,77 @@
+<?php
+
+use PHPUnit\Framework\Assert;
+use Symfony\Bundle\FrameworkBundle\Console\Application;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Output\BufferedOutput;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Filesystem\Filesystem;
+use Symfony\Component\HttpKernel\KernelInterface;
+use Symfony\Component\Process\PhpExecutableFinder;
+use Symfony\Component\Process\Process;
+
+/**
+ * @copyright Copyright (C) eZ Systems AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+
+class GeneratorContext implements \Behat\Symfony2Extension\Context\KernelAwareContext
+{
+    /**
+     * @var string
+     */
+    private $scriptOutput;
+
+    /**
+     * @var \Symfony\Component\HttpKernel\KernelInterface
+     */
+    private $kernel;
+
+    /**
+     * @When /^I run the command "([^"]+)"$/
+     */
+    public function iRunTheCommand($command)
+    {
+        $application = new Application($this->kernel);
+        $application->setAutoExit(false);
+
+        $input = new ArrayInput(['command' => $command, '--env' => 'behat']);
+
+        $output = new BufferedOutput();
+        $application->run($input, $output);
+
+        $content = $output->fetch();
+    }
+
+    /**
+     * @Then /^the schema files are generated in "([^"]*)"$/
+     */
+    public function theSchemaFilesAreGeneratedIn($directory)
+    {
+        $finder = new Finder();
+        Assert::assertFileExists('app/config/graphql/ezplatform/Domain.types.yml');
+        Assert::assertFileExists('app/config/graphql/ezplatform/DomainContentMutation.types.yml');
+    }
+
+    /**
+     * @Given /^the schema has not been generated$/
+     */
+    public function theSchemaHasNotBeenGenerated()
+    {
+        if (file_exists('app/config/graphql/ezplatform')) {
+            $finder = new Finder();
+            $fs = new Filesystem();
+            $fs->remove($finder->in('app/config/graphql/ezplatform')->files());
+        }
+    }
+
+    /**
+     * Sets Kernel instance.
+     *
+     * @param \Symfony\Component\HttpKernel\KernelInterface $kernel
+     */
+    public function setKernel(KernelInterface $kernel)
+    {
+        $this->kernel = $kernel;
+    }
+}