Changeset 40058

Timestamp:

02/14/2017 04:22:32 AM (8 years ago)

Author:

adamsilverstein

Message:

REST API: Add QUnit tests for wp-api.js and PHPUnit fixture generation.

Add QUnit tests: verify that wp-api loads correctly, verify that the expected base models and collections exist and can be instantiated, verify that collections contain the correct models, verify that expected helper functions are in place for each collection.

The QUnit tests rely on two fixture files: tests/qunit/fixtures/wp-api-generated.js contains the data response from each core endpoint and is generated by running the PHPUnit restapi-jsclient group. tests/qunit/fixtures/wp-api.js maps the generated data to endpoint routes, and overrides Backbone.ajax to mock the responses for the tests.

Add PHPUnit tests in tests/phpunit/tests/rest-api/rest-schema-setup.php. First, verify that the API returns the expected routes via server->get_routes(). Then, the test_build_wp_api_client_fixtures test goes thru each endpoint and requests it from the API, tests that it returns data, and builds up the data for the mocked QUnit tests, saving the final results to tests/qunit/fixtures/wp-api-generated.js.

Add a new grunt task restapi-jsclient which runs the phpunit side data generation and the qunit tests together.

Props jnylen0, welcher.
Fixes #39264.

Location:

trunk

Files:

• Gruntfile.js (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-schema-setup.php (added)
• tests/qunit/fixtures/wp-api-generated.js (added)
• tests/qunit/fixtures/wp-api.js (added)
• tests/qunit/index.html (modified) (4 diffs)
• tests/qunit/wp-includes/js/wp-api.js (added)

trunk/Gruntfile.js

@@ -440 +440 @@
                 cmd: 'phpunit',
                 args: ['-c', 'phpunit.xml.dist', '--group', 'external-http']
+            },
+            'restapi-jsclient': {
+                cmd: 'phpunit',
+                args: ['-c', 'phpunit.xml.dist', '--group', 'restapi-jsclient']
             }
         },
@@ -671 +675 @@
         'jshint:core',
         'jshint:media'
+    ] );
+
+    grunt.registerTask( 'restapi-jsclient', [
+        'phpunit:restapi-jsclient',
+        'qunit'
     ] );
 

trunk/tests/qunit/index.html

@@ -16 +16 @@
                     'url': '\/wp-admin\/admin-ajax.php'
                 }
+            };
+        </script>
+        <script>
+            var wpApiSettings = {
+                'root': 'http://localhost/wp-json/'
             };
         </script>
@@ -35 +40 @@
             <script src="fixtures/customize-menus.js"></script>
             <script src="fixtures/customize-widgets.js"></script>
+            <script src="fixtures/wp-api-generated.js"></script>
+            <script src="fixtures/wp-api.js"></script>
         </div>
         <p><a href="editor">TinyMCE tests</a></p>
@@ -44 +51 @@
         <script src="../../src/wp-includes/js/shortcode.js"></script>
         <script src="../../src/wp-admin/js/customize-controls.js"></script>
+        <script src="../../src/wp-includes/js/wp-api.js"></script>
 
         <script type='text/javascript' src='../../src/wp-includes/js/jquery/ui/core.js'></script>
@@ -62 +70 @@
         <script src="wp-admin/js/customize-header.js"></script>
         <script src="wp-includes/js/shortcode.js"></script>
+        <script src="wp-includes/js/wp-api.js"></script>
         <script src="wp-admin/js/customize-controls.js"></script>
         <script src="wp-admin/js/customize-controls-utils.js"></script>