MAGETWO-64523: Add static test on forbidden "final" keyword and eliminate it usage in code

 - covered with unit test
 - applied code location rules
 - added copyright

Author: Volodymyr Kublytskyi

dev/tests/static/framework/Magento/CodeMessDetector/src/Rule/Design/FinalImplementation.php renamed to dev/tests/static/framework/Magento/CodeMessDetector/Rule/Design/FinalImplementation.php

@@ -27,4 +27,4 @@ public function apply(AbstractNode $node)
             $this->addViolation($node, [$node->getType(), $node->getFullQualifiedName()]);
         }
     }
-}
+}

dev/tests/static/framework/Magento/CodeMessDetector/Test/Unit/Rule/Design/FinalImplementationTest.php

@@ -0,0 +1,128 @@
+<?php
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\CodeMessDetector\Test\Unit\Rule\Design;
+
+use PHPUnit_Framework_TestCase as TestCase;
+use PHPUnit_Framework_MockObject_MockObject as MockObject;
+use PHPUnit_Framework_MockObject_Matcher_InvokedRecorder as InvokedRecorder;
+use PHPUnit_Framework_MockObject_Builder_InvocationMocker as InvocationMocker;
+use Magento\CodeMessDetector\Rule\Design\FinalImplementation;
+use PHPMD\Report;
+use PHPMD\AbstractNode;
+use PHPMD\Node\ClassNode;
+use PHPMD\Node\MethodNode;
+use BadMethodCallException;
+
+class FinalImplementationTest extends TestCase
+{
+    /**
+     * @param string $nodeType
+     *
+     * @dataProvider finalizableNodeTypesProvider
+     */
+    public function testRuleNotAppliesToNotFinalFinalizable($nodeType)
+    {
+        $finalizableNode = $this->createFinalizableNodeMock($nodeType);
+        $finalizableNode->method('isFinal')->willReturn(false);
+
+        $rule = new FinalImplementation();
+        $this->expectsRuleViolation($rule, $this->never());
+        $rule->apply($finalizableNode);
+    }
+
+    /**
+     * @param string $nodeType
+     *
+     * @dataProvider finalizableNodeTypesProvider
+     */
+    public function testRuleAppliesToFinalFinalizable($nodeType)
+    {
+        $finalizableNode = $this->createFinalizableNodeMock($nodeType);
+        $finalizableNode->method('isFinal')->willReturn(true);
+
+        $rule = new FinalImplementation();
+        $this->expectsRuleViolation($rule, $this->once());
+        $rule->apply($finalizableNode);
+    }
+
+    /**
+     * @param string $nodeType
+     *
+     * @dataProvider finalizableNodeTypesProvider
+     */
+    public function testRuleVerifiesFinalizableNodes($nodeType)
+    {
+        $finalizableNode = $this->createFinalizableNodeMock($nodeType);
+
+        $finalizableNode->expects($this->atLeastOnce())
+            ->method('isFinal');
+
+        $rule = new FinalImplementation();
+        $rule->apply($finalizableNode);
+    }
+
+    /**
+     * @expectedException BadMethodCallException
+     */
+    public function testRuleFailsOnNotFinalizableNodes()
+    {
+        $someNode = $this->getMockBuilder(AbstractNode::class)
+            ->disableOriginalConstructor()
+            ->getMockForAbstractClass();
+
+        $rule = new FinalImplementation();
+        $rule->apply($someNode);
+    }
+
+    /**
+     * "final" keyword may be applied only to classes and methods
+     *
+     * @return array
+     */
+    public function finalizableNodeTypesProvider()
+    {
+        return [
+            [ClassNode::class],
+            [MethodNode::class],
+        ];
+    }
+
+    /**
+     * If node is finalizable it has "isFinal" magic PHP method
+     *
+     * @param string $nodeType
+     * @return ClassNode|MethodNode|MockObject
+     */
+    private function createFinalizableNodeMock($nodeType)
+    {
+        $finalizableNode = $this->getMockBuilder($nodeType)
+            ->disableOriginalConstructor()
+            ->disableProxyingToOriginalMethods()
+            ->setMethods([
+                'isFinal',
+                // disable name lookup from AST artifact
+                'getNamespaceName',
+                'getParentName',
+                'getName',
+            ])
+            ->getMock();
+        return $finalizableNode;
+    }
+
+    /**
+     * @param FinalImplementation $rule
+     * @param InvokedRecorder $violationExpectation
+     * @return InvocationMocker
+     */
+    private function expectsRuleViolation(FinalImplementation $rule, InvokedRecorder $violationExpectation)
+    {
+        $report = $this->getMockBuilder(Report::class)->getMock();
+        $invokation = $report->expects($violationExpectation)->method('addRuleViolation');
+        $rule->setReport($report);
+        return $invokation;
+    }
+}

dev/tests/static/framework/Magento/CodeMessDetector/resources/rulesets/design.xml

@@ -1,4 +1,10 @@
 <?xml version="1.0"?>
+<!--
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+-->
 <ruleset name="Magento Specific Design Rules"
          xmlns="http://pmd.sf.net/ruleset/1.0.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

dev/tests/static/framework/autoload.php

@@ -18,7 +18,7 @@
         $testsBaseDir . '/../integration/framework/Magento/TestFramework/',
     ]
 );
-$autoloadWrapper->addPsr4('Magento\\CodeMessDetector\\', $testsBaseDir . '/framework/Magento/CodeMessDetector/src');
+$autoloadWrapper->addPsr4('Magento\\CodeMessDetector\\', $testsBaseDir . '/framework/Magento/CodeMessDetector');
 
 $generatedCode = DirectoryList::getDefaultConfig()[DirectoryList::GENERATED_CODE][DirectoryList::PATH];
 $autoloadWrapper->addPsr4('Magento\\', $baseDir . '/' . $generatedCode . '/Magento/');