HarvesterFactoryTest.php

<?php

/**
 * OAI-PMH harvester factory integration test.
 *
 * PHP version 7
 *
 * Copyright (C) Villanova University 2010.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * @category VuFind
 * @package  Tests
 * @author   Demian Katz <demian.katz@villanova.edu>
 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
 * @link     https://vufind.org/wiki/development
 */
namespace VuFindTest\Harvest\OaiPmh;

use VuFindHarvest\OaiPmh\Harvester;
use VuFindHarvest\OaiPmh\HarvesterFactory;
use Laminas\Http\Client;

/**
 * OAI-PMH harvester factory integration test.
 *
 * @category VuFind
 * @package  Tests
 * @author   Demian Katz <demian.katz@villanova.edu>
 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
 * @link     https://vufind.org/wiki/development
 */
class HarvesterFactoryTest extends \PHPUnit\Framework\TestCase
{
    /**
     * Return protected or private property.
     *
     * Uses PHP's reflection API in order to modify property accessibility.
     *
     * @param object|string $object   Object or class name
     * @param string        $property Property name
     *
     * @throws \ReflectionException Property does not exist
     *
     * @return mixed
     */
    protected function getProperty($object, $property)
    {
        $reflectionProperty = new \ReflectionProperty($object, $property);
        $reflectionProperty->setAccessible(true);
        return $reflectionProperty->getValue($object);
    }

    /**
     * 
     * @param string $target      Name of source being harvested (used as directory
     * name for storing harvested data inside $harvestRoot)
     * @param string $harvestRoot Root directory containing harvested data.
     * @param array  $config      Additional settings
     * @param Client $client      HTTP client
     *
     * @return type
     */
    protected function getHarvester($target, $harvestRoot, $config, $client)
    {
        $factory = new HarvesterFactory();
        return $factory->getHarvester($target, $harvestRoot, $client, $config);
    }

    /**
     * Test configuration.
     *
     * @return void
     */
    public function testConfig()
    {
        $config = [
            'url' => 'http://localhost',
            'set' => 'myset',
            'metadataPrefix' => 'fakemdprefix',
            'dateGranularity' => 'mygranularity',
        ];
        $oai = $this->getHarvester(
            'test', sys_get_temp_dir(), $config, $this->getMockClient()
        );

        // Special cases where config key != class property:
        $this->assertEquals(
            $config['dateGranularity'], $this->getProperty($oai, 'granularity')
        );
        unset($config['dateGranularity']);
        unset($config['url']);

        // Generic case for remaining configs:
        foreach ($config as $key => $value) {
            $this->assertEquals($value, $this->getProperty($oai, $key));
        }
    }

    /**
     * Test the injectSetName configuration.
     *
     * @return void
     */
    public function testInjectSetNameConfig()
    {
        $client = $this->getMockClient();
        $response = $client->send();
        $response->expects($this->any())
            ->method('isSuccess')
            ->will($this->returnValue(true));
        $response->expects($this->any())
            ->method('getBody')
            ->will($this->returnValue('<?xml version="1.0"?><OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd"><responseDate>2013-10-11T10:06:06Z</responseDate><request verb="ListSets" metadataPrefix="oai_dc" resumptionToken="" submit="Go">http://vu61162/vufind3/OAI/Server</request><ListSets><set><setSpec>Audio (Music)</setSpec><setName>Audio (Music)</setName></set><set><setSpec>Audio (Non-Music)</setSpec><setName>Audio (Non-Music)</setName></set></ListSets></OAI-PMH>'));
        $config = [
            'url' => 'http://localhost',
            'injectSetName' => 'setnametag',
            'dateGranularity' => 'mygranularity',
            'silent' => true,
        ];
        $oai = $this->getHarvester('test', sys_get_temp_dir(), $config, $client);
        $writer = $this->getProperty($oai, 'writer');
        $formatter = $this->getProperty($writer, 'recordFormatter');
        $this->assertEquals(
            $config['injectSetName'], $this->getProperty($formatter, 'injectSetName')
        );
        $this->assertEquals(
            [
                'Audio (Music)' => 'Audio (Music)',
                'Audio (Non-Music)' => 'Audio (Non-Music)'
            ], $this->getProperty($formatter, 'setNames')
        );
    }

    /**
     * Test the sslverifypeer configuration.
     *
     * @return void
     */
    public function testSSLVerifyPeer()
    {
        $client = $this->getMockClient();
        $client->expects($this->once())
            ->method('setOptions')
            ->with($this->equalTo(['sslverifypeer' => false, 'timeout' => 60]));
        $config = [
            'url' => 'http://localhost',
            'sslverifypeer' => false,
            'dateGranularity' => 'mygranularity',
        ];
        $this->getHarvester('test', sys_get_temp_dir(), $config, $client);
    }

    /**
     * Test date autodetection.
     *
     * @return void
     */
    public function testDateAutodetect()
    {
        $client = $this->getMockClient();
        $response = $client->send();
        $response->expects($this->any())
            ->method('isSuccess')
            ->will($this->returnValue(true));
        $response->expects($this->any())
            ->method('getBody')
            ->will($this->returnValue($this->getIdentifyResponse()));
        $config = [
            'url' => 'http://localhost',
        ];
        $oai = $this->getHarvester('test', sys_get_temp_dir(), $config, $client);
        $this->assertEquals(
            'YYYY-MM-DDThh:mm:ssZ', $this->getProperty($oai, 'granularity')
        );
    }

    /**
     * Test date autodetection w/503 retry.
     *
     * @return void
     */
    public function testDateAutodetectWith503Retry()
    {
        $client = $this->getMockClient();
        $response = $client->send();
        $response->expects($this->any())
            ->method('isSuccess')
            ->will($this->returnValue(true));
        $response->expects($this->at(1))
            ->method('getStatusCode')
            ->will($this->returnValue(503));
        $response->expects($this->any())
            ->method('getBody')
            ->will($this->returnValue($this->getIdentifyResponse()));
        $header = $this->getMockBuilder('Laminas\Http\Header\RetryAfter')->getMock();
        $header->expects($this->once())
            ->method('getDeltaSeconds')
            ->will($this->returnValue(1));
        $headers = $response->getHeaders();
        $headers->expects($this->any())
            ->method('get')
            ->with($this->equalTo('Retry-After'))
            ->will($this->returnValue($header));
        $config = [
            'url' => 'http://localhost',
        ];
        $oai = $this->getHarvester('test', sys_get_temp_dir(), $config, $client);
        $this->assertEquals(
            'YYYY-MM-DDThh:mm:ssZ', $this->getProperty($oai, 'granularity')
        );
    }

    /**
     * Test HTTP error detection.
     *
     * @return void
     *
     * @expectedException        Exception
     * @expectedExceptionMessage HTTP Error
     */
    public function testHTTPErrorDetection()
    {
        $client = $this->getMockClient();
        $response = $client->send();
        $response->expects($this->any())
            ->method('isSuccess')
            ->will($this->returnValue(false));
        $config = [
            'url' => 'http://localhost',
        ];
        $oai = $this->getHarvester('test', sys_get_temp_dir(), $config, $client);
    }

    /**
    /**
     * Test that a missing URL throws an exception.
     *
     * @return void
     *
     * @expectedException        Exception
     * @expectedExceptionMessage Missing base URL for test.
     */
    public function testMissingURLThrowsException()
    {
        $oai = $this->getHarvester('test', sys_get_temp_dir(), [], $this->getMockClient());
    }

    // Internal API

    /**
     * Get a sample Identify response
     *
     * @return string
     */
    protected function getIdentifyResponse()
    {
        return '<?xml version="1.0"?><OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd"><responseDate>2013-10-11T11:12:04Z</responseDate><request verb="Identify" submit="Go">http://fake/my/OAI/Server</request><Identify><repositoryName>myuniversity University VuFind</repositoryName><baseURL>http://fake/my/OAI/Server</baseURL><protocolVersion>2.0</protocolVersion><earliestDatestamp>2000-01-01T00:00:00Z</earliestDatestamp><deletedRecord>transient</deletedRecord><granularity>YYYY-MM-DDThh:mm:ssZ</granularity><adminEmail>libtech@myuniversity.edu</adminEmail><description><oai-identifier xmlns="http://www.openarchives.org/OAI/2.0/oai-identifier" xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai-identifier http://www.openarchives.org/OAI/2.0/oai-identifier.xsd"><scheme>oai</scheme><repositoryIdentifier>fake.myuniversity.edu</repositoryIdentifier><delimiter>:</delimiter><sampleIdentifier>oai:fake.myuniversity.edu:123456</sampleIdentifier></oai-identifier></description></Identify></OAI-PMH>';
    }

    /**
     * Get a fake HTTP client
     *
     * @return \Laminas\Http\Client
     */
    protected function getMockClient()
    {
        $query = $this->getMockBuilder('Laminas\Stdlib\Parameters')->getMock();
        $request = $this->getMockBuilder('Laminas\Http\Request')->getMock();
        $request->expects($this->any())
            ->method('getQuery')
            ->will($this->returnValue($query));
        $headers = $this->getMockBuilder('Laminas\Http\Headers')->getMock();
        $response = $this->getMockBuilder('Laminas\Http\Response')->getMock();
        $response->expects($this->any())
            ->method('getHeaders')
            ->will($this->returnValue($headers));
        $client = $this->getMockBuilder('Laminas\Http\Client')->getMock();
        $client->expects($this->any())
            ->method('getRequest')
            ->will($this->returnValue($request));
        $client->expects($this->any())
            ->method('setMethod')
            ->will($this->returnValue($client));
        $client->expects($this->any())
            ->method('send')
            ->will($this->returnValue($response));
        return $client;
    }
}