abstract class FileTestBase in Feeds 8.3
Base class for file field tests.
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses DeprecatedServicePropertyTrait, UserCreationTrait
- class \Drupal\Tests\feeds\Kernel\FeedsKernelTestBase uses FeedCreationTrait, FeedsCommonTrait, FeedsReflectionTrait
- class \Drupal\Tests\feeds\Kernel\Feeds\Target\FileTestBase uses FeedsMockingTrait
- class \Drupal\Tests\feeds\Kernel\FeedsKernelTestBase uses FeedCreationTrait, FeedsCommonTrait, FeedsReflectionTrait
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses DeprecatedServicePropertyTrait, UserCreationTrait
Expanded class hierarchy of FileTestBase
File
- tests/
src/ Kernel/ Feeds/ Target/ FileTestBase.php, line 24
Namespace
Drupal\Tests\feeds\Kernel\Feeds\TargetView source
abstract class FileTestBase extends FeedsKernelTestBase {
use FeedsMockingTrait;
/**
* The entity type manager prophecy used in the test.
*
* @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\Entity\EntityTypeManagerInterface
*/
protected $entityTypeManager;
/**
* The http client prophecy used in the test.
*
* @var \Prophecy\Prophecy\ProphecyInterface|\GuzzleHttp\ClientInterface
*/
protected $client;
/**
* Token service.
*
* @var \Prophecy\Prophecy\ProphecyInterface|\Drupal\Core\Utility\Token
*/
protected $token;
/**
* The file and stream wrapper helper.
*
* @var \Drupal\Core\File\FileSystemInterface
*/
protected $fileSystem;
/**
* The FeedsTarget plugin being tested.
*
* @var \Drupal\feeds\Feeds\Target\File
*/
protected $targetPlugin;
/**
* {@inheritdoc}
*/
public function setUp() {
parent::setUp();
$this
->setUpFileFields();
$this->entityTypeManager = $this
->prophesize(EntityTypeManagerInterface::class);
$this->client = $this
->prophesize(ClientInterface::class);
$this->token = $this
->prophesize(Token::class);
$this->entityFieldManager = $this
->prophesize(EntityFieldManagerInterface::class);
$this->entityFieldManager
->getFieldStorageDefinitions('file')
->willReturn([]);
$this->entityFinder = $this
->prophesize(EntityFinderInterface::class);
$this->entityFinder
->findEntities(Argument::cetera())
->willReturn([]);
$this->fileSystem = $this
->prophesize(FileSystemInterface::class);
// Made-up entity type that we are referencing to.
$referenceable_entity_type = $this
->prophesize(EntityTypeInterface::class);
$referenceable_entity_type
->getKey('label')
->willReturn('file label');
$this->entityTypeManager
->getDefinition('file')
->willReturn($referenceable_entity_type)
->shouldBeCalled();
$configuration = [
'feed_type' => $this
->createMock(FeedTypeInterface::class),
'target_definition' => $this
->getTargetDefinition(),
];
$this->targetPlugin = $this
->getMockBuilder($this
->getTargetPluginClass())
->setMethods([
'getDestinationDirectory',
])
->setConstructorArgs([
$configuration,
'file',
[],
$this->entityTypeManager
->reveal(),
$this->client
->reveal(),
$this->token
->reveal(),
$this->entityFieldManager
->reveal(),
$this->entityFinder
->reveal(),
$this->fileSystem
->reveal(),
])
->getMock();
$this->targetPlugin
->expects($this
->any())
->method('getDestinationDirectory')
->will($this
->returnValue('public:/'));
// Role::load fails without installing the user config.
$this
->installConfig([
'user',
]);
// Give anonymous users permission to access content, so that they can view
// and download public files. Without this we get an access denied error
// when trying to import public files.
Role::load(Role::ANONYMOUS_ID)
->grantPermission('access content')
->save();
}
/**
* Returns the file target class to instantiate.
*
* @return string
* The class for the file target plugin.
*/
protected abstract function getTargetPluginClass();
/**
* Returns target definition to pass to the target constructor.
*
* @return array
* The target definition for the file target.
*/
protected abstract function getTargetDefinition();
/**
* @covers ::prepareValue
* @dataProvider dataProviderPrepareValue
*
* @param array $expected
* The expected values.
* @param array $values
* The values to pass to prepareValue().
* @param string $expected_exception
* (optional) The name of the expected exception class.
* @param string $expected_exception_message
* (optional) The expected exception message.
*/
public function testPrepareValue(array $expected, array $values, $expected_exception = NULL, $expected_exception_message = NULL) {
$method = $this
->getProtectedClosure($this->targetPlugin, 'prepareValue');
// Add in base URL.
if (isset($values['target_id'])) {
$file_path = strtr($values['target_id'], [
'[url]' => $this
->resourcesPath(),
]);
$values['target_id'] = strtr($values['target_id'], [
'[url]' => $this
->resourcesUrl(),
]);
// Set guzzle client response.
if (file_exists($file_path)) {
$this->client
->request('GET', $values['target_id'], Argument::any())
->will(function () use ($file_path) {
return new Response(200, [], file_get_contents($file_path));
});
}
else {
$this->client
->request('GET', $values['target_id'], Argument::any())
->will(function () {
return new Response(404, [], '');
});
}
}
// Set expected exception if there is one expected.
if ($expected_exception) {
$this
->expectException($expected_exception);
if ($expected_exception_message) {
$expected_exception_message = strtr($expected_exception_message, [
'[url]' => $this
->resourcesUrl(),
]);
$this
->expectExceptionMessage($expected_exception_message);
}
}
// Call prepareValue().
$method(0, $values);
// Asserts.
foreach ($expected as $key => $value) {
$this
->assertEquals($value, $values[$key]);
}
}
/**
* Data provider for testPrepareValue().
*/
public function dataProviderPrepareValue() {
$return = [
// Empty file target value.
'empty-file' => [
'expected' => [],
'values' => [
'target_id' => '',
],
'expected_exception' => EmptyFeedException::class,
'expected_exception_message' => 'The given file url is empty.',
],
// Importing a file url that exists.
'file-success' => [
'expected' => [
'target_id' => 1,
],
'values' => [
'target_id' => '[url]/assets/attersee.jpeg',
],
],
// Importing a file with uppercase extension.
'file-uppercase' => [
'expected' => [
'target_id' => 1,
],
'values' => [
'target_id' => '[url]/assets/attersee.JPG',
],
],
// Importing a file url that does *not* exist.
'file-not-found' => [
'expected' => [],
'values' => [
'target_id' => '[url]/assets/not-found.jpg',
],
'expected_exception' => TargetValidationException::class,
'expected_exception_message' => 'Download of <em class="placeholder">[url]/assets/not-found.jpg</em> failed with code 404.',
],
// Importing a file with invalid extension.
'invalid-extension' => [
'expected' => [],
'values' => [
'target_id' => '[url]/file.foo',
],
'expected_exception' => TargetValidationException::class,
'expected_exception_message' => 'The file, <em class="placeholder">[url]/file.foo</em>, failed to save because the extension, <em class="placeholder">foo</em>, is invalid.',
],
];
return $return;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
EntityKernelTestBase:: |
protected | property | The list of deprecated services. | |
EntityKernelTestBase:: |
protected | property | A list of generated identifiers. | |
EntityKernelTestBase:: |
protected | property | The state service. | |
EntityKernelTestBase:: |
protected | function | Creates a user. | |
EntityKernelTestBase:: |
protected | function | Generates a random ID avoiding collisions. | |
EntityKernelTestBase:: |
protected | function | Returns the entity_test hook invocation info. | |
EntityKernelTestBase:: |
protected | function | Installs a module and refreshes services. | |
EntityKernelTestBase:: |
protected | function | Refresh services. | 1 |
EntityKernelTestBase:: |
protected | function | Uninstalls a module and refreshes services. | |
FeedCreationTrait:: |
protected | function | Creates a feed with default settings. | |
FeedCreationTrait:: |
protected | function | Creates a feed type with default settings. | |
FeedCreationTrait:: |
protected | function | Creates a feed type for the CSV parser. | |
FeedCreationTrait:: |
protected | function | Returns default mappings for tests. | 1 |
FeedCreationTrait:: |
protected | function | Reloads a feed entity. | |
FeedsCommonTrait:: |
protected | property | The node type to test with. | |
FeedsCommonTrait:: |
protected | function | Returns the absolute path to the Drupal root. | |
FeedsCommonTrait:: |
protected | function | Returns the absolute directory path of the Feeds module. | |
FeedsCommonTrait:: |
protected | function | Asserts that the given number of nodes exist. | |
FeedsCommonTrait:: |
protected | function | Creates a field and an associated field storage. | |
FeedsCommonTrait:: |
protected | function | Creates a new node with a feeds item field. | |
FeedsCommonTrait:: |
protected | function | Prints messages useful for debugging. | |
FeedsCommonTrait:: |
protected | function | Reloads an entity. | |
FeedsCommonTrait:: |
protected | function | Returns the absolute directory path of the resources folder. | |
FeedsCommonTrait:: |
protected | function | Returns the url to the Feeds resources directory. | |
FeedsCommonTrait:: |
protected | function | Runs all items from one queue. | |
FeedsCommonTrait:: |
protected | function | Creates a default node type called 'article'. | |
FeedsKernelTestBase:: |
public static | property |
Modules to enable. Overrides EntityKernelTestBase:: |
13 |
FeedsKernelTestBase:: |
protected | function | Installs the taxonomy module and adds a vocabulary. | |
FeedsKernelTestBase:: |
protected | function | Installs body field (not needed for every kernel test). | |
FeedsKernelTestBase:: |
protected | function | Installs a file and image fields (not needed for every kernel test). | |
FeedsKernelTestBase:: |
protected | function | Installs a taxonomy term reference field. | |
FeedsMockingTrait:: |
protected | function | Mocks an account object. | |
FeedsMockingTrait:: |
protected | function | Returns a mocked AccountSwitcher object. | |
FeedsMockingTrait:: |
protected | function | Returns a mocked feed entity. | |
FeedsMockingTrait:: |
protected | function | Returns a mocked feed type entity. | |
FeedsMockingTrait:: |
protected | function | Mocks a field definition. | 1 |
FeedsMockingTrait:: |
protected | function | Mocks the file system. | |
FeedsReflectionTrait:: |
protected | function | Calls a protected method on the given object. | |
FeedsReflectionTrait:: |
protected | function | Gets a ReflectionMethod for a class method. | |
FeedsReflectionTrait:: |
protected | function | Returns a dynamically created closure for the object's method. | |
FeedsReflectionTrait:: |
protected | function | Sets a protected property. | |
FileTestBase:: |
protected | property | The http client prophecy used in the test. | |
FileTestBase:: |
protected | property |
The entity type manager prophecy used in the test. Overrides EntityKernelTestBase:: |
|
FileTestBase:: |
protected | property | The file and stream wrapper helper. | |
FileTestBase:: |
protected | property | The FeedsTarget plugin being tested. | |
FileTestBase:: |
protected | property | Token service. | |
FileTestBase:: |
public | function | Data provider for testPrepareValue(). | 1 |
FileTestBase:: |
abstract protected | function | Returns target definition to pass to the target constructor. | 2 |
FileTestBase:: |
abstract protected | function | Returns the file target class to instantiate. | 2 |
FileTestBase:: |
public | function |
Overrides FeedsKernelTestBase:: |
|
FileTestBase:: |
public | function | @covers ::prepareValue @dataProvider dataProviderPrepareValue | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions | |
UserCreationTrait:: |
protected | function | Creates an administrative role. Aliased as: drupalCreateAdminRole | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. Aliased as: drupalGrantPermissions | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. Aliased as: drupalSetCurrentUser | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser |