tests/Wallabag/CoreBundle/GuzzleSiteAuthenticator/GrabySiteConfigBuilderTest.php

   1 <?php
   2
   3 namespace Tests\Wallabag\CoreBundle\GuzzleSiteAuthenticator;
   4
   5 use Graby\SiteConfig\SiteConfig as GrabySiteConfig;
   6 use Monolog\Handler\TestHandler;
   7 use Monolog\Logger;
   8 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorage;
   9 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
  10 use Tests\Wallabag\CoreBundle\WallabagCoreTestCase;
  11 use Wallabag\CoreBundle\GuzzleSiteAuthenticator\GrabySiteConfigBuilder;
  12
  13 class GrabySiteConfigBuilderTest extends WallabagCoreTestCase
  14 {
  15     public function testBuildConfigExists()
  16     {
  17         $grabyConfigBuilderMock = $this->getMockBuilder('Graby\SiteConfig\ConfigBuilder')
  18             ->disableOriginalConstructor()
  19             ->getMock();
  20
  21         $grabySiteConfig = new GrabySiteConfig();
  22         $grabySiteConfig->requires_login = true;
  23         $grabySiteConfig->login_uri = 'http://api.example.com/login';
  24         $grabySiteConfig->login_username_field = 'login';
  25         $grabySiteConfig->login_password_field = 'password';
  26         $grabySiteConfig->login_extra_fields = ['field=value'];
  27         $grabySiteConfig->not_logged_in_xpath = '//div[@class="need-login"]';
  28
  29         $grabyConfigBuilderMock
  30             ->method('buildForHost')
  31             ->with('api.example.com')
  32             ->will($this->returnValue($grabySiteConfig));
  33
  34         $logger = new Logger('foo');
  35         $handler = new TestHandler();
  36         $logger->pushHandler($handler);
  37
  38         $siteCrentialRepo = $this->getMockBuilder('Wallabag\CoreBundle\Repository\SiteCredentialRepository')
  39             ->disableOriginalConstructor()
  40             ->getMock();
  41         $siteCrentialRepo->expects($this->once())
  42             ->method('findOneByHostsAndUser')
  43             ->with(['api.example.com', '.example.com'], 1)
  44             ->willReturn(['username' => 'foo', 'password' => 'bar']);
  45
  46         $user = $this->getMockBuilder('Wallabag\UserBundle\Entity\User')
  47             ->disableOriginalConstructor()
  48             ->getMock();
  49         $user->expects($this->once())
  50             ->method('getId')
  51             ->willReturn(1);
  52
  53         $token = new UsernamePasswordToken($user, 'pass', 'provider');
  54
  55         $tokenStorage = new TokenStorage();
  56         $tokenStorage->setToken($token);
  57
  58         $builder = new GrabySiteConfigBuilder(
  59             $grabyConfigBuilderMock,
  60             $tokenStorage,
  61             $siteCrentialRepo,
  62             $logger
  63         );
  64
  65         $config = $builder->buildForHost('api.example.com');
  66
  67         $this->assertSame('api.example.com', $config->getHost());
  68         $this->assertTrue($config->requiresLogin());
  69         $this->assertSame('http://api.example.com/login', $config->getLoginUri());
  70         $this->assertSame('login', $config->getUsernameField());
  71         $this->assertSame('password', $config->getPasswordField());
  72         $this->assertSame(['field' => 'value'], $config->getExtraFields());
  73         $this->assertSame('//div[@class="need-login"]', $config->getNotLoggedInXpath());
  74         $this->assertSame('foo', $config->getUsername());
  75         $this->assertSame('bar', $config->getPassword());
  76
  77         $records = $handler->getRecords();
  78
  79         $this->assertCount(1, $records, 'One log was recorded');
  80     }
  81
  82     public function testBuildConfigDoesntExist()
  83     {
  84         $grabyConfigBuilderMock = $this->getMockBuilder('\Graby\SiteConfig\ConfigBuilder')
  85             ->disableOriginalConstructor()
  86             ->getMock();
  87
  88         $grabyConfigBuilderMock
  89             ->method('buildForHost')
  90             ->with('unknown.com')
  91             ->will($this->returnValue(new GrabySiteConfig()));
  92
  93         $logger = new Logger('foo');
  94         $handler = new TestHandler();
  95         $logger->pushHandler($handler);
  96
  97         $siteCrentialRepo = $this->getMockBuilder('Wallabag\CoreBundle\Repository\SiteCredentialRepository')
  98             ->disableOriginalConstructor()
  99             ->getMock();
 100         $siteCrentialRepo->expects($this->once())
 101             ->method('findOneByHostsAndUser')
 102             ->with(['unknown.com', '.com'], 1)
 103             ->willReturn(null);
 104
 105         $user = $this->getMockBuilder('Wallabag\UserBundle\Entity\User')
 106             ->disableOriginalConstructor()
 107             ->getMock();
 108         $user->expects($this->once())
 109             ->method('getId')
 110             ->willReturn(1);
 111
 112         $token = new UsernamePasswordToken($user, 'pass', 'provider');
 113
 114         $tokenStorage = new TokenStorage();
 115         $tokenStorage->setToken($token);
 116
 117         $builder = new GrabySiteConfigBuilder(
 118             $grabyConfigBuilderMock,
 119             $tokenStorage,
 120             $siteCrentialRepo,
 121             $logger
 122         );
 123
 124         $config = $builder->buildForHost('unknown.com');
 125
 126         $this->assertFalse($config);
 127
 128         $records = $handler->getRecords();
 129
 130         $this->assertCount(1, $records, 'One log was recorded');
 131     }
 132
 133     public function testBuildConfigUserNotDefined()
 134     {
 135         $grabyConfigBuilderMock = $this->getMockBuilder('\Graby\SiteConfig\ConfigBuilder')
 136             ->disableOriginalConstructor()
 137             ->getMock();
 138
 139         $grabyConfigBuilderMock
 140             ->method('buildForHost')
 141             ->with('unknown.com')
 142             ->will($this->returnValue(new GrabySiteConfig()));
 143
 144         $logger = new Logger('foo');
 145         $handler = new TestHandler();
 146         $logger->pushHandler($handler);
 147
 148         $siteCrentialRepo = $this->getMockBuilder('Wallabag\CoreBundle\Repository\SiteCredentialRepository')
 149             ->disableOriginalConstructor()
 150             ->getMock();
 151
 152         $tokenStorage = new TokenStorage();
 153
 154         $builder = new GrabySiteConfigBuilder(
 155             $grabyConfigBuilderMock,
 156             $tokenStorage,
 157             $siteCrentialRepo,
 158             $logger
 159         );
 160
 161         $config = $builder->buildForHost('unknown.com');
 162
 163         $this->assertFalse($config);
 164     }
 165
 166     public function dataProviderCredentials()
 167     {
 168         return [
 169             [
 170                 'host' => 'example.com',
 171             ],
 172             [
 173                 'host' => 'other.example.com',
 174             ],
 175             [
 176                 'host' => 'paywall.example.com',
 177                 'expectedUsername' => 'paywall.example',
 178                 'expectedPassword' => 'bar',
 179             ],
 180             [
 181                 'host' => 'api.super.com',
 182                 'expectedUsername' => '.super',
 183                 'expectedPassword' => 'bar',
 184             ],
 185             [
 186                 'host' => '.super.com',
 187                 'expectedUsername' => '.super',
 188                 'expectedPassword' => 'bar',
 189             ],
 190         ];
 191     }
 192
 193     /**
 194      * @dataProvider dataProviderCredentials
 195      */
 196     public function testBuildConfigWithDbAccess($host, $expectedUsername = null, $expectedPassword = null)
 197     {
 198         $grabyConfigBuilderMock = $this->getMockBuilder('Graby\SiteConfig\ConfigBuilder')
 199             ->disableOriginalConstructor()
 200             ->getMock();
 201
 202         $grabySiteConfig = new GrabySiteConfig();
 203         $grabySiteConfig->requires_login = true;
 204         $grabySiteConfig->login_uri = 'http://api.example.com/login';
 205         $grabySiteConfig->login_username_field = 'login';
 206         $grabySiteConfig->login_password_field = 'password';
 207         $grabySiteConfig->login_extra_fields = ['field=value'];
 208         $grabySiteConfig->not_logged_in_xpath = '//div[@class="need-login"]';
 209
 210         $grabyConfigBuilderMock
 211             ->method('buildForHost')
 212             ->with($host)
 213             ->will($this->returnValue($grabySiteConfig));
 214
 215         $user = $this->getMockBuilder('Wallabag\UserBundle\Entity\User')
 216             ->disableOriginalConstructor()
 217             ->getMock();
 218         $user->expects($this->once())
 219             ->method('getId')
 220             ->willReturn(1);
 221
 222         $token = new UsernamePasswordToken($user, 'pass', 'provider');
 223
 224         $tokenStorage = new TokenStorage();
 225         $tokenStorage->setToken($token);
 226
 227         $logger = new Logger('foo');
 228         $handler = new TestHandler();
 229         $logger->pushHandler($handler);
 230
 231         $builder = new GrabySiteConfigBuilder(
 232             $grabyConfigBuilderMock,
 233             $tokenStorage,
 234             $this->getClient()->getContainer()->get('wallabag_core.site_credential_repository'),
 235             $logger
 236         );
 237
 238         $config = $builder->buildForHost($host);
 239
 240         if (null === $expectedUsername && null === $expectedPassword) {
 241             $this->assertFalse($config);
 242
 243             return;
 244         }
 245
 246         $this->assertSame($expectedUsername, $config->getUsername());
 247         $this->assertSame($expectedPassword, $config->getPassword());
 248     }
 249 }