pkg/bufman/bufpkg/bufmodule/bufmoduleconfig/config_test.go

// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements.  See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You 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 bufmoduleconfig_test

import (
	"fmt"
	"strings"
	"testing"
)

import (
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
)

import (
	"github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufmodule/bufmoduleconfig"
	"github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufmodule/bufmoduleref"
	"github.com/apache/dubbo-kubernetes/pkg/bufman/bufpkg/bufmodule/bufmoduletesting"
)

func TestNewConfigV1Beta1Success1(t *testing.T) {
	// https://github.com/ProtobufMan/bufman-cli/issues/56
	t.Parallel()
	testNewConfigV1Beta1Success(
		t,
		[]string{
			"proto",
			"proto-vendor",
		},
		[]string{},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error1(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"/a/b",
		},
		[]string{},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error2(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{},
		[]string{
			"/a/b",
		},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error3(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"a/b",
			"a/b",
		},
		[]string{},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error4(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"a/b",
			"a/b/c",
		},
		[]string{},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error5(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"a/b",
		},
		[]string{
			"a/c",
		},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error6(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			".",
			"a",
		},
		[]string{},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error7(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"proto",
		},
		[]string{
			"proto/a/c",
			// error since not a directory
			"proto/d/1.proto",
		},
		[]string{},
	)
}

func TestNewConfigV1Beta1Error8(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"proto",
		},
		[]string{},
		[]string{
			// Duplicate dependency
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBarV2String,
		},
	)
}

func TestNewConfigV1Beta1Error9(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"proto",
		},
		[]string{},
		[]string{
			// Duplicate dependency
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBarCommitString,
		},
	)
}

func TestNewConfigV1Beta1Error10(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Error(
		t,
		[]string{
			"proto",
		},
		[]string{},
		[]string{
			// Duplicate dependency
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBarV1String,
		},
	)
}

func TestNewConfigV1Beta1Equal1(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Equal(
		t,
		[]string{
			"a",
			"b",
		},
		[]string{
			"a/foob",
		},
		[]string{
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBazCommitString,
		},
		&bufmoduleconfig.Config{
			RootToExcludes: map[string][]string{
				"a": {
					"foob",
				},
				"b": {},
			},
			DependencyModuleReferences: testParseDependencyModuleReferences(
				t,
				bufmoduletesting.TestModuleReferenceFooBarV1String,
				bufmoduletesting.TestModuleReferenceFooBazCommitString,
			),
		},
	)
}

func TestNewConfigV1Beta1Equal2(t *testing.T) {
	t.Parallel()
	testNewConfigV1Beta1Equal(
		t,
		[]string{
			"a",
			"b",
		},
		[]string{
			"a/foob",
			"b/foob",
			"b/barr",
		},
		[]string{},
		&bufmoduleconfig.Config{
			RootToExcludes: map[string][]string{
				"a": {
					"foob",
				},
				"b": {
					"barr",
					"foob",
				},
			},
		},
	)
}

func TestNewConfigV1Success1(t *testing.T) {
	// https://github.com/ProtobufMan/bufman-cli/issues/56
	t.Parallel()
	testNewConfigV1Success(
		t,
		[]string{
			"a",
			"b",
		},
		[]string{},
	)
}

func TestNewConfigV1Error1(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{
			"/a/b",
		},
		[]string{},
	)
}

func TestNewConfigV1Error2(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{
			"a/b",
			"a/b/c",
		},
		[]string{},
	)
}

func TestNewConfigV1Error3(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{
			".",
			"a",
		},
		[]string{},
	)
}

func TestNewConfigV1Error4(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{
			"proto/a/c",
			// error since not a directory
			"proto/d/1.proto",
		},
		[]string{},
	)
}

func TestNewConfigV1Error5(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{},
		[]string{
			// Duplicate dependency
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBarV2String,
		},
	)
}

func TestNewConfigV1Error6(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{},
		[]string{
			// Duplicate dependency
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBarCommitString,
		},
	)
}

func TestNewConfigV1Error7(t *testing.T) {
	t.Parallel()
	testNewConfigV1Error(
		t,
		[]string{},
		[]string{
			// Duplicate dependency
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBarV1String,
		},
	)
}

func TestNewConfigV1Equal1(t *testing.T) {
	t.Parallel()
	testNewConfigV1Equal(
		t,
		[]string{
			"a/foob",
		},
		[]string{
			bufmoduletesting.TestModuleReferenceFooBarV1String,
			bufmoduletesting.TestModuleReferenceFooBazCommitString,
		},
		&bufmoduleconfig.Config{
			RootToExcludes: map[string][]string{
				".": {
					"a/foob",
				},
			},
			DependencyModuleReferences: testParseDependencyModuleReferences(
				t,
				bufmoduletesting.TestModuleReferenceFooBarV1String,
				bufmoduletesting.TestModuleReferenceFooBazCommitString,
			),
		},
	)
}

func TestNewConfigV1Equal2(t *testing.T) {
	t.Parallel()
	testNewConfigV1Equal(
		t,
		[]string{
			"a/foob",
			"b/foob",
			"b/barr",
		},
		[]string{},
		&bufmoduleconfig.Config{
			RootToExcludes: map[string][]string{
				".": {
					"a/foob",
					"b/barr",
					"b/foob",
				},
			},
		},
	)
}

func testNewConfigV1Beta1Success(t *testing.T, roots []string, excludes []string, deps []string) {
	_, err := bufmoduleconfig.NewConfigV1Beta1(bufmoduleconfig.ExternalConfigV1Beta1{Roots: roots, Excludes: excludes}, deps...)
	assert.NoError(t, err, fmt.Sprintf("%v %v %v", roots, excludes, deps))
}

func testNewConfigV1Beta1Error(t *testing.T, roots []string, excludes []string, deps []string) {
	_, err := bufmoduleconfig.NewConfigV1Beta1(bufmoduleconfig.ExternalConfigV1Beta1{Roots: roots, Excludes: excludes}, deps...)
	assert.Error(t, err, fmt.Sprintf("%v %v %v", roots, excludes, deps))
}

func testNewConfigV1Beta1Equal(
	t *testing.T,
	roots []string,
	excludes []string,
	deps []string,
	expectedConfig *bufmoduleconfig.Config,
) {
	config, err := bufmoduleconfig.NewConfigV1Beta1(bufmoduleconfig.ExternalConfigV1Beta1{Roots: roots, Excludes: excludes}, deps...)
	assert.NoError(t, err, fmt.Sprintf("%v %v %v", roots, excludes, deps))
	assert.Equal(t, expectedConfig, config)
}

func testNewConfigV1Success(t *testing.T, excludes []string, deps []string) {
	_, err := bufmoduleconfig.NewConfigV1(bufmoduleconfig.ExternalConfigV1{Excludes: excludes}, deps...)
	assert.NoError(t, err, fmt.Sprintf("%v %v", excludes, deps))
}

func testNewConfigV1Error(t *testing.T, excludes []string, deps []string) {
	_, err := bufmoduleconfig.NewConfigV1(bufmoduleconfig.ExternalConfigV1{Excludes: excludes}, deps...)
	assert.Error(t, err, fmt.Sprintf("%v %v", excludes, deps))
}

func testNewConfigV1Equal(
	t *testing.T,
	excludes []string,
	deps []string,
	expectedConfig *bufmoduleconfig.Config,
) {
	config, err := bufmoduleconfig.NewConfigV1(bufmoduleconfig.ExternalConfigV1{Excludes: excludes}, deps...)
	assert.NoError(t, err, fmt.Sprintf("%v %v", excludes, deps))
	assert.Equal(t, expectedConfig, config)
}

func testParseDependencyModuleReferences(t *testing.T, deps ...string) []bufmoduleref.ModuleReference {
	if len(deps) == 0 {
		return nil
	}
	moduleReferences := make([]bufmoduleref.ModuleReference, 0, len(deps))
	for _, dep := range deps {
		dep := strings.TrimSpace(dep)
		moduleReference, err := bufmoduleref.ModuleReferenceForString(dep)
		require.NoError(t, err)
		moduleReferences = append(moduleReferences, moduleReference)
	}
	err := bufmoduleref.ValidateModuleReferencesUniqueByIdentity(moduleReferences)
	require.NoError(t, err)
	return moduleReferences
}