Consolidate enrich list all and get by name APIs (#45705)

The get and list APIs are a single API in this commit. Whether
requesting one named policy or all policies, a list of policies is
returened. The list API code has all been removed and the GET api is
what remains, which contains much of the list response code.

Author: hub-cap

client/rest-high-level/src/test/java/org/elasticsearch/client/EnrichIT.java

@@ -45,10 +45,13 @@ public void testCRUD() throws Exception {
         Response getPolicyResponse = highLevelClient().getLowLevelClient().performRequest(getPolicyRequest);
         assertThat(getPolicyResponse.getHttpResponse().getStatusLine().getStatusCode(), equalTo(200));
         Map<String, Object> responseBody = toMap(getPolicyResponse);
-        assertThat(responseBody.get("type"), equalTo(putPolicyRequest.getType()));
-        assertThat(responseBody.get("indices"), equalTo(putPolicyRequest.getIndices()));
-        assertThat(responseBody.get("match_field"), equalTo(putPolicyRequest.getMatchField()));
-        assertThat(responseBody.get("enrich_fields"), equalTo(putPolicyRequest.getEnrichFields()));
+        @SuppressWarnings("unchecked")
+        List<Map<String, Object>> responsePolicies = (List<Map<String, Object>>) responseBody.get("policies");
+        assertThat(responsePolicies.size(), equalTo(1));
+        assertThat(responsePolicies.get(0).get("type"), equalTo(putPolicyRequest.getType()));
+        assertThat(responsePolicies.get(0).get("indices"), equalTo(putPolicyRequest.getIndices()));
+        assertThat(responsePolicies.get(0).get("match_field"), equalTo(putPolicyRequest.getMatchField()));
+        assertThat(responsePolicies.get(0).get("enrich_fields"), equalTo(putPolicyRequest.getEnrichFields()));
     }
 
     private static Map<String, Object> toMap(Response response) throws IOException {

docs/reference/ingest/ingest-node.asciidoc

@@ -968,7 +968,6 @@ Also there are several APIs in order to manage and execute enrich policies:
 * <<get-policy-api,Get policy api>>.
 * <<delete-policy-api,Delete policy api>>.
 * <<execute-policy-api,Execute policy api>>.
-* <<list-policies-api,List policies api>>.
 
 If security is enabled then the user managing enrich policies will need to have
 the `enrich_user` builtin role. Also the user will need to have read privileges
@@ -1009,7 +1008,7 @@ Response:
 
 The get policy api allows a policy to be retrieved by id.
 
-Request"
+Request:
 
 [source,js]
 --------------------------------------------------
@@ -1023,18 +1022,27 @@ Response:
 [source,js]
 --------------------------------------------------
 {
-    "type": "exact_match",
-    "indices": ["users"],
-    "match_field": "email",
-    "enrich_fields": ["first_name", "last_name", "address", "city", "zip", "state"]
+    "policies": [
+        {
+            "name" : "my-policy",
+            "type" : "exact_match",
+            "indices" : ["users"],
+            "match_field" : "email",
+            "enrich_fields" : [
+                "first_name",
+                "last_name",
+                "address",
+                "city",
+                "zip",
+                "state"
+            ]
+        }
+    ]
 }
 --------------------------------------------------
 // TESTRESPONSE
 
-[[list-policies-api]]
-==== List Policies API
-
-The list policies api allows all policies to be returned.
+The get policy api allows all policies to be returned.
 
 Request:
 

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/enrich/action/GetEnrichPolicyAction.java

@@ -16,7 +16,11 @@
 import org.elasticsearch.xpack.core.enrich.EnrichPolicy;
 
 import java.io.IOException;
+import java.util.List;
+import java.util.Map;
 import java.util.Objects;
+import java.util.TreeMap;
+import java.util.stream.Collectors;
 
 public class GetEnrichPolicyAction extends ActionType<GetEnrichPolicyAction.Response> {
 
@@ -31,6 +35,8 @@ public static class Request extends MasterNodeReadRequest<Request> {
 
         private String name;
 
+        public Request() { }
+
         public Request(String name) {
             this.name = name;
         }
@@ -75,47 +81,56 @@ public int hashCode() {
 
     public static class Response extends ActionResponse implements ToXContentObject {
 
-        private final EnrichPolicy policy;
+        private final List<EnrichPolicy.NamedPolicy> policies;
 
-        public Response(EnrichPolicy policy) {
-            this.policy = Objects.requireNonNull(policy, "policy cannot be null");
+        public Response(Map<String, EnrichPolicy> policies) {
+            Objects.requireNonNull(policies, "policies cannot be null");
+            // use a treemap to guarantee ordering in the set, then transform it to the list of named policies
+            this.policies = new TreeMap<>(policies).entrySet().stream()
+                .map(entry -> new EnrichPolicy.NamedPolicy(entry.getKey(), entry.getValue())).collect(Collectors.toList());
         }
 
         public Response(StreamInput in) throws IOException {
-            policy = new EnrichPolicy(in);
+            policies = in.readList(EnrichPolicy.NamedPolicy::new);
         }
 
         @Override
         public void writeTo(StreamOutput out) throws IOException {
-            policy.writeTo(out);
+            out.writeList(policies);
         }
 
         @Override
         public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
             builder.startObject();
             {
-                policy.toXContent(builder, params);
+                builder.startArray("policies");
+                {
+                    for (EnrichPolicy.NamedPolicy policy: policies) {
+                        policy.toXContent(builder, params);
+                    }
+                }
+                builder.endArray();
             }
             builder.endObject();
 
             return builder;
         }
 
-        public EnrichPolicy getPolicy() {
-            return policy;
+        public List<EnrichPolicy.NamedPolicy> getPolicies() {
+            return policies;
         }
 
         @Override
         public boolean equals(Object o) {
             if (this == o) return true;
             if (o == null || getClass() != o.getClass()) return false;
             Response response = (Response) o;
-            return policy.equals(response.policy);
+            return policies.equals(response.policies);
         }
 
         @Override
         public int hashCode() {
-            return Objects.hash(policy);
+            return Objects.hash(policies);
         }
     }
 }

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/enrich/action/ListEnrichPolicyAction.java

@@ -11,7 +11,6 @@
 import org.elasticsearch.xpack.core.enrich.action.DeleteEnrichPolicyAction;
 import org.elasticsearch.xpack.core.enrich.action.ExecuteEnrichPolicyAction;
 import org.elasticsearch.xpack.core.enrich.action.GetEnrichPolicyAction;
-import org.elasticsearch.xpack.core.enrich.action.ListEnrichPolicyAction;
 import org.elasticsearch.xpack.core.enrich.action.PutEnrichPolicyAction;
 import org.elasticsearch.transport.TransportRequest;
 import org.elasticsearch.xpack.core.security.authz.permission.ClusterPermission;
@@ -185,7 +184,6 @@ public void testManageEnrichPrivilege() {
         verifyClusterActionAllowed(ClusterPrivilegeResolver.MANAGE_ENRICH, DeleteEnrichPolicyAction.NAME);
         verifyClusterActionAllowed(ClusterPrivilegeResolver.MANAGE_ENRICH, ExecuteEnrichPolicyAction.NAME);
         verifyClusterActionAllowed(ClusterPrivilegeResolver.MANAGE_ENRICH, GetEnrichPolicyAction.NAME);
-        verifyClusterActionAllowed(ClusterPrivilegeResolver.MANAGE_ENRICH, ListEnrichPolicyAction.NAME);
         verifyClusterActionAllowed(ClusterPrivilegeResolver.MANAGE_ENRICH, PutEnrichPolicyAction.NAME);
         verifyClusterActionAllowed(ClusterPrivilegeResolver.MANAGE_ENRICH, "cluster:admin/xpack/enrich/brand_new_api");
         verifyClusterActionDenied(ClusterPrivilegeResolver.MANAGE_ENRICH, "cluster:admin/xpack/whatever");

x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/security/authz/privilege/PrivilegeTests.java

@@ -19,13 +19,15 @@
   - do:
       enrich.get_policy:
         name: policy-crud
-  - match: { type: exact_match }
-  - match: { indices: ["bar*"] }
-  - match: { match_field: baz }
-  - match: { enrich_fields: ["a", "b"] }
+  - length: { policies: 1 }
+  - match: { policies.0.name: policy-crud }
+  - match: { policies.0.type: exact_match }
+  - match: { policies.0.indices: ["bar*"] }
+  - match: { policies.0.match_field: baz }
+  - match: { policies.0.enrich_fields: ["a", "b"] }
 
   - do:
-      enrich.list_policy: {}
+      enrich.get_policy: {}
   - length: { policies: 1 }
   - match: { policies.0.name: policy-crud }
   - match: { policies.0.type: exact_match }

x-pack/plugin/enrich/qa/rest/src/test/resources/rest-api-spec/test/enrich/10_basic.yml

@@ -38,19 +38,16 @@
 import org.elasticsearch.xpack.core.enrich.action.DeleteEnrichPolicyAction;
 import org.elasticsearch.xpack.core.enrich.action.ExecuteEnrichPolicyAction;
 import org.elasticsearch.xpack.core.enrich.action.GetEnrichPolicyAction;
-import org.elasticsearch.xpack.core.enrich.action.ListEnrichPolicyAction;
 import org.elasticsearch.xpack.core.enrich.action.PutEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.action.CoordinatorProxyAction;
 import org.elasticsearch.xpack.enrich.action.EnrichShardMultiSearchAction;
 import org.elasticsearch.xpack.enrich.action.TransportDeleteEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.action.TransportExecuteEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.action.TransportGetEnrichPolicyAction;
-import org.elasticsearch.xpack.enrich.action.TransportListEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.action.TransportPutEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.rest.RestDeleteEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.rest.RestExecuteEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.rest.RestGetEnrichPolicyAction;
-import org.elasticsearch.xpack.enrich.rest.RestListEnrichPolicyAction;
 import org.elasticsearch.xpack.enrich.rest.RestPutEnrichPolicyAction;
 
 import java.util.Collection;
@@ -113,7 +110,6 @@ public Map<String, Processor.Factory> getProcessors(Processor.Parameters paramet
         return List.of(
             new ActionHandler<>(GetEnrichPolicyAction.INSTANCE, TransportGetEnrichPolicyAction.class),
             new ActionHandler<>(DeleteEnrichPolicyAction.INSTANCE, TransportDeleteEnrichPolicyAction.class),
-            new ActionHandler<>(ListEnrichPolicyAction.INSTANCE, TransportListEnrichPolicyAction.class),
             new ActionHandler<>(PutEnrichPolicyAction.INSTANCE, TransportPutEnrichPolicyAction.class),
             new ActionHandler<>(ExecuteEnrichPolicyAction.INSTANCE, TransportExecuteEnrichPolicyAction.class),
             new ActionHandler<>(CoordinatorProxyAction.INSTANCE, CoordinatorProxyAction.TransportAction.class),
@@ -132,7 +128,6 @@ public List<RestHandler> getRestHandlers(Settings settings, RestController restC
         return List.of(
             new RestGetEnrichPolicyAction(restController),
             new RestDeleteEnrichPolicyAction(restController),
-            new RestListEnrichPolicyAction(restController),
             new RestPutEnrichPolicyAction(restController),
             new RestExecuteEnrichPolicyAction(restController)
         );

x-pack/plugin/enrich/src/main/java/org/elasticsearch/xpack/enrich/EnrichPlugin.java

@@ -24,6 +24,7 @@
 import org.elasticsearch.xpack.enrich.EnrichStore;
 
 import java.io.IOException;
+import java.util.Map;
 
 public class TransportGetEnrichPolicyAction extends TransportMasterNodeReadAction<GetEnrichPolicyAction.Request,
     GetEnrichPolicyAction.Response> {
@@ -56,11 +57,18 @@ protected GetEnrichPolicyAction.Response read(StreamInput in) throws IOException
     protected void masterOperation(Task task, GetEnrichPolicyAction.Request request,
                                    ClusterState state,
                                    ActionListener<GetEnrichPolicyAction.Response> listener) throws Exception {
-        final EnrichPolicy policy = EnrichStore.getPolicy(request.getName(), state);
-        if (policy == null) {
-            throw new ResourceNotFoundException("Policy [{}] was not found", request.getName());
+        Map<String, EnrichPolicy> policies;
+        if (request.getName() == null || request.getName().isEmpty()) {
+            policies = EnrichStore.getPolicies(state);
+        } else {
+            EnrichPolicy policy = EnrichStore.getPolicy(request.getName(), state);
+            if (policy == null) {
+                throw new ResourceNotFoundException("Policy [{}] was not found", request.getName());
+            }
+            policies = Map.of(request.getName(), policy);
+
         }
-        listener.onResponse(new GetEnrichPolicyAction.Response(policy));
+        listener.onResponse(new GetEnrichPolicyAction.Response(policies));
     }
 
     @Override