Move generated schemas into sub-folders (elastic#1024)

Author: roncohen

processor/error/schema.go renamed to processor/error/generated/schema/payload.go

@@ -15,13 +15,9 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package error
+package schema
 
-func Schema() string {
-	return errorSchema
-}
-
-var errorSchema = `{
+const PayloadSchema = `{
     "$id": "docs/spec/errors/payload.json",
     "title": "Errors payload",
     "description": "List of errors wrapped in an object containing some other attributes normalized away from the errors themselves",

processor/error/package_tests/json_schema_test.go

@@ -21,6 +21,7 @@ import (
 	"testing"
 
 	er "github.com/elastic/apm-server/processor/error"
+	"github.com/elastic/apm-server/processor/error/generated/schema"
 	"github.com/elastic/apm-server/tests"
 )
 
@@ -165,5 +166,5 @@ func TestPayloadAttributesInSchema(t *testing.T) {
 		"errors.context.request.cookies.c2",
 		"errors.context.tags.organization_uuid",
 	)
-	tests.TestPayloadAttributesInSchema(t, "error", undocumented, er.Schema())
+	tests.TestPayloadAttributesInSchema(t, "error", undocumented, schema.PayloadSchema)
 }

processor/error/processor.go

@@ -21,6 +21,7 @@ import (
 	"github.com/santhosh-tekuri/jsonschema"
 
 	pr "github.com/elastic/apm-server/processor"
+	"github.com/elastic/apm-server/processor/error/generated/schema"
 	"github.com/elastic/beats/libbeat/monitoring"
 )
 
@@ -37,10 +38,10 @@ const (
 	errorDocType  = "error"
 )
 
-var schema = pr.CreateSchema(errorSchema, processorName)
+var loadedSchema = pr.CreateSchema(schema.PayloadSchema, processorName)
 
 func NewProcessor() pr.Processor {
-	return &processor{schema: schema}
+	return &processor{schema: loadedSchema}
 }
 
 func (p *processor) Name() string {

processor/sourcemap/schema.go renamed to processor/sourcemap/generated/schema/payload.go

@@ -15,13 +15,9 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package sourcemap
+package schema
 
-func Schema() string {
-	return sourcemapSchema
-}
-
-var sourcemapSchema = `{
+const PayloadSchema = `{
     "$id": "docs/spec/sourcemaps/sourcemap-metadata.json",
     "title": "Sourcemap Metadata",
     "description": "Sourcemap Metadata",

processor/sourcemap/package_tests/json_schema_test.go

@@ -21,6 +21,7 @@ import (
 	"testing"
 
 	sm "github.com/elastic/apm-server/processor/sourcemap"
+	"github.com/elastic/apm-server/processor/sourcemap/generated/schema"
 	"github.com/elastic/apm-server/tests"
 )
 
@@ -31,7 +32,7 @@ func TestPayloadAttributesInSchema(t *testing.T) {
 		"sourcemap",
 		tests.NewSet("sourcemap", "sourcemap.file", "sourcemap.names", "sourcemap.sources", "sourcemap.sourceRoot",
 			"sourcemap.mappings", "sourcemap.sourcesContent", "sourcemap.version"),
-		sm.Schema())
+		schema.PayloadSchema)
 }
 
 var (

processor/sourcemap/processor.go

@@ -26,6 +26,7 @@ import (
 	parser "github.com/go-sourcemap/sourcemap"
 
 	pr "github.com/elastic/apm-server/processor"
+	"github.com/elastic/apm-server/processor/sourcemap/generated/schema"
 	"github.com/elastic/apm-server/utility"
 	"github.com/elastic/beats/libbeat/monitoring"
 )
@@ -43,10 +44,10 @@ var (
 	decodingError          = monitoring.NewInt(sourcemapUploadMetrics, "decoding.errors")
 )
 
-var schema = pr.CreateSchema(sourcemapSchema, processorName)
+var loadedSchema = pr.CreateSchema(schema.PayloadSchema, processorName)
 
 func NewProcessor() pr.Processor {
-	return &processor{schema: schema}
+	return &processor{schema: loadedSchema}
 }
 
 func (p *processor) Name() string {

processor/transaction/schema.go renamed to processor/transaction/generated/schema/payload.go

@@ -15,13 +15,9 @@
 // specific language governing permissions and limitations
 // under the License.
 
-package transaction
+package schema
 
-func Schema() string {
-	return transactionSchema
-}
-
-var transactionSchema = `{
+const PayloadSchema = `{
     "$id": "docs/spec/transactions/payload.json",
     "title": "Transactions payload",
     "description": "List of transactions wrapped in an object containing some other attributes normalized away from the transactions themselves",

processor/transaction/package_tests/json_schema_test.go

@@ -21,6 +21,7 @@ import (
 	"testing"
 
 	tr "github.com/elastic/apm-server/processor/transaction"
+	"github.com/elastic/apm-server/processor/transaction/generated/schema"
 	"github.com/elastic/apm-server/tests"
 )
 
@@ -190,5 +191,5 @@ func TestPayloadAttributesInSchema(t *testing.T) {
 		"transactions.marks.navigationTiming.navigationStart",
 		"transactions.marks.performance",
 	)
-	tests.TestPayloadAttributesInSchema(t, "transaction", undocumented, tr.Schema())
+	tests.TestPayloadAttributesInSchema(t, "transaction", undocumented, schema.PayloadSchema)
 }

processor/transaction/processor.go

@@ -19,6 +19,7 @@ package transaction
 
 import (
 	pr "github.com/elastic/apm-server/processor"
+	"github.com/elastic/apm-server/processor/transaction/generated/schema"
 	"github.com/elastic/beats/libbeat/monitoring"
 
 	"github.com/santhosh-tekuri/jsonschema"
@@ -38,10 +39,10 @@ const (
 	spanDocType        = "span"
 )
 
-var schema = pr.CreateSchema(transactionSchema, processorName)
+var loadedSchema = pr.CreateSchema(schema.PayloadSchema, processorName)
 
 func NewProcessor() pr.Processor {
-	return &processor{schema: schema}
+	return &processor{schema: loadedSchema}
 }
 
 type processor struct {

script/inline_schemas/inline_schemas.go

@@ -20,6 +20,8 @@ package main
 import (
 	"fmt"
 	"io/ioutil"
+	"os"
+	"path"
 	"path/filepath"
 	"regexp"
 	"strings"
@@ -29,11 +31,11 @@ const basePath = "./docs/spec/"
 
 func main() {
 	schemaPaths := []struct {
-		path, schemaOut, goVariable, packageName string
+		path, schemaOut string
 	}{
-		{"errors/payload.json", "processor/error/schema.go", "errorSchema", "error"},
-		{"transactions/payload.json", "processor/transaction/schema.go", "transactionSchema", "transaction"},
-		{"sourcemaps/payload.json", "processor/sourcemap/schema.go", "sourcemapSchema", "sourcemap"},
+		{"errors/payload.json", "processor/error/generated/schema/payload.go"},
+		{"transactions/payload.json", "processor/transaction/generated/schema/payload.go"},
+		{"sourcemaps/payload.json", "processor/sourcemap/generated/schema/payload.go"},
 	}
 	for _, schemaInfo := range schemaPaths {
 		file := filepath.Join(filepath.Dir(basePath), schemaInfo.path)
@@ -47,8 +49,11 @@ func main() {
 			panic(err)
 		}
 
-		publicSchema := fmt.Sprintf("func Schema() string {\n\treturn %s\n}\n", schemaInfo.goVariable)
-		goScript := fmt.Sprintf("package %s\n\n%s\nvar %s = `%s`\n", schemaInfo.packageName, publicSchema, schemaInfo.goVariable, schema)
+		goScript := fmt.Sprintf("package schema\n\nconst PayloadSchema = `%s`\n", schema)
+		err = os.MkdirAll(path.Dir(schemaInfo.schemaOut), os.ModePerm)
+		if err != nil {
+			panic(err)
+		}
 		err = ioutil.WriteFile(schemaInfo.schemaOut, []byte(goScript), 0644)
 		if err != nil {
 			panic(err)