github.com/googleapis/api-linter@v1.65.2/rules/aip0192/no_markdown_tables_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  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestNoMarkdownTables(t *testing.T) {
    24  	problem := testutils.Problems{{Message: "Markdown tables"}}
    25  	for _, test := range []struct {
    26  		name     string
    27  		Comment  string
    28  		problems testutils.Problems
    29  	}{
    30  		{"Valid", "foo bar baz", nil},
    31  		{"ValidMidline", "foo - bar", nil},
    32  		{"ValidPipe", "foo | bar", nil},
    33  		{"WeirdButLegal", "|-|-|", nil},
    34  		{"TableSeparator", "--- | ---", problem},
    35  		{"BoundedTableSeparator", "| --- | --- |", problem},
    36  		{"MoreColumnTable", "--- | --- | --- | --- | ---", problem},
    37  		{"BiggerColumnTable", "------------ | -----", problem},
    38  	} {
    39  		t.Run(test.name, func(t *testing.T) {
    40  			f := testutils.ParseProto3Tmpl(t, `
    41  			  // {{.Comment}}
    42  			  message Foo {}
    43  			`, test)
    44  			m := f.GetMessageTypes()[0]
    45  			if diff := test.problems.SetDescriptor(m).Diff(noMarkdownTables.Lint(f)); diff != "" {
    46  				t.Errorf(diff)
    47  			}
    48  		})
    49  	}
    50  }