Merge pull request #398 from snyk/feat/resue-code

Feat/resue code

Author: jgresty

.circleci/config.yml

@@ -10,7 +10,7 @@ defaults: &defaults
   resource_class: small
   working_directory: ~/vervet
   docker:
-    - image: cimg/go:1.22.5-node
+    - image: cimg/go:1.23-node
 
 test_defaults: &test_defaults
   resource_class: medium
@@ -59,7 +59,7 @@ jobs:
     steps:
       - checkout
       - go/install:
-          version: 1.22.5
+          version: 1.23.2
       - go/mod-download-cached
       - run:
           name: Verify testdata/output up to date
@@ -70,7 +70,7 @@ jobs:
 
   lint:
     docker:
-      - image: golangci/golangci-lint:v1.59.1
+      - image: golangci/golangci-lint:v1.61.0
     steps:
       - checkout
       - run:

Dockerfile

@@ -1,4 +1,4 @@
-ARG GO_VERSION=1.22.5
+ARG GO_VERSION=1.23
 
 ###############
 # Build stage #

Makefile

@@ -3,7 +3,7 @@ GO_BIN=$(shell pwd)/.bin/go
 
 SHELL:=env PATH="$(GO_BIN):$(PATH)" $(SHELL)
 
-GOCI_LINT_V?=v1.59.1
+GOCI_LINT_V?=v1.61.0
 
 .PHONY: all
 all: lint test build

config/loader.go

@@ -0,0 +1,20 @@
+package config
+
+import (
+	"fmt"
+	"os"
+)
+
+// FromFile loads a vervet Project from a vervet.yaml file at given configPath,
+// defaults to ".vervet.yaml".
+func FromFile(configPath string) (*Project, error) {
+	if configPath == "" {
+		configPath = ".vervet.yaml"
+	}
+	f, err := os.Open(configPath)
+	if err != nil {
+		return nil, fmt.Errorf("failed to open %q: %w", configPath, err)
+	}
+	defer f.Close()
+	return Load(f)
+}

go.mod

@@ -1,6 +1,6 @@
 module github.com/snyk/vervet/v8
 
-go 1.22.5
+go 1.23
 
 require (
 	cloud.google.com/go/storage v1.41.0

internal/cmd/compiler.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/urfave/cli/v2"
 
@@ -144,34 +143,26 @@ func projectFromContext(ctx *cli.Context) (*config.Project, error) {
 		} else {
 			configPath = ".vervet.yaml"
 		}
-		f, err := os.Open(configPath)
-		if err != nil {
-			return nil, fmt.Errorf("failed to open %q: %w", configPath, err)
-		}
-		defer f.Close()
-		project, err = config.Load(f)
-		if err != nil {
-			return nil, err
-		}
-	} else {
-		api := &config.API{
-			Resources: []*config.ResourceSet{{
-				Path: ctx.Args().Get(0),
-			}},
-			Output: &config.Output{
-				Path: ctx.Args().Get(1),
-			},
-		}
-		if includePath := ctx.String("include"); includePath != "" {
-			api.Overlays = append(api.Overlays, &config.Overlay{
-				Include: includePath,
-			})
-		}
-		project = &config.Project{
-			APIs: map[string]*config.API{
-				"": api,
-			},
-		}
+		return config.FromFile(configPath)
+	}
+
+	api := &config.API{
+		Resources: []*config.ResourceSet{{
+			Path: ctx.Args().Get(0),
+		}},
+		Output: &config.Output{
+			Path: ctx.Args().Get(1),
+		},
+	}
+	if includePath := ctx.String("include"); includePath != "" {
+		api.Overlays = append(api.Overlays, &config.Overlay{
+			Include: includePath,
+		})
+	}
+	project = &config.Project{
+		APIs: map[string]*config.API{
+			"": api,
+		},
 	}
 	return project, nil
 }

internal/simplebuild/build.go

@@ -22,6 +22,7 @@ import (
 	"github.com/snyk/vervet/v8"
 	"github.com/snyk/vervet/v8/config"
 	"github.com/snyk/vervet/v8/internal/files"
+	"github.com/snyk/vervet/v8/specs"
 )
 
 // Build compiles the versioned resources in a project configuration based on
@@ -250,60 +251,44 @@ func LoadPaths(ctx context.Context, api *config.API) (Operations, error) {
 	if err != nil {
 		return nil, err
 	}
-
-	for _, resource := range api.Resources {
-		paths, err := ResourceSpecFiles(resource)
+	for doc, err := range specs.GetInputSpecsItr(ctx, api) {
 		if err != nil {
 			return nil, err
 		}
-		for _, path := range paths {
-			versionDir := filepath.Dir(path)
-			versionStr := filepath.Base(versionDir)
-			resourceName := filepath.Base(filepath.Dir(filepath.Dir(path)))
-
-			doc, err := vervet.NewDocumentFile(path)
-			if err != nil {
-				return nil, fmt.Errorf("failed to load spec from %q: %w", path, err)
-			}
-
-			stabilityStr, err := vervet.ExtensionString(doc.T.Extensions, vervet.ExtSnykApiStability)
-			if err != nil {
-				return nil, err
-			}
-			if stabilityStr != "ga" {
-				versionStr = fmt.Sprintf("%s~%s", versionStr, stabilityStr)
-			}
-			version, err := vervet.ParseVersion(versionStr)
-			if err != nil {
-				return nil, fmt.Errorf("invalid version %q", versionStr)
-			}
 
-			doc.InternalizeRefs(ctx, vervet.ResolveRefsWithoutSourceName)
-			err = doc.ResolveRefs()
-			if err != nil {
-				return nil, fmt.Errorf("failed to localize refs: %w", err)
-			}
+		version, err := doc.Version()
+		if err != nil {
+			return nil, fmt.Errorf("invalid version on path %q", doc.Location().String())
+		}
+		stabilityStr, err := vervet.ExtensionString(doc.T.Extensions, vervet.ExtSnykApiStability)
+		if err != nil {
+			return nil, err
+		}
+		version.Stability, err = vervet.ParseStability(stabilityStr)
+		if err != nil {
+			return nil, fmt.Errorf("invalid stability %q", stabilityStr)
+		}
+		resourceName := filepath.Base(filepath.Dir(doc.RelativePath()))
 
-			for _, pathName := range doc.T.Paths.InMatchingOrder() {
-				pathDef := doc.T.Paths.Value(pathName)
-				for opName, opDef := range pathDef.Operations() {
-					if opDef.Extensions == nil {
-						opDef.Extensions = make(map[string]interface{})
-					}
-					opDef.Extensions[vervet.ExtSnykApiOwner] = ownerFinder.Owners(path)
-					k := OpKey{
-						Path:   pathName,
-						Method: opName,
-					}
-					if operations[k] == nil {
-						operations[k] = []VersionedOp{}
-					}
-					operations[k] = append(operations[k], VersionedOp{
-						Version:      version,
-						Operation:    opDef,
-						ResourceName: resourceName,
-					})
+		for _, pathName := range doc.T.Paths.InMatchingOrder() {
+			pathDef := doc.T.Paths.Value(pathName)
+			for opName, opDef := range pathDef.Operations() {
+				if opDef.Extensions == nil {
+					opDef.Extensions = make(map[string]interface{})
+				}
+				opDef.Extensions[vervet.ExtSnykApiOwner] = ownerFinder.Owners(doc.Location().String())
+				k := OpKey{
+					Path:   pathName,
+					Method: opName,
+				}
+				if operations[k] == nil {
+					operations[k] = []VersionedOp{}
 				}
+				operations[k] = append(operations[k], VersionedOp{
+					Version:      version,
+					Operation:    opDef,
+					ResourceName: resourceName,
+				})
 			}
 		}
 	}

resource.go

@@ -199,7 +199,7 @@ func LoadResourceVersions(epPath string) (*ResourceVersions, error) {
 	for _, spec := range specs {
 		dir := filepath.Dir(spec)
 		if _, ok := specDirs[dir]; ok {
-			return nil, fmt.Errorf("duplicate spec found in " + dir)
+			return nil, fmt.Errorf("duplicate spec found in %s", dir)
 		} else {
 			specDirs[dir] = struct{}{}
 		}

specs/load.go

@@ -0,0 +1,86 @@
+package specs
+
+import (
+	"context"
+	"fmt"
+	"iter"
+
+	"github.com/snyk/vervet/v8"
+	"github.com/snyk/vervet/v8/config"
+	"github.com/snyk/vervet/v8/internal/files"
+)
+
+// GetInputSpecs returns a list of all of the input specs for a given project.
+// It will resolve all references in the spec so the output can be consumed by
+// tooling unaware applications.
+func GetInputSpecs(ctx context.Context, api *config.API) ([]*vervet.Document, error) {
+	return gather(GetInputSpecsItr(ctx, api))
+}
+
+// GetInputSpecsItr is a iterator version of GetInputSpecs. It is preferred for
+// lazy operations.
+func GetInputSpecsItr(ctx context.Context, api *config.API) iter.Seq2[*vervet.Document, error] {
+	return func(yield func(*vervet.Document, error) bool) {
+		for _, resource := range api.Resources {
+			paths, err := files.LocalFSSource{}.Match(resource)
+			if err != nil {
+				if !yield(nil, err) {
+					return
+				}
+			}
+			for _, path := range paths {
+				doc, err := vervet.NewDocumentFile(path)
+				if err != nil {
+					if !yield(nil, fmt.Errorf("failed to load spec: %w", err)) {
+						return
+					}
+				}
+				doc.InternalizeRefs(ctx, vervet.ResolveRefsWithoutSourceName)
+				err = doc.ResolveRefs()
+				if !yield(doc, err) {
+					return
+				}
+			}
+		}
+	}
+}
+
+// GetOutputSpecs returns a list of all of the compiled specs for a given
+// project. Assumes that the specs have already been compiled by vervet and are
+// up to date.
+func GetOutputSpecs(ctx context.Context, api *config.API) ([]*vervet.Document, error) {
+	return gather(GetOutputSpecsItr(ctx, api))
+}
+
+// GetOutputSpecsItr is a iterator version of GetOutputSpecs. It is preferred for
+// lazy operations.
+func GetOutputSpecsItr(ctx context.Context, api *config.API) iter.Seq2[*vervet.Document, error] {
+	return func(yield func(*vervet.Document, error) bool) {
+		resource := &config.ResourceSet{
+			Path: api.Output.Path,
+		}
+		paths, err := files.LocalFSSource{}.Match(resource)
+		if err != nil {
+			if !yield(nil, err) {
+				return
+			}
+		}
+		for _, path := range paths {
+			doc, err := vervet.NewDocumentFile(path)
+			if !yield(doc, err) {
+				return
+			}
+		}
+	}
+}
+
+func gather(itr iter.Seq2[*vervet.Document, error]) ([]*vervet.Document, error) {
+	docs := []*vervet.Document{}
+	for doc, err := range itr {
+		if err != nil {
+			return nil, err
+		}
+		docs = append(docs, doc)
+	}
+	return docs, nil
+}