From be957bdcedf9dd756ff831975482ac566c1c34f9 Mon Sep 17 00:00:00 2001 From: hellofromtonya Date: Mon, 24 Apr 2023 16:27:48 -0500 Subject: [PATCH 1/2] Adds tests --- ...bergAddRegisteredFontsToThemeJson-test.php | 315 ++++++++++++++++++ 1 file changed, 315 insertions(+) create mode 100644 phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php diff --git a/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php b/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php new file mode 100644 index 0000000000000..8a434b38d949e --- /dev/null +++ b/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php @@ -0,0 +1,315 @@ +orig_theme_dir = $GLOBALS['wp_theme_directories']; + + // /themes is necessary as theme.php functions assume /themes is the root if there is only one root. + $GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', self::$theme_root ); + + // Set up the new root. + add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); + add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); + add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); + + // Clear caches. + wp_clean_themes_cache(); + unset( $GLOBALS['wp_themes'] ); + } + + public function tear_down() { + // Clear up the filters to modify the theme root. + remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); + remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); + remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); + + WP_Theme_JSON_Resolver::clean_cached_data(); + + parent::tear_down(); + } + /** + * Cleans up global scope. + * + * @global WP_Styles $wp_styles + */ + public function clean_up_global_scope() { + parent::clean_up_global_scope(); + + $GLOBALS['wp_theme_directories'] = $this->orig_theme_dir; + wp_clean_themes_cache(); + + if ( function_exists( 'wp_clean_theme_json_cache' ) ) { + wp_clean_theme_json_cache(); + } + + if ( function_exists( '_gutenberg_clean_theme_json_caches' ) ) { + _gutenberg_clean_theme_json_caches(); + } + + unset( $GLOBALS['wp_themes'] ); + } + + public function filter_set_theme_root() { + return self::$theme_root; + } + + /** + * @dataProvider data_themes + * + * @param string $theme Theme to use. + */ + public function test_should_return_instance( $theme ) { + switch_theme( $theme ); + + $data = new WP_Theme_JSON_Gutenberg( self::$theme_json_data[ $theme ] ); + $actual = gutenberg_add_registered_fonts_to_theme_json( $data ); + + $this->assertInstanceOf( WP_Theme_JSON_Gutenberg::class, $actual, 'Instance of WP_Theme_JSON_Gutenberg should be returned' ); + } + + /** + * @dataProvider data_themes + * + * @param string $theme Theme to use. + */ + public function test_should_bail_out_when_no_registered_fonts( $theme ) { + switch_theme( $theme ); + + $data = new WP_Theme_JSON_Gutenberg( self::$theme_json_data[ $theme ] ); + $actual = gutenberg_add_registered_fonts_to_theme_json( $data ); + + $this->assertEmpty( wp_fonts()->get_registered_font_families(), 'No fonts should be registered in Fonts API' ); + $this->assertSame( $data, $actual, 'Same instance of WP_Theme_JSON_Gutenberg should be returned' ); + } + + /** + * Data Provider. + * + * @return array + */ + public function data_themes() { + return array( + 'no fonts defined' => array( 'block-theme' ), + 'no fonts registered' => array( static::FONTS_THEME ), + ); + } + + /** + * @dataProvider data_should_add_non_theme_json_fonts + * + * @param string $theme Theme to use. + * @param array $fonts Fonts to register. + * @param array $expected Expected fonts to be added. + */ + public function test_should_add_non_theme_json_fonts( $theme, $fonts, $expected ) { + switch_theme( static::FONTS_THEME ); + + // Register the fonts. + wp_register_fonts( $fonts ); + + $data = new WP_Theme_JSON_Gutenberg( self::$theme_json_data[ $theme ] ); + $actual = gutenberg_add_registered_fonts_to_theme_json( $data ); + + $this->assertNotSame( $data, $actual, 'New instance of WP_Theme_JSON_Gutenberg should be returned' ); + $actual_raw_data = $actual->get_raw_data(); + + $this->assertArrayHasKey( 'typography', $actual_raw_data['settings'] ); + $this->assertArrayHasKey( 'fontFamilies', $actual_raw_data['settings']['typography'] ); + $this->assertArrayHasKey( 'theme', $actual_raw_data['settings']['typography']['fontFamilies'] ); + + $this->assertContains( + $expected, + $actual_raw_data['settings']['typography']['fontFamilies']['theme'], + 'Fonts should be added after running gutenberg_add_registered_fonts_to_theme_json()' + ); + } + + /** + * Data Provider. + * + * @return array + */ + public function data_should_add_non_theme_json_fonts() { + $lato = array( + 'Lato' => array( + array( + 'font-family' => 'Lato', + 'font-style' => 'normal', + 'font-weight' => '400', + 'src' => 'https://example.com/tests/assets/fonts/lato/Lato-Regular.woff2', + ), + array( + 'font-family' => 'Lato', + 'font-style' => 'italic', + 'font-weight' => '400', + 'src' => 'https://example.com/tests/assets/fonts/lato/Lato-Regular-Italic.woff2', + ), + ), + ); + + $expected_lato = array( + 'fontFamily' => 'Lato', + 'name' => 'Lato', + 'slug' => 'lato', + 'fontFace' => array( + 'lato-400-normal' => array( + 'origin' => 'gutenberg_wp_fonts_api', + 'provider' => 'local', + 'fontFamily' => 'Lato', + 'fontStyle' => 'normal', + 'fontWeight' => '400', + 'fontDisplay' => 'fallback', + 'src' => 'https://example.com/tests/assets/fonts/lato/Lato-Regular.woff2', + ), + 'lato-400-italic' => array( + 'origin' => 'gutenberg_wp_fonts_api', + 'provider' => 'local', + 'fontFamily' => 'Lato', + 'fontStyle' => 'italic', + 'fontWeight' => '400', + 'fontDisplay' => 'fallback', + 'src' => 'https://example.com/tests/assets/fonts/lato/Lato-Regular-Italic.woff2', + ), + ), + ); + + return array( + 'theme with no fonts defined' => array( + 'theme' => 'block-theme', + 'fonts' => $lato, + 'expected' => $expected_lato, + ), + 'theme with fonts: new fonts not in theme' => array( + 'theme' => static::FONTS_THEME, + 'fonts' => $lato, + 'expected' => $expected_lato, + ), + + /* + * @TODO Add these tests fixing https://github.com/WordPress/gutenberg/issues/50047. + * + 'theme with fonts: new variations registered' => array( + 'theme' => static::FONTS_THEME, + 'fonts' => array( + 'DM Sans' => array( + 'dm-sans-500-normal' => array( + 'font-family' => 'DM Sans', + 'font-style' => 'normal', + 'font-weight' => '500', + 'src' => 'https://example.com/tests/assets/fonts/dm-sans/DMSans-Medium.woff2', + ), + 'dm-sans-500-italic' => array( + 'font-family' => 'DM Sans', + 'font-style' => 'italic', + 'font-weight' => '500', + 'src' => 'https://example.com/tests/assets/fonts/dm-sans/DMSans-Medium.woff2', + ), + ), + ), + 'expected' => array( + 'fontFace' => array( + array( + 'fontFamily' => 'DM Sans', + 'fontStretch' => 'normal', + 'fontStyle' => 'normal', + 'fontWeight' => '400', + 'src' => array( 'file:./assets/fonts/dm-sans/DMSans-Regular.woff2' ), + ), + array( + 'fontFamily' => 'DM Sans', + 'fontStretch' => 'normal', + 'fontStyle' => 'italic', + 'fontWeight' => '400', + 'src' => array( 'file:./assets/fonts/dm-sans/DMSans-Regular-Italic.woff2' ), + ), + 'dm-sans-500-normal' => array( + 'origin' => 'gutenberg_wp_fonts_api', + 'provider' => 'local', + 'fontFamily' => 'DM Sans', + 'fontStretch' => 'normal', + 'fontStyle' => 'normal', + 'fontWeight' => '500', + 'fontDisplay' => 'fallback', + 'src' => array( get_stylesheet_directory_uri() . 'assets/fonts/dm-sans/DMSans-Medium.woff2' ), + ), + 'dm-sans-500-italic' => array( + 'origin' => 'gutenberg_wp_fonts_api', + 'provider' => 'local', + 'fontFamily' => 'DM Sans', + 'fontStretch' => 'normal', + 'fontStyle' => 'italic', + 'fontWeight' => '500', + 'fontDisplay' => 'fallback', + 'src' => array( get_stylesheet_directory_uri() . 'assets/fonts/dm-sans/DMSans-Medium-Italic.woff2' ), + ), + array( + 'fontFamily' => 'DM Sans', + 'fontStretch' => 'normal', + 'fontStyle' => 'normal', + 'fontWeight' => '700', + 'src' => array( 'file:./assets/fonts/dm-sans/DMSans-Bold.woff2' ), + ), + array( + 'fontFamily' => 'DM Sans', + 'fontStretch' => 'normal', + 'fontStyle' => 'italic', + 'fontWeight' => '700', + 'src' => array( 'file:./assets/fonts/dm-sans/DMSans-Bold-Italic.woff2' ), + ), + ), + 'fontFamily' => '"DM Sans", sans-serif', + 'name' => 'DM Sans', + 'slug' => 'dm-sans', + ), + ), + */ + ); + } +} From c086cedc6c74df51775ca15ed03dd68e0f107c1a Mon Sep 17 00:00:00 2001 From: hellofromtonya Date: Tue, 25 Apr 2023 11:20:17 -0500 Subject: [PATCH 2/2] Move switch_theme() setup/teardown to TestCase. Why? To reduce redundant tasks / code for setting up and tearing down theme location functionality in tests that use switch_theme(). --- ...bergAddRegisteredFontsToThemeJson-test.php | 73 ++------------- ...tenbergRegisterFontsFromThemeJson-test.php | 69 +------------- phpunit/fonts-api/wp-fonts-testcase.php | 90 +++++++++++++++++++ 3 files changed, 98 insertions(+), 134 deletions(-) diff --git a/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php b/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php index 8a434b38d949e..61ada8a403ea1 100644 --- a/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php +++ b/phpunit/fonts-api/gutenbergAddRegisteredFontsToThemeJson-test.php @@ -15,26 +15,17 @@ class Tests_Fonts_GutenbergAddRegisteredFontsToThemeJson extends WP_Fonts_TestCase { const FONTS_THEME = 'fonts-block-theme'; - private static $theme_json_data = array(); - - /** - * Theme root directory. - * - * @var string - */ - private static $theme_root; - /** - * Original theme directory. + * Cache of test themes' `theme.json` contents. * - * @var string + * @var array */ - private $orig_theme_dir; + private static $theme_json_data = array(); public static function set_up_before_class() { - parent::set_up_before_class(); + self::$requires_switch_theme_fixtures = true; - self::$theme_root = realpath( __DIR__ . '/../data/themedir1' ); + parent::set_up_before_class(); $themes = array( 'block-theme', @@ -46,60 +37,6 @@ public static function set_up_before_class() { } } - public function set_up() { - parent::set_up(); - - $this->orig_theme_dir = $GLOBALS['wp_theme_directories']; - - // /themes is necessary as theme.php functions assume /themes is the root if there is only one root. - $GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', self::$theme_root ); - - // Set up the new root. - add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); - add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); - add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); - - // Clear caches. - wp_clean_themes_cache(); - unset( $GLOBALS['wp_themes'] ); - } - - public function tear_down() { - // Clear up the filters to modify the theme root. - remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); - remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); - remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); - - WP_Theme_JSON_Resolver::clean_cached_data(); - - parent::tear_down(); - } - /** - * Cleans up global scope. - * - * @global WP_Styles $wp_styles - */ - public function clean_up_global_scope() { - parent::clean_up_global_scope(); - - $GLOBALS['wp_theme_directories'] = $this->orig_theme_dir; - wp_clean_themes_cache(); - - if ( function_exists( 'wp_clean_theme_json_cache' ) ) { - wp_clean_theme_json_cache(); - } - - if ( function_exists( '_gutenberg_clean_theme_json_caches' ) ) { - _gutenberg_clean_theme_json_caches(); - } - - unset( $GLOBALS['wp_themes'] ); - } - - public function filter_set_theme_root() { - return self::$theme_root; - } - /** * @dataProvider data_themes * diff --git a/phpunit/fonts-api/gutenbergRegisterFontsFromThemeJson-test.php b/phpunit/fonts-api/gutenbergRegisterFontsFromThemeJson-test.php index 786043e23fb95..d9c7fbaee5fff 100644 --- a/phpunit/fonts-api/gutenbergRegisterFontsFromThemeJson-test.php +++ b/phpunit/fonts-api/gutenbergRegisterFontsFromThemeJson-test.php @@ -24,73 +24,10 @@ class Tests_Fonts_GutenbergRegisterFontsFromThemeJson extends WP_Fonts_TestCase ), ); - /** - * Theme root directory. - * - * @var string - */ - private $theme_root; - - /** - * Original theme directory. - * - * @var string - */ - private $orig_theme_dir; - - public function set_up() { - parent::set_up(); - - $this->orig_theme_dir = $GLOBALS['wp_theme_directories']; - $this->theme_root = realpath( __DIR__ . '/../data/themedir1' ); - - // /themes is necessary as theme.php functions assume /themes is the root if there is only one root. - $GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', $this->theme_root ); - - // Set up the new root. - add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); - add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); - add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); - - // Clear caches. - wp_clean_themes_cache(); - unset( $GLOBALS['wp_themes'] ); - } - - public function tear_down() { - // Clear up the filters to modify the theme root. - remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); - remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); - remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); - - WP_Theme_JSON_Resolver::clean_cached_data(); - - parent::tear_down(); - } - /** - * Cleans up global scope. - * - * @global WP_Styles $wp_styles - */ - public function clean_up_global_scope() { - parent::clean_up_global_scope(); - - $GLOBALS['wp_theme_directories'] = $this->orig_theme_dir; - wp_clean_themes_cache(); - - if ( function_exists( 'wp_clean_theme_json_cache' ) ) { - wp_clean_theme_json_cache(); - } - - if ( function_exists( '_gutenberg_clean_theme_json_caches' ) ) { - _gutenberg_clean_theme_json_caches(); - } - - unset( $GLOBALS['wp_themes'] ); - } + public static function set_up_before_class() { + self::$requires_switch_theme_fixtures = true; - public function filter_set_theme_root() { - return $this->theme_root; + parent::set_up_before_class(); } public function test_should_bails_out_when_no_fonts_defined() { diff --git a/phpunit/fonts-api/wp-fonts-testcase.php b/phpunit/fonts-api/wp-fonts-testcase.php index d499266ca699e..adb70eca98b0f 100644 --- a/phpunit/fonts-api/wp-fonts-testcase.php +++ b/phpunit/fonts-api/wp-fonts-testcase.php @@ -35,11 +35,66 @@ abstract class WP_Fonts_TestCase extends WP_UnitTestCase { */ protected $property = array(); + /** + * Indicates the test class uses `switch_theme()` and requires + * set_up and tear_down fixtures to set and reset hooks and memory. + * + * If a test class switches themes, set this property to `true`. + * + * @var bool + */ + protected static $requires_switch_theme_fixtures = false; + + /** + * Theme root directory. + * + * @var string + */ + protected static $theme_root; + + /** + * Original theme directory. + * + * @var string + */ + protected $orig_theme_dir; + + public static function set_up_before_class() { + parent::set_up_before_class(); + + if ( self::$requires_switch_theme_fixtures ) { + self::$theme_root = realpath( __DIR__ . '/../data/themedir1' ); + } + } + + public static function tear_down_after_class() { + // Reset static flags. + self::$requires_switch_theme_fixtures = false; + + parent::tear_down_after_class(); + } + public function set_up() { parent::set_up(); $this->old_wp_fonts = $GLOBALS['wp_fonts']; $GLOBALS['wp_fonts'] = null; + + if ( self::$requires_switch_theme_fixtures ) { + $this->orig_theme_dir = $GLOBALS['wp_theme_directories']; + + // /themes is necessary as theme.php functions assume /themes is the root if there is only one root. + $GLOBALS['wp_theme_directories'] = array( WP_CONTENT_DIR . '/themes', self::$theme_root ); + + // Set up the new root. + add_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); + add_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); + add_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); + + // Clear caches. + wp_clean_themes_cache(); + unset( $GLOBALS['wp_themes'] ); + } } public function tear_down() { @@ -52,9 +107,44 @@ public function tear_down() { $this->error_reporting_level = null; } + if ( self::$requires_switch_theme_fixtures ) { + // Clean up the filters to modify the theme root. + remove_filter( 'theme_root', array( $this, 'filter_set_theme_root' ) ); + remove_filter( 'stylesheet_root', array( $this, 'filter_set_theme_root' ) ); + remove_filter( 'template_root', array( $this, 'filter_set_theme_root' ) ); + + WP_Theme_JSON_Resolver::clean_cached_data(); + if ( class_exists( 'WP_Theme_JSON_Resolver_Gutenberg' ) ) { + WP_Theme_JSON_Resolver_Gutenberg::clean_cached_data(); + } + } + parent::tear_down(); } + public function clean_up_global_scope() { + parent::clean_up_global_scope(); + + if ( self::$requires_switch_theme_fixtures ) { + $GLOBALS['wp_theme_directories'] = $this->orig_theme_dir; + wp_clean_themes_cache(); + + if ( function_exists( 'wp_clean_theme_json_cache' ) ) { + wp_clean_theme_json_cache(); + } + + if ( function_exists( '_gutenberg_clean_theme_json_caches' ) ) { + _gutenberg_clean_theme_json_caches(); + } + + unset( $GLOBALS['wp_themes'] ); + } + } + + public function filter_set_theme_root() { + return self::$theme_root; + } + protected function set_up_mock( $method ) { $mock = $this->setup_object_mock( $method, WP_Fonts::class );