cli-const unit test cases added
[cli.git] / docs / trouble_shooting_guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright © Intel Corporation 2019
4
5 .. _cli_trouble_shooting_guide:
6
7 CLI Trouble Shooting Guide
8 ==========================
9
10 This part provides the trouble shooting guide for ONAP CLI. It aims to provide guidance on the known issues you may encounter.
11
12 Details
13 --------
14 1. IllegalArgumentException
15
16    * Problem: Get an IllegalArgumentException after executing the command.
17    * Cause: The input inside the command contains a special character(e.g. '!', '$','\\') and the console mandates to escape this kind of chars
18    * Sample Exception:
19      ::
20
21         oclip:open-cli>policy-type-list-all -m http://10.12.7.6:30240 -u "healthcheck" -p "zb!XztG34"
22              Exception in thread "main" java.lang.IllegalArgumentException: !XztG34": event not found
23               at jline.console.ConsoleReader.expandEvents(ConsoleReader.java:507)
24               at jline.console.ConsoleReader.finishBuffer(ConsoleReader.java:379)
25               at jline.console.ConsoleReader.readLine(ConsoleReader.java:1327)
26               at jline.console.ConsoleReader.readLine(ConsoleReader.java:1117)
27               at jline.console.ConsoleReader.readLine(ConsoleReader.java:1105)
28               at org.onap.cli.main.OnapCli.handleInteractive(OnapCli.java:369)
29               at org.onap.cli.main.OnapCli.handle(OnapCli.java:645)
30               at org.onap.cli.main.OnapCli.main(OnapCli.java:751)
31
32    * Solution: User need to escape the special character while giving input(e.g. using single/double quote or backslash)
33