Add skip_deprecated and skip_obsolete flags to ygot (#1037)

* Add SkipDeprecated and SkipObsolete flags to ygot/ygen

* Extend to individual deprecated/obsolete leaf fields within containers

* Add helper functions isDeprecated(yang.Node) and isObsolete(yang.Node)

Author: nleiva

generator/generator.go

@@ -80,6 +80,8 @@ var (
 	enumOrgPrefixesToTrim                []string
 	ignoreUnsupportedStatements          = flag.Bool("ignore_unsupported", false, "If set to true, unsupported YANG statements are ignored.")
 	ignoreDeviateNotsupported            = flag.Bool("ignore_deviate_notsupported", false, "If set to true, 'deviate not-supported' YANG statements are ignored, thus target nodes are retained in the generated code.")
+	skipDeprecated                       = flag.Bool("skip_deprecated", false, "If set to true, YANG fields with status 'deprecated' are excluded from the generated code.")
+	skipObsolete                         = flag.Bool("skip_obsolete", false, "If set to true, YANG fields with status 'obsolete' are excluded from the generated code.")
 
 	// Flags used for GoStruct generation only.
 	generateFakeRoot        = flag.Bool("generate_fakeroot", false, "If set to true, a fake element at the root of the data tree is generated. By default the fake root entity is named Device, its name can be controlled with the fakeroot_name flag.")
@@ -351,6 +353,8 @@ func main() {
 					EnumOrgPrefixesToTrim:                enumOrgPrefixesToTrim,
 					UseDefiningModuleForTypedefEnumNames: *useDefiningModuleForTypedefEnumNames,
 					EnumerationsUseUnderscores:           true,
+					SkipDeprecated:                       *skipDeprecated,
+					SkipObsolete:                         *skipObsolete,
 				},
 			},
 			gogen.GoOpts{

ygen/codegen.go

@@ -36,6 +36,48 @@ import (
 	gpb "github.com/openconfig/gnmi/proto/gnmi"
 )
 
+// isDeprecated checks if a YANG node has status "deprecated".
+func isDeprecated(node yang.Node) bool {
+	if node == nil {
+		return false
+	}
+	var status *yang.Value
+	switch n := node.(type) {
+	case *yang.Container:
+		status = n.Status
+	case *yang.Leaf:
+		status = n.Status
+	case *yang.LeafList:
+		status = n.Status
+	case *yang.List:
+		status = n.Status
+	case *yang.Typedef:
+		status = n.Status
+	}
+	return status != nil && status.Name == "deprecated"
+}
+
+// isObsolete checks if a YANG node has status "obsolete".
+func isObsolete(node yang.Node) bool {
+	if node == nil {
+		return false
+	}
+	var status *yang.Value
+	switch n := node.(type) {
+	case *yang.Container:
+		status = n.Status
+	case *yang.Leaf:
+		status = n.Status
+	case *yang.LeafList:
+		status = n.Status
+	case *yang.List:
+		status = n.Status
+	case *yang.Typedef:
+		status = n.Status
+	}
+	return status != nil && status.Name == "obsolete"
+}
+
 // ParseOpts contains parsing configuration for a given schema.
 type ParseOpts struct {
 	// IgnoreUnsupportedStatements ignores unsupported YANG statements when
@@ -112,6 +154,12 @@ type TransformationOpts struct {
 	// EnumerationsUseUnderscores specifies whether enumeration names
 	// should use underscores between path segments.
 	EnumerationsUseUnderscores bool
+	// SkipDeprecated specifies whether YANG fields with status "deprecated"
+	// should be excluded from the generated code output.
+	SkipDeprecated bool
+	// SkipObsolete specifies whether YANG fields with status "obsolete"
+	// should be excluded from the generated code output.
+	SkipObsolete bool
 }
 
 // yangEnum represents an enumerated type in YANG that is to be output in the
@@ -236,7 +284,7 @@ func mappedDefinitions(yangFiles, includePaths []string, opts IROptions) (*mappe
 		// Need to transform the AST based on compression behaviour.
 		genutil.TransformEntry(module, opts.TransformationOptions.CompressBehaviour)
 
-		errs = append(errs, findMappableEntities(module, dirs, enums, opts.ParseOptions.ExcludeModules, opts.TransformationOptions.CompressBehaviour.CompressEnabled(), opts.ParseOptions.IgnoreUnsupportedStatements, modules)...)
+		errs = append(errs, findMappableEntities(module, dirs, enums, opts.ParseOptions.ExcludeModules, opts.TransformationOptions.CompressBehaviour.CompressEnabled(), opts.ParseOptions.IgnoreUnsupportedStatements, modules, opts.TransformationOptions)...)
 		if module == nil {
 			errs = append(errs, errors.New("found a nil module in the returned module set"))
 			continue
@@ -301,7 +349,7 @@ func mappedDefinitions(yangFiles, includePaths []string, opts IROptions) (*mappe
 // mapped with path compression enabled. The set of modules that the current code generation
 // is processing is specified by the modules slice. This function returns slice of errors
 // encountered during processing.
-func findMappableEntities(e *yang.Entry, dirs map[string]*yang.Entry, enums map[string]*yang.Entry, excludeModules []string, compressPaths, ignoreUnsupportedStatements bool, modules []*yang.Entry) util.Errors {
+func findMappableEntities(e *yang.Entry, dirs map[string]*yang.Entry, enums map[string]*yang.Entry, excludeModules []string, compressPaths, ignoreUnsupportedStatements bool, modules []*yang.Entry, transformOpts TransformationOpts) util.Errors {
 	// Skip entities who are defined within a module that we have been instructed
 	// not to generate code for.
 	for _, s := range excludeModules {
@@ -314,6 +362,16 @@ func findMappableEntities(e *yang.Entry, dirs map[string]*yang.Entry, enums map[
 
 	var errs util.Errors
 	for _, ch := range util.Children(e) {
+		// Skip children with deprecated status if SkipDeprecated is enabled
+		if transformOpts.SkipDeprecated && isDeprecated(ch.Node) {
+			continue // skip this entity
+		}
+
+		// Skip children with obsolete status if SkipObsolete is enabled
+		if transformOpts.SkipObsolete && isObsolete(ch.Node) {
+			continue // skip this entity
+		}
+
 		switch {
 		case ch.IsLeaf(), ch.IsLeafList():
 			// Leaves are not mapped as directories so do not map them unless we find
@@ -326,12 +384,12 @@ func findMappableEntities(e *yang.Entry, dirs map[string]*yang.Entry, enums map[
 			// If this is a config or state container and we are compressing paths
 			// then we do not want to map this container - but we do want to map its
 			// children.
-			errs = util.AppendErrs(errs, findMappableEntities(ch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules))
+			errs = util.AppendErrs(errs, findMappableEntities(ch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules, transformOpts))
 		case util.HasOnlyChild(ch) && util.Children(ch)[0].IsList() && compressPaths:
 			// This is a surrounding container for a list, and we are compressing
 			// paths, so we don't want to map it but again we do want to map its
 			// children.
-			errs = util.AppendErrs(errs, findMappableEntities(ch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules))
+			errs = util.AppendErrs(errs, findMappableEntities(ch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules, transformOpts))
 		case util.IsChoiceOrCase(ch):
 			// Don't map for a choice or case node itself, and rather skip over it.
 			// However, we must walk each branch to find the first container that
@@ -351,12 +409,12 @@ func findMappableEntities(e *yang.Entry, dirs map[string]*yang.Entry, enums map[
 				if gch.IsContainer() || gch.IsList() {
 					dirs[fmt.Sprintf("%s/%s", ch.Parent.Path(), gch.Name)] = gch
 				}
-				errs = util.AppendErrs(errs, findMappableEntities(gch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules))
+				errs = util.AppendErrs(errs, findMappableEntities(gch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules, transformOpts))
 			}
 		case ch.IsContainer(), ch.IsList():
 			dirs[ch.Path()] = ch
 			// Recurse down the tree.
-			errs = util.AppendErrs(errs, findMappableEntities(ch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules))
+			errs = util.AppendErrs(errs, findMappableEntities(ch, dirs, enums, excludeModules, compressPaths, ignoreUnsupportedStatements, modules, transformOpts))
 		case ch.Kind == yang.AnyDataEntry:
 			continue
 		default:

ygen/codegen_test.go

@@ -27,11 +27,12 @@ import (
 // into Go code from a YANG schema.
 func TestFindMappableEntities(t *testing.T) {
 	tests := []struct {
-		name                          string        // name is an identifier for the test.
-		in                            *yang.Entry   // in is the yang.Entry corresponding to the YANG root element.
-		inSkipModules                 []string      // inSkipModules is a slice of strings indicating modules to be skipped.
-		inModules                     []*yang.Entry // inModules is the set of modules that the code generation is for.
-		inIgnoreUnsupportedStatements bool          // inIgnoreUnsupportedStatements determines whether unsupported statements should error out.
+		name                          string             // name is an identifier for the test.
+		in                            *yang.Entry        // in is the yang.Entry corresponding to the YANG root element.
+		inSkipModules                 []string           // inSkipModules is a slice of strings indicating modules to be skipped.
+		inModules                     []*yang.Entry      // inModules is the set of modules that the code generation is for.
+		inIgnoreUnsupportedStatements bool               // inIgnoreUnsupportedStatements determines whether unsupported statements should error out.
+		transformOpts                 TransformationOpts // transformOpts contains transformation options like SkipDeprecated/SkipObsolete
 		// wantCompressed is a map keyed by the string "structs" or "enums" which contains a slice
 		// of the YANG identifiers for the corresponding mappable entities that should be
 		// found. wantCompressed is the set that are expected when compression is enabled.
@@ -395,6 +396,106 @@ func TestFindMappableEntities(t *testing.T) {
 		wantUncompressed: map[string][]string{
 			"structs": {"container"},
 			"enums":   {"choice-case-container-leaf", "choice-case2-leaf", "direct"}},
+	}, {
+		name: "no-filtering",
+		in: &yang.Entry{
+			Name: "module",
+			Kind: yang.DirectoryEntry,
+			Dir: map[string]*yang.Entry{
+				"deprecated-container": {
+					Name:   "deprecated-container",
+					Kind:   yang.DirectoryEntry,
+					Parent: &yang.Entry{Name: "module"},
+					Node: &yang.Container{
+						Status: &yang.Value{Name: "deprecated"},
+					},
+				},
+			},
+		},
+		transformOpts: TransformationOpts{},
+		wantCompressed: map[string][]string{
+			"structs": {"deprecated-container"},
+			"enums":   {},
+		},
+		wantUncompressed: map[string][]string{
+			"structs": {"deprecated-container"},
+			"enums":   {},
+		},
+	}, {
+		name: "skip-deprecated",
+		in: &yang.Entry{
+			Name: "module",
+			Kind: yang.DirectoryEntry,
+			Dir: map[string]*yang.Entry{
+				"deprecated-container": {
+					Name:   "deprecated-container",
+					Kind:   yang.DirectoryEntry,
+					Parent: &yang.Entry{Name: "module"},
+					Node: &yang.Container{
+						Status: &yang.Value{Name: "deprecated"},
+					},
+				},
+			},
+		},
+		transformOpts: TransformationOpts{SkipDeprecated: true},
+		wantCompressed: map[string][]string{
+			"structs": {},
+			"enums":   {},
+		},
+		wantUncompressed: map[string][]string{
+			"structs": {},
+			"enums":   {},
+		},
+	}, {
+		name: "skip-obsolete-with-deprecated",
+		in: &yang.Entry{
+			Name: "module",
+			Kind: yang.DirectoryEntry,
+			Dir: map[string]*yang.Entry{
+				"deprecated-container": {
+					Name:   "deprecated-container",
+					Kind:   yang.DirectoryEntry,
+					Parent: &yang.Entry{Name: "module"},
+					Node: &yang.Container{
+						Status: &yang.Value{Name: "deprecated"},
+					},
+				},
+			},
+		},
+		transformOpts: TransformationOpts{SkipObsolete: true},
+		wantCompressed: map[string][]string{
+			"structs": {"deprecated-container"},
+			"enums":   {},
+		},
+		wantUncompressed: map[string][]string{
+			"structs": {"deprecated-container"},
+			"enums":   {},
+		},
+	}, {
+		name: "skip-obsolete-actual",
+		in: &yang.Entry{
+			Name: "module",
+			Kind: yang.DirectoryEntry,
+			Dir: map[string]*yang.Entry{
+				"obsolete-container": {
+					Name:   "obsolete-container",
+					Kind:   yang.DirectoryEntry,
+					Parent: &yang.Entry{Name: "module"},
+					Node: &yang.Container{
+						Status: &yang.Value{Name: "obsolete"},
+					},
+				},
+			},
+		},
+		transformOpts: TransformationOpts{SkipObsolete: true},
+		wantCompressed: map[string][]string{
+			"structs": {},
+			"enums":   {},
+		},
+		wantUncompressed: map[string][]string{
+			"structs": {},
+			"enums":   {},
+		},
 	}}
 
 	for _, tt := range tests {
@@ -407,7 +508,7 @@ func TestFindMappableEntities(t *testing.T) {
 			structs := make(map[string]*yang.Entry)
 			enums := make(map[string]*yang.Entry)
 
-			errs := findMappableEntities(tt.in, structs, enums, tt.inSkipModules, compress, tt.inIgnoreUnsupportedStatements, tt.inModules)
+			errs := findMappableEntities(tt.in, structs, enums, tt.inSkipModules, compress, tt.inIgnoreUnsupportedStatements, tt.inModules, tt.transformOpts)
 
 			var err error
 			switch {

ygen/directory.go

@@ -221,6 +221,17 @@ func getOrderedDirDetails(langMapper LangMapper, directory map[string]*Directory
 		pd.Fields = make(map[string]*NodeDetails, len(dir.Fields))
 		for _, fn := range GetOrderedFieldNames(dir) {
 			field := dir.Fields[fn]
+
+			// Skip fields with deprecated status if SkipDeprecated is enabled
+			if opts.TransformationOptions.SkipDeprecated && isDeprecated(field.Node) {
+				continue // skip this field
+			}
+
+			// Skip fields with obsolete status if SkipObsolete is enabled
+			if opts.TransformationOptions.SkipObsolete && isObsolete(field.Node) {
+				continue // skip this field
+			}
+
 			shadowField, hasShadowField := dir.ShadowedFields[fn]
 
 			mp, mm, err := findMapPaths(dir, fn, opts.TransformationOptions.CompressBehaviour.CompressEnabled(), false, opts.AbsoluteMapPaths)