Merge pull request #47 from shreelakshmijoshi/make-server-items-confi…

…gurable

Make server items configurable

docs/openapi.yaml

@@ -31,7 +31,9 @@ info:
     - **Base path**:
       - Base path is the path on which API is served, relative to the host
       - It is the initial part of the API
-      - The base path value could be configured according to the deployment
+      - These base path values could be configured according to the deployment
+      - The base path for [DX AAA Server](https://github.com/datakaveri/iudx-aaa-server) is set to `/auth/v1`
+      - The base path for [DX Catalogue Server](https://github.com/datakaveri/iudx-catalogue-server) is set to `/iudx/cat/v1`
           Currently, the following APIs have `/ngsi-ld/v1` base path
           -  /entities
           -  /temporal/entities

src/main/java/iudx/rs/proxy/apiserver/ApiServerVerticle.java

@@ -87,7 +87,8 @@ public class ApiServerVerticle extends AbstractVerticle {
   private DatabaseService databaseService;
   private MeteringService meteringService;
   private DatabrokerService brokerService;
-
+  private String dxCatalogueBasePath;
+  private String dxAuthBasePath;
   private String dxApiBasePath;
 
   @Override
@@ -97,8 +98,11 @@ public void start() throws Exception {
     meteringService = MeteringService.createProxy(vertx, METERING_SERVICE_ADDRESS);
     brokerService = DatabrokerService.createProxy(vertx, DATABROKER_SERVICE_ADDRESS);
     validator = new ParamsValidator(catalogueService);
-
+
+    /* Get base paths from config */
     dxApiBasePath=config().getString("dxApiBasePath");
+    dxCatalogueBasePath = config().getString("dxCatalogueBasePath");
+    dxAuthBasePath = config().getString("dxAuthBasePath");
     Api apis=Api.getInstance(dxApiBasePath);
 
     router = Router.router(vertx);

src/main/java/iudx/rs/proxy/apiserver/service/CatalogueService.java

@@ -1,6 +1,8 @@
 package iudx.rs.proxy.apiserver.service;
 
 import static iudx.rs.proxy.apiserver.util.Util.toList;
+import static iudx.rs.proxy.authenticator.Constants.CAT_ITEM_PATH;
+import static iudx.rs.proxy.authenticator.Constants.CAT_SEARCH_PATH;
 
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
@@ -36,8 +38,9 @@ public class CatalogueService {
   private long cacheTimerid;
   private static String catHost;
   private static int catPort;;
-  private static String catSearchPath;
-  private static String catItemPath;
+  private String catBasePath;
+  private String catItemPath;
+  private String catSearchPath;
   private Vertx vertx;
 
   private final Cache<String, List<String>> applicableFilterCache =
@@ -48,8 +51,9 @@ public CatalogueService(Vertx vertx, JsonObject config) {
     this.vertx = vertx;
     catHost = config.getString("catServerHost");
     catPort = config.getInteger("catServerPort");
-    catSearchPath = Constants.CAT_RSG_PATH;
-    catItemPath = Constants.CAT_ITEM_PATH;
+    catBasePath = config.getString("dxCatalogueBasePath");
+    catItemPath = catBasePath + CAT_ITEM_PATH;
+    catSearchPath = catBasePath + CAT_SEARCH_PATH;
 
     WebClientOptions options =
         new WebClientOptions().setTrustAll(true).setVerifyHost(false).setSsl(true);
@@ -189,8 +193,8 @@ private void callCatalogueAPI(String id, Handler<AsyncResult<List<String>>> hand
         });
         handler.handle(Future.succeededFuture(filters));
       } else if (catHandler.failed()) {
-        LOGGER.error("catalogue call(/iudx/cat/v1/item) failed for id" + id);
-        handler.handle(Future.failedFuture("catalogue call(/iudx/cat/v1/item) failed for id" + id));
+        LOGGER.error("catalogue call ("+ catItemPath + ") failed for id" + id);
+        handler.handle(Future.failedFuture("catalogue call(" + catItemPath + ") failed for id" + id));
       }
     });
   }

src/main/java/iudx/rs/proxy/authenticator/AuthenticationVerticle.java

@@ -1,5 +1,6 @@
 package iudx.rs.proxy.authenticator;
 
+import static iudx.rs.proxy.authenticator.Constants.AUTH_CERTIFICATE_PATH;
 import static iudx.rs.proxy.common.Constants.*;
 
 import io.vertx.core.AbstractVerticle;
@@ -117,8 +118,9 @@ public void stop() {
   private Future<String> getJwtPublicKey(Vertx vertx, JsonObject config) {
     Promise<String> promise = Promise.promise();
     webClient = createWebClient(vertx, config);
+    String authCert = config.getString("dxAuthBasePath") + AUTH_CERTIFICATE_PATH;
     webClient
-        .get(443, config.getString("authServerHost"), "/auth/v1/cert")
+        .get(443, config.getString("authServerHost"), authCert)
         .send(
             handler -> {
               if (handler.succeeded()) {

src/main/java/iudx/rs/proxy/authenticator/Constants.java

@@ -6,8 +6,9 @@ public class Constants {
 
   public static final List<String> OPEN_ENDPOINTS = List.of("/temporal/entities","/entities","/consumer/audit","/entityOperations/query");
   public static final long CACHE_TIMEOUT_AMOUNT = 30;
-  public static final String CAT_RSG_PATH = "/iudx/cat/v1/search";
-  public static final String CAT_ITEM_PATH = "/iudx/cat/v1/item";
+  public static final String CAT_SEARCH_PATH = "/search";
+  public static final String AUTH_CERTIFICATE_PATH = "/cert";
+  public static final String CAT_ITEM_PATH = "/item";
   public static final String JSON_USERID = "userid";
   public static final String JSON_IID = "iid";
   public static final String JSON_EXPIRY = "expiry";

src/main/java/iudx/rs/proxy/authenticator/JwtAuthenticationServiceImpl.java

@@ -1,10 +1,5 @@
 package iudx.rs.proxy.authenticator;
 
-import static iudx.rs.proxy.authenticator.Constants.JSON_EXPIRY;
-import static iudx.rs.proxy.authenticator.Constants.JSON_IID;
-import static iudx.rs.proxy.authenticator.Constants.JSON_USERID;
-import static iudx.rs.proxy.authenticator.Constants.OPEN_ENDPOINTS;
-
 import com.google.common.cache.Cache;
 import com.google.common.cache.CacheBuilder;
 import io.vertx.core.AsyncResult;
@@ -40,6 +35,8 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
+import static iudx.rs.proxy.authenticator.Constants.*;
+
 public class JwtAuthenticationServiceImpl implements AuthenticationService {
 
   private static final Logger LOGGER = LogManager.getLogger(JwtAuthenticationServiceImpl.class);
@@ -52,6 +49,7 @@ public class JwtAuthenticationServiceImpl implements AuthenticationService {
   final CacheService cache;
   static WebClient catWebClient;
   final Api apis;
+  final String catBasePath;
   // resourceGroupCache will contain ACL info about all resource group in a resource server
   Cache<String, String> resourceGroupCache = CacheBuilder.newBuilder().maximumSize(1000)
       .expireAfterAccess(Constants.CACHE_TIMEOUT_AMOUNT, TimeUnit.MINUTES).build();
@@ -67,7 +65,8 @@ public class JwtAuthenticationServiceImpl implements AuthenticationService {
     this.audience = config.getString("audience");
     this.host = config.getString("catServerHost");
     this.port = config.getInteger("catServerPort");
-    this.path = Constants.CAT_RSG_PATH;
+    this.catBasePath = config.getString("dxCatalogueBasePath");
+    this.path = catBasePath + CAT_SEARCH_PATH;
     this.apis=apis;
     WebClientOptions options = new WebClientOptions();
     options.setTrustAll(true).setVerifyHost(false).setSsl(true);

src/test/java/iudx/rs/proxy/authenticator/JwtAuthenticationServiceImplTest.java

@@ -88,6 +88,8 @@ static void init(Vertx vertx, VertxTestContext testContext) {
         authConfig.put("host", "rs.iudx.io");
         authConfig.put("catServerPort", 8080);
         authConfig.put("dxApiBasePath","/ngsi-ld/v1");
+        authConfig.put("dxCatalogueBasePath", "/iudx/cat/v1");
+        authConfig.put("dxAuthBasePath", "/auth/v1");
 
         JWTAuthOptions jwtAuthOptions = new JWTAuthOptions();
         jwtAuthOptions.addPubSecKey(

src/test/resources/IUDX-Resource-Proxy-Server-Consumer-APIs.postman_collection.json

@@ -46,14 +46,13 @@
 							}
 						},
 						"url": {
-							"raw": "https://{{auth-url}}/auth/v1/token",
+							"raw": "https://{{auth-url}}/{{dxAuthBasePath}}/token",
 							"protocol": "https",
 							"host": [
 								"{{auth-url}}"
 							],
 							"path": [
-								"auth",
-								"v1",
+								"{{dxAuthBasePath}}",
 								"token"
 							]
 						}
@@ -113,14 +112,13 @@
 							}
 						},
 						"url": {
-							"raw": "https://{{auth-url}}/auth/v1/token",
+							"raw": "https://{{auth-url}}/{{dxAuthBasePath}}/token",
 							"protocol": "https",
 							"host": [
 								"{{auth-url}}"
 							],
 							"path": [
-								"auth",
-								"v1",
+								"{{dxAuthBasePath}}",
 								"token"
 							]
 						}
@@ -191,16 +189,15 @@
 							}
 						},
 						"url": {
-							"raw": "https://authvertx.iudx.io/auth/v1/token",
+							"raw": "https://authvertx.iudx.io/{{dxAuthBasePath}}/token",
 							"protocol": "https",
 							"host": [
 								"authvertx",
 								"iudx",
 								"io"
 							],
 							"path": [
-								"auth",
-								"v1",
+								"{{dxAuthBasePath}}",
 								"token"
 							]
 						}
@@ -271,16 +268,15 @@
 							}
 						},
 						"url": {
-							"raw": "https://authvertx.iudx.io/auth/v1/token",
+							"raw": "https://authvertx.iudx.io/{{dxAuthBasePath}}/token",
 							"protocol": "https",
 							"host": [
 								"authvertx",
 								"iudx",
 								"io"
 							],
 							"path": [
-								"auth",
-								"v1",
+								"{{dxAuthBasePath}}",
 								"token"
 							]
 						}
@@ -351,16 +347,15 @@
 							}
 						},
 						"url": {
-							"raw": "https://authvertx.iudx.io/auth/v1/token",
+							"raw": "https://authvertx.iudx.io/{{dxAuthBasePath}}/token",
 							"protocol": "https",
 							"host": [
 								"authvertx",
 								"iudx",
 								"io"
 							],
 							"path": [
-								"auth",
-								"v1",
+								"{{dxAuthBasePath}}",
 								"token"
 							]
 						}
@@ -431,16 +426,15 @@
 							}
 						},
 						"url": {
-							"raw": "https://authvertx.iudx.io/auth/v1/token",
+							"raw": "https://authvertx.iudx.io/{{dxAuthBasePath}}/token",
 							"protocol": "https",
 							"host": [
 								"authvertx",
 								"iudx",
 								"io"
 							],
 							"path": [
-								"auth",
-								"v1",
+								"{{dxAuthBasePath}}",
 								"token"
 							]
 						}

src/test/resources/IUDX-Resource-Proxy-Server-Consumer-APIs.postman_environment.postman_environment.json

@@ -7,6 +7,11 @@
 			"value": "ngsi-ld/v1",
 			"enabled": true
 		},
+		{
+			"key": "dxAuthBasePath",
+			"value": "auth/v1",
+			"enabled": true
+		},
 		{
 			"key": "openResourceToken",
 			"value": "",

src/test/resources/README.md

@@ -1,8 +1,8 @@
 ### Making configurable base path
 - Base path can be added in postman environment file or in postman.
-- `IUDX-Resource-Proxy-Server-Consumer-APIs.postman_environment.postman_environment.json` has **values** array which has a fields named **basePath** whose **value** is currently set to `ngsi-ld/v1`.
+- `IUDX-Resource-Proxy-Server-Consumer-APIs.postman_environment.postman_environment.json` has **values** array which has fields named **basePath** whose **value** is currently set to `ngsi-ld/v1`, **dxAuthBasePath** with value `auth/v1`.
 - The **value** could be changed according to the deployment and then the collection with the `IUDX-Resource-Proxy-Server-Consumer-APIs.postman_environment.postman_environment.json` file can be uploaded to Postman
-- For the changing the **basePath** value in postman after importing the collection and environment files, locate `Resource Proxy Environment` from **Environments** in sidebar of Postman application.
+- For the changing the **basePath**, **dxAuthBasePath** value in postman after importing the collection and environment files, locate `Resource Proxy Environment` from **Environments** in sidebar of Postman application.
 - To know more about Postman environments, refer : [postman environments](https://learning.postman.com/docs/sending-requests/managing-environments/)
 - The **CURRENT VALUE** of the variable could be changed