Cover magento/module-admin-analytics with unit tests

app/code/Magento/AdminAnalytics/Controller/Adminhtml/Config/DisableAdminUsage.php

@@ -7,16 +7,16 @@
 
 namespace Magento\AdminAnalytics\Controller\Adminhtml\Config;
 
+use Magento\AdminAnalytics\Model\ResourceModel\Viewer\Logger as NotificationLogger;
 use Magento\Backend\App\Action;
+use Magento\Config\Model\Config\Factory;
 use Magento\Framework\App\Action\HttpPostActionInterface;
-use Magento\Framework\Controller\ResultFactory;
-use Magento\AdminAnalytics\Model\ResourceModel\Viewer\Logger as NotificationLogger;
 use Magento\Framework\App\ProductMetadataInterface;
+use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Controller\ResultInterface;
-use Magento\Config\Model\Config\Factory;
 
 /**
- * Controller to record Admin analytics usage log
+ * Controller to record Admin analytics usage log.
  */
 class DisableAdminUsage extends Action implements HttpPostActionInterface
 {
@@ -56,7 +56,26 @@ public function __construct(
     }
 
     /**
-     * Change the value of config/admin/usage/enabled
+     * Log information about the last shown advertisement.
+     *
+     * @return ResultInterface
+     */
+    public function execute()
+    {
+        $this->disableAdminUsage();
+        $this->markUserNotified();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function _isAllowed()
+    {
+        return $this->_authorization->isAllowed(static::ADMIN_RESOURCE);
+    }
+
+    /**
+     * Change the value of config/admin/usage/enabled.
      */
     private function disableAdminUsage()
     {
@@ -66,7 +85,7 @@ private function disableAdminUsage()
     }
 
     /**
-     * Log information about the last admin usage selection
+     * Log information about the last admin usage selection.
      *
      * @return ResultInterface
      */
@@ -80,25 +99,7 @@ private function markUserNotified(): ResultInterface
         ];
 
         $resultJson = $this->resultFactory->create(ResultFactory::TYPE_JSON);
-        return $resultJson->setData($responseContent);
-    }
 
-    /**
-     * Log information about the last shown advertisement
-     *
-     * @return ResultInterface
-     */
-    public function execute()
-    {
-        $this->disableAdminUsage();
-        $this->markUserNotified();
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected function _isAllowed()
-    {
-        return $this->_authorization->isAllowed(static::ADMIN_RESOURCE);
+        return $resultJson->setData($responseContent);
     }
 }

app/code/Magento/AdminAnalytics/Controller/Adminhtml/Config/EnableAdminUsage.php

@@ -7,16 +7,16 @@
 
 namespace Magento\AdminAnalytics\Controller\Adminhtml\Config;
 
+use Magento\AdminAnalytics\Model\ResourceModel\Viewer\Logger as NotificationLogger;
 use Magento\Backend\App\Action;
+use Magento\Config\Model\Config\Factory;
 use Magento\Framework\App\Action\HttpPostActionInterface;
-use Magento\Framework\Controller\ResultFactory;
-use Magento\AdminAnalytics\Model\ResourceModel\Viewer\Logger as NotificationLogger;
 use Magento\Framework\App\ProductMetadataInterface;
+use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Controller\ResultInterface;
-use Magento\Config\Model\Config\Factory;
 
 /**
- * Controller to record that the current admin user has responded to Admin Analytics notice
+ * Controller to record that the current admin user has responded to Admin Analytics notice.
  */
 class EnableAdminUsage extends Action implements HttpPostActionInterface
 {
@@ -54,7 +54,26 @@ public function __construct(
     }
 
     /**
-     * Change the value of config/admin/usage/enabled
+     * Log information about the last shown advertisement.
+     *
+     * @return \Magento\Framework\Controller\ResultInterface
+     */
+    public function execute()
+    {
+        $this->enableAdminUsage();
+        $this->markUserNotified();
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function _isAllowed()
+    {
+        return $this->_authorization->isAllowed(static::ADMIN_RESOURCE);
+    }
+
+    /**
+     * Change the value of config/admin/usage/enabled.
      */
     private function enableAdminUsage()
     {
@@ -64,7 +83,7 @@ private function enableAdminUsage()
     }
 
     /**
-     * Log information about the last user response
+     * Log information about the last user response.
      *
      * @return ResultInterface
      */
@@ -78,25 +97,7 @@ private function markUserNotified(): ResultInterface
         ];
 
         $resultJson = $this->resultFactory->create(ResultFactory::TYPE_JSON);
-        return $resultJson->setData($responseContent);
-    }
 
-    /**
-     * Log information about the last shown advertisement
-     *
-     * @return \Magento\Framework\Controller\ResultInterface
-     */
-    public function execute()
-    {
-        $this->enableAdminUsage();
-        $this->markUserNotified();
-    }
-
-    /**
-     * @inheritDoc
-     */
-    protected function _isAllowed()
-    {
-        return $this->_authorization->isAllowed(static::ADMIN_RESOURCE);
+        return $resultJson->setData($responseContent);
     }
 }

app/code/Magento/AdminAnalytics/Model/Condition/CanViewNotification.php

@@ -8,8 +8,8 @@
 namespace Magento\AdminAnalytics\Model\Condition;
 
 use Magento\AdminAnalytics\Model\ResourceModel\Viewer\Logger;
-use Magento\Framework\View\Layout\Condition\VisibilityConditionInterface;
 use Magento\Framework\App\CacheInterface;
+use Magento\Framework\View\Layout\Condition\VisibilityConditionInterface;
 
 /**
  * Dynamic validator for UI admin analytics notification, control UI component visibility.
@@ -24,7 +24,7 @@ class CanViewNotification implements VisibilityConditionInterface
     private static $conditionName = 'can_view_admin_usage_notification';
 
     /**
-     * Prefix for cache
+     * Prefix for cache.
      *
      * @var string
      */
@@ -53,7 +53,7 @@ public function __construct(
     }
 
     /**
-     * Validate if notification popup can be shown and set the notification flag
+     * Validate if notification popup can be shown and set the notification flag.
      *
      * @param array $arguments Attributes from element node.
      * @inheritdoc
@@ -67,13 +67,15 @@ public function isVisible(array $arguments): bool
             if ($logExists) {
                 $this->cacheStorage->save('log-exists', $cacheKey);
             }
+
             return !$logExists;
         }
+
         return false;
     }
 
     /**
-     * Get condition name
+     * Get condition name.
      *
      * @return string
      */

app/code/Magento/AdminAnalytics/Model/ResourceModel/Viewer/Logger.php

@@ -19,7 +19,7 @@
 class Logger
 {
     /**
-     * Admin Analytics usage version log table name
+     * Admin Analytics usage version log table name.
      */
     const LOG_TABLE_NAME = 'admin_analytics_usage_version_log';
 
@@ -64,6 +64,7 @@ public function log(string $lastViewVersion): bool
                 'last_viewed_in_version',
             ]
         );
+
         return true;
     }
 
@@ -80,17 +81,18 @@ public function get(): Log
     /**
      * Checks is log already exists.
      *
-     * @return boolean
+     * @return bool
      */
     public function checkLogExists(): bool
     {
         $data = $this->logFactory->create(['data' => $this->loadLatestLogData()]);
         $lastViewedVersion = $data->getLastViewVersion();
+
         return isset($lastViewedVersion);
     }
 
     /**
-     * Load release notification viewer log data by last view version
+     * Load release notification viewer log data by last view version.
      *
      * @return array
      */
@@ -106,6 +108,7 @@ private function loadLatestLogData(): array
         if (!$data) {
             $data = [];
         }
+
         return $data;
     }
 }

app/code/Magento/AdminAnalytics/Model/Viewer/Log.php

@@ -10,12 +10,12 @@
 use Magento\Framework\DataObject;
 
 /**
- * Admin Analytics log resource
+ * Admin Analytics log resource.
  */
 class Log extends DataObject
 {
     /**
-     * Get log id
+     * Get log id.
      *
      * @return int
      */
@@ -25,7 +25,7 @@ public function getId() : ?int
     }
 
     /**
-     * Get last viewed product version
+     * Get last viewed product version.
      *
      * @return string
      */

app/code/Magento/AdminAnalytics/Test/Unit/Condition/CanViewNotificationTest.php

@@ -11,7 +11,6 @@
 use Magento\AdminAnalytics\Model\ResourceModel\Viewer\Logger;
 use Magento\AdminAnalytics\Model\Viewer\Log;
 use Magento\Framework\App\CacheInterface;
-use Magento\Framework\App\ProductMetadataInterface;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -21,31 +20,28 @@ class CanViewNotificationTest extends TestCase
     /** @var CanViewNotification */
     private $canViewNotification;
 
-    /** @var  Logger|MockObject */
+    /** @var Logger|MockObject */
     private $viewerLoggerMock;
 
-    /** @var ProductMetadataInterface|MockObject */
-    private $productMetadataMock;
+    /** @var CacheInterface|MockObject */
+    private $cacheStorageMock;
 
-    /** @var  Log|MockObject */
+    /** @var Log|MockObject */
     private $logMock;
 
-    /** @var MockObject|CacheInterface $cacheStorageMock */
-    private $cacheStorageMock;
-
     protected function setUp(): void
     {
+        $this->viewerLoggerMock = $this->createMock(Logger::class);
         $this->cacheStorageMock = $this->getMockBuilder(CacheInterface::class)
             ->getMockForAbstractClass();
+
         $this->logMock = $this->createMock(Log::class);
-        $this->viewerLoggerMock = $this->createMock(Logger::class);
-        $this->productMetadataMock = $this->getMockForAbstractClass(ProductMetadataInterface::class);
+
         $objectManager = new ObjectManager($this);
         $this->canViewNotification = $objectManager->getObject(
             CanViewNotification::class,
             [
                 'viewerLogger' => $this->viewerLoggerMock,
-                'productMetadata' => $this->productMetadataMock,
                 'cacheStorage' => $this->cacheStorageMock,
             ]
         );
@@ -55,6 +51,7 @@ protected function setUp(): void
      * @param $expected
      * @param $cacheResponse
      * @param $logExists
+     *
      * @dataProvider isVisibleProvider
      */
     public function testIsVisibleLoadDataFromLog($expected, $cacheResponse, $logExists)
@@ -72,6 +69,13 @@ public function testIsVisibleLoadDataFromLog($expected, $cacheResponse, $logExis
         $this->assertEquals($expected, $this->canViewNotification->isVisible([]));
     }
 
+    public function testGetName()
+    {
+        $result = $this->canViewNotification->getName();
+
+        $this->assertSame('can_view_admin_usage_notification', $result);
+    }
+
     /**
      * @return array
      */