Parser and .NET type generator for YANG model.
Currently, the dev environment is VS 2017 Preview, which means that we require F# compiler version 10.1.1. Eventually, we will support the production tools (VS 2017 and F# compiler); hopefully, when we reach that point the output binaries should also be of use with the tool-chain shipped with VS 2015. However, we do not plan to test and support versions 13.x and earlier of Visual Studio.
First, run .\init.ps1 from PowerShell. This will download paket and setup a few other
things. It will also load the YangDevHelper PowerShell module that provides some commands
that are useful during development. It is advised (although not required) to initialize
your working (Power)shell with this script.
Running the .\build.bat should compile the main project and run the unit tests.
The output is placed in the .\build directory.
This uses the FAKE build system (which is based on F#).
Alternatively, (if you initialize with the init.ps1 script) you can also use
the commands build and qb for the full build, or a quick build (only the main project)
respectively.
To run the unit tests, use .\build.bat Test.
To get some statistics on the code coverage of the unit tests use the Show-YangCodeCoverage
command (this is part of YangDevHelper). To see a list of the active to-do items
use the command Get-YangWorkItems.
You can also open the Visual Studio solution file in .\src\YANG\Yang.sln. However, before doing
so do restore the dependencies if necessary. We use the paket system for package management.
So, you will need to do:
.paket\paket.exe restoreModeling of YANG is complete at the statement level. We need to finish other constructs, such as conditionals, etc. Overall, most of the YANG language is already modelled accurately. There is also some basic support for processing statements, which will be enriched with time.
The very basic parser that parses YANG models without interpreting them, can correctly
parse an extensive set of models (over 12K files), which exist in the Models-External
directory. We have identified a few problems, but these are due to incorrect YANG models,
and there are fixes for them. We may need to consider creating a robust extension that
pre-processes YANG models and corrects a few of the common errors.
The proper parser parses Juniper configuration models (version 16.x), excluding the constructs that are not currently captured by the model (see above).
For the model processing pipeline, there are some tools in various levels of maturity. There is support for discovering type and group definitions and use; this tool will need to be extended to also discover prefixes, and to also deal with sub-modules. There is some preliminary work on a tool that will simplify XML parsing for the purpose of mapping data to objects.
The C# source code generator is in early phases. Currently, the goal is to specify what we want to achieve which is both end-user friendly, but also easy to generate automatically. The Type Provider is in an earlier stage at the moment.
This repository contains the following directories (in addition to src which contains the source code):
-
Models-External: Contains repos to sources of YANG models. These are not linked as submodules, since some of them are quite big, and they are not always needed for development. To retrieve them run theDownload.ps1PowerShell script from that directory. -
Documents: Contains various resources and notes related to the project. -
Documents\References: Contains useful reference material (e.g. specs). -
Reports: Automatically generated reports of unit tests and test coverage are placed in this directory.
The build output is written in:
-
build: final binaries (release builds by default) -
test: binaries for testing (debug build)
The rest of the directories are:
-
node_modules: Use bynode.jsto put some structure on thegit commitmessages. -
packages: Used bypaketand contains external packages used for development. -
paket-files: Also used bypaketand contains external source code.
The main file that contains our model of the YANG language is
src\YANG\Model\Statements.fs.
For the YANG parser the gist of the implementation is in:
-
src\YANG\Parser\Statements.fs, and -
src\YANG\Parser\BodyStatements.fs
See the LICENSE file. We are using the A
55FA
pache License.
Let us know, if you have other specific needs.