64 lines
1.7 KiB
Go
64 lines
1.7 KiB
Go
/*
|
|
Copyright 2022 The Karmada Authors.
|
|
|
|
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 main
|
|
|
|
import "testing"
|
|
|
|
func TestCleanupForInclude(t *testing.T) {
|
|
var tests = []struct {
|
|
name string
|
|
markdown, expectedMarkdown string
|
|
}{
|
|
{
|
|
name: "add the title and auto-generated tag",
|
|
markdown: "line 1\n" +
|
|
"line 2\n" +
|
|
"line 3\n",
|
|
expectedMarkdown: "---\n" +
|
|
"title: line 1\n" +
|
|
"---\n" +
|
|
"line 2\n" +
|
|
"line 3\n" +
|
|
"###### Auto generated by [spf13/cobra script in Karmada](https://github.com/karmada-io/karmada/tree/master/hack/tools/gencomponentdocs)",
|
|
},
|
|
{
|
|
name: "remove see also",
|
|
markdown: "line 1\n" +
|
|
"line 2\n" +
|
|
"line 3\n" +
|
|
"### SEE ALSO\n" +
|
|
"line 3",
|
|
expectedMarkdown: "---\n" +
|
|
"title: line 1\n" +
|
|
"---\n" +
|
|
"line 2\n" +
|
|
"line 3\n" +
|
|
"###### Auto generated by [spf13/cobra script in Karmada](https://github.com/karmada-io/karmada/tree/master/hack/tools/gencomponentdocs)",
|
|
},
|
|
}
|
|
for _, rt := range tests {
|
|
actual := cleanupForInclude(rt.markdown)
|
|
if actual != rt.expectedMarkdown {
|
|
t.Errorf(
|
|
"failed cleanupForInclude:\n\texpected: %s\n\t actual: %s",
|
|
rt.expectedMarkdown,
|
|
actual,
|
|
)
|
|
}
|
|
}
|
|
}
|