Merge pull request #380 from snyk/feat/populate-api-owners

feat: populate api owners in operation extensions

go.mod

@@ -95,6 +95,7 @@ require (
 	github.com/google/s2a-go v0.1.7 // indirect
 	github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
 	github.com/googleapis/gax-go/v2 v2.12.4 // indirect
+	github.com/hairyhenderson/go-codeowners v0.5.0 // indirect
 	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/invopop/yaml v0.3.1 // indirect
 	github.com/jmespath/go-jmespath v0.4.0 // indirect

go.sum

@@ -309,6 +309,8 @@ github.com/googleapis/gax-go/v2 v2.12.4/go.mod h1:KYEYLorsnIGDi/rPC8b5TdlB9kbKoF
 github.com/googleapis/google-cloud-go-testing v0.0.0-20200911160855-bcd43fbb19e8/go.mod h1:dvDLG8qkwmyD9a/MJJN3XJcT3xFxOKAvTZGvuZmac9g=
 github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
 github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
+github.com/hairyhenderson/go-codeowners v0.5.0 h1:dpQB+hVHiRc2VVvc2BHxkuM+tmu9Qej/as3apqUbsWc=
+github.com/hairyhenderson/go-codeowners v0.5.0/go.mod h1:R3uW1OQXEj2Gu6/OvZ7bt6hr0qdkLvUWPiqNaWnexpo=
 github.com/hashicorp/golang-lru v0.5.0/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
 github.com/hashicorp/golang-lru v0.5.1/go.mod h1:/m3WP610KZHVQ1SGc6re/UDhFvYD7pJ4Ao+sR/qLZy8=
 github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4=

internal/simplebuild/build.go

@@ -6,13 +6,15 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"os"
 	"path/filepath"
 	"slices"
 	"sort"
 	"strings"
 	"time"
 
 	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/hairyhenderson/go-codeowners"
 	"github.com/tufin/oasdiff/checker"
 	"github.com/tufin/oasdiff/diff"
 	"github.com/tufin/oasdiff/load"
@@ -84,6 +86,9 @@ func Build(
 				return err
 			}
 
+			if doc.Doc.Extensions == nil {
+				doc.Doc.Extensions = make(map[string]interface{})
+			}
 			doc.Doc.Extensions[vervet.ExtSnykApiVersion] = doc.VersionDate.Format(time.DateOnly)
 
 			refResolver := NewRefResolver()
@@ -205,6 +210,14 @@ func (ops Operations) VersionDates() []time.Time {
 
 func LoadPaths(ctx context.Context, api *config.API) (Operations, error) {
 	operations := map[OpKey]VersionSet{}
+	cwd, err := os.Getwd()
+	if err != nil {
+		return nil, err
+	}
+	ownerFinder, err := codeowners.FromFile(cwd)
+	if err != nil {
+		return nil, err
+	}
 
 	for _, resource := range api.Resources {
 		paths, err := ResourceSpecFiles(resource)
@@ -242,6 +255,10 @@ func LoadPaths(ctx context.Context, api *config.API) (Operations, error) {
 			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,

resource.go

@@ -5,12 +5,14 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"os"
 	"path/filepath"
 	"strings"
 	"time"
 
 	"github.com/bmatcuk/doublestar/v4"
 	"github.com/getkin/kin-openapi/openapi3"
+	"github.com/hairyhenderson/go-codeowners"
 	"golang.org/x/exp/maps"
 )
 
@@ -33,6 +35,10 @@ const (
 	// overall version of the compiled spec at the document level.
 	ExtSnykApiVersion = "x-snyk-api-version"
 
+	// ExtSnykApiOwner is used to annotate an operation in a compiled OpenAPI spec
+	// with the owners of the operation. This is useful to get to the owning github team.
+	ExtSnykApiOwner = "x-snyk-api-owners"
+
 	// ExtSnykApiReleases is used to annotate a path in a compiled OpenAPI spec
 	// with all the release versions containing a change in the path info. This
 	// is useful for navigating changes in a particular path across versions.
@@ -208,7 +214,14 @@ func LoadResourceVersionsFileset(specYamls []string) (*ResourceVersions, error)
 		path, operation string
 	}
 	opReleases := map[operationKey]VersionSlice{}
-
+	cwd, err := os.Getwd()
+	if err != nil {
+		return nil, err
+	}
+	ownerFinder, err := codeowners.FromFile(cwd)
+	if err != nil {
+		return nil, err
+	}
 	for i := range specYamls {
 		specYamls[i], err = filepath.Abs(specYamls[i])
 		if err != nil {
@@ -238,6 +251,7 @@ func LoadResourceVersionsFileset(specYamls []string) (*ResourceVersions, error)
 						op.Extensions = make(map[string]any)
 					}
 					op.Extensions[ExtSnykApiVersion] = rc.Version.String()
+					op.Extensions[ExtSnykApiOwner] = ownerFinder.Owners(specYamls[i])
 					opKey := operationKey{path, opName}
 					opReleases[opKey] = append(opReleases[opKey], rc.Version)
 				}