php-ovh/tests/ApiFunctionalTest.php

<?php
# Copyright (c) 2013-2017, OVH SAS.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#   * Redistributions of source code must retain the above copyright
#     notice, this list of conditions and the following disclaimer.
#   * Redistributions in binary form must reproduce the above copyright
#     notice, this list of conditions and the following disclaimer in the
#     documentation and/or other materials provided with the distribution.
#   * Neither the name of OVH SAS nor the
#     names of its contributors may be used to endorse or promote products
#     derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY OVH SAS AND CONTRIBUTORS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL OVH SAS AND CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

namespace Ovh\tests;

use GuzzleHttp\Client;
use GuzzleHttp\Exception\ClientException;
use Ovh\Api;
use PHPUnit\Framework\TestCase;

/**
 * Functional tests of Api class
 *
 * @package  Ovh
 * @category Ovh
 */
class ApiFunctionalTest extends TestCase
{

    /**
     * @var string
     */
    private $application_key;

    /**
     * @var string
     */
    private $application_secret;

    /**
     * @var string
     */
    private $consumer_key;

    /**
     * @var string
     */
    private $endpoint;

    /**
     * @var string
     */
    private $rangeIP;

    /**
     * @var string
     */
    private $alternativeRangeIP;

    /**
     * @var Client
     */
    private $client;

    /**
     * @var Api
     */
    private $api;

    /**
     * Define id to create object
     */
    protected function setUp() :void
    {
        foreach (['APP_KEY', 'APP_SECRET', 'CONSUMER', 'ENDPOINT'] as $envName) {
            if (!getenv($envName)) {
                $this->markTestSkipped("Skip test due to missing $envName variable");
                return;
            }
        }

        $this->application_key    = getenv('APP_KEY');
        $this->application_secret = getenv('APP_SECRET');
        $this->consumer_key       = getenv('CONSUMER');
        $this->endpoint           = getenv('ENDPOINT');
        $this->rangeIP            = '127.0.0.20/32';
        $this->alternativeRangeIP = '127.0.0.30/32';

        $this->client = new Client();
        $this->api    = new Api(
            $this->application_key,
            $this->application_secret,
            $this->endpoint,
            $this->consumer_key,
            $this->client
        );
    }

    /**
     * Get private and protected method to unit test it
     *
     * @param string $name
     *
     * @return \ReflectionMethod
     */
    protected static function getPrivateMethod($name)
    {
        $class  = new \ReflectionClass('Ovh\Api');
        $method = $class->getMethod($name);
        $method->setAccessible(true);

        return $method;
    }

    /**
     * Get private and protected property to unit test it
     *
     * @param string $name
     *
     * @return \ReflectionProperty
     */
    protected static function getPrivateProperty($name)
    {
        $class    = new \ReflectionClass('Ovh\Api');
        $property = $class->getProperty($name);
        $property->setAccessible(true);

        return $property;
    }

    /**
     * Test if result contains consumerKey and validationUrl
     */
    public function testIfConsumerKeyIsReplace()
    {
        $property    = self::getPrivateProperty('consumer_key');
        $accessRules = json_decode(' [
			{ "method": "GET", "path": "/*" },
			{ "method": "POST", "path": "/*" },
			{ "method": "PUT", "path": "/*" },
			{ "method": "DELETE", "path": "/*" }
		] ');

        $credentials  = $this->api->requestCredentials($accessRules);
        $consumer_key = $property->getValue($this->api);

        $this->assertEquals($consumer_key, $credentials["consumerKey"]);
        $this->assertNotEquals($consumer_key, $this->consumer_key);
    }

    /**
     * Test if post request on me
     */
    public function testPostRestrictionAccessIp()
    {
        $this->assertNull(
            $this->api->post('/me/accessRestriction/ip', ['ip' => $this->rangeIP, 'rule' => 'deny', 'warning' => true])
        );

        $this->assertNull(
            $this->api->post('/me/accessRestriction/ip', ['ip'      => $this->alternativeRangeIP,
                                                          'rule'    => 'deny',
                                                          'warning' => true,
            ])
        );
    }

    /**
     * Test if get request on /me
     */
    public function testGetRestrictionAccessIP()
    {
        $result = $this->api->get('/me/accessRestriction/ip');

        $restrictionIps = [];

        foreach ($result as $restrictionId) {
            $restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);

            $restrictionIps[] = $restriction['ip'];
        }

        $this->assertContains($this->rangeIP, $restrictionIps);
        $this->assertContains($this->alternativeRangeIP, $restrictionIps);
    }

    /**
     * Test if delete request on /me
     */
    public function testPutRestrictionAccessIP()
    {
        $result = $this->api->get('/me/accessRestriction/ip');

        foreach ($result as $restrictionId) {
            $restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);

            if (in_array($restriction["ip"], [$this->rangeIP, $this->alternativeRangeIP])) {
                $this->assertNull(
                    $this->api->put('/me/accessRestriction/ip/' . $restrictionId, ['rule' => 'accept', 'warning' => true])
                );

                $restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);
                $this->assertEquals('accept', $restriction['rule']);
            }
        }
    }

    /**
     * Test if delete request on /me
     */
    public function testDeleteRestrictionAccessIP()
    {
        $result = $this->api->get('/me/accessRestriction/ip');
        foreach ($result as $restrictionId) {
            $restriction = $this->api->get('/me/accessRestriction/ip/' . $restrictionId);

            if (in_array($restriction["ip"], [$this->rangeIP, $this->alternativeRangeIP])) {
                $result = $this->api->delete('/me/accessRestriction/ip/' . $restrictionId);
                $this->assertNull($result);
            }
        }
    }

    /**
     * Test if request without authentication works
     */
    public function testIfRequestWithoutAuthenticationWorks()
    {
        $api     = new Api($this->application_key, $this->application_secret, $this->endpoint, null, $this->client);
        $invoker = self::getPrivateMethod('rawCall');
        $result = $invoker->invokeArgs($api, ['GET', '/xdsl/incidents']);
        $this->assertIsObject($result);
    }

    /**
     * Test Api::get
     */
    public function testApiGetWithParameters()
    {
        $this->expectException(ClientException::class);

        $this->api->get('/me/accessRestriction/ip', ['foo' => 'bar']);
    }

    /**
     * Test Api::get, should build valide signature
     */
    public function testApiGetWithQueryString()
    {
        $result = $this->api->get('/me/api/credential', ['status' => 'pendingValidation']);
        $this->assertIsArray($result);
    }

    /**
     * Test APi::get without authentication
     */
    public function testApiGetWithoutAuthentication()
    {
        $api = new Api(null, null, $this->endpoint, null, $this->client);
        $result = $api->get('/hosting/web/moduleList', null, null, false);
        $this->assertIsArray($result);
    }
}