AssertGraphQLIntrospectionEquals.md

assertGraphQLIntrospectionEquals

Compares default public schema (as the client sees it through introspection).

<?php declare(strict_types = 1);

namespace LastDragon_ru\LaraASP\GraphQL\Docs\Assertions;

use LastDragon_ru\LaraASP\Core\Provider as CoreProvider;
use LastDragon_ru\LaraASP\GraphQL\Provider;
use LastDragon_ru\LaraASP\GraphQL\Testing\GraphQLAssertions;
use LastDragon_ru\LaraASP\GraphQL\Testing\Package\Directives\TestDirective;
use LastDragon_ru\LaraASP\GraphQL\Testing\Package\Provider as TestProvider;
use LastDragon_ru\LaraASP\Testing\Package\TestCase;
use Nuwave\Lighthouse\LighthouseServiceProvider;
use Nuwave\Lighthouse\Schema\DirectiveLocator;
use Override;
use PHPUnit\Framework\Attributes\CoversNothing;

use function array_merge;

// @phpcs:disable Generic.Files.LineLength.TooLong

/**
 * @internal
 */
#[CoversNothing]
final class AssertGraphQLIntrospectionEqualsTest extends TestCase {
    /**
     * Trait where assertion defined.
     */
    use GraphQLAssertions;

    /**
     * Preparation for test.
     *
     * @inheritDoc
     */
    #[Override]
    protected function getPackageProviders(mixed $app): array {
        return array_merge(parent::getPackageProviders($app), [
            Provider::class,
            CoreProvider::class,
            TestProvider::class,
            LighthouseServiceProvider::class,
        ]);
    }

    /**
     * Assertion test.
     */
    public function testAssertion(): void {
        // Prepare
        $this->app()->make(DirectiveLocator::class)
            ->setResolved('a', TestDirective::class)
            ->setResolved('test', TestDirective::class);

        $this->useGraphQLSchema(
            <<<'GRAPHQL'
            directive @a(b: B) on OBJECT

            type Query {
                a: A @test
            }

            type A @a {
                id: ID!
            }

            input B {
                b: String!
            }

            input C {
                c: ID
            }
            GRAPHQL,
        );

        // Test
        $this->assertGraphQLIntrospectionEquals(
            <<<'GRAPHQL'
            directive @a(
                b: B
            )
            on
                | OBJECT

            """
            Marks an element of a GraphQL schema as no longer supported.
            """
            directive @deprecated(
                """
                Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).
                """
                reason: String = "No longer supported"
            )
            on
                | ARGUMENT_DEFINITION
                | ENUM_VALUE
                | FIELD_DEFINITION
                | INPUT_FIELD_DEFINITION

            """
            Directs the executor to include this field or fragment only when the `if` argument is true.
            """
            directive @include(
                """
                Included when true.
                """
                if: Boolean!
            )
            on
                | FIELD
                | FRAGMENT_SPREAD
                | INLINE_FRAGMENT

            """
            Directs the executor to skip this field or fragment when the `if` argument is true.
            """
            directive @skip(
                """
                Skipped when true.
                """
                if: Boolean!
            )
            on
                | FIELD
                | FRAGMENT_SPREAD
                | INLINE_FRAGMENT

            """
            A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.
            """
            enum __DirectiveLocation {
                """
                Location adjacent to an argument definition.
                """
                ARGUMENT_DEFINITION

                """
                Location adjacent to an enum definition.
                """
                ENUM

                """
                Location adjacent to an enum value definition.
                """
                ENUM_VALUE

                """
                Location adjacent to a field.
                """
                FIELD

                """
                Location adjacent to a field definition.
                """
                FIELD_DEFINITION

                """
                Location adjacent to a fragment definition.
                """
                FRAGMENT_DEFINITION

                """
                Location adjacent to a fragment spread.
                """
                FRAGMENT_SPREAD

                """
                Location adjacent to an inline fragment.
                """
                INLINE_FRAGMENT

                """
                Location adjacent to an input object field definition.
                """
                INPUT_FIELD_DEFINITION

                """
                Location adjacent to an input object type definition.
                """
                INPUT_OBJECT

                """
                Location adjacent to an interface definition.
                """
                INTERFACE

                """
                Location adjacent to a mutation operation.
                """
                MUTATION

                """
                Location adjacent to an object type definition.
                """
                OBJECT

                """
                Location adjacent to a query operation.
                """
                QUERY

                """
                Location adjacent to a scalar definition.
                """
                SCALAR

                """
                Location adjacent to a schema definition.
                """
                SCHEMA

                """
                Location adjacent to a subscription operation.
                """
                SUBSCRIPTION

                """
                Location adjacent to a union definition.
                """
                UNION

                """
                Location adjacent to a variable definition.
                """
                VARIABLE_DEFINITION
            }

            """
            An enum describing what kind of type a given `__Type` is.
            """
            enum __TypeKind {
                """
                Indicates this type is an enum. `enumValues` is a valid field.
                """
                ENUM

                """
                Indicates this type is an input object. `inputFields` is a valid field.
                """
                INPUT_OBJECT

                """
                Indicates this type is an interface. `fields`, `interfaces`, and `possibleTypes` are valid fields.
                """
                INTERFACE

                """
                Indicates this type is a list. `ofType` is a valid field.
                """
                LIST

                """
                Indicates this type is a non-null. `ofType` is a valid field.
                """
                NON_NULL

                """
                Indicates this type is an object. `fields` and `interfaces` are valid fields.
                """
                OBJECT

                """
                Indicates this type is a scalar.
                """
                SCALAR

                """
                Indicates this type is a union. `possibleTypes` is a valid field.
                """
                UNION
            }

            input B {
                b: String!
            }

            input C {
                c: ID
            }

            """
            The `Boolean` scalar type represents `true` or `false`.
            """
            scalar Boolean

            """
            The `ID` scalar type represents a unique identifier, often used to
            refetch an object or as key for a cache. The ID type appears in a JSON
            response as a String; however, it is not intended to be human-readable.
            When expected as an input type, any string (such as `"4"`) or integer
            (such as `4`) input value will be accepted as an ID.
            """
            scalar ID

            """
            The `String` scalar type represents textual data, represented as UTF-8
            character sequences. The String type is most often used by GraphQL to
            represent free-form human-readable text.
            """
            scalar String

            type A {
                id: ID!
            }

            type Query {
                a: A
            }

            """
            A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

            In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
            """
            type __Directive {
                args: [__InputValue!]!
                description: String
                isRepeatable: Boolean!
                locations: [__DirectiveLocation!]!
                name: String!
            }

            """
            One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
            """
            type __EnumValue {
                deprecationReason: String
                description: String
                isDeprecated: Boolean!
                name: String!
            }

            """
            Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
            """
            type __Field {
                args(
                    includeDeprecated: Boolean = false
                ): [__InputValue!]!

                deprecationReason: String
                description: String
                isDeprecated: Boolean!
                name: String!
                type: __Type!
            }

            """
            Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
            """
            type __InputValue {
                """
                A GraphQL-formatted string representing the default value for this input value.
                """
                defaultValue: String

                deprecationReason: String
                description: String
                isDeprecated: Boolean!
                name: String!
                type: __Type!
            }

            """
            A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
            """
            type __Schema {
                """
                A list of all directives supported by this server.
                """
                directives: [__Directive!]!

                """
                If this server supports mutation, the type that mutation operations will be rooted at.
                """
                mutationType: __Type

                """
                The type that query operations will be rooted at.
                """
                queryType: __Type!

                """
                If this server support subscription, the type that subscription operations will be rooted at.
                """
                subscriptionType: __Type

                """
                A list of all types supported by this server.
                """
                types: [__Type!]!
            }

            """
            The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.

            Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.
            """
            type __Type {
                description: String

                enumValues(
                    includeDeprecated: Boolean = false
                ): [__EnumValue!]

                fields(
                    includeDeprecated: Boolean = false
                ): [__Field!]

                inputFields(
                    includeDeprecated: Boolean = false
                ): [__InputValue!]

                interfaces: [__Type!]
                kind: __TypeKind!
                name: String
                ofType: __Type
                possibleTypes: [__Type!]
            }

            GRAPHQL,
        );
    }
}