Fedex Soap Mock

Creates a mock soap client for fetching rates during test execution.

Fixes magento/graphql-ce#740

Author: pmclain

dev/tests/api-functional/_files/Magento/TestModuleFedex/Model/MockResponseBodyLoader.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestModuleFedex\Model;
+
+use Magento\Framework\Exception\NotFoundException;
+use Magento\Framework\HTTP\AsyncClient\Request;
+use Magento\Framework\Module\Dir;
+use Magento\Framework\Filesystem\Io\File;
+use Magento\Framework\Stdlib\ArrayManager;
+
+/**
+ * Load mock response body for Fedex rate request
+ */
+class MockResponseBodyLoader
+{
+    private const RESPONSE_FILE_PATTERN = '%s/_files/mock_response_%s_%s.json';
+    private const PATH_COUNTRY = 'RequestedShipment/Recipient/Address/CountryCode';
+    private const PATH_SERVICE_TYPE = 'RequestedShipment/ServiceType';
+
+    /**
+     * @var Dir
+     */
+    private $moduleDirectory;
+
+    /**
+     * @var File
+     */
+    private $fileIo;
+
+    /**
+     * @var ArrayManager
+     */
+    private $arrayManager;
+
+    /**
+     * @param Dir $moduleDirectory
+     * @param File $fileIo
+     * @param ArrayManager
+     */
+    public function __construct(
+        Dir $moduleDirectory,
+        File $fileIo,
+        ArrayManager $arrayManager
+    ) {
+        $this->moduleDirectory = $moduleDirectory;
+        $this->fileIo = $fileIo;
+        $this->arrayManager = $arrayManager;
+    }
+
+    /**
+     * Loads mock response xml for a given request
+     *
+     * @param array $request
+     * @return string
+     * @throws NotFoundException
+     */
+    public function loadForRequest(array $request): string
+    {
+        $moduleDir = $this->moduleDirectory->getDir('Magento_TestModuleFedex');
+
+        $type = strtolower($this->arrayManager->get(static::PATH_SERVICE_TYPE, $request) ?? 'general');
+        $country = strtolower($this->arrayManager->get(static::PATH_COUNTRY, $request) ?? '');
+
+        $responsePath = sprintf(static::RESPONSE_FILE_PATTERN, $moduleDir, $type, $country);
+
+        if (!$this->fileIo->fileExists($responsePath)) {
+            throw new NotFoundException(
+                __('"%1" is not a valid mock response type for country "%2".', $type, $country)
+            );
+        }
+
+        return $this->fileIo->read($responsePath);
+    }
+}

dev/tests/api-functional/_files/Magento/TestModuleFedex/Model/MockSoapClient.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestModuleFedex\Model;
+
+/**
+ * Mock Fedex soap client factory
+ */
+class MockSoapClient extends \SoapClient
+{
+    /**
+     * @var MockResponseBodyLoader
+     */
+    private $mockResponseBodyLoader;
+
+    /**
+     * @param string $wsdl
+     * @param MockResponseBodyLoader $mockResponseBodyLoader
+     * @param array|null $options
+     */
+    public function __construct(
+        string $wsdl,
+        MockResponseBodyLoader $mockResponseBodyLoader,
+        array $options = null
+    ) {
+        parent::__construct($wsdl, $options);
+        $this->mockResponseBodyLoader = $mockResponseBodyLoader;
+    }
+
+    /**
+     * Fetch mock Fedex rates
+     *
+     * @param array $rateRequest
+     * @return \stdClass
+     * @throws \Magento\Framework\Exception\NotFoundException
+     */
+    public function getRates(array $rateRequest): \stdClass
+    {
+        $response = $this->mockResponseBodyLoader->loadForRequest($rateRequest);
+
+        return json_decode($response);
+    }
+}

dev/tests/api-functional/_files/Magento/TestModuleFedex/Model/MockSoapClientFactory.php

@@ -0,0 +1,34 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\TestModuleFedex\Model;
+
+use Magento\Framework\App\ObjectManager;
+
+/**
+ * Mock Fedex soap client factory
+ */
+class MockSoapClientFactory extends \Magento\Framework\Webapi\Soap\ClientFactory
+{
+    /**
+     * Create instance of the mock SoapClient
+     *
+     * @param string $wsdl
+     * @param array $options
+     * @return \SoapClient
+     */
+    public function create($wsdl, array $options = []): \SoapClient
+    {
+        return ObjectManager::getInstance()->create(
+            MockSoapClient::class,
+            [
+                'wsdl' => $wsdl,
+                'options' => $options,
+            ]
+        );
+    }
+}