tests/DiceHttpMockHandlerTrait.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2024, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Test;
  23
  24 use Dice\Dice;
  25 use Friendica\DI;
  26 use Friendica\Network\HTTPClient\Factory\HttpClient;
  27 use Friendica\Network\HTTPClient\Capability\ICanSendHttpRequests;
  28 use GuzzleHttp\HandlerStack;
  29
  30 /**
  31  * This class injects a mockable handler into the IHTTPClient dependency per Dice
  32  */
  33 trait DiceHttpMockHandlerTrait
  34 {
  35         use FixtureTestTrait;
  36
  37         /**
  38          * Handler for mocking requests anywhere for testing purpose
  39          *
  40          * @var HandlerStack
  41          */
  42         protected $httpRequestHandler;
  43
  44         protected function setupHttpMockHandler(): void
  45         {
  46                 $this->setUpFixtures();
  47
  48                 $this->httpRequestHandler = HandlerStack::create();
  49
  50                 $dice = DI::getDice();
  51                 // addRule() clones the current instance and returns a new one, so no concurrency problems :-)
  52                 $newDice = $dice->addRule(ICanSendHttpRequests::class, [
  53                         'instanceOf' => HttpClient::class,
  54                         'call'       => [
  55                                 ['createClient', [$this->httpRequestHandler], Dice::CHAIN_CALL],
  56                         ],
  57                 ]);
  58
  59                 DI::init($newDice);
  60         }
  61
  62         protected function tearDownHandler(): void
  63         {
  64                 $this->tearDownFixtures();
  65         }
  66 }