Configure the following environment variables, before using it:
1. **HOST_URL** - Onap Micro service bus(MSB) URL or a service URL
-2. **ONAP_USERNAME** - Onap user name
-3. **ONAP_PASSWORD** - Onap user password
+2. **HOST_USERNAME** - Onap user name
+3. **HOST_PASSWORD** - Onap user password
To Run a command
-----------------
And use the directive set to set the values for following parameters:
-1. **host-url** - Onap Micro service bus(MSB) URL or a service URL
-2. **onap-username** - Onap user name
-3. **onap-password** - Onap user password
+1. **onap-host-url** - Onap Micro service bus(MSB) URL or a service URL
+2. **host-username** - Onap user name
+3. **host-password** - Onap user password
Set the product version
------------------------
More details
-------------
-https://wiki.onap.org
\ No newline at end of file
+https://wiki.onap.org
</head>
<body onload="showSlides()" style="background-color: white;color: black">
-<div class="readme">
-<h2>ONAP Command-Line Interface (CLI)</h2>
-
-<p>Provides unified commands to operate ONAP from Linux shell and web-console.
-
-<h3 >Web Command Console</h3>
-<p>To open web command console for ONAP,
-<a onclick="redirectToConsole();" style="color: blue;cursor: pointer">Click here !</a>
-
-<h3>Linux Command Console</h3>
-<p>Please follow the instructions given below for installing ONAP CLI.</p>
-<ol>
-<li>Download ONAP CLI from <a href="./onap-cli.zip">here</a></li>
-<li>Unzip into folder /opt/onap/cli</li>
-<li>Initialize CLI by running /opt/onap/cli/cli-init.sh</li>
-<li>Run ONAP CLI, by typing <strong>onap</strong> from command line
-<li>For more details, refer /opt/onap/cli/README.md</li>
-</ol>
-<br>
-<a href="http://onap.readthedocs.io/en/latest/submodules/cli.git/docs/index.html" style="color: blue;">
-<sub style="color: blue;"><strong>One Command to command whole Onap !!</strong></sub></a>
-<hr>
-<p><i>Powered by <strong>Open CLI Platform (OCLIP) </strong>
-<a href="http://onap.readthedocs.io/en/latest/submodules/cli.git/docs/OCLIP.html" style="color: blue;">1.0</a>
-</i></p>
-</div>
</body></html>
author is allowed to customize the inclusion or exclusion of these input
parameters for a given command.
-name: onap-username
+name: host-username
~~~~~~~~~~~~~~~~~~~
type: string
short_option: u
- long_option: onap-username
+ long_option: host-username
- default_value: ${ONAP_USERNAME}
+ default_value: ${HOST_USERNAME}
is_optional: false
-name: onap-password
+name: host-password
~~~~~~~~~~~~~~~~~~~
type: string
short_option: p
- long_option: onap-password
+ long_option: host-password
- default_value: ${ONAP_PASSWORD}
+ default_value: ${HOST_PASSWORD}
is_secured: true
For example, OCLIP platform provides a command called 'schema-validate' to
validate schematics of template against the specification defined in this
-document. For this command, host-url, onap-username, onap-password, no-auth
+document. For this command, host-url, host-username, host-password, no-auth
parameters are required. so author could exclude these parameters by defining
as :
default_parameters:
exclude:
- \- onap-username
+ \- host-username
- \- onap-password
+ \- host-password
\- host-url
public static final String DEFAULT_PARAMETER_FILE_NAME = "default_input_parameters.yaml";
// 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_USERNAME = "host-username";
+ public static final String DEAFULT_PARAMETER_PASS_WORD = "host-password";
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";
open_cli_schema_version: 1.0
parameters:
- - name: onap-username
+ - name: host-username
type: string
- description: Onap user name
+ description: Host user name
short_option: u
- long_option: onap-username
- default_value: $s{env:ONAP_USERNAME}
+ long_option: host-username
+ default_value: $s{env:HOST_USERNAME}
is_optional: false
- - name: onap-password
+ - name: host-password
type: string
- description: Onap user password
+ description: Host user password
short_option: p
- long_option: onap-password
- default_value: $s{env:ONAP_PASSWORD}
+ long_option: host-password
+ default_value: $s{env:HOST_PASSWORD}
is_secured: true
is_optional: false
- name: host-url
version: 1.0.0
default_parameters:
exclude:
- - onap-username
- - onap-password
+ - host-username
+ - host-password
- host-url
- no-auth
parameters:
cli.auth_service=auth
# service section
-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.exclude_params_internal_cmd=host-username,host-password,host-url,no-auth
+cli.no_auth_disable_include_params_external_cmd=host-username,host-password,host-url,no-auth
+cli.no_auth_enable_exclude_params_external_cmd=host-username,host-password,no-auth
cli.no_auth_enable_include_params_external_cmd=host-url
cli.http.basic.common_headers=x-auth-token,x-transaction-id,x-app-id
# Service specific headers
cli.http.basic.common_headers.sdc=user-id
cli.http.basic.common_headers.sdc.user-id=USER_ID
-cli.http.basic.common_headers.sdc.user-id.value=${onap-username}
+cli.http.basic.common_headers.sdc.user-id.value=${host-username}
#TODO mrkanag add support for aaf like defined above for basic
#cli.service.auth=aaf
@Test(expected = OnapCommandException.class)
public void runTest() throws OnapCommandException {
OnapCommandParameter param1 = new OnapCommandParameter();
- param1.setLongOption("onap-username");
- param1.setName("onap-username");
+ param1.setLongOption("host-username");
+ param1.setName("host-username");
param1.setParameterType(ParameterType.STRING);
OnapCommandParameter param2 = new OnapCommandParameter();
- param2.setLongOption("onap-password");
- param2.setName("onap-password");
+ param2.setLongOption("host-password");
+ param2.setName("host-password");
param2.setParameterType(ParameterType.STRING);
OnapCommandParameter param3 = new OnapCommandParameter();
param3.setLongOption("host-url");
OnapSchemaValidateCommand cmd = new OnapSchemaValidateCommand();
cmd.initializeSchema("schema-validate.yaml");
for (OnapCommandParameter param : cmd.getParameters()) {
- if ("onap-username".equals(param.getName())) {
+ if ("host-username".equals(param.getName())) {
param.setValue("test");
- } else if ("onap-password".equals(param.getName())) {
+ } else if ("host-password".equals(param.getName())) {
param.setValue("test");
} else if ("host-url".equals(param.getName())) {
param.setValue("test-url");
OnapSchemaValidateCommand cmd = new OnapSchemaValidateCommand();
cmd.initializeSchema("schema-validate.yaml");
for (OnapCommandParameter param : cmd.getParameters()) {
- if ("onap-username".equals(param.getName())) {
+ if ("host-username".equals(param.getName())) {
param.setValue("test");
- } else if ("onap-password".equals(param.getName())) {
+ } else if ("host-password".equals(param.getName())) {
param.setValue("test");
} else if ("host-url".equals(param.getName())) {
param.setValue("test-url");
OnapCommandUtils.loadSchema(cmd, "sample-test-include-param.yaml", true, false);
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("host-username"));
+ assertTrue(parameters.contains("host-password"));
assertTrue(parameters.contains("host-url"));
}
OnapCommandUtils.loadSchema(cmd, "sample-test-exclude-param.yaml", true, false);
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("host-username"));
+ assertTrue(parameters.contains("host-password"));
assertTrue(parameters.contains("host-url"));
assertFalse(parameters.contains("long"));
assertFalse(parameters.contains("format"));
OnapCommandUtils.loadSchema(cmd, "sample-test-include-exclude.yaml", true, false);
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("host-username"));
+ assertTrue(parameters.contains("host-password"));
assertTrue(parameters.contains("host-url"));
}
OnapCommandUtils.loadSchema(cmd, "onap-test-schema.yaml", true, false);
List<String> parameters = cmd.getParameters().stream().map(p -> p.getName()).collect(Collectors.toList());
- assertFalse(parameters.contains("onap-username"));
- assertFalse(parameters.contains("onap-password"));
+ assertFalse(parameters.contains("host-username"));
+ assertFalse(parameters.contains("host-password"));
assertTrue(parameters.contains("host-url"));
assertTrue(parameters.contains("debug"));
assertTrue(parameters.contains("long"));
Onap service: sample v1
Options:
-[-u | --onap-username] [-p | --onap-password] [-m | --host-url]
+[-u | --host-username] [-p | --host-password] [-m | --host-url]
[-h | --help] [-v | --version] [-d | --debug]
[-f | --format] [-s | --long] [-t | --no-title]
[-a | --no-auth] [-b | --bool] [-x | --secure]
[-l | --long-opt] [-r | --url] [-z | --env]
<positional-args>
where,
--u | --onap-username Onap user name. It is of type STRING. By
+-u | --host-username Onap user name. It is of type STRING. By
default, it is read from environment variable
- ONAP_USERNAME.
--p | --onap-password Onap user password. It is of type STRING. By
+ HOST_USERNAME.
+-p | --host-password Onap user password. It is of type STRING. By
default, it is read from environment variable
- ONAP_PASSWORD. Secured.
+ HOST_PASSWORD. Secured.
-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.
open_cli_schema_version: 1.0
default_parameters:
include:
- - onap-username
- - onap-password
+ - host-username
+ - host-password
- host-url
- no-auth
exclude:
open_cli_schema_version: 1.0
default_parameters:
include:
- - onap-username
- - onap-password
+ - host-username
+ - host-password
- no-auth
open_cli_schema_version: 1.0
default_parameters:
exclude:
- - onap-username
\ No newline at end of file
+ - host-username
\ No newline at end of file
auth: none
default_parameters:
include:
- - onap-username
\ No newline at end of file
+ - host-username
\ No newline at end of file
configure the following environment variables:
1. ONAP_MSB_URL - Onap Micro service bus(MSB) URL
-2. ONAP_USERNAME - Onap user name
-3. ONAP_PASSWORD - Onap user password
+2. HOST_USERNAME - Onap user name
+3. HOST_PASSWORD - Onap user password
To know the CLI version, type onap [-v|--version]
To know the CLI usage, type onap [-h|--help]
@Test
public void testHandleSampleCommandSet() throws OnapCommandException {
OnapCommandRegistrar.getRegistrar().addParamCache("sample:string-param", "paramValue");
- OnapCommandRegistrar.getRegistrar().addParamCache("onap-username", "paramValue");
- OnapCommandRegistrar.getRegistrar().addParamCache("onap-password", "paramValue");
+ OnapCommandRegistrar.getRegistrar().addParamCache("host-username", "paramValue");
+ OnapCommandRegistrar.getRegistrar().addParamCache("host-password", "paramValue");
OnapCommandRegistrar.getRegistrar().addParamCache("host-url", "paramValue");
this.handle(new String[] { "sample-test", "--string-param", "test"});
}
@Test
public void testpopulateParamsLong() throws OnapCommandException {
OnapCommandParameter param1 = new OnapCommandParameter();
- param1.setLongOption("onap-username");
- param1.setName("onap-username");
+ param1.setLongOption("host-username");
+ param1.setName("host-username");
param1.setParameterType(ParameterType.STRING);
OnapCommandParameter param2 = new OnapCommandParameter();
- param2.setLongOption("onap-password");
- param2.setName("onap-password");
+ param2.setLongOption("host-password");
+ param2.setName("host-password");
param2.setParameterType(ParameterType.STRING);
OnapCommandParameter param3 = new OnapCommandParameter();
param3.setLongOption("host-url");
paramslist.add(param4);
paramslist.add(param5);
- String[] args = new String[] { "sample-create", "--onap-username", "admin", "--onap-password", "123",
+ String[] args = new String[] { "sample-create", "--host-username", "admin", "--host-password", "123",
"--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("host-username", expectedList.get(2), param1.getValue());
+ Assert.assertEquals("host-password", expectedList.get(4), param2.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());
OnapCommandParameter param1 = new OnapCommandParameter();
param1.setShortOption("u");
- param1.setName("onap-username");
+ param1.setName("host-username");
param1.setParameterType(ParameterType.STRING);
OnapCommandParameter param2 = new OnapCommandParameter();
param2.setShortOption("p");
- param2.setName("onap-password");
+ param2.setName("host-password");
param2.setParameterType(ParameterType.STRING);
OnapCommandParameter param3 = new OnapCommandParameter();
param3.setShortOption("r");
samples:
sample1:
name: Checkin the Vendor Software Product
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
+ input: --host-username cs0008 --host-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
samples:
sample1:
name: Checkout the Vendor Software Product
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
+ input: --host-username cs0008 --host-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
samples:
sample1:
name: Create the Vendor Software Product
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://locahost:8080 --vsp-name demo-vsp2 --vsp-vendor-name 5aa8a88c --vsp-vendor-id DBB202617952486691C1E35C9 621CD4E --license-agreement-id E19DBDDB137B494385F9535325BFD585 --feature-group-id 94835F096DAF4ED78781A394A4F22AD1
+ input: --host-username cs0008 --host-password demo123456! --host-url http://locahost:8080 --vsp-name demo-vsp2 --vsp-vendor-name 5aa8a88c --vsp-vendor-id DBB202617952486691C1E35C9 621CD4E --license-agreement-id E19DBDDB137B494385F9535325BFD585 --feature-group-id 94835F096DAF4ED78781A394A4F22AD1
output: |
+----------+----------------------------------+
|property |value |
samples:
sample1:
name: List Vendor Software Products
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080
+ input: --host-username cs0008 --host-password demo123456! --host-url http://localhost:8080
output: |
+----------------------------------+------------+
|ID |name |
samples:
sample1:
name: Show the details of Vendor Software Products
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id 2DEB6CB4B082415BB7A697C9CD1273BA
+ input: --host-username cs0008 --host-password demo123456! --host-url http://localhost:8080 --vsp-id 2DEB6CB4B082415BB7A697C9CD1273BA
output: |
+----------+----------------------------------+--------------------------+
|name |ID |description |
samples:
sample1:
name: Submit the Vendor Software Product
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
+ input: --host-username cs0008 --host-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929
samples:
sample1:
name: upload the zip file to Vendor Software Product
- input: --onap-username cs0008 --onap-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip
+ input: --host-username cs0008 --host-password demo123456! --host-url http://localhost:8080 --vsp-id E563CB23A6BE49AF9A84CF579DAFB929 --vsp-file /home/user/vFW.zip
Code Review / cli.git / commitdiff