MTA-3952: Refactoring comments history block in Order module

Author: VasylKozyrenko

dev/tests/functional/tests/app/Magento/Braintree/Test/Constraint/AssertTransactionIsPresentInSettlementReport.php

@@ -11,7 +11,7 @@
 use Magento\Sales\Test\Page\Adminhtml\SalesOrderView;
 
 /**
- * Class AssertTransactionIsPresentInSettlementReport
+ * Assert that comment with transaction id exists in Comments History section on order page in Admin.
  */
 class AssertTransactionIsPresentInSettlementReport extends AbstractConstraint
 {
@@ -26,6 +26,8 @@ class AssertTransactionIsPresentInSettlementReport extends AbstractConstraint
     private $settlementReportIndex;
 
     /**
+     * Assert that comment with transaction id exists in Comments History section on order page in Admin.
+     *
      * @param $orderId
      * @param OrderIndex $orderIndex
      * @param SalesOrderView $salesOrderView
@@ -58,23 +60,28 @@ public function processAssert(
     }
 
     /**
-     * @inheritdoc
+     * Returns a string representation of the object.
+     *
+     * @return string
      */
     public function toString()
     {
         return 'Transaction is present in settlement report.';
     }
 
     /**
-     * Get transaction id from order comments
-     * @return mixed
+     * Get transaction id from order comments.
+     *
+     * @return null|string
      */
     private function getTransactionId()
     {
-        $comments = $this->salesOrderView->getOrderHistoryBlock()->getCommentsHistory();
+        /** @var \Magento\Sales\Test\Block\Adminhtml\Order\View\Tab\Info $infoTab */
+        $infoTab = $this->salesOrderView->getOrderForm()->openTab('info')->getTab('info');
+        $latestComment = $infoTab->getCommentsHistoryBlock()->getLatestComment();
         $transactionId = null;
 
-        preg_match('/(\w+-*\w+)"/', $comments, $matches);
+        preg_match('/(\w+-*\w+)"/', $latestComment['comment'], $matches);
         if (!empty($matches[1])) {
             $transactionId = $matches[1];
         }

dev/tests/functional/tests/app/Magento/Sales/Test/Block/Adminhtml/Order/History.php

@@ -7,6 +7,7 @@
 namespace Magento\Sales\Test\Block\Adminhtml\Order\View\Tab;
 
 use Magento\Backend\Test\Block\Widget\Tab;
+use Magento\Sales\Test\Block\Adminhtml\Order\View\Tab\Info\CommentsHistoryBlock;
 use Magento\Sales\Test\Block\Adminhtml\Order\View\Tab\Info\PaymentInfoBlock;
 
 /**
@@ -28,6 +29,13 @@ class Info extends Tab
      */
     private $paymentInfoBlockSelector = '.order-payment-method';
 
+    /**
+     * Selector for Comments history block.
+     *
+     * @var string
+     */
+    private $commentsHistoryBlockSelector = '#order_history_block';
+
     /**
      * Get order status from info block.
      *
@@ -50,4 +58,17 @@ public function getPaymentInfoBlock()
             ['element' => $this->_rootElement->find($this->paymentInfoBlockSelector)]
         );
     }
+
+    /**
+     * Returns Comments history block.
+     *
+     * @return CommentsHistoryBlock
+     */
+    public function getCommentsHistoryBlock()
+    {
+        return $this->blockFactory->create(
+            CommentsHistoryBlock::class,
+            ['element' => $this->_rootElement->find($this->commentsHistoryBlockSelector)]
+        );
+    }
 }

dev/tests/functional/tests/app/Magento/Sales/Test/Block/Adminhtml/Order/View/Tab/Info.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * Copyright © 2016 Magento. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Sales\Test\Block\Adminhtml\Order\View\Tab\Info;
+
+use Magento\Mtf\Block\Block;
+
+/**
+ * Order comments history block.
+ */
+class CommentsHistoryBlock extends Block
+{
+    /**
+     * Comment history list locator.
+     *
+     * @var string
+     */
+    protected $commentHistory = '.note-list-item';
+
+    /**
+     * Comment date.
+     *
+     * @var string
+     */
+    protected $commentHistoryDate = '.note-list-date';
+
+    /**
+     * Comment time.
+     *
+     * @var string
+     */
+    protected $commentHistoryTime = '.note-list-time';
+
+    /**
+     * Comment status.
+     *
+     * @var string
+     */
+    protected $commentHistoryStatus = '.note-list-status';
+
+    /**
+     * Comment notified status.
+     *
+     * @var string
+     */
+    protected $commentHistoryNotifiedStatus = '.note-list-customer';
+
+    /**
+     * Comment locator.
+     *
+     * @var string
+     */
+    protected $comment = '.note-list-comment';
+
+    /**
+     * Get comment history block data.
+     *
+     * @return array
+     */
+    public function getComments()
+    {
+        $result = [];
+        $elements = $this->_rootElement->getElements($this->commentHistory);
+        foreach ($elements as $key => $item) {
+            $result[$key] = [
+                'date' => $item->find($this->commentHistoryDate)->getText(),
+                'time' => $item->find($this->commentHistoryTime)->getText(),
+                'status' => $item->find($this->commentHistoryStatus)->getText(),
+                'is_customer_notified' => $item->find($this->commentHistoryNotifiedStatus)->getText(),
+                'comment' => $item->find($this->comment)->getText()
+            ];
+        }
+
+        return $result;
+    }
+
+    /**
+     * Get last comment.
+     *
+     * @return array
+     */
+    public function getLatestComment()
+    {
+        $comments = $this->getComments();
+        return current($comments);
+    }
+}