Merge pull request #135 from kmala/swagger

feat(swagger): generate the server stub for the workflow manager api spec

Author: kmala

Makefile

@@ -9,9 +9,11 @@ export GO15VENDOREXPERIMENT=1
 # dockerized development environment variables
 REPO_PATH := github.com/deis/${SHORT_NAME}
 DEV_ENV_IMAGE := quay.io/deis/go-dev:0.9.1
+SWAGGER_IMAGE := quay.io/goswagger/swagger:0.5.0
 DEV_ENV_WORK_DIR := /go/src/${REPO_PATH}
 DEV_ENV_PREFIX := docker run --rm -e GO15VENDOREXPERIMENT=1 -v ${CURDIR}:${DEV_ENV_WORK_DIR} -w ${DEV_ENV_WORK_DIR}
 DEV_ENV_CMD := ${DEV_ENV_PREFIX} ${DEV_ENV_IMAGE}
+SWAGGER_CMD := docker run --rm -e GOPATH=/go -v ${CURDIR}:${DEV_ENV_WORK_DIR} -w ${DEV_ENV_WORK_DIR} ${SWAGGER_IMAGE}
 
 # SemVer with build information is defined in the SemVer 2 spec, but Docker
 # doesn't allow +, so we use -.
@@ -43,6 +45,9 @@ build:
 	@$(call check-static-binary,$(BINARY_DEST_DIR)/${SHORT_NAME})
 	${DEV_ENV_PREFIX} ${DEV_ENV_IMAGE} goupx --strip-binary -9 ${BINARY_DEST_DIR}/${SHORT_NAME} || exit 1
 
+swagger-serverstub:
+	${SWAGGER_CMD} generate server -A WorkflowManager -t pkg/swagger -f https://raw.githubusercontent.com/deis/workflow-manager/master/api/swagger-spec/swagger.yml
+
 test:
 	${DEV_ENV_CMD} sh -c 'go test -tags testonly $$(glide nv)'
 

glide.lock

@@ -20,3 +20,5 @@ import:
   - sqlite3
 - package: github.com/pborman/uuid
 - package: github.com/jinzhu/gorm
+- package: github.com/go-swagger/go-swagger
+  version: 0.5.0

glide.yaml

@@ -0,0 +1,45 @@
+package main
+
+import (
+	"log"
+	"os"
+
+	spec "github.com/go-swagger/go-swagger/spec"
+	flags "github.com/jessevdk/go-flags"
+
+	"github.com/deis/workflow-manager-api/pkg/swagger/restapi"
+	"github.com/deis/workflow-manager-api/pkg/swagger/restapi/operations"
+)
+
+// This file was generated by the swagger tool.
+// Make sure not to overwrite this file after you generated it because all your edits would be lost!
+
+func main() {
+	swaggerSpec, err := spec.New(restapi.SwaggerJSON, "")
+	if err != nil {
+		log.Fatalln(err)
+	}
+
+	api := operations.NewWorkflowManagerAPI(swaggerSpec)
+	server := restapi.NewServer(api)
+	defer server.Shutdown()
+
+	parser := flags.NewParser(server, flags.Default)
+	parser.ShortDescription = `Workflow Manager`
+	parser.LongDescription = swaggerSpec.Spec().Info.Description
+
+	server.ConfigureFlags()
+	for _, optsGroup := range api.CommandLineOptionsGroups {
+		parser.AddGroup(optsGroup.ShortDescription, optsGroup.LongDescription, optsGroup.Options)
+	}
+
+	if _, err := parser.Parse(); err != nil {
+		os.Exit(1)
+	}
+
+	server.ConfigureAPI()
+
+	if err := server.Serve(); err != nil {
+		log.Fatalln(err)
+	}
+}

pkg/swagger/cmd/workflow-manager-server/main.go

@@ -0,0 +1,92 @@
+package models
+
+// This file was generated by the swagger tool.
+// Editing this file might prove futile when you re-run the swagger generate command
+
+import (
+	strfmt "github.com/go-swagger/go-swagger/strfmt"
+
+	"github.com/go-swagger/go-swagger/errors"
+	"github.com/go-swagger/go-swagger/httpkit/validate"
+)
+
+/*ClusterDetail cluster detail
+
+swagger:model clusterDetail
+*/
+type ClusterDetail struct {
+
+	/* components
+
+	Required: true
+	*/
+	Components []*ComponentDetail `json:"components"`
+
+	/* first seen
+	 */
+	FirstSeen *strfmt.DateTime `json:"firstSeen,omitempty"`
+
+	/* id
+
+	Required: true
+	Min Length: 1
+	*/
+	ID string `json:"id"`
+
+	/* last seen
+	 */
+	LastSeen *strfmt.DateTime `json:"lastSeen,omitempty"`
+}
+
+// Validate validates this cluster detail
+func (m *ClusterDetail) Validate(formats strfmt.Registry) error {
+	var res []error
+
+	if err := m.validateComponents(formats); err != nil {
+		// prop
+		res = append(res, err)
+	}
+
+	if err := m.validateID(formats); err != nil {
+		// prop
+		res = append(res, err)
+	}
+
+	if len(res) > 0 {
+		return errors.CompositeValidationError(res...)
+	}
+	return nil
+}
+
+func (m *ClusterDetail) validateComponents(formats strfmt.Registry) error {
+
+	if err := validate.Required("components", "body", m.Components); err != nil {
+		return err
+	}
+
+	for i := 0; i < len(m.Components); i++ {
+
+		if m.Components[i] != nil {
+
+			if err := m.Components[i].Validate(formats); err != nil {
+				return err
+			}
+		}
+
+	}
+
+	return nil
+}
+
+func (m *ClusterDetail) validateID(formats strfmt.Registry) error {
+
+	if err := validate.RequiredString("id", "body", string(m.ID)); err != nil {
+		return err
+	}
+
+	if err := validate.MinLength("id", "body", string(m.ID), 1); err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/swagger/models/cluster_detail.go

@@ -0,0 +1,57 @@
+package models
+
+// This file was generated by the swagger tool.
+// Editing this file might prove futile when you re-run the swagger generate command
+
+import (
+	strfmt "github.com/go-swagger/go-swagger/strfmt"
+
+	"github.com/go-swagger/go-swagger/errors"
+	"github.com/go-swagger/go-swagger/httpkit/validate"
+)
+
+/*Component component
+
+swagger:model component
+*/
+type Component struct {
+
+	/* description
+	 */
+	Description *string `json:"description,omitempty"`
+
+	/* name
+
+	Required: true
+	Min Length: 1
+	*/
+	Name string `json:"name"`
+}
+
+// Validate validates this component
+func (m *Component) Validate(formats strfmt.Registry) error {
+	var res []error
+
+	if err := m.validateName(formats); err != nil {
+		// prop
+		res = append(res, err)
+	}
+
+	if len(res) > 0 {
+		return errors.CompositeValidationError(res...)
+	}
+	return nil
+}
+
+func (m *Component) validateName(formats strfmt.Registry) error {
+
+	if err := validate.RequiredString("name", "body", string(m.Name)); err != nil {
+		return err
+	}
+
+	if err := validate.MinLength("name", "body", string(m.Name), 1); err != nil {
+		return err
+	}
+
+	return nil
+}

pkg/swagger/models/component.go

@@ -0,0 +1,26 @@
+package models
+
+import "github.com/go-swagger/go-swagger/strfmt"
+
+// This file was generated by the swagger tool.
+// Editing this file might prove futile when you re-run the swagger generate command
+
+/*ComponentDetail component detail
+
+swagger:model componentDetail
+*/
+type ComponentDetail struct {
+
+	/* component
+	 */
+	Component *Component `json:"component,omitempty"`
+
+	/* version
+	 */
+	Version *Version `json:"version,omitempty"`
+}
+
+// Validate validates this component detail
+func (m *ComponentDetail) Validate(formats strfmt.Registry) error {
+	return nil
+}

pkg/swagger/models/component_detail.go

@@ -0,0 +1,77 @@
+package models
+
+// This file was generated by the swagger tool.
+// Editing this file might prove futile when you re-run the swagger generate command
+
+import (
+	strfmt "github.com/go-swagger/go-swagger/strfmt"
+	"github.com/go-swagger/go-swagger/swag"
+
+	"github.com/go-swagger/go-swagger/errors"
+	"github.com/go-swagger/go-swagger/httpkit/validate"
+)
+
+/*Data data
+
+swagger:model data
+*/
+type Data struct {
+
+	/* description
+
+	Min Length: 1
+	*/
+	Description string `json:"description,omitempty"`
+
+	/* fixes
+
+	Min Length: 1
+	*/
+	Fixes string `json:"fixes,omitempty"`
+}
+
+// Validate validates this data
+func (m *Data) Validate(formats strfmt.Registry) error {
+	var res []error
+
+	if err := m.validateDescription(formats); err != nil {
+		// prop
+		res = append(res, err)
+	}
+
+	if err := m.validateFixes(formats); err != nil {
+		// prop
+		res = append(res, err)
+	}
+
+	if len(res) > 0 {
+		return errors.CompositeValidationError(res...)
+	}
+	return nil
+}
+
+func (m *Data) validateDescription(formats strfmt.Registry) error {
+
+	if swag.IsZero(m.Description) { // not required
+		return nil
+	}
+
+	if err := validate.MinLength("description", "body", string(m.Description), 1); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (m *Data) validateFixes(formats strfmt.Registry) error {
+
+	if swag.IsZero(m.Fixes) { // not required
+		return nil
+	}
+
+	if err := validate.MinLength("fixes", "body", string(m.Fixes), 1); err != nil {
+		return err
+	}
+
+	return nil
+}