integration_test.go

// Copyright 2019 Istio 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 (
	"bytes"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
	"testing"
)

const goldenDir = "testdata/golden/"

func TestOpenAPIGeneration(t *testing.T) {
	testcases := []struct {
		name       string
		id         string
		perPackage bool
		genOpts    string
		inputFiles map[string][]string
		protocArgs []string
		wantFiles  []string
	}{
		{
			name:       "Per Package Generation",
			id:         "test1",
			perPackage: true,
			genOpts:    "",
			inputFiles: map[string][]string{
				"testpkg":  {"./testdata/testpkg/test1.proto", "./testdata/testpkg/test2.proto", "./testdata/testpkg/test6.proto"},
				"testpkg2": {"./testdata/testpkg2/test3.proto"},
			},
			wantFiles: []string{"testpkg.json", "testpkg2.json"},
		},
		{
			name:       "Single File Generation",
			id:         "test2",
			perPackage: false,
			genOpts:    "single_file=true",
			inputFiles: map[string][]string{
				"testpkg":  {"./testdata/testpkg/test1.proto", "./testdata/testpkg/test2.proto", "./testdata/testpkg/test6.proto"},
				"testpkg2": {"./testdata/testpkg2/test3.proto"},
			},
			wantFiles: []string{"openapiv3.json"},
		},
		{
			name:       "Use $ref in the output",
			id:         "test3",
			perPackage: false,
			genOpts:    "single_file=true,use_ref=true",
			inputFiles: map[string][]string{
				"testpkg":  {"./testdata/testpkg/test1.proto", "./testdata/testpkg/test2.proto", "./testdata/testpkg/test6.proto"},
				"testpkg2": {"./testdata/testpkg2/test3.proto"},
			},
			wantFiles: []string{"testRef/openapiv3.json"},
		},
		{
			name:       "Use yaml, proto_oneof, int_native, validation rules, and multiline_description",
			id:         "test4",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true",
			inputFiles: map[string][]string{
				"testpkg":  {"./testdata/testpkg/test1.proto", "./testdata/testpkg/test2.proto", "./testdata/testpkg/test6.proto"},
				"testpkg2": {"./testdata/testpkg2/test3.proto"},
			},
			wantFiles: []string{"test4/openapiv3.yaml"},
		},
		{
			name:       "Test validation rules",
			id:         "test5",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true",
			inputFiles: map[string][]string{
				"test5": {"./testdata/test5/rules.proto"},
			},
			wantFiles: []string{"test5/openapiv3.yaml"},
		},
		{
			name:       "Test kubebuilder markers",
			id:         "test6",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true",
			inputFiles: map[string][]string{
				"test6": {"./testdata/test6/markers.proto"},
			},
			wantFiles: []string{"test6/openapiv3.yaml"},
		},
		{
			name:       "Test disable_kube_markers option",
			id:         "test7",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true,disable_kube_markers=true",
			inputFiles: map[string][]string{
				"test7": {"./testdata/test7/markers.proto"},
			},
			wantFiles: []string{"test7/openapiv3.yaml"},
		},
		{
			name:       "Test no markers are ignored when ignored_kube_markers is zero length",
			id:         "test8",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true,disable_kube_markers=false,ignored_kube_marker_substrings=",
			inputFiles: map[string][]string{
				"test8": {"./testdata/test8/markers.proto"},
			},
			wantFiles: []string{"test8/openapiv3.yaml"},
		},
		{
			name:       "Test ignored_kube_markers option ignores a single marker",
			id:         "test9",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true,disable_kube_markers=false,ignored_kube_marker_substrings=Required",
			inputFiles: map[string][]string{
				"test9": {"./testdata/test9/markers.proto"},
			},
			wantFiles: []string{"test9/openapiv3.yaml"},
		},
		{
			name:       "Test ignored_kube_markers option ignores multiple markers",
			id:         "test10",
			perPackage: false,
			genOpts:    "yaml=true,single_file=true,proto_oneof=true,int_native=true,multiline_description=true,disable_kube_markers=false,ignored_kube_marker_substrings=Required+example",
			inputFiles: map[string][]string{
				"test10": {"./testdata/test10/markers.proto"},
			},
			wantFiles: []string{"test10/openapiv3.yaml"},
		},
	}

	for _, tc := range testcases {
		t.Run(tc.name, func(t *testing.T) {
			if len(tc.inputFiles) == 0 {
				t.Fatalf("inputFiles must be set for test case %s", tc.name)
			}

			tempDir, err := os.MkdirTemp("", "openapi-temp")
			if err != nil {
				t.Fatal(err)
			}
			defer os.RemoveAll(tempDir)

			if tc.perPackage {
				for _, files := range tc.inputFiles {
					args := []string{"-Itestdata", "--openapi_out=" + tc.genOpts + ":" + tempDir}
					args = append(args, files...)
					protocOpenAPI(t, args)
				}
			} else {
				args := []string{"-Itestdata", "--openapi_out=" + tc.genOpts + ":" + tempDir}
				for _, files := range tc.inputFiles {
					args = append(args, files...)
				}
				protocOpenAPI(t, args)
			}

			// get the golden file and compare with the generated files.
			for _, file := range tc.wantFiles {
				wantPath := goldenDir + file
				// we are looking for the same file name in the generated path
				genPath := filepath.Join(tempDir, filepath.Base(wantPath))
				got, err := os.ReadFile(genPath)
				if err != nil {
					if os.IsNotExist(err) {
						t.Fatalf("expected generated file %v does not exist: %v", genPath, err)
					} else {
						t.Errorf("error reading the generated file: %v", err)
					}
				}

				want, err := os.ReadFile(wantPath)
				if err != nil {
					t.Errorf("error reading the golden file: %v", err)
				}

				if bytes.Equal(got, want) {
					continue
				}

				cmd := exec.Command("diff", "-u", wantPath, genPath)
				out, _ := cmd.CombinedOutput()
				t.Errorf("golden file differs: %v\n%v", filepath.Base(wantPath), string(out))
			}
		})
	}
}

func protocOpenAPI(t *testing.T, args []string) {
	cmd := exec.Command("protoc", "--plugin=protoc-gen-openapi="+os.Args[0])
	cmd.Args = append(cmd.Args, args...)
	cmd.Env = append(os.Environ(), "RUN_AS_PROTOC_GEN_OPENAPI=1")
	out, err := cmd.CombinedOutput()
	if len(out) > 0 || err != nil {
		t.Log("RUNNING: ", strings.Join(cmd.Args, " "))
	}
	if len(out) > 0 {
		t.Log(string(out))
	}
	if err != nil {
		t.Fatalf("protoc: %v", err)
	}
}

func init() {
	// when "RUN_AS_PROTOC_GEN_OPENAPI" is set, we use the protoc-gen-openapi directly
	// for the test scenarios.
	if os.Getenv("RUN_AS_PROTOC_GEN_OPENAPI") != "" {
		main()
		os.Exit(0)
	}
}