graphql-php/tests/Validator/DisableIntrospectionTest.php

<?php

declare(strict_types=1);

namespace GraphQL\Tests\Validator;

use GraphQL\Error\FormattedError;
use GraphQL\Language\SourceLocation;
use GraphQL\Validator\Rules\DisableIntrospection;

class DisableIntrospectionTest extends ValidatorTestCase
{
    // Validate: Disable Introspection
    /**
     * @see it('fails if the query contains __schema')
     */
    public function testQueryContainsSchema() : void
    {
        $this->expectFailsRule(
            new DisableIntrospection(DisableIntrospection::ENABLED),
            '
      query { 
        __schema {
          queryType {
            name
          }
        }
      }
        ',
            [$this->error(3, 9)]
        );
    }

    private function error($line, $column)
    {
        return FormattedError::create(
            DisableIntrospection::introspectionDisabledMessage(),
            [new SourceLocation($line, $column)]
        );
    }

    /**
     * @see it('fails if the query contains __type')
     */
    public function testQueryContainsType() : void
    {
        $this->expectFailsRule(
            new DisableIntrospection(DisableIntrospection::ENABLED),
            '
      query { 
        __type(
          name: "Query"
        ){
          name
        }
      }
        ',
            [$this->error(3, 9)]
        );
    }

    /**
     * @see it('does not fail on a query that does not contain __type')
     */
    public function testValidQuery() : void
    {
        $this->expectPassesRule(
            new DisableIntrospection(DisableIntrospection::ENABLED),
            '
      query {
        user {
          name
          email
          friends {
            name
          }
        }
      }
        '
        );
    }

    /**
     * @see it('does not fail when not enabled')
     */
    public function testQueryWhenDisabled() : void
    {
        $this->expectPassesRule(
            new DisableIntrospection(DisableIntrospection::DISABLED),
            '
      query { 
        __type(
          name: "Query"
        ){
          name
        }
      }
        '
        );
    }

    /**
     * @see it('has a public interface for enabeling the rule')
     */
    public function testPublicEnableInterface() : void
    {
        $disableIntrospection = new DisableIntrospection(DisableIntrospection::DISABLED);
        $disableIntrospection->setEnabled(DisableIntrospection::ENABLED);
        $this->expectFailsRule(
            $disableIntrospection,
            '
      query { 
        __type(
          name: "Query"
        ){
          name
        }
      }
        ',
            [$this->error(3, 9)]
        );
    }

    /**
     * @see it('has a public interface for disableing the rule')
     */
    public function testPublicDisableInterface() : void
    {
        $disableIntrospection = new DisableIntrospection(DisableIntrospection::ENABLED);
        $disableIntrospection->setEnabled(DisableIntrospection::DISABLED);
        $this->expectPassesRule(
            $disableIntrospection,
            '
      query { 
        __type(
          name: "Query"
        ){
          name
        }
      }
        '
        );
    }
}