WIP

codegen/go-composite-schema/main.go

@@ -5,7 +5,6 @@ package main
 import (
 	"fmt"
 	"go/build"
-	"go/format"
 	"io/ioutil"
 	"log"
 	"os"
@@ -16,6 +15,7 @@ import (
 	"github.com/kr/text"
 	"github.com/taskcluster/jsonschema2go"
 	"github.com/taskcluster/taskcluster-base-go/jsontest"
+	"golang.org/x/tools/imports"
 )
 
 var (
@@ -105,7 +105,7 @@ func main() {
 		log.Fatalf("ERROR: Problem assembling content for file '%v': %s", goFile, err)
 	}
 	generatedCode = append(generatedCode, []byte("\n"+generateFunctions(ymlFile, j.SubSchema(url).TypeName, schemaProperty, req))...)
-	sourceCode, err := format.Source([]byte(generatedCode))
+	sourceCode, err := imports.Process(goFile, []byte(generatedCode), &imports.Options{AllErrors: true})
 	if err != nil {
 		log.Fatalf("ERROR: Could not format generated source code for file '%v': %s\nCode:\n%v", goFile, err, string(generatedCode))
 	}
@@ -129,21 +129,19 @@ func generateFunctions(ymlFile, goType, schemaProperty string, req bool) string
 	if err != nil {
 		log.Fatalf("ERROR: Problem pretty printing json in '%v' - %s", ymlFile, err)
 	}
-	result := "func " + goType + `Schema() runtime.CompositeSchema {
-		schema, err := runtime.NewCompositeSchema(
-			"` + schemaProperty + `", 
-			[]byte(` + "`\n" + text.Indent(fmt.Sprintf("%v", string(rawJson)), "\t\t") + "\n\t\t`" + `),
-			`
+	result := "func " + goType + "Schema() runtime.CompositeSchema {\n"
+	result += "schema, err := runtime.NewCompositeSchema(\n"
+	result += "\"" + schemaProperty + "\",\n"
+	result += "`\n" + text.Indent(fmt.Sprintf("%v", string(rawJson)), "\t\t") + "\n\t\t`" + ",\n"
 	if req {
-		result += `true,
-		`
+		result += "true,\n"
 	}
-	result += `func() interface{} { return &` + goType + `{} },
-		)
-		if err != nil {
-	    	panic(err)
-  		}
-    	return schema;
-	}`
+	result += "func() interface{} { return &" + goType + "{} },\n"
+	result += ")\n"
+	result += "if err != nil {\n"
+	result += "panic(err)\n"
+	result += "}\n"
+	result += "return schema\n"
+	result += "}"
 	return result
 }

engines/docker/config-schema.yml

@@ -1,12 +1,12 @@
 $schema:            http://json-schema.org/draft-04/schema#
 title:              Config
-description: |
+description: |-
   Config applicable to docker engine
 type:               object
 properties:
   rootVolume:
     title:          Root Volume
-    description: |
+    description: |-
       Root Volume blah blah
     type:           string
 additionalProperties: false

engines/docker/docker.go

@@ -1,4 +1,4 @@
-//go:generate schema-gen
+//go:generate go-composite-schema --required config config-schema.yml generated_configschema.go
 
 // comments
 package docker

engines/docker/generated_configschema.go

@@ -0,0 +1,40 @@
+package docker
+
+import "github.com/taskcluster/taskcluster-worker/runtime"
+
+type (
+	Config struct {
+		RootVolume string `json:"rootVolume"`
+	}
+)
+
+func ConfigSchema() runtime.CompositeSchema {
+	schema, err := runtime.NewCompositeSchema(
+		"config",
+		`
+		{
+		  "$schema": "http://json-schema.org/draft-04/schema#",
+		  "additionalProperties": false,
+		  "description": "Config applicable to docker engine",
+		  "properties": {
+		    "rootVolume": {
+		      "description": "Root Volume blah blah",
+		      "title": "Root Volume",
+		      "type": "string"
+		    }
+		  },
+		  "required": [
+		    "rootVolume"
+		  ],
+		  "title": "Config",
+		  "type": "object"
+		}
+		`,
+		true,
+		func() interface{} { return &Config{} },
+	)
+	if err != nil {
+		panic(err)
+	}
+	return schema
+}

engines/engine.go

@@ -40,9 +40,9 @@ type Engine interface {
 	// from this method.
 	PayloadSchema() runtime.CompositeSchema
 
-	// ConfigSchema returns the json schema that defines the structure of the
-	// config used by the engine
-	ConfigSchema() []byte
+	// ConfigSchema returns the CompositeSchema that represents the engine
+	// configuration
+	ConfigSchema() runtime.CompositeSchema
 
 	// Capabilities returns a structure declaring which features are supported,
 	// this is used for up-front feature checking. Unsupport methods must also
@@ -128,8 +128,8 @@ func (EngineBase) PayloadSchema() runtime.CompositeSchema {
 
 // ConfigSchema returns an empty jsonschema indicating that no custom config is
 // required.
-func (EngineBase) ConfigSchema() []byte {
-	return []byte("{}")
+func (EngineBase) ConfigSchema() runtime.CompositeSchema {
+	return runtime.NewEmptyCompositeSchema()
 }
 
 // Capabilities returns an zero value Capabilities struct indicating that

engines/mock/generatedcode.go → engines/mock/generated_payloadschema.go

@@ -1,29 +1,21 @@
-// This source code file is AUTO-GENERATED by github.com/taskcluster/jsonschema2go
-
 package mockengine
 
+import "github.com/taskcluster/taskcluster-worker/runtime"
+
 type (
 	Payload struct {
 		Argument string `json:"argument"`
 
 		Delay int `json:"delay"`
 
-		// Possible values:
-		//   * "true"
-		//   * "false"
-		//   * "set-volume"
-		//   * "get-volume"
-		//   * "ping-proxy"
-		//   * "write-log"
-		//   * "write-error-log"
 		Function string `json:"function"`
 	}
 )
 
 func PayloadSchema() runtime.CompositeSchema {
 	schema, err := runtime.NewCompositeSchema(
-		"p",
-		[]byte(`
+		"start",
+		`
 		{
 		  "$schema": "http://json-schema.org/draft-04/schema#",
 		  "additionalProperties": false,
@@ -55,7 +47,7 @@ func PayloadSchema() runtime.CompositeSchema {
 		  "title": "Payload",
 		  "type": "object"
 		}
-		`),
+		`,
 		true,
 		func() interface{} { return &Payload{} },
 	)

engines/mock/mockengine.go

@@ -1,4 +1,4 @@
-//go:generate go-composite-schema --required p payload-schema.yml generatedcode.go
+//go:generate go-composite-schema --required start payload-schema.yml generated_payloadschema.go
 
 // Package mockengine implements a MockEngine that doesn't really do anything,
 // but allows us to test plugins without having to run a real engine.
@@ -29,54 +29,21 @@ func init() {
 	}, "mock")
 }
 
-// task.payload.start when engine is "mock"
-type payload struct {
-	Function string `json:"function"`
-	Argument string `json:"argument"`
-	Delay    int64  `json:"delay"`
-}
-
 // mock config contains no fields
-func (e engine) ConfigSchema() []byte {
-	return []byte("{}")
+func (e engine) ConfigSchema() runtime.CompositeSchema {
+	return runtime.NewEmptyCompositeSchema()
 }
 
 func (e engine) PayloadSchema() runtime.CompositeSchema {
-	// Declare the schema for the "task.payload.start" property
-	schema, err := runtime.NewCompositeSchema("start", `{
-    "type": "object",
-    "properties": {
-      "delay": {"type": "integer"},
-      "function": {
-        "type": "string",
-        "enum": [
-          "true",
-          "false",
-          "set-volume",
-          "get-volume",
-          "ping-proxy",
-          "write-log",
-					"write-error-log"
-        ]
-      },
-      "argument": {"type": "string"}
-    },
-    "required": ["delay", "function", "argument"],
-    "additionalProperties": false
-  }`, true, func() interface{} { return &payload{} })
-	if err != nil {
-		// Any errors here are supposed to be static
-		panic(err)
-	}
-	return schema
+	return PayloadSchema()
 }
 
 func (e engine) NewSandboxBuilder(options engines.SandboxOptions) (engines.SandboxBuilder, error) {
 	// We know that payload was created with CompositeSchema.Parse() from the
 	// schema returned by PayloadSchema(), so here we type assert that it is
 	// indeed a pointer to such a thing.
 	e.Log.Debug("Building Sandbox")
-	p, valid := options.Payload.(*payload)
+	p, valid := options.Payload.(*Payload)
 	if !valid {
 		// TODO: Write to some sort of log if the type assertion fails
 		return nil, engines.ErrContractViolation

engines/mock/mocksandbox.go

@@ -29,7 +29,7 @@ type sandbox struct {
 	engines.SandboxBuilderBase
 	engines.SandboxBase
 	engines.ResultSetBase
-	payload *payload
+	payload *Payload
 	context *runtime.TaskContext
 	mounts  map[string]*mount
 	proxies map[string]http.Handler

engines/winnative/config-schema.yml

@@ -1,12 +1,12 @@
 $schema:            http://json-schema.org/draft-04/schema#
 title:              Config
-description: |
+description: |-
   Config applicable to windows native engine
 type:               object
 properties:
   usePsExec:
     title:          Use PSExec
-    description: |
+    description: |-
       Whether to use PSExec for executing processes
     type:           boolean
 additionalProperties: false