Merge pull request #8 from micovery/main

Add remove_oas_extensions template function

cmd/apigee-go-gen/main.go

@@ -16,7 +16,7 @@ package main
 
 import (
 	"fmt"
-	v1 "github.com/apigee/apigee-go-gen/pkg/apigee/v1"
+	"github.com/apigee/apigee-go-gen/pkg/utils"
 	"github.com/go-errors/errors"
 	"os"
 )
@@ -25,11 +25,12 @@ func main() {
 	err := RootCmd.Execute()
 
 	if err != nil {
-		var validationErrors v1.ValidationErrors
-		isValidationErrors := errors.As(err, &validationErrors)
-		if isValidationErrors {
-			for i := 0; i < len(validationErrors.Errors) && i < 10; i++ {
-				_, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", validationErrors.Errors[i].Error())
+		var multiErrors utils.MultiError
+		isMultiErrors := errors.As(err, &multiErrors)
+
+		if isMultiErrors {
+			for i := 0; i < len(multiErrors.Errors) && i < 10; i++ {
+				_, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", multiErrors.Errors[i].Error())
 			}
 		} else {
 			_, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", err.Error())

cmd/apigee-go-gen/transform/cmd.go

@@ -19,7 +19,6 @@ import (
 	apiproxy_to_yaml "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/apiproxy-to-yaml"
 	json_to_yaml "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/json-to-yaml"
 	oas2_to_oas3 "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/oas2-to-oas3"
-	oas3_to_oas2 "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/oas3-to-oas2"
 	resolve_refs "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/resolve-refs"
 	sharedflow_to_yaml "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/sharedflow-to-yaml"
 	xml_to_yaml "github.com/apigee/apigee-go-gen/cmd/apigee-go-gen/transform/xml-to-yaml"
@@ -43,7 +42,6 @@ func init() {
 	Cmd.AddCommand(sharedflow_to_yaml.Cmd)
 	Cmd.AddCommand(yaml_to_sharedflow.Cmd)
 	Cmd.AddCommand(oas2_to_oas3.Cmd)
-	Cmd.AddCommand(oas3_to_oas2.Cmd)
 	Cmd.AddCommand(resolve_refs.Cmd)
 	Cmd.AddCommand(json_to_yaml.Cmd)
 	Cmd.AddCommand(yaml_to_json.Cmd)

docs/transform/index.md

@@ -32,9 +32,7 @@ The `apigee-go-gen` includes the following set of `transform` commands to help y
 * [sharedflow-to-yaml](./commands/sharedflow-to-yaml.md) - Transforms an Apigee API shared flow bundle to a YAML doc
 * [yaml-to-sharedflow](./commands/yaml-to-sharedflow.md) - Transforms a YAML doc to an Apigee shared flow bundle
 
-
 * [oas2-to-oas3](./commands/oas2-to-oas3.md) - Transforms an OpenAPI 2 spec (also known as Swagger) into OpenAPI 3
-* [oas3-to-oas2](./commands/oas3-to-oas2.md) - Transforms an OpenAPI 3 spec into OpenAPI 2 (also known as Swagger)
 
 * [resolve-refs](./commands/resolve-refs.md) - Replace external $refs (JSONRefs) in input YAML or JSON doc with actual values
 

examples/templates/oas3/apiproxy.yaml

@@ -65,6 +65,7 @@ Resources:
   - Resource:
       Type: oas
       #{{ os_writefile "./spec.yaml" $.Values.spec_string }}
+      #{{ remove_oas_extensions "./spec.yaml" }}
       Path: ./spec.yaml
   - Resource:
       Type: properties

go.mod

@@ -24,7 +24,7 @@ require (
 	github.com/getkin/kin-openapi v0.124.0
 	github.com/go-errors/errors v1.5.1
 	github.com/gosimple/slug v1.14.0
-	github.com/pb33f/libopenapi v0.16.2
+	github.com/pb33f/libopenapi v0.16.5
 	github.com/spf13/cobra v1.8.0
 	github.com/stretchr/testify v1.9.0
 	github.com/vektah/gqlparser/v2 v2.5.11

go.sum

@@ -111,8 +111,8 @@ github.com/onsi/gomega v1.10.1/go.mod h1:iN09h71vgCQne3DLsj+A5owkum+a2tYe+TOCB1y
 github.com/onsi/gomega v1.17.0/go.mod h1:HnhC7FXeEQY45zxNK3PPoIUhzk/80Xly9PcubAlGdZY=
 github.com/onsi/gomega v1.19.0 h1:4ieX6qQjPP/BfC3mpsAtIGGlxTWPeA3Inl/7DtXw1tw=
 github.com/onsi/gomega v1.19.0/go.mod h1:LY+I3pBVzYsTBU1AnDwOSxaYi9WoWiqgwooUqq9yPro=
-github.com/pb33f/libopenapi v0.16.2 h1:vAZisFmtMLScN68Hu26/T7ClEt5tWg+2HZd1Omw3abA=
-github.com/pb33f/libopenapi v0.16.2/go.mod h1:PEXNwvtT4KNdjrwudp5OYnD1ryqK6uJ68aMNyWvoMuc=
+github.com/pb33f/libopenapi v0.16.5 h1:jqb/N5nc2zuSUSWDgCXi2vKGxMQfTsWHgtmPWSKQGqc=
+github.com/pb33f/libopenapi v0.16.5/go.mod h1:PEXNwvtT4KNdjrwudp5OYnD1ryqK6uJ68aMNyWvoMuc=
 github.com/perimeterx/marshmallow v1.1.5 h1:a2LALqQ1BlHM8PZblsDdidgv1mWi1DgC2UmX50IvK2s=
 github.com/perimeterx/marshmallow v1.1.5/go.mod h1:dsXbUu8CRzfYP5a87xpp0xq9S3u0Vchtcl8we9tYaXw=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=

pkg/apigee/v1/apiproxymodel.go

@@ -64,7 +64,7 @@ func (a *APIProxyModel) Validate() error {
 		return nil
 	}
 
-	err := ValidationErrors{Errors: []error{}}
+	err := utils.MultiError{Errors: []error{}}
 	path := "Root"
 	if len(a.UnknownNode) > 0 {
 		err.Errors = append(err.Errors, &UnknownNodeError{path, a.UnknownNode[0]})

pkg/apigee/v1/model.go

@@ -109,16 +109,8 @@ func Model2BundleZip(model Model, outputZip string) error {
 
 func HydrateResources(model Model, fromDir string) error {
 	// switch to directory relative to the YAML file so that resource paths are valid
-	wd, err := os.Getwd()
-	if err != nil {
-		return errors.New(err)
-	}
-	defer func() { utils.Must(os.Chdir(wd)) }()
-
-	err = os.Chdir(fromDir)
-	if err != nil {
-		return errors.New(err)
-	}
+	popd := utils.PushDir(fromDir)
+	defer popd()
 
 	for _, resource := range model.GetResources().List {
 		parsedUrl, err := url.Parse(resource.Path)

pkg/apigee/v1/sharedflowbundlemodel.go

@@ -124,7 +124,7 @@ func (a *SharedFlowBundleModel) Validate() error {
 		return nil
 	}
 
-	err := ValidationErrors{Errors: []error{}}
+	err := utils.MultiError{Errors: []error{}}
 	path := "Root"
 	if len(a.UnknownNode) > 0 {
 		err.Errors = append(err.Errors, &UnknownNodeError{path, a.UnknownNode[0]})

pkg/apigee/v1/unknown.go

@@ -38,11 +38,3 @@ type UnknownNodeError struct {
 func (e *UnknownNodeError) Error() string {
 	return fmt.Sprintf(`unknown node "%s" found at "%s"`, e.Node.XMLName.Local, e.Location)
 }
-
-type ValidationErrors struct {
-	Errors []error
-}
-
-func (e ValidationErrors) Error() string {
-	return e.Errors[0].Error()
-}

pkg/common/resources/helper_functions.txt

@@ -59,6 +59,15 @@
         You can also use it to dump values to stdout in order to see the contents.
         e.g. {{ fmt_printf "url: %%v\n" $url }}
 
+    remove_oas_extensions(src string) string
+        Removes the OpenAPI spec extensions from the file specified by src
+        The file must already exist in the output directory
+
+        This is useful if to make the spec files small within the generated bundles
+        e.g.
+          {{ os_writefile "./spec.yaml" $.Values.spec_string }}
+          {{ remove_oas_extensions "./spec.yaml" }}
+
     Sprig
       Template functions from Sprig library
       e.g. {{ "Hello World" | upper }}

pkg/render/helper_funcs.go

@@ -15,6 +15,7 @@
 package render
 
 import (
+	"github.com/apigee/apigee-go-gen/pkg/utils"
 	"os"
 	"path/filepath"
 	"strings"
@@ -76,3 +77,39 @@ func getOSCopyFileFunc(templateFile string, outputFile string, dryRun bool) Help
 
 	return _osCopyFileFunc
 }
+
+func getRemoveOASExtensions(templateFile string, outputFile string, dryRun bool) HelperFunc {
+	_removeOASExtensionsFunc := func(args ...any) string {
+		if len(args) < 1 {
+			panic("remove_oas_extensions function requires one argument")
+		}
+
+		//both destination and source are the same
+		dst := args[0].(string)
+		src := args[0].(string)
+
+		if filepath.IsAbs(src) {
+			panic("remove_oas_extensions src must not be absolute")
+		}
+		if strings.Index(src, "..") >= 0 {
+			panic("remove_oas_extensions src must not use ..")
+		}
+
+		//both destination and source are relative to the output file
+		dstPath := filepath.Join(filepath.Dir(outputFile), dst)
+		srcPath := filepath.Join(filepath.Dir(outputFile), src)
+
+		if !dryRun {
+			err := utils.RemoveExtensions(srcPath, dstPath)
+			if err != nil {
+				panic(err)
+			}
+		} else {
+			//fmt.Printf(`remove_oas_extensions("%s", "%s")\n`, dstPath, srcPath)
+		}
+
+		return dst
+	}
+
+	return _removeOASExtensionsFunc
+}

pkg/render/model.go

@@ -108,16 +108,8 @@ func CreateBundle(model v1.Model, output string, validate bool, dryRun string) (
 }
 
 func ResolveYAML(text []byte, filePath string) ([]byte, error) {
-	wd, err := os.Getwd()
-	if err != nil {
-		return nil, errors.New(err)
-	}
-	defer func() { utils.Must(os.Chdir(wd)) }()
-
-	err = os.Chdir(filepath.Dir(filePath))
-	if err != nil {
-		return nil, errors.New(err)
-	}
+	popd := utils.PushDir(filepath.Dir(filePath))
+	defer popd()
 
 	yaml, err := utils.Text2YAML(bytes.NewReader(text))
 	if err != nil {

pkg/render/render.go

@@ -246,6 +246,7 @@ func CreateTemplate(templateFile string, includeList []string, outputFile string
 	helperFuncs["os_getenv"] = osGetEnvFunc
 	helperFuncs["os_getenvs"] = osGetEnvs
 	helperFuncs["os_copyfile"] = getOSCopyFileFunc(templateFile, outputFile, dryRun)
+	helperFuncs["remove_oas_extensions"] = getRemoveOASExtensions(templateFile, outputFile, dryRun)
 	helperFuncs["blank"] = blankFunc
 	helperFuncs["deref"] = derefFunc
 	helperFuncs["slug_make"] = slugMakeFunc