class JsonPathParserTest in Feeds extensible parsers 8

@coversDefaultClass \Drupal\feeds_ex\Feeds\Parser\JsonPathParser @group feeds_ex

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\feeds\Unit\FeedsUnitTestCase uses FeedsMockingTrait, FeedsReflectionTrait
    • class \Drupal\Tests\feeds_ex\Unit\UnitTestBase
      • class \Drupal\Tests\feeds_ex\Unit\Feeds\Parser\ParserTestBase
        • class \Drupal\Tests\feeds_ex\Unit\Feeds\Parser\JsonPathParserTest

File

tests/src/Unit/Feeds/Parser/JsonPathParserTest.php, line 16

Namespace

Drupal\Tests\feeds_ex\Unit\Feeds\Parser

class JsonPathParserTest extends ParserTestBase {

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $configuration = [
      'feed_type' => $this->feedType,
    ];
    $utility = new JsonUtility();
    $utility
      ->setStringTranslation($this
      ->getStringTranslationStub());
    $this->parser = new JsonPathParser($configuration, 'jsonpath', [], $utility);
    $this->parser
      ->setStringTranslation($this
      ->getStringTranslationStub());
    $this->parser
      ->setFeedsExMessenger(new TestMessenger());
  }

  /**
   * Tests simple parsing.
   */
  public function testSimpleParsing() {
    $fetcher_result = new RawFetcherResult(file_get_contents($this->moduleDir . '/tests/resources/test.json'), $this->fileSystem);
    $config = [
      'context' => [
        'value' => '$.items.*',
      ],
      'sources' => [
        'title' => [
          'name' => 'Title',
          'value' => 'title',
        ],
        'description' => [
          'name' => 'Title',
          'value' => 'description',
        ],
      ],
    ] + $this->parser
      ->defaultConfiguration();
    $this->parser
      ->setConfiguration($config);
    $result = $this->parser
      ->parse($this->feed, $fetcher_result, $this->state);
    $this
      ->assertCount(3, $result);
    foreach ($result as $delta => $item) {
      $this
        ->assertSame('I am a title' . $delta, $item
        ->get('title'));
      $this
        ->assertSame('I am a description' . $delta, $item
        ->get('description'));
    }
  }

  /**
   * Tests parsing error handling.
   */
  public function testErrorHandling() {

    // Parse some invalid JSON.
    json_decode('\\"asdfasfd');
    $errors = $this
      ->invokeMethod($this->parser, 'getErrors');
    $this
      ->assertSame(3, $errors[0]['severity']);
  }

  /**
   * Tests batch parsing.
   */
  public function testBatchParsing() {
    $fetcher_result = new RawFetcherResult(file_get_contents($this->moduleDir . '/tests/resources/test.json'), $this->fileSystem);
    $config = [
      'context' => [
        'value' => '$.items.*',
      ],
      'sources' => [
        'title' => [
          'name' => 'Title',
          'value' => 'title',
        ],
        'description' => [
          'name' => 'Title',
          'value' => 'description',
        ],
      ],
      'line_limit' => 1,
    ] + $this->parser
      ->defaultConfiguration();
    $this->parser
      ->setConfiguration($config);
    foreach (range(0, 2) as $delta) {
      $result = $this->parser
        ->parse($this->feed, $fetcher_result, $this->state);
      $this
        ->assertCount(1, $result);
      $this
        ->assertSame('I am a title' . $delta, $result[0]
        ->get('title'));
      $this
        ->assertSame('I am a description' . $delta, $result[0]
        ->get('description'));
    }

    // We should be out of items.
    $result = $this->parser
      ->parse($this->feed, $fetcher_result, $this->state);
    $this
      ->assertCount(0, $result);
  }

  /**
   * Tests parsing with a root object.
   */
  public function testRootContext() {
    $fetcher_result = new RawFetcherResult(file_get_contents($this->moduleDir . '/tests/resources/test.json'), $this->fileSystem);
    $config = [
      'context' => [
        'value' => '.',
      ],
      'sources' => [
        'title' => [
          'name' => 'Title',
          'value' => 'items[0].title',
        ],
      ],
    ] + $this->parser
      ->defaultConfiguration();
    $this->parser
      ->setConfiguration($config);
    $result = $this->parser
      ->parse($this->feed, $fetcher_result, $this->state);
    $this
      ->assertCount(1, $result);
    $this
      ->assertEquals('I am a title0', $result[0]
      ->get('title'));
  }

  /**
   * Tests JSONPath validation.
   */
  public function testValidateExpression() {

    // Invalid expression.
    $expression = '!! ';
    $this
      ->assertStringStartsWith('Unable to parse token !! in expression', $this
      ->invokeMethod($this->parser, 'validateExpression', [
      &$expression,
    ]));

    // Test that value was trimmed.
    $this
      ->assertSame($expression, '!!', 'Value was trimmed.');
  }

  /**
   * Tests parsing invalid JSON.
   */
  public function testInvalidJson() {
    $config = [
      'context' => [
        'value' => '$.items[asdfasdf]',
      ],
    ] + $this->parser
      ->defaultConfiguration();
    $this->parser
      ->setConfiguration($config);
    $this
      ->expectException(RuntimeException::class);
    $this
      ->expectExceptionMessage('The JSON is invalid.');
    $this->parser
      ->parse($this->feed, new RawFetcherResult('invalid json', $this->fileSystem), $this->state);
  }

  /**
   * Tests log messages when using invalid JSON.
   *
   * @todo Feeds log is gone.
   */
  public function _testInvalidJsonLogMessages() {
    $config = [
      'context' => [
        'value' => '$.items[asdfasdf]',
      ],
    ] + $this->parser
      ->defaultConfiguration();
    $this->parser
      ->setConfiguration($config);
    try {
      $this->parser
        ->parse($this->feed, new RawFetcherResult('invalid json', $this->fileSystem), $this->state);
    } catch (Exception $e) {

      // Ignore any exceptions.
    }
    $log_messages = $this->feed
      ->getLogMessages();
    $this
      ->assertCount(1, $log_messages);
    $this
      ->assertSame($log_messages[0]['message'], 'Syntax error');
    $this
      ->assertSame($log_messages[0]['type'], 'feeds_ex');
    $this
      ->assertSame($log_messages[0]['severity'], 3);
  }

  /**
   * Tests empty feed handling.
   */
  public function testEmptyFeed() {
    $this->parser
      ->parse($this->feed, new RawFetcherResult(' ', $this->fileSystem), $this->state);
    $this
      ->assertEmptyFeedMessage($this->parser
      ->getMessenger()
      ->getMessages());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FeedsMockingTrait::getMockAccount	protected	function	Mocks an account object.
FeedsMockingTrait::getMockedAccountSwitcher	protected	function	Returns a mocked AccountSwitcher object.
FeedsMockingTrait::getMockFeed	protected	function	Returns a mocked feed entity.
FeedsMockingTrait::getMockFeedType	protected	function	Returns a mocked feed type entity.
FeedsMockingTrait::getMockFieldDefinition	protected	function	Mocks a field definition.	1
FeedsMockingTrait::getMockFileSystem	protected	function	Mocks the file system.
FeedsReflectionTrait::callProtectedMethod	protected	function	Calls a protected method on the given object.
FeedsReflectionTrait::getMethod	protected	function	Gets a ReflectionMethod for a class method.
FeedsReflectionTrait::getProtectedClosure	protected	function	Returns a dynamically created closure for the object's method.
FeedsReflectionTrait::setProtectedProperty	protected	function	Sets a protected property.
FeedsUnitTestCase::absolutePath	protected	function	Returns the absolute directory path of the Feeds module.
FeedsUnitTestCase::defineConstants	protected	function	Defines stub constants.
FeedsUnitTestCase::getMockStreamWrapperManager	protected	function	Returns a mock stream wrapper manager.
FeedsUnitTestCase::resourcesPath	protected	function	Returns the absolute directory path of the resources folder.
JsonPathParserTest::setUp	public	function	Overrides ParserTestBase::setUp
JsonPathParserTest::testBatchParsing	public	function	Tests batch parsing.
JsonPathParserTest::testEmptyFeed	public	function	Tests empty feed handling.
JsonPathParserTest::testErrorHandling	public	function	Tests parsing error handling.
JsonPathParserTest::testInvalidJson	public	function	Tests parsing invalid JSON.
JsonPathParserTest::testRootContext	public	function	Tests parsing with a root object.
JsonPathParserTest::testSimpleParsing	public	function	Tests simple parsing.
JsonPathParserTest::testValidateExpression	public	function	Tests JSONPath validation.
JsonPathParserTest::_testInvalidJsonLogMessages	public	function	Tests log messages when using invalid JSON.
ParserTestBase::$feed	protected	property	The feed entity.
ParserTestBase::$feedType	protected	property	The feed type entity.
ParserTestBase::$parser	protected	property	The Feeds parser plugin.
ParserTestBase::$state	protected	property	The state object.
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.
UnitTestBase::$fileSystem	protected	property	A mocked file system.
UnitTestBase::$moduleDir	protected	property	The module directory.
UnitTestBase::assertEmptyFeedMessage	protected	function	Asserts that the empty message is correct.
UnitTestBase::invokeMethod	protected	function	Calls a private or protected method on an object.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.