class AnnounceFetcherTest

Same name in other branches
  1. 11.x core/modules/announcements_feed/tests/src/Kernel/AnnounceFetcherTest.php \Drupal\Tests\announcements_feed\Kernel\AnnounceFetcherTest

@coversDefaultClass \Drupal\announcements_feed\AnnounceFetcher

@group announcements_feed

Hierarchy

Expanded class hierarchy of AnnounceFetcherTest

File

core/modules/announcements_feed/tests/src/Kernel/AnnounceFetcherTest.php, line 14

Namespace

Drupal\Tests\announcements_feed\Kernel
View source
class AnnounceFetcherTest extends AnnounceTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'announcements_feed',
        ]);
    }
    
    /**
     * Tests announcement that should be displayed.
     *
     * @param mixed[] $feed_item
     *   The feed item to test. 'title' and 'url' are omitted from this array
     *   because they do not need to vary between test cases.
     *
     * @dataProvider providerShowAnnouncements
     */
    public function testShowAnnouncements(array $feed_item) : void {
        $this->markTestSkipped('Skipped due to major version-specific logic. See https://www.drupal.org/project/drupal/issues/3359322');
        $this->setFeedItems([
            $feed_item,
        ]);
        $feeds = $this->fetchFeedItems();
        $this->assertCount(1, $feeds);
        $this->assertSame('https://www.drupal.org/project/announce', $feeds[0]->url);
        $this->assertSame('Drupal security update Test', $feeds[0]->title);
        $this->assertSame('^10', $feeds[0]->version);
        $this->assertCount(1, $this->history);
    }
    
    /**
     * Tests feed fields.
     */
    public function testFeedFields() : void {
        $this->markTestSkipped('Skipped due to major version-specific logic. See https://www.drupal.org/project/drupal/issues/3359322');
        $feed_item_1 = [
            'id' => '1001',
            'content_html' => 'Test teaser 1',
            'url' => 'https://www.drupal.org/project/announce',
            '_drupalorg' => [
                'featured' => TRUE,
                'version' => '^10',
            ],
            'date_modified' => "2021-09-02T15:09:42+00:00",
            'date_published' => "2021-09-01T15:09:42+00:00",
        ];
        $this->setFeedItems([
            $feed_item_1,
        ]);
        $feeds = $this->fetchFeedItems();
        $this->assertCount(1, $feeds);
        $this->assertSame($feed_item_1['id'], $feeds[0]->id);
        $this->assertSame($feed_item_1['content_html'], $feeds[0]->content_html);
        $this->assertSame($feed_item_1['_drupalorg']['featured'], $feeds[0]->featured);
        $this->assertSame($feed_item_1['date_published'], $feeds[0]->date_published);
        $this->assertSame($feed_item_1['_drupalorg']['version'], $feeds[0]->version);
    }
    
    /**
     * Data provider for testShowAnnouncements().
     */
    public static function providerShowAnnouncements() : array {
        return [
            '1' => [
                'feed_item' => [
                    'id' => '1001',
                    'content_html' => 'Test teaser 1',
                    '_drupalorg' => [
                        'featured' => 1,
                        'version' => '^10',
                    ],
                    'date_modified' => "2021-09-02T15:09:42+00:00",
                    'date_published' => "2021-09-01T15:09:42+00:00",
                ],
            ],
            '2' => [
                'feed_item' => [
                    'id' => '1002',
                    'content_html' => 'Test teaser 2',
                    '_drupalorg' => [
                        'featured' => 1,
                        'version' => '^10',
                    ],
                    'date_modified' => "2021-09-02T15:09:42+00:00",
                    'date_published' => "2021-09-01T15:09:42+00:00",
                ],
            ],
            '3' => [
                'feed_item' => [
                    'id' => '1003',
                    'content_html' => 'Test teaser 3',
                    '_drupalorg' => [
                        'featured' => 1,
                        'version' => '^10',
                    ],
                    'date_modified' => "2021-09-02T15:09:42+00:00",
                    'date_published' => "2021-09-01T15:09:42+00:00",
                ],
            ],
            '4' => [
                'feed_item' => [
                    'id' => '1004',
                    'content_html' => 'Test teaser 4',
                    '_drupalorg' => [
                        'featured' => 1,
                        'version' => '^10',
                    ],
                    'date_modified' => "2021-09-02T15:09:42+00:00",
                    'date_published' => "2021-09-01T15:09:42+00:00",
                ],
            ],
        ];
    }
    
    /**
     * Sets the feed items to be returned for the test.
     *
     * @param mixed[][] $feed_items
     *   The feeds items to test. Every time the http_client makes a request the
     *   next item in this array will be returned. For each feed item 'title' and
     *   'url' are omitted because they do not need to vary between test cases.
     */
    protected function setFeedItems(array $feed_items) : void {
        $responses = [];
        foreach ($feed_items as $feed_item) {
            $feed_item += [
                'title' => 'Drupal security update Test',
                'url' => 'https://www.drupal.org/project/announce',
            ];
            $responses[] = new Response(200, [], json_encode([
                'items' => [
                    $feed_item,
                ],
            ]));
        }
        $this->setTestFeedResponses($responses);
    }
    
    /**
     * Gets the announcements from the 'announce.fetcher' service.
     *
     * @return \Drupal\announcements_feed\Announcement[]
     *   The return value of AnnounceFetcher::fetch().
     */
    protected function fetchFeedItems() : array {
        return $this->container
            ->get('announcements_feed.fetcher')
            ->fetch();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AnnounceFetcherTest::fetchFeedItems protected function Gets the announcements from the 'announce.fetcher' service.
AnnounceFetcherTest::providerShowAnnouncements public static function Data provider for testShowAnnouncements().
AnnounceFetcherTest::setFeedItems protected function Sets the feed items to be returned for the test. Overrides AnnounceTestBase::setFeedItems
AnnounceFetcherTest::setUp protected function Overrides AnnounceTestBase::setUp
AnnounceFetcherTest::testFeedFields public function Tests feed fields.
AnnounceFetcherTest::testShowAnnouncements public function Tests announcement that should be displayed.
AnnounceTestBase::$history protected property History of requests/responses.
AnnounceTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 1
AnnounceTestBase::setTestFeedResponses protected function Sets test feed responses.
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 raw text IS NOT found escaped on 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::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.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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 Deprecated 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 public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
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 Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.