Plugins endpoint (#90)

* Adds SparsePlugin

* Adds plugins list endpoint

* Implement list plugins request and its parsers

* Replace plugin parsers with add_uniffi_exported_parser

* Replace plugin_list_params! with generate! macro

* Use extracted test helpers for plugins

* Implement create plugin request

* Implement run_and_restore_wp_content_plugins

* Implements retrieve plugin

* Fix the retrieve plugin endpoint and its return type

* A temporary helper bash script for fetching plugins

* Disable restoring wp-content plugins from plugins_mut tests

* Add a separate parser for create plugin response

* Fix retrieve plugins endpoint

* Implement update plugin request

* Add an integration test for update plugin

* Implement delete plugin request

* Improve unit & immut integration tests for plugins

* Fix backup/restoration of wp-content/plugins for integration tests

* Remove temporary scripts used to test plugins

* Ignore failures for delete-wp-plugins-backup make task

* Remove unused PluginAuthor

* Add url encoding related unit tests for plugins endpoint

* Add an assertion for plugin author for retrieve plugin test

Author: oguzkocer

.buildkite/setup-test-site.sh

@@ -42,3 +42,7 @@ wp plugin delete wordpress-importer
   ## Create an Application password for a subscriber user, and store it where it can be used by the test suite
   wp user application-password create themedemos test --porcelain
 } >> /tmp/test_credentials
+
+## Used for integration tests
+wp plugin install hello-dolly --activate
+wp plugin install classic-editor

Makefile

@@ -192,7 +192,7 @@ test-server: stop-server
 	docker-compose up -d
 	docker-compose run wpcli
 
-stop-server:
+stop-server: delete-wp-plugins-backup
 	docker-compose down
 
 dump-mysql:
@@ -201,6 +201,15 @@ dump-mysql:
 restore-mysql:
 	docker exec -it wordpress-rs-mysql-1 /bin/bash -c "mysql --defaults-extra-file=mysql_config/config.cnf --database wordpress < dump.sql"
 
+backup-wp-content-plugins:
+	docker exec -it wordpress /bin/bash -c "cp -R ./wp-content/plugins /tmp/backup_wp_plugins"
+
+restore-wp-content-plugins:
+	docker exec -it wordpress /bin/bash -c "rm -rf ./wp-content/plugins &&  cp -R /tmp/backup_wp_plugins ./wp-content/plugins"
+
+delete-wp-plugins-backup:
+	docker exec -it wordpress /bin/bash -c "rm -rf /tmp/backup_wp_plugins" || true
+
 lint: lint-rust lint-swift
 
 lint-rust:

wp_api/src/endpoint.rs

@@ -1,7 +1,9 @@
 use url::Url;
 
+pub use plugins_endpoint::*;
 pub use users_endpoint::*;
 
+mod plugins_endpoint;
 mod users_endpoint;
 
 const WP_JSON_PATH_SEGMENTS: [&str; 3] = ["wp-json", "wp", "v2"];
@@ -47,13 +49,15 @@ impl ApiBaseUrl {
 pub struct ApiEndpoint {
     pub base_url: ApiBaseUrl,
     pub users: UsersEndpoint,
+    pub plugins: PluginsEndpoint,
 }
 
 impl ApiEndpoint {
     pub fn new(api_base_url: ApiBaseUrl) -> Self {
         Self {
             base_url: api_base_url.clone(),
             users: UsersEndpoint::new(api_base_url.clone()),
+            plugins: PluginsEndpoint::new(api_base_url.clone()),
         }
     }
 

wp_api/src/endpoint/plugins_endpoint.rs

@@ -0,0 +1,146 @@
+use url::Url;
+
+use crate::{plugins::PluginListParams, ApiBaseUrl, WPContext};
+
+pub struct PluginsEndpoint {
+    api_base_url: ApiBaseUrl,
+}
+
+impl PluginsEndpoint {
+    pub fn new(api_base_url: ApiBaseUrl) -> Self {
+        Self { api_base_url }
+    }
+
+    pub fn create(&self) -> Url {
+        self.plugins_base_url()
+    }
+
+    pub fn delete(&self, plugin: &str) -> Url {
+        self.plugins_url_with_slug(plugin)
+    }
+
+    pub fn list(&self, context: WPContext, params: Option<&PluginListParams>) -> Url {
+        let mut url = self.plugins_base_url();
+        url.query_pairs_mut()
+            .append_pair("context", context.as_str());
+        if let Some(params) = params {
+            url.query_pairs_mut().extend_pairs(params.query_pairs());
+        }
+        url
+    }
+
+    pub fn retrieve(&self, context: WPContext, plugin: &str) -> Url {
+        let mut url = self.plugins_url_with_slug(plugin);
+        url.query_pairs_mut()
+            .append_pair("context", context.as_str());
+        url
+    }
+
+    pub fn update(&self, plugin: &str) -> Url {
+        self.plugins_url_with_slug(plugin)
+    }
+
+    fn plugins_base_url(&self) -> Url {
+        self.api_base_url.by_appending("plugins")
+    }
+
+    fn plugins_url_with_slug(&self, plugin: &str) -> Url {
+        self.api_base_url
+            // The '/' character has to be preserved and not get encoded
+            .by_extending(["plugins"].into_iter().chain(plugin.split('/')))
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::{
+        endpoint::tests::{fixture_api_base_url, validate_endpoint},
+        generate, ApiEndpoint, PluginStatus,
+    };
+    use rstest::*;
+
+    #[rstest]
+    fn create_plugin(plugins_endpoint: PluginsEndpoint) {
+        validate_endpoint(plugins_endpoint.create(), "/plugins");
+    }
+
+    #[rstest]
+    #[case("hello-dolly/hello", "/plugins/hello-dolly/hello")]
+    #[case(
+        "classic-editor/classic-editor",
+        "/plugins/classic-editor/classic-editor"
+    )]
+    #[case("foo/bar%baz", "/plugins/foo/bar%25baz")]
+    #[case("foo/です", "/plugins/foo/%E3%81%A7%E3%81%99")]
+    fn delete_plugin(
+        plugins_endpoint: PluginsEndpoint,
+        #[case] plugin_slug: &str,
+        #[case] expected_path: &str,
+    ) {
+        validate_endpoint(plugins_endpoint.delete(plugin_slug), expected_path);
+    }
+
+    #[rstest]
+    #[case(WPContext::Edit, generate!(PluginListParams, (search, Some("foo".to_string()))), "/plugins?context=edit&search=foo")]
+    #[case(WPContext::Embed, generate!(PluginListParams, (status, Some(PluginStatus::Active))), "/plugins?context=embed&status=active")]
+    #[case(WPContext::View, generate!(PluginListParams, (search, Some("foo".to_string())), (status, Some(PluginStatus::Inactive))), "/plugins?context=view&search=foo&status=inactive")]
+    fn list_plugins_with_params(
+        plugins_endpoint: PluginsEndpoint,
+        #[case] context: WPContext,
+        #[case] params: PluginListParams,
+        #[case] expected_path: &str,
+    ) {
+        validate_endpoint(plugins_endpoint.list(context, Some(&params)), expected_path);
+    }
+
+    #[rstest]
+    #[case(
+        "hello-dolly/hello",
+        WPContext::View,
+        "/plugins/hello-dolly/hello?context=view"
+    )]
+    #[case(
+        "classic-editor/classic-editor",
+        WPContext::Embed,
+        "/plugins/classic-editor/classic-editor?context=embed"
+    )]
+    #[case("foo/bar%baz", WPContext::Edit, "/plugins/foo/bar%25baz?context=edit")]
+    #[case(
+        "foo/です",
+        WPContext::View,
+        "/plugins/foo/%E3%81%A7%E3%81%99?context=view"
+    )]
+    fn retrieve_plugin(
+        plugins_endpoint: PluginsEndpoint,
+        #[case] plugin_slug: &str,
+        #[case] context: WPContext,
+        #[case] expected_path: &str,
+    ) {
+        validate_endpoint(
+            plugins_endpoint.retrieve(context, plugin_slug),
+            expected_path,
+        );
+    }
+
+    #[rstest]
+    #[case("hello-dolly/hello", "/plugins/hello-dolly/hello")]
+    #[case(
+        "classic-editor/classic-editor",
+        "/plugins/classic-editor/classic-editor"
+    )]
+    #[case("foo/bar%baz", "/plugins/foo/bar%25baz")]
+    #[case("foo/です", "/plugins/foo/%E3%81%A7%E3%81%99")]
+    fn update_plugin(
+        plugins_endpoint: PluginsEndpoint,
+        #[case] plugin_slug: &str,
+        #[case] expected_path: &str,
+    ) {
+        validate_endpoint(plugins_endpoint.update(plugin_slug), expected_path);
+    }
+
+    #[fixture]
+    fn plugins_endpoint(fixture_api_base_url: ApiBaseUrl) -> PluginsEndpoint {
+        ApiEndpoint::new(fixture_api_base_url).plugins
+    }
+}

wp_api/src/lib.rs

@@ -7,6 +7,7 @@ pub use api_error::*;
 pub use endpoint::*;
 pub use login::*;
 pub use pages::*;
+pub use plugins::*;
 pub use posts::*;
 pub use url::*;
 pub use users::*;
@@ -15,6 +16,7 @@ pub mod api_error;
 pub mod endpoint;
 pub mod login;
 pub mod pages;
+pub mod plugins;
 pub mod posts;
 pub mod url;
 pub mod users;
@@ -223,6 +225,63 @@ impl WPApiHelper {
         }
     }
 
+    pub fn list_plugins_request(
+        &self,
+        context: WPContext,
+        params: &Option<PluginListParams>, // UniFFI doesn't support Option<&T>
+    ) -> WPNetworkRequest {
+        WPNetworkRequest {
+            method: RequestMethod::GET,
+            url: self
+                .api_endpoint
+                .plugins
+                .list(context, params.as_ref())
+                .into(),
+            header_map: self.header_map(),
+            body: None,
+        }
+    }
+
+    pub fn create_plugin_request(&self, params: &PluginCreateParams) -> WPNetworkRequest {
+        WPNetworkRequest {
+            method: RequestMethod::POST,
+            url: self.api_endpoint.plugins.create().into(),
+            header_map: self.header_map_for_post_request(),
+            body: serde_json::to_vec(&params).ok(),
+        }
+    }
+
+    pub fn retrieve_plugin_request(&self, context: WPContext, plugin: &str) -> WPNetworkRequest {
+        WPNetworkRequest {
+            method: RequestMethod::GET,
+            url: self.api_endpoint.plugins.retrieve(context, plugin).into(),
+            header_map: self.header_map(),
+            body: None,
+        }
+    }
+
+    pub fn update_plugin_request(
+        &self,
+        plugin: &str,
+        params: PluginUpdateParams,
+    ) -> WPNetworkRequest {
+        WPNetworkRequest {
+            method: RequestMethod::POST,
+            url: self.api_endpoint.plugins.update(plugin).into(),
+            header_map: self.header_map_for_post_request(),
+            body: serde_json::to_vec(&params).ok(),
+        }
+    }
+
+    pub fn delete_plugin_request(&self, plugin: &str) -> WPNetworkRequest {
+        WPNetworkRequest {
+            method: RequestMethod::DELETE,
+            url: self.api_endpoint.plugins.delete(plugin).into(),
+            header_map: self.header_map(),
+            body: None,
+        }
+    }
+
     fn header_map(&self) -> HashMap<String, String> {
         let mut header_map = HashMap::new();
         header_map.insert(