MC-36802: SVC doesn't catch MINOR change in PATCH release when adding @api to a class

Author: zakdma

src/ClassHierarchy/Entity.php

@@ -124,7 +124,7 @@ public function __construct(string $name, string $type)
      */
     public function isApi(): bool
     {
-        return $this->isApi;
+        return (bool)$this->isApi;
     }
 
     /**

src/Helper/Node.php

@@ -10,8 +10,8 @@
 namespace Magento\SemanticVersionChecker\Helper;
 
 use Magento\SemanticVersionChecker\SemanticVersionChecker;
+use PhpParser\Comment\Doc as DocComment;
 use PhpParser\Node as PhpNode;
-use PhpParser\Node\Stmt\TraitUse;
 
 /**
  * Implements a helper that deals with nodes.
@@ -26,9 +26,18 @@ class Node
      */
     public function isApiNode(PhpNode $node)
     {
-        $comment = $node->getAttribute('comments');
+        $comments = $node->getAttribute('comments');
 
-        return isset($comment[0])
-               && strpos($comment[0]->getText(), SemanticVersionChecker::ANNOTATION_API) !== false;
+        $result = false;
+        if (is_array($comments) && !empty($comments)) {
+            foreach ($comments as $comment) {
+                if ($comment instanceof DocComment) {
+                    $result = $result || (strpos($comment->getText(),
+                                SemanticVersionChecker::ANNOTATION_API) !== false);
+                }
+            }
+        }
+
+        return $result;
     }
 }

tests/Unit/Console/Command/CompareSourceCommandApiClassesTest.php

@@ -479,6 +479,14 @@ public function changesDataProvider()
                 ],
                 'Major change is detected.',
             ],
+            'api-annotation-not-changed' => [
+                $pathToFixtures . '/annotation-not-changed/source-code-before',
+                $pathToFixtures . '/annotation-not-changed/source-code-after',
+                [
+                    'Suggested semantic versioning change: NONE',
+                ],
+                'Patch change is detected.',
+            ],
         ];
     }
 }

tests/Unit/Console/Command/CompareSourceCommandApiInterfacesTest.php

@@ -250,6 +250,14 @@ public function changesDataProvider()
                 ],
                 'Major change is detected.',
             ],
+            'api-annotation-not-changed' => [
+                $pathToFixtures . '/annotation-not-changed/source-code-before',
+                $pathToFixtures . '/annotation-not-changed/source-code-after',
+                [
+                    'Suggested semantic versioning change: NONE',
+                ],
+                'Patch change is detected.',
+            ],
         ];
     }
 }

tests/Unit/Console/Command/CompareSourceCommandTest/_files/api-class/annotation-not-changed/source-code-after/TestClass.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ *
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs;
+
+// phpcs:disable Magento2.Classes.AbstractApi
+/**
+ * Test class
+ *
+ * @api
+ */
+class TestClass
+{
+
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/api-class/annotation-not-changed/source-code-before/TestClass.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ *
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs;
+
+/**
+ * Test class
+ *
+ * @api
+ */
+class TestClass
+{
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/api-interface/annotation-not-changed/source-code-after/TestInterface.php

@@ -0,0 +1,17 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs;
+
+// phpcs:disable Magento2.Classes.AbstractApi
+/**
+ * Test interface
+ *
+ * @api
+ */
+interface TestInterface
+{
+
+}

tests/Unit/Console/Command/CompareSourceCommandTest/_files/api-interface/annotation-not-changed/source-code-before/TestInterface.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Test\Vcs;
+
+/**
+ * Test interface
+ *
+ * @api
+ */
+interface TestInterface
+{
+
+}