Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pantheontech/lighty-yang-validator
https://github.com/pantheontech/lighty-yang-validator
Last synced: 27 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pantheontech/lighty-yang-validator
- Owner: PANTHEONtech
- License: epl-1.0
- Created: 2021-01-25T13:26:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T12:45:01.000Z (about 1 month ago)
- Last Synced: 2024-11-15T13:38:30.858Z (about 1 month ago)
- Language: Java
- Size: 1010 KB
- Stars: 3
- Watchers: 4
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :cloud_with_lightning: lighty YANG Validator 22
This tool validates YANG modules using the YANG-Tools parser. If there are any problems parsing the module, it will show the stacktrace with the problem, linking to the corresponding module.
> This makes lighty YANG Validator **a must-have tool, when using [OpenDaylight](https://github.com/opendaylight) or [lighty.io](https://github.com/PANTHEONtech/lighty).**
[YANG Tools](https://github.com/opendaylight/yangtools) help parse YANG modules, represent the YANG model in Java and serialize / deserialize YANG model data. However, custom YANG module can contain improper data, which would result in an application failure. To avoid these situations, [PANTHEON.tech](https://pantheon.tech) engineers created the lighty YANG Validator.
## Compile, Build & Generate Distribution
Go to the root directory `/lighty-yang-validator/` and use the command:
```
mvn clean install
```
The distribution will be stored in the **"target"** directory, as a file called *lighty-yang-validator-22.0.0-SNAPSHOT-bin.zip*
## Run from Distribution
1. Unzip the distribution:
```
unzip lighty-yang-validator-22.0.0-SNAPSHOT-bin.zip
```
2. Enter the directory, to which the distribution was extracted to.
3. Run the script with the command:
```
./lyv \
```
To parse the module, we need to:
- [x] have all the imported and included modules of a testing module on the same path
- [x] or we need to add a `-p` or `--path` option (with a path or column separated paths to the modules that are needed)
Use `-r` or `--recursive` option to search for the files recursively, within the file structure.
## Options
* **Logs**: Use the `-o` or `--output` option, to specify the path for the output file directory for logs.
* **Parse All**: Use the `-a` or `--parse-all` option to parse all files within given directory. This option can be used with the `-p` option.
* **Search**: Use `-p` or `--path` option, to specify path as a colon (:) separated list of directories, to search for YANG modules.
* **Recursive Search**: Use `-r` or `--recursive` option, to specify recursive search of directories specified by `-p` or `--path` option.
* **Search by Module Name**: Use `-m` or `--module-name` option, to search for file by module name instead of specifying the whole path.
* **Prune and Search**: Use `-e` or `--features` option, to prune the data model by removing all nodes that are defined with a *if-feature*.
* **Print Help Message**: Use `-h` or `--help` option, to print help message and exit.
* **Specify Output Format**: Use **-f, --format** option to specify output format. Supported formats:
* tree
* depend
* yang
* json-tree
* jstree
* name-revision
* analyze
* **Simplify YANG**: Use `-s` or `--simplify` option, to to simplify the YANG file. The YANG file will be simplified,
based on the nodes used in the XML file. Use with `-o` to specify output directory where will be simplified yang generated.
In this case out.log file will contain only error message if some error will be present. Without specified output directory
will be result printed to *stdout*.
## Formats
* tree: tree is printed in following format *\--\ \\ \ *
\ is either:
+ for current
x for deprecated
o for obsolete
\ is either:
rw for configuration data
ro for non-configuration data, output parameters to rpcs
and actions, and notification parameters
-w for input parameters to rpcs and actions
-x for rpcs and actions
-n for notifications
\ is the name of the node:
() means that the node is a choice node
:() means that the node is a case node
\ is either:
? for an optional leaf, choice
* for a leaf-list or list
[] for a list's keys
\ is the name of the type for leafs and leaf-lists.
If the type is a leafref, the type is printed as "-> TARGET",
whereTARGET is the leafref path, with prefixes removed if possible.
\ is the list of features this node depends on, printed
within curly brackets and a question mark "{...}?"
* **name-revision**: name-revision is printed as the following format:
```
\@\
```
* **depend**: list of all the modules that the validated module depends on
* **json-tree**: generates a json tree with all the node information
* **jstree**: generates a html with java script with a yang tree
* **yang**: generates a yang file (used with simplify will print
the simplified yang file)
* **analyze**: the analyze function counts the occurrence of each keyword in a model
*note: analyze format does not work with --parse-all option*
## Examples
* Validate: To **validate the module only**:
```
./lyv \
```
* **Validate w/ Dependencies**: To validate a module, which has **dependencies on a different path recursively**:
```
./lyv -r -p \
\
```
* **Format YANG Tree**: To create a **formatted YANG tree**:
```
/lyv -f tree \
```
* **YANG jstree**: To create **formatted YANG jstree**:
```
./lyv -f jstree \
```
* **Simplify YANG**: To simplify and print the YANG file, **based on XML**:
```
./lyv -o \ -s
\ -p \ -f yang
```
* **Analyze module**: To counts the occurrence of each keyword in a model:
```
./lyv \ -f analyze
```
# References
The lighty YANG Validator release corresponds with the latest release of [lighty.io](https://github.com/PANTHEONtech/lighty). Learn more [about lighty.io here](https://lighty.io).
Inspiration from this tool comes from the [pyang YANG Validator](https://github.com/mbj4668/pyang).