layer_test.go

package archunit

import (
	"github.com/kcmvp/archunit/internal"
	"github.com/samber/lo"
	"github.com/stretchr/testify/assert"
	"strings"
	"testing"
)

func TestLayerPackages(t *testing.T) {
	tests := []struct {
		name   string
		paths  []string
		except []string
		size1  int
		size2  int
	}{
		{
			name:  "sample only",
			paths: []string{".../internal/sample"},
			size1: 0,
		},
		{
			name:   "sample and sub Layer",
			paths:  []string{".../internal/sample/..."},
			except: []string{".../ext"},
			size1:  12,
			size2:  10,
		},
		{
			name:  "ext",
			paths: []string{".../sample/.../ext"},
			size1: 2,
		},
		{
			name:  "ext",
			paths: []string{".../repository/ext"},
			size1: 1,
		},
	}
	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			layer, _ := Layer(test.paths...)
			assert.Equal(t, test.size1, len(layer.packages()))
			if len(test.except) > 0 {
				layer, _ = layer.Exclude(test.except...)
				assert.Equal(t, test.size2, len(layer.packages()))
			}
		})
	}
}

func TestLayer_Sub(t *testing.T) {
	tests := []struct {
		name  string
		paths []string
		sub   []string
		size1 int
		size2 int
	}{
		{
			name:  "ext sub",
			paths: []string{".../service/..."},
			sub:   []string{".../ext/"},
			size1: 5,
			size2: 1,
		},
		{
			name:  "ext sub",
			paths: []string{".../service/..."},
			sub:   []string{".../ext/..."},
			size1: 5,
			size2: 3,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			layer, _ := Layer(tt.paths...)
			assert.Equal(t, tt.size1, len(layer.packages()))
			layer, _ = layer.Sub(tt.name, tt.sub...)
			assert.Equal(t, tt.size2, len(layer.packages()))
		})
	}
}

func TestSourceNameShould(t *testing.T) {
	err := SourceNameShould(BeLowerCase)
	assert.Error(t, err)
	assert.True(t, strings.Contains(err.Error(), "internal/sample/views/UserView.go's name breaks the rule"))
}

func TestConstantsShouldBeDefinedInOneFileByPackage(t *testing.T) {
	err := ConstantsShouldBeDefinedInOneFileByPackage()
	assert.Error(t, err)
	assert.True(t, strings.Contains(err.Error(), "package github.com/kcmvp/archunit/internal/sample/repository constants are definied in files "))
}

func TestLayPackages(t *testing.T) {
	layer, _ := Layer("sample/controller/...")
	assert.ElementsMatch(t, []string{"github.com/kcmvp/archunit/internal/sample/controller",
		"github.com/kcmvp/archunit/internal/sample/controller/module1"}, layer.packages())
	assert.ElementsMatch(t, layer.Imports(),
		[]string{"github.com/kcmvp/archunit/internal/sample/service",
			"github.com/kcmvp/archunit/internal/sample/views",
			"github.com/kcmvp/archunit/internal/sample/repository",
			"github.com/kcmvp/archunit/internal/sample/service/ext/v1",
			"fmt",
			"time",
			"context",
		})
}

func TestLayer_Refer(t *testing.T) {
	controller, _ := Layer("sample/controller", "sample/controller/...")
	model, _ := Layer("sample/model")
	service, _ := Layer("sample/service", "sample/service/...")
	repository, _ := Layer("sample/repository", "sample/repository/...")
	assert.NoError(t, controller.ShouldNotReferLayers(model))
	assert.NoError(t, controller.ShouldNotReferPackages("sample/model"))
	assert.Errorf(t, controller.ShouldNotReferLayers(repository), "controller should not refer repository")
	assert.Error(t, controller.ShouldOnlyReferLayers(service))
	assert.NoError(t, repository.ShouldOnlyReferLayers(model), "repository should not refer model")
	assert.NoError(t, repository.ShouldOnlyReferPackages("sample/model"), "repository should not refer model")
	assert.Error(t, model.ShouldBeOnlyReferredByLayers(repository), "model should be only referred repository")
	assert.Error(t, repository.ShouldBeOnlyReferredByLayers(service), "repository is referenced by controller")
	assert.ElementsMatch(t, controller.packages(), []string{"github.com/kcmvp/archunit/internal/sample/controller",
		"github.com/kcmvp/archunit/internal/sample/controller/module1"})
	assert.ElementsMatch(t, lo.Map(controller.Types(), func(typ internal.Type, index int) string {
		return typ.Name()
	}), []string{
		"github.com/kcmvp/archunit/internal/sample/controller.CustomizeHandler",
		"github.com/kcmvp/archunit/internal/sample/controller.LoginController",
		"github.com/kcmvp/archunit/internal/sample/controller/module1.AppController",
		"github.com/kcmvp/archunit/internal/sample/controller.AppContext",
	})
	assert.ElementsMatch(t, lo.Map(controller.Functions(), func(item internal.Function, index int) string {
		return item.Name()
	}), []string{"LoginHandler"})
}