Migrate msb-url into host-url 07/7307/1
authorKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Fri, 11 Aug 2017 05:11:29 +0000 (10:41 +0530)
committerKanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
Fri, 11 Aug 2017 05:14:08 +0000 (10:44 +0530)
CLI framework is being enhanced to support
different service mode like direct and catalog
and msb term is verfy specific to catalog mode.
so its migrated to move to generic format

CLI-29
Change-Id: I93f8354e2f32f7cae1660168ce403c76cca0587f
Signed-off-by: Kanagaraj Manickam k00365106 <kanagaraj.manickam@huawei.com>
17 files changed:
framework/src/main/java/org/onap/cli/fw/ad/OnapAuthClient.java
framework/src/main/java/org/onap/cli/fw/ad/OnapCredentials.java
framework/src/main/java/org/onap/cli/fw/conf/Constants.java
framework/src/main/java/org/onap/cli/fw/utils/OnapCommandUtils.java
framework/src/main/resources/default_input_parameters.yaml
framework/src/main/resources/onap.properties
framework/src/main/resources/schema-validate.yaml
framework/src/test/java/org/onap/cli/cmd/sample/OnapCommandSampleTest.java
framework/src/test/java/org/onap/cli/fw/TestCommandValidate.java
framework/src/test/java/org/onap/cli/fw/ad/OnapCredentialsTest.java
framework/src/test/java/org/onap/cli/fw/cmd/OnapHttpCommandTest.java
framework/src/test/java/org/onap/cli/fw/cmd/OnapSchemaValidateCommandTest.java
framework/src/test/java/org/onap/cli/fw/defaultParameter/TestDefaultParameterSection.java
framework/src/test/resources/onap.properties
framework/src/test/resources/sample-cmd-test-help.txt
framework/src/test/resources/sample-test-include-exclude.yaml
main/src/test/java/org/onap/cli/main/utils/OnapCliUtilsTest.java

index e6c69a1..e87ef0a 100644 (file)
@@ -45,7 +45,7 @@ public class OnapAuthClient {
 
     public OnapAuthClient(OnapCredentials creds, boolean debug) throws OnapCommandHttpFailure {
         this.creds = creds;
-        this.http = new OnapHttpConnection(creds.getMsbUrl().startsWith("https"), debug);
+        this.http = new OnapHttpConnection(creds.getHostUrl().startsWith("https"), debug);
     }
 
     /**
@@ -136,13 +136,13 @@ public class OnapAuthClient {
      */
     public String getServiceBasePath(OnapService srv) throws OnapCommandException {
         if (srv.getName().equals(OnapCommandConfg.getApiGateway())) {
-            return this.getMsbUrl();
+            return this.getApiGatewayUrl();
         } else if (srv.isModeDirect()){
-            return this.creds.getMsbUrl();
+            return this.creds.getHostUrl();
         }
 
 
-        HttpInput input = new HttpInput().setUri(this.creds.getMsbUrl()
+        HttpInput input = new HttpInput().setUri(this.creds.getHostUrl()
                 + String.format(Constants.MSB_SERVICE_URI, srv.getName(), srv.getVersion()));
         HttpResult result = this.http.get(input);
 
@@ -154,7 +154,7 @@ public class OnapAuthClient {
         }
 
         try {
-            return this.creds.getMsbUrl() + JsonPath.read(result.getBody(), "url");
+            return this.creds.getHostUrl() + JsonPath.read(result.getBody(), "url");
         } catch (Exception e) {
             throw new OnapCommandExecutionFailed(e, srv.toString());
         }
@@ -167,8 +167,8 @@ public class OnapAuthClient {
         return this.getServiceBasePath(srv);
     }
 
-    private String getMsbUrl() {
-        return this.creds.getMsbUrl() + Constants.MSB_URI;
+    private String getApiGatewayUrl() {
+        return this.creds.getHostUrl() + Constants.MSB_URI;
     }
 
     public String getAuthToken() {
index 7c3c3ac..02291b2 100644 (file)
@@ -32,9 +32,9 @@ public class OnapCredentials {
     private String password;
 
     /*
-     * Onap Service msb-url
+     * Onap Service host-url
      */
-    private String msbUrl;
+    private String hostUrl;
 
     /**
      * Onap credentials with username and password.
@@ -43,14 +43,14 @@ public class OnapCredentials {
      *            user name
      * @param password
      *            password
-     * @param msbUrl
-     *            msb url
+     * @param hostUrl
+     *            host url
      */
-    public OnapCredentials(String username, String password, String msbUrl) {
+    public OnapCredentials(String username, String password, String hostUrl) {
         super();
         this.username = username;
         this.password = password;
-        this.msbUrl = msbUrl;
+        this.hostUrl = hostUrl;
     }
 
     public String getUsername() {
@@ -61,7 +61,7 @@ public class OnapCredentials {
         return password;
     }
 
-    public String getMsbUrl() {
-        return msbUrl;
+    public String getHostUrl() {
+        return hostUrl;
     }
 }
index e487bbf..d711ba2 100644 (file)
@@ -94,7 +94,7 @@ public class Constants {
     // Common parameters used across all commands.
     public static final String DEAFULT_PARAMETER_USERNAME = "onap-username";
     public static final String DEAFULT_PARAMETER_PASS_WORD = "onap-password";
-    public static final String DEAFULT_PARAMETER_MSB_URL = "msb-url";
+    public static final String DEAFULT_PARAMETER_HOST_URL = "host-url";
     public static final String DEFAULT_PARAMETER_HELP = "help";
     public static final String DEFAULT_PARAMETER_VERSION = "version";
     public static final String DEFAULT_PARAMETER_DEBUG = "debug";
index b4df2ac..9a42539 100644 (file)
@@ -682,7 +682,7 @@ public class OnapCommandUtils {
 
         return new OnapCredentials(paramMap.get(Constants.DEAFULT_PARAMETER_USERNAME),
                 paramMap.get(Constants.DEAFULT_PARAMETER_PASS_WORD),
-                paramMap.get(Constants.DEAFULT_PARAMETER_MSB_URL));
+                paramMap.get(Constants.DEAFULT_PARAMETER_HOST_URL));
     }
 
     /**
index 4f0d419..3b7e198 100644 (file)
@@ -15,13 +15,13 @@ parameters:
     default_value: ${ONAP_PASSWORD}
     is_secured: true
     is_optional: false
-  - name: msb-url
+  - name: host-url
     type: url
-    description: Onap MSB url
+    description: Onap host url
     short_option: m
-    long_option: msb-url
+    long_option: host-url
     is_optional: false
-    default_value: ${ONAP_MSB_URL}
+    default_value: ${ONAP_HOST_URL}
   - name: help
     type: string
     description: Onap command help message
index b8f08d3..47b02c8 100644 (file)
@@ -8,7 +8,7 @@ cli.api_gateway=msb
 cli.auth_service=auth
 
 # service section
-cli.exclude_params_internal_cmd=onap-username,onap-password,msb-url,no-auth
-cli.no_auth_disable_include_params_external_cmd=onap-username,onap-password,msb-url,no-auth
+cli.exclude_params_internal_cmd=onap-username,onap-password,host-url,no-auth
+cli.no_auth_disable_include_params_external_cmd=onap-username,onap-password,host-url,no-auth
 cli.no_auth_enable_exclude_params_external_cmd=onap-username,onap-password,no-auth
-cli.no_auth_enable_include_params_external_cmd=msb-url
\ No newline at end of file
+cli.no_auth_enable_include_params_external_cmd=host-url
\ No newline at end of file
index 06bb656..6678791 100644 (file)
@@ -9,7 +9,7 @@ default_parameters:
   exclude:
     - onap-username
     - onap-password
-    - msb-url
+    - host-url
     - no-auth
 parameters:
   - name: schema-location
index 9cf6bdf..e50490f 100644 (file)
@@ -98,7 +98,7 @@ public class OnapCommandSampleTest {
             d.setValue("true");
             parameters.add(d);
             OnapCommandParameter m = new OnapCommandParameter();
-            m.setName(Constants.DEAFULT_PARAMETER_MSB_URL);
+            m.setName(Constants.DEAFULT_PARAMETER_HOST_URL);
             m.setValue("http://localhost");
             parameters.add(m);
             sample.setParameters(parameters);
@@ -142,7 +142,7 @@ public class OnapCommandSampleTest {
         d.setValue("true");
         parameters.add(d);
         OnapCommandParameter m = new OnapCommandParameter();
-        m.setName(Constants.DEAFULT_PARAMETER_MSB_URL);
+        m.setName(Constants.DEAFULT_PARAMETER_HOST_URL);
         m.setValue("http://localhost");
         parameters.add(m);
         sample.setParameters(parameters);
index b8ac72e..5784725 100644 (file)
@@ -42,7 +42,7 @@ public class TestCommandValidate {
 
         OnapCommandParameter noAuthParam = cmd.getParameters().stream().filter(p -> p.getName().equalsIgnoreCase("no-auth")).findFirst().get();
         noAuthParam.setValue(true);
-        OnapCommandParameter msbParam = cmd.getParameters().stream().filter(p -> p.getName().equalsIgnoreCase("msb-url")).findFirst().get();
+        OnapCommandParameter msbParam = cmd.getParameters().stream().filter(p -> p.getName().equalsIgnoreCase("host-url")).findFirst().get();
         msbParam.setValue("localhost://msbip:msb:port");
         cmd.validate();
     }
index a1987c0..cc43145 100644 (file)
@@ -26,7 +26,7 @@ public class OnapCredentialsTest {
     public void credentialsTest() {
         OnapCredentials cre = new OnapCredentials("test", "test123", "url");
         assertTrue(cre.getUsername().equals("test") && cre.getPassword().equals("test123")
-                && cre.getMsbUrl().equals("url"));
+                && cre.getHostUrl().equals("url"));
     }
 
 }
index e7af1aa..bfdb14a 100644 (file)
@@ -39,8 +39,8 @@ public class OnapHttpCommandTest {
         param2.setName("onap-password");
         param2.setParameterType(ParameterType.STRING);
         OnapCommandParameter param3 = new OnapCommandParameter();
-        param3.setLongOption("msb-url");
-        param3.setName("msb-url");
+        param3.setLongOption("host-url");
+        param3.setName("host-url");
         param3.setParameterType(ParameterType.STRING);
         OnapCommandParameter param4 = new OnapCommandParameter();
         param4.setLongOption("string-param");
index b70bf6f..89c32c9 100644 (file)
@@ -32,7 +32,7 @@ public class OnapSchemaValidateCommandTest {
                 param.setValue("test");
             } else if ("onap-password".equals(param.getName())) {
                 param.setValue("test");
-            } else if ("msb-url".equals(param.getName())) {
+            } else if ("host-url".equals(param.getName())) {
                 param.setValue("test-url");
             } else if ("schema-location".equals(param.getName())) {
                 param.setValue("schema-validate-pass.yaml");
@@ -52,7 +52,7 @@ public class OnapSchemaValidateCommandTest {
                 param.setValue("test");
             } else if ("onap-password".equals(param.getName())) {
                 param.setValue("test");
-            } else if ("msb-url".equals(param.getName())) {
+            } else if ("host-url".equals(param.getName())) {
                 param.setValue("test-url");
             } else if ("schema-location".equals(param.getName())) {
                 param.setValue(
index 004bf7c..da37f6f 100644 (file)
@@ -43,7 +43,7 @@ public class TestDefaultParameterSection {
         List<String> parameters = cmd.getParameters().stream().map(p -> p.getName()).collect(Collectors.toList());
         assertTrue(parameters.contains("onap-username"));
         assertTrue(parameters.contains("onap-password"));
-        assertTrue(parameters.contains("msb-url"));
+        assertTrue(parameters.contains("host-url"));
     }
 
     @Test
@@ -57,7 +57,7 @@ public class TestDefaultParameterSection {
         List<String> parameters = cmd.getParameters().stream().map(p -> p.getName()).collect(Collectors.toList());
         assertTrue(parameters.contains("onap-username"));
         assertTrue(parameters.contains("onap-password"));
-        assertTrue(parameters.contains("msb-url"));
+        assertTrue(parameters.contains("host-url"));
         assertFalse(parameters.contains("long"));
         assertFalse(parameters.contains("format"));
         assertTrue(parameters.contains("debug"));
@@ -75,7 +75,7 @@ public class TestDefaultParameterSection {
 
         assertTrue(parameters.contains("onap-username"));
         assertTrue(parameters.contains("onap-password"));
-        assertTrue(parameters.contains("msb-url"));
+        assertTrue(parameters.contains("host-url"));
     }
 
     @Test
@@ -90,7 +90,7 @@ public class TestDefaultParameterSection {
 
         assertFalse(parameters.contains("onap-username"));
         assertFalse(parameters.contains("onap-password"));
-        assertTrue(parameters.contains("msb-url"));
+        assertTrue(parameters.contains("host-url"));
         assertTrue(parameters.contains("debug"));
         assertTrue(parameters.contains("long"));
         assertTrue(parameters.contains("format"));
index a6c991c..b2b4fee 100644 (file)
@@ -8,7 +8,7 @@ cli.api_gateway=msb
 cli.auth_service=auth
 
 # service section
-cli.exclude_params_internal_cmd=onap-username,onap-password,msb-url,no-auth
-cli.no_auth_disable_include_params_external_cmd=onap-username,onap-password,msb-url,no-auth
+cli.exclude_params_internal_cmd=onap-username,onap-password,host-url,no-auth
+cli.no_auth_disable_include_params_external_cmd=onap-username,onap-password,host-url,no-auth
 cli.no_auth_enable_exclude_params_external_cmd=onap-username,onap-password,no-auth
-cli.no_auth_enable_include_params_external_cmd=msb-url
+cli.no_auth_enable_include_params_external_cmd=host-url
index d8ce1ef..074e833 100644 (file)
@@ -5,7 +5,7 @@ Onap sample command to test the command features
 Onap service: sample v1
 
 Options:
-[-u | --onap-username] [-p | --onap-password] [-m | --msb-url]
+[-u | --onap-username] [-p | --onap-password] [-m | --host-url]
 [-h | --help] [-v | --version] [-d | --debug]
 [-f | --format] [-s | --long] [-t | --no-title]
 [-a | --no-auth] [-b | --bool] [-x | --secure]
@@ -19,7 +19,7 @@ where,
 -p | --onap-password   Onap user password. It is of type STRING. By
                         default, it is read from environment variable
                         ONAP_PASSWORD. Secured.
--m | --msb-url          Onap MSB url. It is of type URL. By default, it
+-m | --host-url          Onap MSB url. It is of type URL. By default, it
                         is read from environment variable ONAP_MSB_URL.
 -h | --help             Onap command help message. It is of type STRING.
                         By default, it is false.
index a1494bf..7a14f26 100644 (file)
@@ -3,7 +3,7 @@ default_parameters:
   include:
     - onap-username
     - onap-password
-    - msb-url
+    - host-url
     - no-auth
   exclude:
     - long
index c7fb798..8870029 100644 (file)
@@ -42,8 +42,8 @@ public class OnapCliUtilsTest {
         param2.setName("onap-password");
         param2.setParameterType(ParameterType.STRING);
         OnapCommandParameter param3 = new OnapCommandParameter();
-        param3.setLongOption("msb-url");
-        param3.setName("msb-url");
+        param3.setLongOption("host-url");
+        param3.setName("host-url");
         param3.setParameterType(ParameterType.STRING);
         OnapCommandParameter param4 = new OnapCommandParameter();
         param4.setLongOption("string-param");
@@ -62,13 +62,13 @@ public class OnapCliUtilsTest {
         paramslist.add(param5);
 
         String[] args = new String[] { "sample-create", "--onap-username", "admin", "--onap-password", "123",
-                "--msb-url", "a@b.com", "--string-param", "blah", "--long-opt", "10" };
+                "--host-url", "a@b.com", "--string-param", "blah", "--long-opt", "10" };
         OnapCliUtils.populateParams(paramslist, Arrays.asList(args));
         List<String> expectedList = Arrays.asList(args);
 
         Assert.assertEquals("onap-username", expectedList.get(2), param1.getValue());
         Assert.assertEquals("onap-password", expectedList.get(4), param2.getValue());
-        Assert.assertEquals("msb-url", expectedList.get(6), param3.getValue());
+        Assert.assertEquals("host-url", expectedList.get(6), param3.getValue());
         Assert.assertEquals("string-param", expectedList.get(8), param4.getValue());
         Assert.assertEquals("long-opt", expectedList.get(10), param5.getValue());
 
@@ -161,7 +161,7 @@ public class OnapCliUtilsTest {
         param2.setParameterType(ParameterType.STRING);
         OnapCommandParameter param3 = new OnapCommandParameter();
         param3.setShortOption("r");
-        param3.setName("msb-url");
+        param3.setName("host-url");
         param3.setParameterType(ParameterType.STRING);
         OnapCommandParameter param4 = new OnapCommandParameter();
         param4.setShortOption("c");