README
¶
This repository contains a gRIBI client and in-memory server, written in Go, which serves as a reference implementation for the gRIBI protocol.
In addition, the fluent/ directory contains a human-readable API for use in
writing functional tests against a gRIBI server. This API is designed for use intest frameworks such as ONDATRA. The
fluent-style API is a test-only library.
Note: This is not an official Google product.
Contributing
We accept external pull requests to this repository, which are subject to the Google CLA. Please see the CONTRIBUTING document for additional details relating to contributions.
Licensing
This project is licensed under the Apache 2.0 license.
Trivia
The logo for this repository is a rib-eye steak, somewhat of an inside joke between the main collaborators on gRIBI, who cannot agree whether it is pronounced gee-rib-ee or gee-rib-eye.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package aft is a generated package which contains definitions of structs which represent a YANG schema.
|
Package aft is a generated package which contains definitions of structs which represent a YANG schema. |
|
Package afthelper provides helper functions for handling the OpenConfig AFT schema.
|
Package afthelper provides helper functions for handling the OpenConfig AFT schema. |
|
Package chk implements checks against the gRIBI client return values, it can be used to determine whether there are expected results within a specific set of return values.
|
Package chk implements checks against the gRIBI client return values, it can be used to determine whether there are expected results within a specific set of return values. |
|
Package client defines a gRIBI stub client implementation in Go.
|
Package client defines a gRIBI stub client implementation in Go. |
|
cmd
|
|
|
ccli
Package ccli is a compliance test package that can be run against a gRIBI server for compliance testing.
|
Package ccli is a compliance test package that can be run against a gRIBI server for compliance testing. |
|
stubrtr
Binary stubrtr is a basic gRIBI stub server.
|
Binary stubrtr is a basic gRIBI stub server. |
|
Package compliance encapsulates a set of compliance tests for gRIBI.
|
Package compliance encapsulates a set of compliance tests for gRIBI. |
|
package constants defines constants that are shared amongst multiple gRIBIgo packages.
|
package constants defines constants that are shared amongst multiple gRIBIgo packages. |
|
demo
|
|
|
ipv4
Package ipv4 is a very simple (test) demo package that shows an IPv4 entry being sent to the gRIBI server using the fluent API and client packages defined in this package.
|
Package ipv4 is a very simple (test) demo package that shows an IPv4 entry being sent to the gRIBI server using the fluent API and client packages defined in this package. |
|
Package fluent defines a fluent-style API for a gRIBI client that can be called from testing frameworks such as ONDATRA.
|
Package fluent defines a fluent-style API for a gRIBI client that can be called from testing frameworks such as ONDATRA. |
|
Package rib implements a basic RIB for a gRIBI server.
|
Package rib implements a basic RIB for a gRIBI server. |
|
reconciler
Package reconciler reconciles the contents of two gRIBI RIBs -- the intended RIB is assumed to contain the desired RIB entries, whereas the 'target' RIB is to be programmed.
|
Package reconciler reconciles the contents of two gRIBI RIBs -- the intended RIB is assumed to contain the desired RIB entries, whereas the 'target' RIB is to be programmed. |
|
Package server defines the basic elements of a gRIBI server that uses an in-memory data store for the AFT contents.
|
Package server defines the basic elements of a gRIBI server that uses an in-memory data store for the AFT contents. |
|
Package testcommon implements common helpers that can be used throughout the gRIBIgo package.
|
Package testcommon implements common helpers that can be used throughout the gRIBIgo package. |