如何在 PHPUnit 测试用例中使用服务器变量？

Question

我正在使用 PHPUnit 测试用例测试模块。一切正常，但当我使用$_SERVER['REMOTE_ADDR'] 时，它会出现致命错误并停止执行。

CategoryControllerTest.php

<?php
namespace ProductBundle\Controller\Tests\Controller;
use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
class CategoryControllerTest extends WebTestCase {

     protected function setUp() {
        static::$kernel = static::createKernel();
        static::$kernel->boot();
        $this->container = static::$kernel->getContainer();
        $this->em = static::$kernel->getContainer()->get('doctrine')->getManager();
    }

    public function testCategory() {
        $ip_address = $_SERVER['REMOTE_ADDR'];
        $client = static::createClient(
          array(), array('HTTP_HOST' => static::$kernel->getContainer()->getParameter('test_http_host')
        ));

        $crawler = $client->request('POST', '/category/new');
        $client->enableProfiler();

        $this->assertEquals('ProductBundle\Controller\CategoryController::addAction', $client->getRequest()->attributes->get('_controller'));
        $form = $crawler->selectButton('new_category')->form();
        $form['category[name]'] = "Electronics";
        $form['category[id]']   = "For US";
        $form['category[ip]']   = $ip_address;
        $client->submit($form);

        $this->assertTrue($client->getResponse()->isRedirect('/category/new')); // check if redirecting properly
        $client->followRedirect();
        $this->assertEquals(1, $crawler->filter('html:contains("Category Created Successfully.")')->count());
    }
}

错误

有 1 个错误：

1) ProductBundle\Tests\Controller\CategoryControllerTest::testCategory 未定义索引：REMOTE_ADDR

我已尝试将其添加到 setUp() 函数中，但效果不佳。

Answer 1

从技术上讲，您尚未向您的应用程序发送请求，因此没有可参考的远程地址。事实上，这也是你的错误告诉我们的。

要解决这个问题：

1. 将线移到下方：

   // Won't work, see comment below    
   $crawler = $client->request('POST', '/category/new');
   

2. 或者你可以组成一个 IP 地址并用它进行测试。由于您只使用 IP 来保存模型，因此也可以。

就像 cmets 中提到的 @apokryfos 一样，在测试用例中访问超全局变量被认为是不好的做法。所以选项 2 可能是您最好的选择。

Answer 2

创建返回IP地址的服务并在测试用例中模拟该服务。

在这里，将控制器和服务创建为 UserIpAddress。 get() 将返回用户的 IP 地址。

service.yml

UserIpAddress:
    class: AppBundle\Controller\UserIpAddressController
    arguments: 
    container: "@service_container"  

UserIpAddressController.php

class UserIpAddressController
{
  public function get()
  {
    return $_SERVER['REMOTE_ADDR'];
  }
}

创建“UserIpAddress”服务的模拟。它将覆盖现有服务。使用“UserIpAddress”服务获取项目中的 IP 地址。

CategoryControllerTest.php

$UserIpAddress = $this->getMockBuilder('UserIpAddress')
    ->disableOriginalConstructor()
    ->getMock();

$UserIpAddress->expects($this->once())
  ->method('get')
  ->willReturn('192.161.1.1'); // Set ip address whatever you want to use

现在，使用$UserIpAddress->get();获取IP地址

Answer 3

您可以创建另一个将返回服务器变量的类，然后对其进行模拟。

或者您可以直接在您的测试用例中设置/取消设置服务器变量。 用 PHPUnit 6.2.2 做到了：

 /**
 * Return true if the user agent matches a robot agent
 */
public function testShouldReturnTrueIfRobot()
{
    $_SERVER['HTTP_USER_AGENT'] = 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)';

    $this->configMock->method('getRobotUserAgents')
        ->willReturn('bot|crawl|slurp|spider|mediapartner');

    $test = $this->robotTest->isBot();

    static::assertTrue($test);
}

/**
 * Test return false if no user agent
 */
public function testShouldReturnFalseIfNoAgentUser()
{
    unset($_SERVER['HTTP_USER_AGENT']);

    $test = $this->robotTest->isBot();

    static::assertFalse($test);
}

测试方法在哪里：

 /**
 * Detect if current user agent matches a robot user agent
 *
 * @return bool
 */
public function isBot(): bool
{
    if (empty($_SERVER['HTTP_USER_AGENT'])) {
        return false;
    }

    $userAgents = $this->config->getRobotUserAgents();
    $pattern = '/' . $userAgents . '/i';

    return \preg_match($pattern, $_SERVER['HTTP_USER_AGENT']);
}