You are here

Home » API reference » GraphQL 8.3 » TestFrameworkTest.php

class TestFrameworkTest in GraphQL 8.3

Same name and namespace in other branches
  1. 8.4 tests/src/Kernel/Framework/TestFrameworkTest.php \Drupal\Tests\graphql\Kernel\Framework\TestFrameworkTest

Test the test framework.

@group graphql

Hierarchy

Expanded class hierarchy of TestFrameworkTest

File

tests/src/Kernel/Framework/TestFrameworkTest.php, line 17

Namespace

Drupal\Tests\graphql\Kernel\Framework
View source 
class TestFrameworkTest extends GraphQLTestBase {

  /**
   * Test mocked fields.
   */
  public function testFieldMock() {
    $this
      ->mockField('root', [
      'name' => 'root',
      'type' => 'String',
      'response_cache_tags' => [
        'my_tag',
      ],
    ], function () {
      (yield (new CacheableValue('test'))
        ->mergeCacheMaxAge(42));
    });
    $metadata = $this
      ->defaultCacheMetaData();
    $metadata
      ->setCacheMaxAge(42);
    $metadata
      ->addCacheTags([
      'my_tag',
    ]);
    $schema = $this
      ->introspect();
    $this
      ->assertArraySubset([
      'types' => [
        'Query' => [
          'fields' => [
            'root' => [
              'name' => 'root',
              'type' => [
                'kind' => 'SCALAR',
                'name' => 'String',
              ],
            ],
          ],
        ],
      ],
    ], $schema);
    $this
      ->assertResults('{ root }', [], [
      'root' => 'test',
    ], $metadata);
  }

  /**
   * Test result error assertions.
   */
  public function testErrorAssertion() {

    // Errors are not cached at all.
    $metadata = new CacheableMetadata();
    $metadata
      ->setCacheMaxAge(0);
    $this
      ->assertErrors('{ root }', [], [
      'Cannot query field "root" on type "Query".',
    ], $metadata);
    $this
      ->assertErrors('{ root }', [], [
      '/root.*Query/',
    ], $metadata);
  }

  /**
   * Test type mocking.
   */
  public function testTypeMock() {
    $this
      ->mockField('value', [
      'name' => 'value',
      'parents' => [
        'Test',
      ],
      'type' => 'String',
    ], function ($value, array $args, ResolveContext $context, ResolveInfo $info) {
      (yield $value['value']);
    });
    $this
      ->mockType('test', [
      'name' => 'Test',
    ]);
    $this
      ->mockField('root', [
      'name' => 'root',
      'type' => 'Test',
    ], function ($value, array $args, ResolveContext $context, ResolveInfo $info) {
      (yield [
        'value' => 'test',
      ]);
    });
    $this
      ->assertResults('{ root { value } }', [], [
      'root' => [
        'value' => 'test',
      ],
    ], $this
      ->defaultCacheMetaData());
  }

  /**
   * Test mutation mocking.
   */
  public function testMutationMock() {

    // Fake at least a root field, or the schema will return an error.
    $this
      ->mockField('root', [
      'name' => 'root',
      'type' => 'Boolean',
    ], TRUE);
    $this
      ->mockEnum('gender', [
      'name' => 'Gender',
    ], function () {
      return [
        'Female' => [
          'value' => 'f',
          'description' => '',
        ],
        'Male' => [
          'value' => 'm',
          'description' => '',
        ],
      ];
    });
    $this
      ->mockInputType('user', [
      'name' => 'User',
      'fields' => [
        'name' => 'String',
        'age' => 'Int',
        'gender' => 'Gender',
      ],
    ]);
    $this
      ->mockMutation('addUser', [
      'name' => 'addUser',
      'type' => 'Boolean',
      'arguments' => [
        'user' => 'User',
      ],
    ], function ($value, $args) {
      return $args['user']['age'] > 50 && $args['user']['gender'] == 'm';
    });
    $metadata = $this
      ->defaultMutationCacheMetaData();
    $this
      ->assertResults('mutation ($user: User!) { addUser(user: $user) }', [
      'user' => [
        'name' => 'John Doe',
        'age' => 52,
        'gender' => 'Male',
      ],
    ], [
      'addUser' => TRUE,
    ], $metadata);
  }

  /**
   * Test interface mocking.
   */
  public function testInterfaceMock() {
    $this
      ->mockInterface('token', [
      'name' => 'Token',
    ]);
    $this
      ->mockType('number', [
      'name' => 'Number',
      'interfaces' => [
        'Token',
      ],
    ], function ($value) {
      return is_int($value['value']);
    });
    $this
      ->mockType('word', [
      'name' => 'Word',
      'interfaces' => [
        'Token',
      ],
    ], function ($value) {
      return is_string($value['value']);
    });
    $this
      ->mockField('int_value', [
      'name' => 'value',
      'type' => 'Int',
      'parents' => [
        'Number',
      ],
    ], function ($value) {
      (yield $value['value']);
    });
    $this
      ->mockField('string_value', [
      'name' => 'value',
      'type' => 'String',
      'parents' => [
        'Word',
      ],
    ], function ($value) {
      (yield $value['value']);
    });
    $this
      ->mockField('root', [
      'name' => 'root',
      'type' => '[Token]',
    ], function () {
      (yield [
        'value' => 42,
      ]);
      (yield [
        'value' => 'GraphQL',
      ]);
    });
    $this
      ->assertResults('{ root { ... on Number { number:value } ... on Word { word:value }  } }', [], [
      'root' => [
        0 => [
          'number' => 42,
        ],
        1 => [
          'word' => 'GraphQL',
        ],
      ],
    ], $this
      ->defaultCacheMetaData());
  }

  /**
   * Test union mocks.
   *
   * @todo Unions are identical to interfaces right now, but they should not be.
   */
  public function testUnionMock() {
    $this
      ->mockUnion('token', [
      'name' => 'Token',
      'types' => [
        'Word',
      ],
    ]);
    $this
      ->mockType('number', [
      'name' => 'Number',
      'unions' => [
        'Token',
      ],
    ], function ($value) {
      return is_int($value['value']);
    });
    $this
      ->mockType('word', [
      'name' => 'Word',
    ], function ($value) {
      return is_string($value['value']);
    });
    $this
      ->mockField('int_value', [
      'name' => 'value',
      'type' => 'Int',
      'parents' => [
        'Number',
      ],
    ], function ($value) {
      (yield $value['value']);
    });
    $this
      ->mockField('string_value', [
      'name' => 'value',
      'type' => 'String',
      'parents' => [
        'Word',
      ],
    ], function ($value) {
      (yield $value['value']);
    });
    $this
      ->mockField('root', [
      'name' => 'root',
      'type' => '[Token]',
    ], function () {
      (yield [
        'value' => 42,
      ]);
      (yield [
        'value' => 'GraphQL',
      ]);
    });
    $this
      ->assertResults('{ root { ... on Number { number:value } ... on Word { word:value }  } }', [], [
      'root' => [
        0 => [
          'number' => 42,
        ],
        1 => [
          'word' => 'GraphQL',
        ],
      ],
    ], $this
      ->defaultCacheMetaData());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
EnableCliCacheTrait::enableCliCache protected function Enable caching in CLI environments.
GraphQLTestBase::$modules public static property Modules to enable. Overrides KernelTestBase::$modules 9
GraphQLTestBase::defaultCacheContexts protected function Return the default cache contexts for this test case. Overrides QueryResultAssertionTrait::defaultCacheContexts
GraphQLTestBase::defaultCacheMaxAge protected function Return the default cache max age for this test case. Overrides QueryResultAssertionTrait::defaultCacheMaxAge
GraphQLTestBase::defaultCacheTags protected function Return the default cache cache tags for this test case. Overrides QueryResultAssertionTrait::defaultCacheTags
GraphQLTestBase::getDefaultSchema protected function Return the default schema for this test. Overrides QueryResultAssertionTrait::getDefaultSchema
GraphQLTestBase::getSchemaDefinitions protected function
GraphQLTestBase::register public function Registers test-specific services. Overrides KernelTestBase::register 2
GraphQLTestBase::setUp protected function Overrides KernelTestBase::setUp 5
HttpRequestTrait::batchedQueries protected function Simulate batched queries over http.
HttpRequestTrait::persistedQuery protected function Issue a persisted query over http.
HttpRequestTrait::query protected function Issue a simple query over http.
IntrospectionTestTrait::assertGraphQLFields protected function Assert certain fields in the GraphQL schema.
IntrospectionTestTrait::indexByName private function Recursively index all sequences by name.
IntrospectionTestTrait::introspect protected function Retrieve a name-index schema to easy assert type system plugins.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
MockGraphQLPluginTrait::$graphQLPluginClassMap protected property Maps type system manager id's to required plugin interfaces.
MockGraphQLPluginTrait::$graphqlPluginDecorators protected property
MockGraphQLPluginTrait::$graphQLPluginManagers protected property
MockGraphQLPluginTrait::$graphQLPlugins protected property The list of mocked type system plugins.
MockGraphQLPluginTrait::addTypeSystemPlugin protected function Add a new plugin to the GraphQL type system.
MockGraphQLPluginTrait::getBasePluginId private function
MockGraphQLPluginTrait::getTypeSystemPluginDefinition protected function Get a plugin definition.
MockGraphQLPluginTrait::injectTypeSystemPluginManagers protected function Register the mocked plugin managers during container build.
MockGraphQLPluginTrait::mockEnum protected function Mock a GraphQL enum.
MockGraphQLPluginTrait::mockEnumFactory protected function
MockGraphQLPluginTrait::mockField protected function Mock a GraphQL field.
MockGraphQLPluginTrait::mockFieldFactory protected function
MockGraphQLPluginTrait::mockInputType protected function Mock a GraphQL input type.
MockGraphQLPluginTrait::mockInputTypeFactory protected function
MockGraphQLPluginTrait::mockInterface protected function Mock a GraphQL interface.
MockGraphQLPluginTrait::mockInterfaceFactory protected function
MockGraphQLPluginTrait::mockMutation protected function Mock a GraphQL mutation.
MockGraphQLPluginTrait::mockMutationFactory protected function 1
MockGraphQLPluginTrait::mockSchema protected function Mock a schema instance.
MockGraphQLPluginTrait::mockSchemaFactory protected function
MockGraphQLPluginTrait::mockType protected function Mock a GraphQL type.
MockGraphQLPluginTrait::mockTypeFactory protected function
MockGraphQLPluginTrait::mockUnion protected function Mock a GraphQL union.
MockGraphQLPluginTrait::mockUnionFactory protected function
MockGraphQLPluginTrait::resetStaticCaches protected function Reset static caches in plugin managers.
MockGraphQLPluginTrait::toBoundPromise protected function Turn a value into a bound result promise.
MockGraphQLPluginTrait::toPromise protected function Turn a value into a result promise.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
ProphesizePermissionsTrait::$accountProphecy protected property
ProphesizePermissionsTrait::injectAccount protected function Bypass user access.
ProphesizePermissionsTrait::userPermissions protected function Set the prophesized permissions. 3
ProphesizePermissionsTrait::userRoles protected function Set the prophesized roles.
QueryFileTrait::getQueriesDirectory protected function Get the path to the directory containing test query files.
QueryFileTrait::getQueryFromFile public function Retrieve the GraphQL query stored in a file as string.
QueryResultAssertionTrait::assertErrors protected function Assert a query result with certain errors.
QueryResultAssertionTrait::assertResultData private function Assert a certain result data set on a query result.
QueryResultAssertionTrait::assertResultErrors private function Assert that the result contains contains a certain set of errors.
QueryResultAssertionTrait::assertResultMetadata private function Assert a certain set of result metadata on a query result.
QueryResultAssertionTrait::assertResults protected function Assert a result for a graphql query and variables.
QueryResultAssertionTrait::defaultCacheMetaData protected function The default cache metadata object.
QueryResultAssertionTrait::defaultMutationCacheMetaData protected function The default mutation cache metadata object.
QueryResultAssertionTrait::graphQlProcessor protected function Retrieve the graphql processor.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestFrameworkTest::testErrorAssertion public function Test result error assertions.
TestFrameworkTest::testFieldMock public function Test mocked fields.
TestFrameworkTest::testInterfaceMock public function Test interface mocking.
TestFrameworkTest::testMutationMock public function Test mutation mocking.
TestFrameworkTest::testTypeMock public function Test type mocking.
TestFrameworkTest::testUnionMock public function Test union mocks.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.