feat: [IDP-693]: Remove empty paths in allow list (#49349)

Author: vigneswara-propelo

idp-service/src/main/java/io/harness/idp/allowlist/services/AllowListServiceImpl.java

@@ -44,6 +44,7 @@ public class AllowListServiceImpl implements AllowListService {
   private static final String ALLOW_LIST = "allow-list";
   private static final String READING_PROPERTY = "reading";
   private static final String ALLOW_PROPERTY = "allow";
+  private static final String PATHS_PROPERTY = "paths";
 
   @Override
   public List<HostInfo> getAllowList(String harnessAccount) throws Exception {
@@ -59,6 +60,7 @@ public List<HostInfo> getAllowList(String harnessAccount) throws Exception {
   @Override
   public List<HostInfo> saveAllowList(List<HostInfo> hostInfoList, String harnessAccount) throws Exception {
     JsonNode allowListNode = asJsonNode(YamlUtils.writeObjectAsYaml(hostInfoList));
+    removePathsNodeIfEmpty(allowListNode);
     String yamlString = CommonUtils.readFileFromClassPath(ALLOW_LIST_CONFIG_FILE);
     JsonNode rootNode = asJsonNode(yamlString);
     JsonNode readingNode = ConfigManagerUtils.getNodeByName(rootNode, READING_PROPERTY);
@@ -68,6 +70,15 @@ public List<HostInfo> saveAllowList(List<HostInfo> hostInfoList, String harnessA
     return hostInfoList;
   }
 
+  private void removePathsNodeIfEmpty(JsonNode jsonNode) {
+    for (JsonNode allowNode : jsonNode) {
+      JsonNode pathsNode = allowNode.get(PATHS_PROPERTY);
+      if (pathsNode.isArray() && pathsNode.isEmpty()) {
+        ((ObjectNode) allowNode).remove(PATHS_PROPERTY);
+      }
+    }
+  }
+
   private void createOrUpdateAllowListAppConfig(String config, String accountIdentifier) throws Exception {
     String schema = CommonUtils.readFileFromClassPath(ALLOW_LIST_JSON_SCHEMA_FILE);
     if (!isValidSchema(config, schema)) {

idp-service/src/main/resources/configs/allowlist/allow-list-json-schema.json

@@ -38,8 +38,7 @@
                 "type": "object",
                 "additionalProperties": false,
                 "required": [
-                  "host",
-                  "paths"
+                  "host"
                 ],
                 "properties": {
                   "host": {

idp-service/src/test/java/io/harness/idp/allowlist/services/AllowListServiceImplTest.java

@@ -72,14 +72,19 @@ public void testGetAllowList() throws Exception {
   @Category(UnitTests.class)
   public void testSaveAllowList() throws Exception {
     List<HostInfo> hostInfoList = new ArrayList<>();
-    HostInfo hostInfo = new HostInfo();
-    hostInfo.setHost("stress.harness.io");
-    hostInfo.setPaths(new ArrayList<>());
+    HostInfo hostInfo1 = new HostInfo();
+    hostInfo1.setHost("stress.harness.io");
+    hostInfo1.setPaths(new ArrayList<>());
+    hostInfoList.add(hostInfo1);
+    HostInfo hostInfo2 = new HostInfo();
+    hostInfo2.setHost("qa.harness.io");
+    hostInfo2.setPaths(List.of("/v1/secrets"));
+    hostInfoList.add(hostInfo2);
     MockedStatic<YamlUtils> yamlUtilsMockedStatic = Mockito.mockStatic(YamlUtils.class);
     MockedStatic<CommonUtils> commonUtilsMockedStatic = Mockito.mockStatic(CommonUtils.class);
 
     String yamlString = "backend:\n  reading:\n    allow: []";
-    String allowListString = "- host: stress.harness.io\n  paths: []";
+    String allowListString = "- host: stress.harness.io\n  paths: []\n- host: qa.harness.io\n  paths:\n  - /v1/secrets";
     when(YamlUtils.writeObjectAsYaml(any())).thenReturn(allowListString);
     when(CommonUtils.readFileFromClassPath(any())).thenReturn(yamlString).thenReturn(schema);