Merge pull request #1062 from kgadams/pathlib

Ditch pathlib and fix Windows bugs

Author: LandonTClipp

.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

.github/workflows/reusable-testing.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: ["macos-latest", "ubuntu-latest"]
+        os: ["macos-latest", "ubuntu-latest", "windows-latest"]
         go_vers: ["1.23", "1.24"]
     steps:
       - uses: actions/checkout@v2
@@ -30,4 +30,4 @@ jobs:
         run: go mod download -x
 
       - name: Test
-        run: go run github.com/go-task/task/v3/cmd/task test.ci
+        run: go run github.com/go-task/task/v3/cmd/task test.ci

Taskfile.yml

@@ -16,10 +16,36 @@ tasks:
 
   mocks:
     desc: generate new mocks from scratch
-    deps: [mocks.remove, mocks.generate]
+    cmds:
+      - task: mocks.remove
+      - task: mocks.generate
 
   mocks.remove:
     desc: remove all mock files
+    deps:
+      - mocks.remove.windows
+      - mocks.remove.unix
+
+  mocks.remove.windows:
+    desc: remove all mock files on windows
+    platforms: ["windows"]
+    cmds:
+      - rm -f files.txt
+      - where /r . '*_mock.go' > files.txt           || true
+      - where /r . 'mock_*_test.go' >> files.txt     || true
+      - where /r . 'mocks_moq.go' >> files.txt       || true
+      - where /r . 'mocks_test.go' >> files.txt      || true
+      - where /r . 'mocks_*_test.go' >> files.txt    || true
+      - where /r . 'mocks_matryer_*.go' >> files.txt || true
+      - where /r . 'mocks.go' >> files.txt           || true
+      - powershell -Command 'foreach ($file in Get-Content "files.txt") { If (Test-Path $file) {Remove-Item $file} }'
+      - rm -rf mocks/
+      - rm -f files.txt
+
+
+  mocks.remove.unix:
+    desc: remove all mock files on unix
+    platforms: ["darwin", "linux"]
     cmds:
       - find . -name '*_mock.go' -o -name 'mock_*_test.go' -o -name "mocks_moq.go"  -o -name 'mocks_test.go' -o -name 'mocks_*_test.go' -o -name 'mocks_matryer_*.go' -o -name 'mocks.go' | xargs -r rm
       - rm -rf mocks/
@@ -77,7 +103,7 @@ tasks:
   test.e2e:
     desc: run end-to-end tests
     cmds:
-      - ./e2e/run_all.sh
+      - bash ./e2e/run_all.sh
       - go run gotest.tools/gotestsum --format testname -- -v -count=1 ./e2e/...
 
   test.ci:

config/config.go

@@ -20,7 +20,6 @@ import (
 	"text/template"
 
 	"github.com/brunoga/deep"
-	"github.com/chigopher/pathlib"
 	"github.com/go-viper/mapstructure/v2"
 	koanfYAML "github.com/knadh/koanf/parsers/yaml"
 	"github.com/knadh/koanf/providers/env"
@@ -93,14 +92,14 @@ type RootConfig struct {
 	Config     `koanf:",squash" yaml:",inline"`
 	Packages   map[string]*PackageConfig `koanf:"packages" yaml:"packages"`
 	koanf      *koanf.Koanf
-	configFile *pathlib.Path
+	configFile string
 }
 
 func NewRootConfig(
 	ctx context.Context,
 	flags *pflag.FlagSet,
 ) (*RootConfig, *koanf.Koanf, error) {
-	var configFile *pathlib.Path
+	var configFile string
 
 	log := zerolog.Ctx(ctx)
 	var err error
@@ -131,24 +130,24 @@ func NewRootConfig(
 
 	configFileFromEnv := os.Getenv("MOCKERY_CONFIG")
 	if configFileFromEnv != "" {
-		configFile = pathlib.NewPath(configFileFromEnv)
+		configFile = configFileFromEnv
 	}
-	if configFile == nil {
+	if configFile == "" {
 		configFileFromFlags, err := flags.GetString("config")
 		if err != nil {
 			return nil, nil, fmt.Errorf("getting --config from flags: %w", err)
 		}
 		if configFileFromFlags != "" {
-			configFile = pathlib.NewPath(configFileFromFlags)
+			configFile = configFileFromFlags
 		}
 	}
-	if configFile == nil {
+	if configFile == "" {
 		log.Debug().Msg("config file not specified, searching")
 		configFile, err = internalConfig.FindConfig()
 		if err != nil {
 			return nil, k, fmt.Errorf("discovering mockery config: %w", err)
 		}
-		log.Debug().Str("config-file", configFile.String()).Msg("config file found")
+		log.Debug().Str("config-file", configFile).Msg("config file found")
 	}
 	rootConfig.configFile = configFile
 
@@ -187,7 +186,7 @@ func NewRootConfig(
 		return nil, nil, stackerr.NewStackErr(err)
 	}
 
-	if err := k.Load(file.Provider(configFile.String()), koanfYAML.Parser()); err != nil {
+	if err := k.Load(file.Provider(configFile), koanfYAML.Parser()); err != nil {
 		return nil, k, fmt.Errorf("loading config file: %w", err)
 	}
 
@@ -212,7 +211,7 @@ func NewRootConfig(
 	return &rootConfig, k, nil
 }
 
-func (c *RootConfig) ConfigFileUsed() *pathlib.Path {
+func (c *RootConfig) ConfigFileUsed() string {
 	return c.configFile
 }
 
@@ -551,8 +550,8 @@ func (c Config) koanfTagNames() map[string]struct{} {
 	return tags
 }
 
-func (c *Config) FilePath() *pathlib.Path {
-	return pathlib.NewPath(*c.Dir).Join(*c.FileName).Clean()
+func (c *Config) FilePath() string {
+	return filepath.ToSlash(filepath.Clean(filepath.Join(*c.Dir, *c.FileName)))
 }
 
 func (c *Config) ShouldExcludeSubpkg(pkgPath string) bool {
@@ -595,32 +594,35 @@ func (c *Config) ParseTemplates(
 	if err != nil {
 		return fmt.Errorf("get working directory: %w", err)
 	}
-	interfaceDirPath := pathlib.NewPath(ifaceFilePath).Parent()
-	interfaceDirRelativePath, err := interfaceDirPath.RelativeToStr(workingDir)
+	workingDir = filepath.ToSlash(workingDir)
+	ifaceFilePath = filepath.ToSlash(filepath.Clean(ifaceFilePath))
+	interfaceDirPath := filepath.ToSlash(filepath.Dir(ifaceFilePath))
+	interfaceDirRelativePath, err := filepath.Rel(filepath.FromSlash(workingDir), filepath.FromSlash(interfaceDirPath))
 
 	var interfaceDirRelative string
 
 	if err != nil {
 		log.Debug().
 			Err(err).
 			Str("working-dir", workingDir).
-			Str("interfaceDirPath", interfaceDirPath.String()).
-			Str("interface-dir-relative-path", interfaceDirRelativePath.String()).
+			Str("interfaceDirPath", interfaceDirPath).
+			Str("interface-dir-relative-path", interfaceDirRelativePath).
 			Msg("can't make path relative to working dir, setting to './'")
 		interfaceDirRelative = "."
 	} else {
+		interfaceDirRelativePath = filepath.ToSlash(interfaceDirRelativePath)
 		log.Debug().
 			Str("working-dir", workingDir).
-			Str("interfaceDirPath", interfaceDirPath.String()).
-			Str("interface-dir-relative-path", interfaceDirRelativePath.String()).
+			Str("interfaceDirPath", interfaceDirPath).
+			Str("interface-dir-relative-path", interfaceDirRelativePath).
 			Msg("found relative path")
-		interfaceDirRelative = interfaceDirRelativePath.String()
+		interfaceDirRelative = interfaceDirRelativePath
 	}
 
 	// data is the struct sent to the template parser
 	data := TemplateData{
 		ConfigDir:            filepath.Dir(*c.ConfigFile),
-		InterfaceDir:         interfaceDirPath.String(),
+		InterfaceDir:         interfaceDirPath,
 		InterfaceDirRelative: interfaceDirRelative,
 		InterfaceFile:        ifaceFilePath,
 		InterfaceName:        ifaceName,

config/config_test.go

@@ -4,9 +4,10 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
+	"path"
 	"testing"
 
-	"github.com/chigopher/pathlib"
 	"github.com/spf13/pflag"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -31,13 +32,13 @@ packages:
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			configFile := pathlib.NewPath(t.TempDir()).Join("config.yaml")
-			require.NoError(t, configFile.WriteFile([]byte(tt.config)))
+			configFile := path.Join(t.TempDir(), "config.yaml")
+			require.NoError(t, os.WriteFile(configFile, []byte(tt.config), 0o600))
 
 			flags := pflag.NewFlagSet("test", pflag.ExitOnError)
 			flags.String("config", "", "")
 
-			require.NoError(t, flags.Parse([]string{"--config", configFile.String()}))
+			require.NoError(t, flags.Parse([]string{"--config", configFile}))
 
 			_, _, err := NewRootConfig(context.Background(), flags)
 			if tt.wantErr == nil {
@@ -57,16 +58,16 @@ packages:
 
 func TestNewRootConfigUnknownEnvVar(t *testing.T) {
 	t.Setenv("MOCKERY_UNKNOWN", "foo")
-	configFile := pathlib.NewPath(t.TempDir()).Join("config.yaml")
-	require.NoError(t, configFile.WriteFile([]byte(`
+	configFile := path.Join(t.TempDir(), "config.yaml")
+	require.NoError(t, os.WriteFile(configFile, []byte(`
 packages:
   github.com/vektra/mockery/v3:
-`)))
+`), 0o600))
 
 	flags := pflag.NewFlagSet("test", pflag.ExitOnError)
 	flags.String("config", "", "")
 
-	require.NoError(t, flags.Parse([]string{"--config", configFile.String()}))
+	require.NoError(t, flags.Parse([]string{"--config", configFile}))
 	_, _, err := NewRootConfig(context.Background(), flags)
 	assert.NoError(t, err)
 }

e2e/test_remote_templates/remote_templates_test.go

@@ -4,10 +4,11 @@ import (
 	"fmt"
 	"net/http"
 	"net/http/httptest"
+	"os"
 	"os/exec"
+	"path"
 	"testing"
 
-	"github.com/chigopher/pathlib"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -29,19 +30,15 @@ packages:
 `
 
 func TestRemoteTemplates(t *testing.T) {
-	var err error
-
 	// the temp dir needs to reside within the mockery project because mockery
 	// requires a go.mod file to function correctly. Using t.TempDir() won't work
 	// because of this.
-	tmpDirBase := pathlib.NewPath("./test")
-	_ = tmpDirBase.RemoveAll()
-	require.NoError(t, tmpDirBase.Mkdir())
-	tmpDirBase, err = tmpDirBase.ResolveAll()
-	require.NoError(t, err)
+	tmpDirBase := "./test"
+	_ = os.RemoveAll(tmpDirBase)
+	require.NoError(t, os.Mkdir(tmpDirBase, 0o755))
 
 	//nolint:errcheck
-	defer tmpDirBase.RemoveAll()
+	defer os.RemoveAll(tmpDirBase)
 
 	type test struct {
 		name             string
@@ -92,11 +89,11 @@ func TestRemoteTemplates(t *testing.T) {
 		},
 	} {
 		t.Run(tt.name, func(t *testing.T) {
-			tmpdir := tmpDirBase.Join(t.Name())
-			require.NoError(t, tmpdir.MkdirAll())
+			tmpdir := path.Join(tmpDirBase, t.Name())
+			require.NoError(t, os.MkdirAll(tmpdir, 0o755))
 
-			configFile := tmpdir.Join(".mockery.yml")
-			outFile := tmpdir.Join("out.txt")
+			configFile := path.Join(tmpdir, ".mockery.yml")
+			outFile := path.Join(tmpdir, "out.txt")
 
 			templateName := "template.templ"
 			mux := http.NewServeMux()
@@ -112,23 +109,24 @@ func TestRemoteTemplates(t *testing.T) {
 
 			fullPath := fmt.Sprintf("%s/%s", ts.URL, templateName)
 
+			parent, name := path.Split(outFile)
 			configFileContents := fmt.Sprintf(
 				configTemplate,
-				outFile.Parent().String(),
-				outFile.Name(),
+				parent,
+				name,
 				fullPath,
 			)
-			require.NoError(t, configFile.WriteFile([]byte(configFileContents)))
+			require.NoError(t, os.WriteFile(configFile, []byte(configFileContents), 0o600))
 
 			//nolint: gosec
 			out, err := exec.Command(
 				"go", "run", "github.com/vektra/mockery/v3",
-				"--config", configFile.String()).CombinedOutput()
+				"--config", configFile).CombinedOutput()
 			if tt.expectMockeryErr {
 				assert.Error(t, err)
 			} else {
 				require.NoError(t, err, string(out))
-				outFileBytes, err := outFile.ReadFile()
+				outFileBytes, err := os.ReadFile(outFile)
 				require.NoError(t, err)
 				assert.Equal(t, "Hello, world!", string(outFileBytes))
 			}

e2e/test_template_data_schema_validation/validation_test.go

@@ -1,19 +1,19 @@
 package test_template_exercise
 
 import (
+	"os"
 	"os/exec"
 	"strings"
 	"testing"
 
-	"github.com/chigopher/pathlib"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestExercise(t *testing.T) {
 	t.Parallel()
-	outfile := pathlib.NewPath("./exercise.txt")
+	outfile := "./exercise.txt"
 	//nolint:errcheck
-	defer outfile.Remove()
+	defer os.Remove(outfile)
 
 	out, err := exec.Command(
 		"go", "run", "github.com/vektra/mockery/v3",

e2e/test_template_exercise/exercise_test.go

@@ -6,16 +6,15 @@ import (
 	"os/exec"
 	"testing"
 
-	"github.com/chigopher/pathlib"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestExercise(t *testing.T) {
 	t.Parallel()
 
-	outfile := pathlib.NewPath("./exercise.txt")
+	outfile := "./exercise.txt"
 	//nolint:errcheck
-	defer outfile.Remove()
+	defer os.Remove(outfile)
 
 	out, err := exec.Command(
 		"go", "run", "github.com/vektra/mockery/v3",
@@ -26,13 +25,13 @@ func TestExercise(t *testing.T) {
 		os.Exit(1)
 	}
 
-	b, err := outfile.ReadFile()
+	b, err := os.ReadFile(outfile)
 	if err != nil {
 		fmt.Println(err)
 		os.Exit(1)
 	}
-	expectedPath := pathlib.NewPath("exercise_expected.txt")
-	expected, err := expectedPath.ReadFile()
+	expectedPath := "exercise_expected.txt"
+	expected, err := os.ReadFile(expectedPath)
 	if err != nil {
 		fmt.Println(err)
 		os.Exit(1)