PR: Feature Request - New Resource Notification Policy and Label selector endpoint (#308)

Allow for policy definition where any resource (supported in ResourceTypes enum) with an associated label or labels may be collected into a report and sent to recipients (i.e, discrete label values are suffixed with email-domain).

Co-authored-by: samar singhal <samarsinghal@ssamar-a01.vmware.com>

Author: samarsinghal

README.md

@@ -236,6 +236,18 @@ As mentioned previously the policy file must adhere to a naming convention
 See additional property requirements in Query policies and the aforementioned sample Github repository.
 
 
+#### Resource Notification Policies
+
+Resource Notification policies are useful when you want to generate a report containing resources of a particular type and send that report to email recipients identified by one or more label values ascribed to the those resources.
+
+For example, you might notify primary and/or secondary owners of a collection of a resources.
+
+As mentioned previously the policy file must adhere to a naming convention
+
+* a filename ending with `-RNP.json` encapsulates an individual [ResourceNotificationPolicy](src/main/java/io/pivotal/cfapp/domain/ResourceNotificationPolicy.java)
+
+See additional property requirements in Resource Notification policies and the aforementioned sample Github repository.
+
 #### Endpoint Policies
 
 Endpoint policies are useful when you want to exercise any of the available GET endpoints and have the results sent to one or more designated email recipients.
@@ -1139,7 +1151,7 @@ POST /policies
   "legacy-policies": [
     {
       "notifyee-email-template": {
-        "body": "<h3>TThese applications are deployed to a legacy stack</h3><p>To avoid repeated notification:</p><ul><li>for each application please execute a cf push and update the stack to a modern alternative or cf delete</li></ul><p>depending on whether or not you want to keep the workload running.</p>",
+        "body": "<h3>These applications are deployed to a legacy stack</h3><p>To avoid repeated notification:</p><ul><li>for each application please execute a cf push and update the stack to a modern alternative or cf delete</li></ul><p>depending on whether or not you want to keep the workload running.</p>",
         "from": "admin@pcf.demo.ironleg.me",
         "subject": "Legacy Policy Sample Report"
       },
@@ -1175,7 +1187,32 @@ POST /policies
       "service-offerings": [
         "p-config-server"
       ]
-    }
+    },
+    {
+    "resource-notification-policies": [
+        {
+            "resource-email-template": {
+                "from": "admin@pcf.demo.ironleg.me",
+                "subject": "Platform Updates",
+                "body": "Please take a moment to review the platform updates and share it with your Org users"
+            },
+            "resource-email-metadata": {
+                "resource": "organizations",
+                "labels": [
+                            "PrimaryOwner",
+                            "SecondaryOwner"
+                          ],
+                "email-domain": "pivotal.io"
+            }
+            "resource-whitelist": [
+                "p-config-server"
+            ]
+            "resource-blacklist": [
+                "pivot-sample-org"
+            ]
+        }
+    ]
+}
   ]
 }
 ```

src/main/java/io/pivotal/cfapp/controller/DbmsOnlyPoliciesController.java

@@ -43,6 +43,12 @@ public Mono<ResponseEntity<Void>> deleteHygienePolicy(@PathVariable String id) {
                 .map(ResponseEntity::ok);
     }
 
+    @DeleteMapping("/policies/resourcenotification/{id}")
+    public Mono<ResponseEntity<Void>> deleteResourceNotificationPolicy(@PathVariable String id) {
+        return policiesService.deleteResourceNotificationPolicyById(id)
+                .map(ResponseEntity::ok);
+    }
+
     @DeleteMapping("/policies/legacy/{id}")
     public Mono<ResponseEntity<Void>> deleteLegacyPolicy(@PathVariable String id) {
         return policiesService.deleteLegacyPolicyById(id)

src/main/java/io/pivotal/cfapp/controller/OnDemandResourceMetadataController.java

@@ -7,10 +7,12 @@
 import org.springframework.web.bind.annotation.PatchMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 import io.pivotal.cfapp.domain.Metadata;
 import io.pivotal.cfapp.domain.Resource;
+import io.pivotal.cfapp.domain.Resources;
 import io.pivotal.cfapp.service.ResourceMetadataService;
 import reactor.core.publisher.Mono;
 
@@ -28,6 +30,21 @@ public OnDemandResourceMetadataController(
         this.service = service;
     }
 
+    @GetMapping("/metadata/{type}")
+    public Mono<ResponseEntity<Resources>> getResourcesMetadata(
+    @PathVariable("type") String type,
+    @RequestParam(value = "label_selector", required = false) String labelSelector
+    ) {
+        if (labelSelector != null){
+            return service.getResources(type,labelSelector)
+            .map(r -> ResponseEntity.ok(r))
+            .defaultIfEmpty(ResponseEntity.notFound().build());
+        }
+        return service.getResources(type)
+                        .map(r -> ResponseEntity.ok(r))
+                        .defaultIfEmpty(ResponseEntity.notFound().build());
+    }
+
     @GetMapping("/metadata/{type}/{id}")
     public Mono<ResponseEntity<Resource>> getResourceMetadata(
             @PathVariable("type") String type,

src/main/java/io/pivotal/cfapp/domain/EmailValidator.java

@@ -16,12 +16,12 @@ public class EmailValidator {
 
     public static boolean isValid(String email) {
 
-        if (StringUtils.isBlank(email)) {
-            return false;
-        }
+		if (StringUtils.isBlank(email)) {
+			return false;
+		}
 
-        Matcher matcher = EMAIL_PATTERN.matcher(email);
-        return matcher.matches();
-    }
+		Matcher matcher = EMAIL_PATTERN.matcher(email);
+		return matcher.matches();
+	}
 
 }

src/main/java/io/pivotal/cfapp/domain/OwnerNotificationTemplate.java

@@ -0,0 +1,46 @@
+package io.pivotal.cfapp.domain;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+
+import lombok.Builder;
+import lombok.Getter;
+
+@Builder
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonPropertyOrder({ "from", "subject", "body" })
+@Getter
+public class OwnerNotificationTemplate {
+
+    @JsonProperty("from")
+    private String from;
+
+    @JsonProperty("subject")
+    private String subject;
+
+    @JsonProperty("body")
+    private String body;
+
+    @JsonCreator
+    public OwnerNotificationTemplate(
+            @JsonProperty("from") String from,
+            @JsonProperty("subject") String subject,
+            @JsonProperty("body") String body
+            ) {
+        this.from = from;
+        this.subject = subject;
+        this.body = body;
+    }
+
+    @JsonIgnore
+    public boolean isValid() {
+        return EmailValidator.isValid(from)
+                && StringUtils.isNotBlank(subject)
+                && StringUtils.isNotBlank(body);
+    }
+}

src/main/java/io/pivotal/cfapp/domain/Policies.java

@@ -13,7 +13,7 @@
 
 @Builder
 @JsonInclude(JsonInclude.Include.NON_EMPTY)
-@JsonPropertyOrder({ "application-policies", "service-instance-policies", "endpoint-policies", "query-policies", "hygiene-policies", "legacy-policies" })
+@JsonPropertyOrder({ "application-policies", "service-instance-policies", "endpoint-policies", "query-policies", "hygiene-policies", "legacy-policies","resource-notification-policies" })
 public class Policies {
 
     @JsonProperty("application-policies")
@@ -34,20 +34,26 @@ public class Policies {
     @JsonProperty("legacy-policies")
     private List<LegacyPolicy> legacyPolicies;
 
+    @JsonProperty("resource-notification-policies")
+    private List<ResourceNotificationPolicy> resourceNotificationPolicies;
+
     @JsonCreator
     Policies(
             @JsonProperty("application-policies") List<ApplicationPolicy> applicationPolicies,
             @JsonProperty("service-instance-policies") List<ServiceInstancePolicy> serviceInstancePolicies,
             @JsonProperty("endpoint-policies") List<EndpointPolicy> endpointPolicies,
             @JsonProperty("query-policies") List<QueryPolicy> queryPolicies,
             @JsonProperty("hygiene-policies") List<HygienePolicy> hygienePolicies,
-            @JsonProperty("legacy-policies") List<LegacyPolicy> legacyPolicies) {
+            @JsonProperty("legacy-policies") List<LegacyPolicy> legacyPolicies,
+            @JsonProperty("resource-notification-policies") List<ResourceNotificationPolicy> resourceNotificationPolicies) {
         this.applicationPolicies = applicationPolicies;
         this.serviceInstancePolicies = serviceInstancePolicies;
         this.endpointPolicies = endpointPolicies;
         this.queryPolicies = queryPolicies;
         this.hygienePolicies = hygienePolicies;
         this.legacyPolicies = legacyPolicies;
+        this.resourceNotificationPolicies = resourceNotificationPolicies;
+
     }
 
     public List<ApplicationPolicy> getApplicationPolicies() {
@@ -74,14 +80,19 @@ public List<ServiceInstancePolicy> getServiceInstancePolicies() {
         return serviceInstancePolicies != null ? serviceInstancePolicies: Collections.emptyList();
     }
 
+    public List<ResourceNotificationPolicy> getResourceNotificationPolicies() {
+        return resourceNotificationPolicies != null ? resourceNotificationPolicies: Collections.emptyList();
+    }
+
     @JsonIgnore
     public boolean isEmpty() {
         return getApplicationPolicies().isEmpty()
                 && getServiceInstancePolicies().isEmpty()
                 && getEndpointPolicies().isEmpty()
                 && getQueryPolicies().isEmpty()
                 && getHygienePolicies().isEmpty()
-                && getLegacyPolicies().isEmpty();
+                && getLegacyPolicies().isEmpty()
+                && getResourceNotificationPolicies().isEmpty();
     }
 
 }

src/main/java/io/pivotal/cfapp/domain/PoliciesValidator.java

@@ -27,6 +27,7 @@ public class PoliciesValidator {
     private static final String QUERY_REJECTED_MESSAGE = "-- {} was rejected because either name or sql was blank or sql did not start with SELECT.";
     private static final String EMAIL_NOTIFICATION_TEMPLATE_REJECTED_MESSAGE = "-- {} was rejected because either the email template did not contain valid email addresses for from/to or the subject/body was blank.";
     private static final String LEGACY_FILTER_REJECTED_MESSAGE = "-- {} was rejected because it must have only one filter. Choose either stacks or service-offerings filter.";
+    private static final String RESOURCE_EMAIL_METADATA_REJECTED_MESSAGE = "-- {} was rejected because either the metadata template did not contain valid resource type or the labels/domain was blank.";
 
 
     private final StacksCache stacksCache;
@@ -153,6 +154,30 @@ public boolean validate(HygienePolicy policy) {
         return valid;
     }
 
+    public boolean validate(ResourceNotificationPolicy policy) {
+        boolean hasId = Optional.ofNullable(policy.getId()).isPresent();
+        boolean hasResourceEmailTemplate = Optional.ofNullable(policy.getResourceEmailTemplate()).isPresent();
+        boolean hasResourceEmailMetadata = Optional.ofNullable(policy.getResourceEmailMetadata()).isPresent();
+
+        boolean valid = !hasId && hasResourceEmailTemplate && hasResourceEmailMetadata;
+        if (hasResourceEmailTemplate) {
+            if (!policy.getResourceEmailTemplate().isValid()) {
+                valid = false;
+                log.warn(EMAIL_NOTIFICATION_TEMPLATE_REJECTED_MESSAGE, policy.toString());
+            }
+        }
+        if (hasResourceEmailMetadata) {
+            if (!policy.getResourceEmailMetadata().isValid()) {
+                valid = false;
+                log.warn(RESOURCE_EMAIL_METADATA_REJECTED_MESSAGE, policy.toString());
+            }
+        }
+        if (valid == false) {
+            log.warn(REQUIRED_PROPERTIES_REJECTED_MESSAGE, policy.toString());
+        }
+        return valid;
+    }
+
     public boolean validate(LegacyPolicy policy) {
         boolean hasId = Optional.ofNullable(policy.getId()).isPresent();
         boolean hasOperatorTemplate = Optional.ofNullable(policy.getOperatorTemplate()).isPresent();

src/main/java/io/pivotal/cfapp/domain/Resource.java

@@ -11,12 +11,15 @@
 
 @Builder
 @Getter
-@JsonPropertyOrder({ "guid", "created_at", "updated_at", "metadata" })
+@JsonPropertyOrder({ "guid","name","created_at", "updated_at", "metadata" })
 public class Resource {
 
     @JsonProperty("guid")
     private String guid;
 
+    @JsonProperty("name")
+    private String name;
+
     @JsonProperty("created_at")
     private Instant createdAt;
 
@@ -28,11 +31,15 @@ public class Resource {
 
     @JsonCreator
     public Resource(
-            @JsonProperty("guid") String guid,
-            @JsonProperty("created_at") Instant createdAt,
-            @JsonProperty("updated_at") Instant updatedAt,
-            @JsonProperty("metadata") EmbeddedMetadata metadata) {
+
+        @JsonProperty("guid") String guid,
+        @JsonProperty("name") String name,
+        @JsonProperty("created_at") Instant createdAt,
+        @JsonProperty("updated_at") Instant updatedAt,
+        @JsonProperty("metadata") EmbeddedMetadata metadata) {
+
         this.guid = guid;
+        this.name = name;
         this.createdAt = createdAt;
         this.updatedAt = updatedAt;
         this.metadata = metadata;

src/main/java/io/pivotal/cfapp/domain/ResourceEmailMetadata.java

@@ -0,0 +1,62 @@
+package io.pivotal.cfapp.domain;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.commons.lang3.StringUtils;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+
+import io.jsonwebtoken.lang.Collections;
+import lombok.Builder;
+import lombok.Builder.Default;
+import lombok.Getter;
+
+@Builder
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonPropertyOrder({ "resource", "labels", "email-domain" })
+@Getter
+public class ResourceEmailMetadata {
+
+    @JsonProperty("resource")
+    private String resource;
+
+    @Default
+    @JsonProperty("labels")
+    private List<String> labels = new ArrayList<>();
+
+    @JsonProperty("email-domain")
+    private String emailDomain;
+
+
+    @JsonCreator
+    public ResourceEmailMetadata(
+            @JsonProperty("resource") String resource,
+            @JsonProperty("labels") List<String> labels,
+            @JsonProperty("email-domain") String emailDomain
+            ) {
+        this.resource = resource;
+        this.labels = labels;
+        this.emailDomain = emailDomain;
+    }
+
+    @JsonIgnore
+    public boolean isValid() {
+        return isValidResource(resource)
+                && !Collections.isEmpty(labels)
+                && StringUtils.isNotBlank(emailDomain);
+    }
+    
+    private static boolean isValidResource(String resource) {
+        ResourceType[] resourceTypes = ResourceType.values();
+        for (ResourceType resourceType : resourceTypes)
+            if (resourceType.getId().equals(resource))
+                return true;
+        return false;
+    }
+
+}