Plugin management endpoints by claudiulodro · Pull Request #9 · Automattic/newspack-plugin

claudiulodro · 2019-03-25T19:56:35Z

All Submissions:

Have you followed the Newspack Contributing guideline?
Does your code follow the WordPress' coding standards and VIP Go coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Closes #4.

This PR adds the following REST API endpoints for users with the correct capabilities:

GET newspack/v1/plugins
GET newspack/v1/plugins/{some-plugin}
POST newspack/v1/plugins/{some-plugin}/activate
POST newspack/v1/plugins/{some-plugin}/deactivate
POST newspack/v1/plugins/{some-plugin}/install
POST newspack/v1/plugins/{some-plugin}/uninstall

The GET endpoints retrieve info about plugins and their installation status. The POST endpoints can be used to activate/deactivate/etc. a plugin. See the unit tests for usage.

I've also added a minimal way to get information about the managed plugins, since that was required for the GET endpoints. See my comment below, and please let me know if there's a better way you know (loading from a config file?).

How to test the changes in this Pull Request:

Run/examine unit tests.
Examine source code.

Sorry about the length of this PR; the way endpoints are registered and handled is very verbose in WP. Most of the relevant logic is in the Plugins_Controller::{something}_item methods. It should all be straightforward and following the controller design pattern recommended for REST API endpoints.

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you successfully ran tests with your changes locally?

claudiulodro · 2019-03-25T20:00:13Z

+				'name'     => __( 'AMP', 'newspack' ),
+				'download' => 'wporg',
+			],
+		];


What sort of information do we need available about the plugins? I've kicked it off with the following info for each plugin:

name - The plugin name. download - 'wporg' or a URL to a zip file. status - 'active', 'inactive', or 'uninstalled'

Any additional information we need? Instead of having this information hard-coded in the get_managed_plugins method, is there a better way of storing/retrieving the managed plugin info?

jeffersonrabb

Tests are failing with the following output:


1) Newspack_Test_Plugins_Controller::test_activate_deactivate_plugin_authorized
Failed asserting that 500 matches expected 200.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/api-plugins-controller.php:134

2) Newspack_Test_Plugins_Controller::test_install_uninstall_authorized
Failed asserting that 500 matches expected 200.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/api-plugins-controller.php:191

3) Newspack_Test_Plugin_Manager::test_activate_deactivate_wporg_uninstalled
Failed asserting that WP_Error Object &000000002e5748130000000060def72e (
    'errors' => Array &0 (
        'newspack_plugin_failed_install' => Array &1 (
            0 => 'The authenticity of <span class="code">hello-dolly.1.6.zip</span> could not be verified as no signature was found.'
        )
    )
    'error_data' => Array &2 ()
) is true.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/plugin-manager.php:88

4) Newspack_Test_Plugin_Manager::test_activate_deactivate_url_uninstalled
Failed asserting that WP_Error Object &000000002e57482a0000000060def72e (
    'errors' => Array &0 (
        'newspack_plugin_failed_install' => Array &1 (
            0 => 'The authenticity of <span class="code">hello-dolly.1.6.zip</span> could not be verified as no signature was found.'
        )
    )
    'error_data' => Array &2 ()
) is true.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/plugin-manager.php:104

5) Newspack_Test_Plugin_Manager::test_activate_deactivate_installed
Failed asserting that WP_Error Object &000000002e5748120000000060def72e (
    'errors' => Array &0 (
        'newspack_plugin_failed_install' => Array &1 (
            0 => 'The authenticity of <span class="code">hello-dolly.1.6.zip</span> could not be verified as no signature was found.'
        )
    )
    'error_data' => Array &2 ()
) is true.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/plugin-manager.php:134

6) Newspack_Test_Plugin_Manager::test_plugin_install_uninstall_wporg
Failed asserting that WP_Error Object &000000002e574b630000000060def72e (
    'errors' => Array &0 (
        'newspack_plugin_failed_install' => Array &1 (
            0 => 'The authenticity of <span class="code">hello-dolly.1.6.zip</span> could not be verified as no signature was found.'
        )
    )
    'error_data' => Array &2 ()
) is true.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/plugin-manager.php:163

7) Newspack_Test_Plugin_Manager::test_plugin_install_uninstall_url
Failed asserting that WP_Error Object &000000002e574a2f0000000060def72e (
    'errors' => Array &0 (
        'newspack_plugin_failed_install' => Array &1 (
            0 => 'The authenticity of <span class="code">hello-dolly.1.6.zip</span> could not be verified as no signature was found.'
        )
    )
    'error_data' => Array &2 ()
) is true.

/srv/www/wordpress-trunk/public_html/src/wp-content/plugins/newspack-plugin/tests/unit-tests/plugin-manager.php:178

FAILURES!
Tests: 21, Assertions: 50, Failures: 7.```

claudiulodro · 2019-04-10T13:21:30Z

The previous errors seem to be caused by the wordpress.org repo not being ready for WP 5.2 yet. WP 5.2 adds file signature checking to prevent infrastructure attacks on wordpress.org, but it's not quite ready yet. When the signature files are added to wordpress.org, things should work correctly. In the meantime, I recommend WP 5.1 for testing this PR.

jeffersonrabb · 2019-04-11T16:52:50Z