fix: add godoc comment to generated embed.FS

This adds a godoc comment to the generated embed.go which embeds the
compiled OpenAPI specs for compilation into a Go service.

Added a test to assert that the godoc comment does not interfere with
the //go:embed magic comments.

Fixes #120.

internal/compiler/compiler.go

@@ -375,6 +375,7 @@ import "embed"
 {{ range .VersionSpecFiles -}}
 //go:embed {{ . }}
 {{ end -}}
+// Versions contains OpenAPI specs for each distinct release version.
 var Versions embed.FS
 `))
 

versionware/example/embed_test.go

@@ -0,0 +1,29 @@
+package example
+
+import (
+	"testing"
+
+	qt "github.com/frankban/quicktest"
+
+	"github.com/snyk/vervet"
+	"github.com/snyk/vervet/versionware/example/releases"
+)
+
+func TestEmbedding(t *testing.T) {
+	c := qt.New(t)
+
+	specs, err := vervet.LoadVersions(releases.Versions)
+	c.Assert(err, qt.IsNil)
+	c.Assert(specs, qt.HasLen, 3)
+	var versions []string
+	for i := range specs {
+		version, err := vervet.ExtensionString(specs[i].ExtensionProps, vervet.ExtSnykApiVersion)
+		c.Assert(err, qt.IsNil)
+		versions = append(versions, version)
+	}
+	c.Assert(versions, qt.ContentEquals, []string{
+		"2021-11-01~experimental",
+		"2021-11-08~experimental",
+		"2021-11-20~experimental",
+	})
+}

versionware/example/go.mod

@@ -3,6 +3,7 @@ module github.com/snyk/vervet/versionware/example
 go 1.16
 
 require (
+	github.com/frankban/quicktest v1.13.0 // indirect
 	github.com/getkin/kin-openapi v0.87.0
 	github.com/go-chi/chi/v5 v5.0.7
 	github.com/gorilla/mux v1.8.0

versionware/example/releases/embed.go

@@ -11,4 +11,5 @@ import "embed"
 //go:embed 2021-11-08~experimental/spec.yaml
 //go:embed 2021-11-20~experimental/spec.json
 //go:embed 2021-11-20~experimental/spec.yaml
+// Versions contains OpenAPI specs for each distinct release version.
 var Versions embed.FS