feat(114): support IncludePath option to define directory for non-absolute import files (#130)

Signed-off-by: lsytj0413 <[email protected]>

Signed-off-by: lsytj0413 <[email protected]>

Author: lsytj0413

model/util.go

@@ -22,6 +22,7 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
+	"sync/atomic"
 
 	"sigs.k8s.io/yaml"
 )
@@ -44,11 +45,20 @@ func getBytesFromFile(s string) (b []byte, err error) {
 		}
 		return buf.Bytes(), nil
 	}
-	if strings.HasPrefix(s, prefix) {
-		s = strings.TrimPrefix(s, prefix)
-	} else if s, err = filepath.Abs(s); err != nil {
-		return nil, err
+	s = strings.TrimPrefix(s, prefix)
+
+	if !filepath.IsAbs(s) {
+		// The import file is an non-absolute path, we join it with include path
+		// TODO: if the file didn't find in any include path, we should report an error
+		for _, p := range IncludePaths() {
+			sn := filepath.Join(p, s)
+			if _, err := os.Stat(sn); err == nil {
+				s = sn
+				break
+			}
+		}
 	}
+
 	if b, err = os.ReadFile(filepath.Clean(s)); err != nil {
 		return nil, err
 	}
@@ -104,3 +114,30 @@ func unmarshalFile(data []byte) (b []byte, err error) {
 	}
 	return file, nil
 }
+
+var defaultIncludePaths atomic.Value
+
+func init() {
+	wd, err := os.Getwd()
+	if err != nil {
+		panic(err)
+	}
+
+	SetIncludePaths([]string{wd})
+}
+
+// IncludePaths will return the search path for non-absolute import file
+func IncludePaths() []string {
+	return defaultIncludePaths.Load().([]string)
+}
+
+// SetIncludePaths will update the search path for non-absolute import file
+func SetIncludePaths(paths []string) {
+	for _, path := range paths {
+		if !filepath.IsAbs(path) {
+			panic(fmt.Errorf("%s must be an absolute file path", path))
+		}
+	}
+
+	defaultIncludePaths.Store(paths)
+}

model/util_benchmark_test.go

@@ -0,0 +1,31 @@
+// Copyright 2022 The Serverless Workflow Specification 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 model
+
+import (
+	"fmt"
+	"testing"
+)
+
+func Benchmark_IncludePaths_Parallel(b *testing.B) {
+	b.RunParallel(func(p *testing.PB) {
+		i := 0
+		for p.Next() {
+			IncludePaths()
+			SetIncludePaths([]string{fmt.Sprintf("%v", i)})
+			i++
+		}
+	})
+}

model/util_test.go

@@ -13,3 +13,23 @@
 // limitations under the License.
 
 package model
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestIncludePaths(t *testing.T) {
+	assert.NotNil(t, IncludePaths())
+	assert.True(t, len(IncludePaths()) > 0)
+
+	// update include paths
+	paths := []string{"/root", "/path"}
+	SetIncludePaths(paths)
+	assert.Equal(t, IncludePaths(), paths)
+
+	assert.PanicsWithError(t, "1 must be an absolute file path", assert.PanicTestFunc(func() {
+		SetIncludePaths([]string{"1"})
+	}))
+}

parser/parser_test.go

@@ -24,12 +24,16 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	"github.com/serverlessworkflow/sdk-go/v2/model"
+	"github.com/serverlessworkflow/sdk-go/v2/test"
 )
 
 func TestBasicValidation(t *testing.T) {
 	rootPath := "./testdata/workflows"
 	files, err := os.ReadDir(rootPath)
 	assert.NoError(t, err)
+
+	model.SetIncludePaths(append(model.IncludePaths(), filepath.Join(test.CurrentProjectPath(), "./parser/testdata")))
+
 	for _, file := range files {
 		if !file.IsDir() {
 			workflow, err := FromFile(filepath.Join(rootPath, file.Name()))