Test_Jetpack_Sync_Search::test_module_is_enabled() - Code Metrics - Inspection of "Clean up the linting errors for the tests." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/jp-search-sync ( 59fc08...405a37 )

unknown

created 2021-02-18 23:11 UTC

Test_Jetpack_Sync_Search::test_module_is_enabled() A

↳ Parent: Test_Jetpack_Sync_Search

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Integration Tests for Search syncing.
 *
 * @package automattic/jetpack-sync
 */

// phpcs:disable Squiz.Commenting
// phpcs:disable Generic.Commenting

use Automattic\Jetpack\Sync\Modules;

class Test_Jetpack_Sync_Search extends WP_Test_Jetpack_Sync_Base {
	protected $post_id;
	protected static $search_sync;

	public static function setUpBeforeClass() {
		parent::setUpBeforeClass();

		self::$search_sync = Modules::get_module( 'search' );
	}

	public function setUp() {
		parent::setUp();

		// create a post.
		$this->post_id = $this->factory->post->create();
		$this->sender->do_sync();
	}

	public function test_module_is_enabled() {
		$this->assertTrue( (bool) Modules::get_module( 'search' ) );
	}

	/**
	 * Data Providers.
	 */

	public function get_allowed_postmeta_keys() {
		$search_sync = Modules::get_module( 'search' );
		$params      = array();
		$keys        = $search_sync->get_all_postmeta_keys();
		foreach ( $keys as $k ) {
			$params[] = array( $k );
		}
		return $params;
	}

	public function get_allowed_taxonomies() {
		$search_sync = Modules::get_module( 'search' );
		$params      = array();
		$keys        = $search_sync->get_all_taxonomies();
		foreach ( $keys as $k ) {
			$params[] = array( $k );
		}
		return $params;
	}

	/**
	 * Post meta tests.
	 */

	/**
	 * @dataProvider get_allowed_postmeta_keys
	 */
	public function test_add_post_meta( $key ) {
		$v = md5( wp_rand() );
		add_post_meta( $this->post_id, $key, $v, true );

		$this->sender->do_sync();
		$this->assertEquals(
			array( $v ),
			$this->server_replica_storage->get_metadata( 'post', $this->post_id, $key )
		);
		delete_post_meta( $this->post_id, $key, $v );
	}

	public function test_doesn_t_sync_meta() {
		add_post_meta( $this->post_id, 'no_sync_jetpack_search', 'foo' );

		$this->sender->do_sync();

		$this->assertEquals(
			array(),
			$this->server_replica_storage->get_metadata( 'post', $this->post_id, 'no_sync_jetpack_search' )
		);
		delete_post_meta( $this->post_id, 'no_sync_jetpack_search', 'foo' );
	}

	public function test_meta_is_indexable() {
		$this->assertTrue( self::$search_sync->is_indexable( 'postmeta', 'jetpack-search-meta0' ) );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	public function test_meta_is_not_indexable() {
		$this->assertFalse( self::$search_sync->is_indexable( 'postmeta', 'no_one_wants_to_index_me' ), 'no_one_wants_to_index_me' );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		$this->assertFalse( self::$search_sync->is_indexable( 'postmeta', 'no_one_wants_to_index_me' ), '_no_one_wants_to_index_me' );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	public function test_meta_no_overlap() {
		$indexed_keys = self::$search_sync->get_all_postmeta_keys();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		asort( $indexed_keys );
		$unindexed_keys = self::$search_sync->get_all_unindexed_postmeta_keys();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		asort( $unindexed_keys );
		$this->assertEmpty( array_intersect( $unindexed_keys, $indexed_keys ) );
	}

	/**
	 * Important that we double check the specification format since
	 * this will often get added to.
	 *
	 * @dataProvider get_allowed_postmeta_keys
	 */
	public function test_check_postmeta_spec( $key ) {
		$spec = self::$search_sync->get_postmeta_spec( $key );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

		$this->assertIsArray( $spec );
		$this->assertThat(
			$spec,
			$this->logicalOr(
				$this->isEmpty(),
				$this->arrayHasKey( 'searchable_in_all_content' ),
				$this->arrayHasKey( 'available' ),
				$this->arrayHasKey( 'alternatives' )
			),
			'Post meta specification does not match.'
		);

		if ( isset( $spec['searchable_in_all_content'] ) ) {
			$this->assertIsBool( $spec['searchable_in_all_content'] );
		}
		if ( isset( $spec['available'] ) ) {
			$this->assertIsBool( $spec['available'] );
		}
		if ( isset( $spec['alternatives'] ) ) {
			$this->assertIsArray( $spec['alternatives'] );
		}
	}

	/**
	 * Custom Taxonomy Tests.
	 */

	/**
	 * @dataProvider get_allowed_taxonomies
	 */
	public function test_add_taxonomy( $taxonomy ) {
		register_taxonomy(
			$taxonomy,
			'post',
			array(
				'label'        => __( 'Taxonomy Test', 'jetpack' ),
				'rewrite'      => array( 'slug' => $taxonomy ),
				'hierarchical' => true,
			)
		);

		$term = md5( wp_rand() );
		if ( 'post_format' === $taxonomy ) {
			// Special case in Core.
			$term = 'Standard';
		}
		$term_obj = wp_insert_term( $term, $taxonomy );
		wp_set_post_terms( $this->post_id, array( $term_obj['term_id'] ), $taxonomy, false );
		$this->sender->do_sync();

		// Check taxonomy and added term.
		$this->assertEquals(
			$this->get_terms( $taxonomy ),
			$this->server_replica_storage->get_terms( $taxonomy ),
			'Terms on cache site match do not match client site'
		);

		$this->assertEqualsObject(
			get_the_terms( $this->post_id, $taxonomy ),
			$this->server_replica_storage->get_the_terms( $this->post_id, $taxonomy ),
			'Adeded term does not match local term.'
		);

		// clean up - speeds up tests
		wp_remove_object_terms( $this->post_id, array( $term_obj['term_id'] ), $taxonomy );
		unregister_taxonomy_for_object_type( $taxonomy, 'post' );
	}

	public function test_taxonomy_is_indexable() {
		$this->assertTrue( self::$search_sync->is_indexable( 'taxonomy', 'jetpack-search-tag0' ) );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	public function test_taxonomy_is_not_indexable() {
		$this->assertFalse( self::$search_sync->is_indexable( 'taxonomy', 'no_one_wants_to_index_me' ) );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
	}

	/**
	 * Helpers
	 */

	protected function get_terms( $taxonomy ) {
		$terms = get_terms(
			array(
				'taxonomy'   => $taxonomy,
				'hide_empty' => false,
			)
		);
		// We need an array of stdClass rather than WP_Term.
		return array_map(
			function ( $object ) {
				return (object) (array) $object; },
			$terms
		);
	}

}



Push — add/jp-search-sync ( 59fc08...405a37 )

Test_Jetpack_Sync_Search::test_module_is_enabled() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Automattic / jetpack

Push — add/jp-search-sync ( 59fc08...405a37 )

Test_Jetpack_Sync_Search::test_module_is_enabled() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like