复制项目

tools/yamlfmt/main.go

@@ -0,0 +1,72 @@
+// Copyright © 2023 OpenIM. 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.
+
+// OPENIM plan on prow tools
+package main
+
+import (
+	"flag"
+	"fmt"
+	"io"
+	"os"
+
+	"gopkg.in/yaml.v3"
+)
+
+func main() {
+	// Prow OWNERs file defines the default indent as 2 spaces.
+	indent := flag.Int("indent", 2, "default indent")
+	flag.Parse()
+	for _, path := range flag.Args() {
+		sourceYaml, err := os.ReadFile(path)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: %v\n", path, err)
+			continue
+		}
+		rootNode, err := fetchYaml(sourceYaml)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: %v\n", path, err)
+			continue
+		}
+		writer, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o666)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: %v\n", path, err)
+			continue
+		}
+		err = streamYaml(writer, indent, rootNode)
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "%s: %v\n", path, err)
+			continue
+		}
+	}
+}
+
+func fetchYaml(sourceYaml []byte) (*yaml.Node, error) {
+	rootNode := yaml.Node{}
+	err := yaml.Unmarshal(sourceYaml, &rootNode)
+	if err != nil {
+		return nil, err
+	}
+	return &rootNode, nil
+}
+
+func streamYaml(writer io.Writer, indent *int, in *yaml.Node) error {
+	encoder := yaml.NewEncoder(writer)
+	encoder.SetIndent(*indent)
+	err := encoder.Encode(in)
+	if err != nil {
+		return err
+	}
+	return encoder.Close()
+}

tools/yamlfmt/main_test.go

@@ -0,0 +1,158 @@
+// Copyright © 2023 OpenIM. 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 main
+
+import (
+	"bufio"
+	"bytes"
+	"reflect"
+	"testing"
+
+	"github.com/likexian/gokit/assert"
+	"gopkg.in/yaml.v3"
+)
+
+func Test_main(t *testing.T) {
+	sourceYaml := ` # See the OWNERS docs at https://go.k8s.io/owners
+approvers:
+- dep-approvers
+- thockin         # Network
+- liggitt
+
+labels:
+- sig/architecture
+`
+
+	outputYaml := `# See the OWNERS docs at https://go.k8s.io/owners
+approvers:
+  - dep-approvers
+  - thockin # Network
+  - liggitt
+labels:
+  - sig/architecture
+`
+	node, _ := fetchYaml([]byte(sourceYaml))
+	var output bytes.Buffer
+	indent := 2
+	writer := bufio.NewWriter(&output)
+	_ = streamYaml(writer, &indent, node)
+	_ = writer.Flush()
+	assert.Equal(t, outputYaml, string(output.Bytes()), "yaml was not formatted correctly")
+}
+
+func Test_fetchYaml(t *testing.T) {
+	type args struct {
+		sourceYaml []byte
+	}
+	tests := []struct {
+		name    string
+		args    args
+		want    *yaml.Node
+		wantErr bool
+	}{
+		{
+			name: "Valid YAML",
+			args: args{sourceYaml: []byte("key: value")},
+			want: &yaml.Node{
+				Kind:  yaml.MappingNode,
+				Tag:   "!!map",
+				Value: "",
+				Content: []*yaml.Node{
+					{
+						Kind:  yaml.ScalarNode,
+						Tag:   "!!str",
+						Value: "key",
+					},
+					{
+						Kind:  yaml.ScalarNode,
+						Tag:   "!!str",
+						Value: "value",
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name:    "Invalid YAML",
+			args:    args{sourceYaml: []byte("key:")},
+			want:    nil,
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			got, err := fetchYaml(tt.args.sourceYaml)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("fetchYaml() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("fetchYaml() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}
+
+func Test_streamYaml(t *testing.T) {
+	type args struct {
+		indent *int
+		in     *yaml.Node
+	}
+	defaultIndent := 2
+	tests := []struct {
+		name       string
+		args       args
+		wantWriter string
+		wantErr    bool
+	}{
+		{
+			name: "Valid YAML node with default indent",
+			args: args{
+				indent: &defaultIndent,
+				in: &yaml.Node{
+					Kind:  yaml.MappingNode,
+					Tag:   "!!map",
+					Value: "",
+					Content: []*yaml.Node{
+						{
+							Kind:  yaml.ScalarNode,
+							Tag:   "!!str",
+							Value: "key",
+						},
+						{
+							Kind:  yaml.ScalarNode,
+							Tag:   "!!str",
+							Value: "value",
+						},
+					},
+				},
+			},
+			wantWriter: "key: value\n",
+			wantErr:    false,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			writer := &bytes.Buffer{}
+			if err := streamYaml(writer, tt.args.indent, tt.args.in); (err != nil) != tt.wantErr {
+				t.Errorf("streamYaml() error = %v, wantErr %v", err, tt.wantErr)
+				return
+			}
+			if gotWriter := writer.String(); gotWriter != tt.wantWriter {
+				t.Errorf("streamYaml() = %v, want %v", gotWriter, tt.wantWriter)
+			}
+		})
+	}
+}