Refactored extension namespacing and added support for BEHAT_SCREENSH…

…OT_DIR variable. * Updated config requirements. * Refactored extension classes to use simplified loading. * Added dist behat config. * Added support for BEHAT_SCREENSHOT_DIR env variable.
drevops · Jun 28, 2017 · 5af005a · 5af005a
1 parent 4714bd2
commit 5af005a
Show file tree

Hide file tree

Showing 10 changed files with 126 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -23,10 +23,10 @@ default:
   suites:
     default:
       contexts:
-        - IntegratedExperts\Behat\Screenshot\Context\ScreenshotContext
+        - IntegratedExperts\BehatScreenshotExtension\Context\ScreenshotContext
         - FeatureContext
   extensions:
-    IntegratedExperts\Behat\Screenshot\ScreenshotExtension:
+    IntegratedExperts\BehatScreenshotExtension:
       dir: %paths.base%/screenshots
       fail: true
       purge: false

diff --git a/behat.yml b/behat.yml
@@ -7,7 +7,7 @@ default:
         - IntegratedExperts\BehatPhpServer\PhpServerContext:
           -
             docroot: %paths.base%/tests/behat/features/fixtures
-        - IntegratedExperts\Behat\Screenshot\Context\ScreenshotContext
+        - IntegratedExperts\BehatScreenshotExtension\Context\ScreenshotContext
         - FeatureContext:
           -
             screenshot_dir: %paths.base%/screenshots
@@ -17,7 +17,7 @@ default:
       files_path: %paths.base%/tests/behat/features/fixtures
       selenium2: ~
       browser_name: chrome
-    IntegratedExperts\Behat\Screenshot\ScreenshotExtension:
+    IntegratedExperts\BehatScreenshotExtension:
       dir: %paths.base%/screenshots
       fail: false
-      purge: true
+      purge: true
diff --git a/behat.yml.dist b/behat.yml.dist
@@ -0,0 +1,11 @@
+default:
+  suites:
+    default:
+      contexts:
+        - FeatureContext
+        - IntegratedExperts\BehatScreenshotExtension\Context\ScreenshotContext
+  extensions:
+    IntegratedExperts\BehatScreenshotExtension:
+      dir: %paths.base%/screenshots
+      fail: true
+      purge: false
diff --git a/composer.json b/composer.json
@@ -29,7 +29,7 @@
   },
   "autoload": {
     "psr-0": {
-      "IntegratedExperts\\Behat\\Screenshot": "src/"
+      "IntegratedExperts\\BehatScreenshot": "src/"
     }
   },
   "scripts": {

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -10,5 +10,8 @@
   <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace">
     <exclude-pattern>./tests/*</exclude-pattern>
   </rule>
+  <rule ref="Symfony2.NamingConventions.ValidClassName.InvalidInterfaceName">
+    <exclude-pattern>.*context.*</exclude-pattern>
+  </rule>
 
 </ruleset>
diff --git a/src/IntegratedExperts/Behat/Screenshot/ScreenshotExtension.php b/src/IntegratedExperts/Behat/Screenshot/ScreenshotExtension.php
diff --git a/...tializer/ScreenshotContextInitializer.php → ...tializer/ScreenshotContextInitializer.php b/...tializer/ScreenshotContextInitializer.php → ...tializer/ScreenshotContextInitializer.php
@@ -4,11 +4,11 @@
  * This file is part of the IntegratedExperts\BehatScreenshot package.
  */
 
-namespace IntegratedExperts\Behat\Screenshot\Context\Initializer;
+namespace IntegratedExperts\BehatScreenshotExtension\Context\Initializer;
 
 use Behat\Behat\Context\Context;
 use Behat\Behat\Context\Initializer\ContextInitializer;
-use IntegratedExperts\Behat\Screenshot\Context\ScreenshotContextInterface;
+use IntegratedExperts\BehatScreenshotExtension\Context\ScreenshotAwareContext;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
 
@@ -23,28 +23,28 @@ class ScreenshotContextInitializer implements ContextInitializer
      *
      * @var string
      */
-    private $dir;
+    protected $dir;
 
     /**
      * Makes screenshot when fail.
      *
      * @var bool
      */
-    private $fail;
+    protected $fail;
 
     /**
      * Purge dir before start test.
      *
      * @var bool
      */
-    private $purge;
+    protected $purge;
 
     /**
-     * Does need to clear directory trigger.
+     * Check if need to actually purge.
      *
      * @var bool
      */
-    private $toPurge;
+    protected $needsPurging;
 
     /**
      * ScreenshotContextInitializer constructor.
@@ -55,7 +55,7 @@ class ScreenshotContextInitializer implements ContextInitializer
      */
     public function __construct($dir, $fail, $purge)
     {
-        $this->toPurge = true;
+        $this->needsPurging = true;
         $this->dir = $dir;
         $this->fail = $fail;
         $this->purge = $purge;
@@ -66,12 +66,12 @@ public function __construct($dir, $fail, $purge)
      */
     public function initializeContext(Context $context)
     {
-        if ($context instanceof ScreenshotContextInterface) {
-            $context->setParameters($this->dir, $this->fail);
-            // Calling clearing screenshot directory function.
-            if ($this->purge && $this->toPurge) {
+        if ($context instanceof ScreenshotAwareContext) {
+            $dir = $this->resolveDir();
+            $context->setScreenshotParameters($dir, $this->fail);
+            if ($this->purge && $this->needsPurging) {
                 $this->purgeFilesInDir();
-                $this->toPurge = false;
+                $this->needsPurging = false;
             }
         }
     }
@@ -87,4 +87,17 @@ protected function purgeFilesInDir()
             $fs->remove($finder->files()->in($this->dir));
         }
     }
+
+    /**
+     * Resolve directory using one of supported paths.
+     */
+    protected function resolveDir()
+    {
+        $dir = getenv('BEHAT_SCREENSHOT_DIR');
+        if (!empty($dir)) {
+            return $dir;
+        }
+
+        return $this->dir;
+    }
 }
diff --git a/...ot/Context/ScreenshotContextInterface.php → ...ension/Context/ScreenshotAwareContext.php b/...ot/Context/ScreenshotContextInterface.php → ...ension/Context/ScreenshotAwareContext.php
@@ -5,14 +5,14 @@
  * Behat context interface to enable Screenshot.
  */
 
-namespace IntegratedExperts\Behat\Screenshot\Context;
+namespace IntegratedExperts\BehatScreenshotExtension\Context;
 
 use Behat\Behat\Context\Context;
 
 /**
  * Interface ScreenshotContext.
  */
-interface ScreenshotContextInterface extends Context
+interface ScreenshotAwareContext extends Context
 {
 
     /**
@@ -23,5 +23,5 @@ interface ScreenshotContextInterface extends Context
      *
      * @return $this
      */
-    public function setParameters($dir, $fail);
+    public function setScreenshotParameters($dir, $fail);
 }
diff --git a/.../Screenshot/Context/ScreenshotContext.php → ...otExtension/Context/ScreenshotContext.php b/.../Screenshot/Context/ScreenshotContext.php → ...otExtension/Context/ScreenshotContext.php
@@ -5,7 +5,7 @@
  * Behat context to enable Screenshot support in tests.
  */
 
-namespace IntegratedExperts\Behat\Screenshot\Context;
+namespace IntegratedExperts\BehatScreenshotExtension\Context;
 
 use Behat\Behat\Context\SnippetAcceptingContext;
 use Behat\Behat\Hook\Scope\AfterStepScope;
@@ -18,7 +18,7 @@
 /**
  * Class ScreenshotContext.
  */
-class ScreenshotContext extends RawMinkContext implements SnippetAcceptingContext, ScreenshotContextInterface
+class ScreenshotContext extends RawMinkContext implements SnippetAcceptingContext, ScreenshotAwareContext
 {
 
     /**
@@ -52,7 +52,7 @@ class ScreenshotContext extends RawMinkContext implements SnippetAcceptingContex
     /**
      * {@inheritdoc}
      */
-    public function setParameters($dir, $fail)
+    public function setScreenshotParameters($dir, $fail)
     {
         $this->dir = $dir;
         $this->fail = $fail;

diff --git a/src/IntegratedExperts/BehatScreenshotExtension/ServiceContainer/BehatScreenshotExtension.php b/src/IntegratedExperts/BehatScreenshotExtension/ServiceContainer/BehatScreenshotExtension.php
@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * @file
+ * Behat screenshot extension.
+ */
+
+namespace IntegratedExperts\BehatScreenshotExtension\ServiceContainer;
+
+use Behat\Behat\Context\ServiceContainer\ContextExtension;
+use Behat\Testwork\ServiceContainer\Extension as ExtensionInterface;
+use Behat\Testwork\ServiceContainer\ExtensionManager;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+/**
+ * Class ScreenshotExtension
+ */
+class BehatScreenshotExtension implements ExtensionInterface
+{
+
+    /**
+     * Extension configuration ID.
+     */
+    const MOD_ID = 'integratedexperts_screenshot';
+
+    /**
+     * {@inheritdoc}
+     */
+    public function process(ContainerBuilder $container)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfigKey()
+    {
+        return self::MOD_ID;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function initialize(ExtensionManager $extensionManager)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function configure(ArrayNodeDefinition $builder)
+    {
+        $builder->children()
+            ->scalarNode('dir')->isRequired()->cannotBeEmpty()->end()
+            ->scalarNode('fail')->isRequired()->cannotBeEmpty()->end()
+            ->scalarNode('purge')->isRequired()->cannotBeEmpty()->end();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function load(ContainerBuilder $container, array $config)
+    {
+        $definition = new Definition('IntegratedExperts\BehatScreenshotExtension\Context\Initializer\ScreenshotContextInitializer', [
+            $config['dir'],
+            $config['fail'],
+            $config['purge'],
+        ]);
+        $definition->addTag(ContextExtension::INITIALIZER_TAG, ['priority' => 0]);
+        $container->setDefinition('integratedexperts_screenshot.screenshot_context_initializer', $definition);
+    }
+}