github.com/googleapis/api-linter@v1.65.2/rules/aip0192/no_markdown_headings_test.go (about)

     1  // Copyright 2021 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0192
    16  
    17  import (
    18  	"strings"
    19  	"testing"
    20  
    21  	"github.com/googleapis/api-linter/rules/internal/testutils"
    22  )
    23  
    24  func TestNoMarkdownHeadings(t *testing.T) {
    25  	problem := testutils.Problems{{Message: "Markdown headings"}}
    26  	for _, test := range []struct {
    27  		name     string
    28  		comment  string
    29  		problems testutils.Problems
    30  	}{
    31  		{"Valid", "foo bar baz", nil},
    32  		{"ValidMidline", "foo bar # baz", nil},
    33  		{"H1", "# foo bar baz", problem},
    34  		{"H2", "## foo bar baz", problem},
    35  		{"H3", "### foo bar baz", problem},
    36  		{"H4", "#### foo bar baz", problem},
    37  		{"InvalidThirdLine", "foo bar baz\n\n# spam eggs", problem},
    38  	} {
    39  		t.Run(test.name, func(t *testing.T) {
    40  			cmt := "// " + strings.ReplaceAll(test.comment, "\n", "\n// ")
    41  			f := testutils.ParseProto3Tmpl(t, `
    42  			  {{.Comment}}
    43  			  message Foo {}
    44  			`, struct{ Comment string }{cmt})
    45  			m := f.GetMessageTypes()[0]
    46  			if diff := test.problems.SetDescriptor(m).Diff(noMarkdownHeadings.Lint(f)); diff != "" {
    47  				t.Errorf(diff)
    48  			}
    49  		})
    50  	}
    51  }