9810dcd4b9
* Update bpdocs to filter nested properties by tag Prior to this change nested properties tagged with `blueprint:"mutated"` are erroneously included in documentation, this corrects that behavior and adds testing to verify. Tested: go test bpdocs tests Change-Id: I822c9a98276634d2f584d8709e83003824cdffd5
63 lines
1.8 KiB
Go
63 lines
1.8 KiB
Go
// Copyright 2019 Google Inc. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package bpdoc
|
|
|
|
import (
|
|
"reflect"
|
|
"testing"
|
|
)
|
|
|
|
func TestExcludeByTag(t *testing.T) {
|
|
r := NewReader(pkgFiles)
|
|
ps, err := r.PropertyStruct(pkgPath, "tagTestProps", reflect.ValueOf(tagTestProps{}))
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
ps.ExcludeByTag("tag1", "a")
|
|
|
|
expected := []string{"c", "d", "g"}
|
|
actual := actualProperties(t, ps.Properties)
|
|
if !reflect.DeepEqual(expected, actual) {
|
|
t.Errorf("unexpected ExcludeByTag result, expected: %q, actual: %q", expected, actual)
|
|
}
|
|
}
|
|
|
|
func TestIncludeByTag(t *testing.T) {
|
|
r := NewReader(pkgFiles)
|
|
ps, err := r.PropertyStruct(pkgPath, "tagTestProps", reflect.ValueOf(tagTestProps{A: "B"}))
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
ps.IncludeByTag("tag1", "c")
|
|
|
|
expected := []string{"b", "c", "d", "f", "g"}
|
|
actual := actualProperties(t, ps.Properties)
|
|
if !reflect.DeepEqual(expected, actual) {
|
|
t.Errorf("unexpected IncludeByTag result, expected: %q, actual: %q", expected, actual)
|
|
}
|
|
}
|
|
|
|
func actualProperties(t *testing.T, props []Property) []string {
|
|
t.Helper()
|
|
|
|
actual := []string{}
|
|
for _, p := range props {
|
|
actual = append(actual, p.Name)
|
|
actual = append(actual, actualProperties(t, p.Properties)...)
|
|
}
|
|
return actual
|
|
}
|