Test AMP compatibility of entire site

includes/class-amp-autoloader.php

@@ -92,6 +92,7 @@ class AMP_Autoloader {
 		'AMP_Validation_Manager'                      => 'includes/validation/class-amp-validation-manager',
 		'AMP_Invalid_URL_Post_Type'                   => 'includes/validation/class-amp-invalid-url-post-type',
 		'AMP_Validation_Error_Taxonomy'               => 'includes/validation/class-amp-validation-error-taxonomy',
+		'AMP_Site_Validation'                         => 'includes/validation/class-amp-site-validation',
 		'AMP_String_Utils'                            => 'includes/utils/class-amp-string-utils',
 		'AMP_WP_Utils'                                => 'includes/utils/class-amp-wp-utils',
 		'AMP_Widget_Archives'                         => 'includes/widgets/class-amp-widget-archives',

includes/validation/class-amp-site-validation.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * Class AMP_Site_Validation
+ *
+ * @package AMP
+ */
+
+/**
+ * Class AMP_Site_Validation
+ *
+ * @since 1.0
+ */
+class AMP_Site_Validation {
+
+	/**
+	 * Gets the permalinks of all public post types with the status 'publish,' to check for AMP validity.
+	 *
+	 * This excludes 'attachment' post types, as it only searches for posts with the status 'publish.'
+	 * Attachments have a default status of 'inherit,' so they can depend on the status of their parent like a post.
+	 *
+	 * @todo: consider whether this should also return 'attachment' IDs.
+	 * @param int $number_posts The maximum amount of posts to get the permalinks for (optional).
+	 * @return string[] $permalinks The post permalinks in an array.
+	 */
+	public static function get_post_permalinks( $number_posts = 200 ) {
+		$post_types = get_post_types( array( 'public' => true ), 'names' );
+		$query      = new WP_Query( array(
+			'posts_per_page' => $number_posts,
+			'post_type'      => array_values( $post_types ),
+			'post_status'    => 'publish',
+		) );
+
+		$post_ids = wp_list_pluck( $query->posts, 'ID' );
+		return array_map( 'get_permalink', $post_ids );
+	}
+
+	/**
+	 * Gets the front-end links for public taxonomy terms, like categories and tags.
+	 *
+	 * For example, https://example.org/?cat=2
+	 * This includes categories and tags, and any more that are registered.
+	 * But it excludes post_format terms.
+	 *
+	 * @param int $number_links The maximum amount of links to get (optional).
+	 * @return string[] $links The term links in an array.
+	 */
+	public static function get_taxonomy_links( $number_links = 200 ) {
+		$public_taxonomies = get_taxonomies( array(
+			'public' => true,
+		) );
+
+		// It doesn't seem necessary to get links for post format terms, like asides, galleries, or quotes.
+		unset( $public_taxonomies['post_format'] );
+		$terms = get_terms( array(
+			'taxonomy' => $public_taxonomies,
+			'count'    => $number_links,
+		) );
+
+		return array_map( 'get_term_link', $terms );
+	}
+
+	/**
+	 * Validates the URLs on the site.
+	 *
+	 * @todo: Consider wrapping this function with another, as different use cases will probably require a different return value or display.
+	 * For example, the <button> in /wp-admin that makes an AJAX request for this will need a different response than a WP-CLI command.
+	 * @return array $validation_result The post ID as the index, and the result of validation as the value.
+	 */
+	public static function validate_site_urls() {
+		$site_post_ids = self::get_post_ids();
+		foreach ( $site_post_ids as $id ) {
+			AMP_Validation_Manager::$posts_pending_frontend_validation[ $id ] = true;
+		}
+		return AMP_Validation_Manager::validate_queued_posts_on_frontend();
+	}
+}

tests/test-class-amp-site-validation.php

@@ -0,0 +1,134 @@
+<?php
+/**
+ * Tests for AMP_Site_Validation class.
+ *
+ * @package AMP
+ */
+
+/**
+ * Tests for AMP_Site_Validation class.
+ *
+ * @since 1.0
+ */
+class Test_AMP_Site_Validation extends \WP_UnitTestCase {
+
+	/**
+	 * The name of the tested class.
+	 *
+	 * @var string
+	 */
+	const TESTED_CLASS = 'AMP_Site_Validation';
+
+	/**
+	 * The name of the tag to test.
+	 *
+	 * @var string
+	 */
+	const TAG_NAME = 'img';
+
+	/**
+	 * A disallowed element, which should cause a validation error.
+	 *
+	 * @var string
+	 */
+	const DISALLOWED_TAG = '<script>doThis();</script>';
+
+	/**
+	 * An instance of DOMElement to test.
+	 *
+	 * @var DOMElement
+	 */
+	public $node;
+
+	/**
+	 * Setup.
+	 *
+	 * @inheritdoc
+	 * @global $wp_registered_widgets
+	 */
+	public function setUp() {
+		parent::setUp();
+		$dom_document = new DOMDocument( '1.0', 'utf-8' );
+		$this->node   = $dom_document->createElement( self::TAG_NAME );
+		AMP_Validation_Manager::reset_validation_results();
+	}
+
+	/**
+	 * Test get_post_permalinks.
+	 *
+	 * @covers AMP_Site_Validation::get_post_permalinks()
+	 */
+	public function test_get_post_permalinks() {
+		$number_posts_each_post_type = 20;
+		$post_types                  = get_post_types( array( 'public' => true ), 'names' );
+		$expected_post_permalinks    = array();
+
+		/**
+		 * The tested method does not get attachment permalinks.
+		 * It only searches for posts with the status 'publish.'
+		 * Attachments have a default status of 'inherit,' to depend on the status of their parent post.
+		 */
+		unset( $post_types['attachment'] );
+		foreach ( $post_types as $post_type ) {
+			for ( $i = 0; $i < $number_posts_each_post_type; $i++ ) {
+				$expected_post_permalinks[] = get_permalink( $this->factory()->post->create( array(
+					'post_type' => $post_type,
+				) ) );
+			}
+		}
+		$number_of_posts        = count( $post_types ) * $number_posts_each_post_type;
+		$actual_post_permalinks = AMP_Site_Validation::get_post_permalinks( $number_of_posts );
+
+		/*
+		 * The factory() method above creates posts so quickly that the WP_Query() default argument of 'orderby' => 'date'
+		 * doesn't return them in the exact order they were created.
+		 * So this simply ensures all of the created $post_ids are present in the return value of the tested method.
+		 */
+		$this->assertEquals( 0, count( array_diff( $expected_post_permalinks, $actual_post_permalinks ) ) );
+		$this->assertEquals( count( $expected_post_permalinks ), count( $actual_post_permalinks ) );
+	}
+
+	/**
+	 * Test get_taxonomy_links.
+	 *
+	 * @covers AMP_Site_Validation::get_taxonomy_links()
+	 */
+	public function test_get_taxonomy_links() {
+		$number_links_each_taxonomy = 20;
+		$taxonomies                 = get_taxonomies( array(
+			'public' => true,
+		) );
+
+		unset( $taxonomies['post_format'] );
+		$all_terms = array();
+
+		foreach ( $taxonomies as $taxonomy ) {
+			$terms_for_current_taxonomy = array();
+			for ( $i = 0; $i < $number_links_each_taxonomy; $i++ ) {
+				$terms_for_current_taxonomy[] = $this->factory()->term->create( array(
+					'taxonomy' => $taxonomy,
+				) );
+			}
+
+			// Terms need to be associated with a post in order to be returned in get_terms().
+			wp_set_post_terms(
+				$this->factory()->post->create(),
+				$terms_for_current_taxonomy,
+				$taxonomy
+			);
+			$all_terms = array_merge( $all_terms, $terms_for_current_taxonomy );
+		}
+
+		$expected_links  = array_map( 'get_term_link', $all_terms );
+		$number_of_links = 100;
+		$actual_links    = AMP_Site_Validation::get_taxonomy_links( $number_of_links );
+
+		/*
+		 * Test that all of the $expected_links are present.
+		 * There is already one term present before this test method adds any,
+		 * so that can also appear in the returned $actual_links.
+		 */
+		$this->assertEquals( 0, count( array_diff( $expected_links, $actual_links ) ) );
+		$this->assertLessThan( $number_of_links, count( $actual_links ) );
+	}
+}