mirror of https://github.com/go-gitea/gitea.git
84 lines
2.6 KiB
Go
84 lines
2.6 KiB
Go
// Copyright 2015 go-swagger maintainers
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package commands
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"log"
|
|
|
|
"github.com/go-openapi/loads"
|
|
"github.com/go-openapi/strfmt"
|
|
"github.com/go-openapi/validate"
|
|
)
|
|
|
|
const (
|
|
// Output messages
|
|
missingArgMsg = "The validate command requires the swagger document url to be specified"
|
|
validSpecMsg = "\nThe swagger spec at %q is valid against swagger specification %s\n"
|
|
invalidSpecMsg = "\nThe swagger spec at %q is invalid against swagger specification %s.\nSee errors below:\n"
|
|
warningSpecMsg = "\nThe swagger spec at %q showed up some valid but possibly unwanted constructs."
|
|
)
|
|
|
|
// ValidateSpec is a command that validates a swagger document
|
|
// against the swagger specification
|
|
type ValidateSpec struct {
|
|
// SchemaURL string `long:"schema" description:"The schema url to use" default:"http://swagger.io/v2/schema.json"`
|
|
SkipWarnings bool `long:"skip-warnings" description:"when present will not show up warnings upon validation"`
|
|
StopOnError bool `long:"stop-on-error" description:"when present will not continue validation after critical errors are found"`
|
|
}
|
|
|
|
// Execute validates the spec
|
|
func (c *ValidateSpec) Execute(args []string) error {
|
|
if len(args) == 0 {
|
|
return errors.New(missingArgMsg)
|
|
}
|
|
|
|
swaggerDoc := args[0]
|
|
|
|
specDoc, err := loads.Spec(swaggerDoc)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// Attempts to report about all errors
|
|
validate.SetContinueOnErrors(!c.StopOnError)
|
|
|
|
v := validate.NewSpecValidator(specDoc.Schema(), strfmt.Default)
|
|
result, _ := v.Validate(specDoc) // returns fully detailed result with errors and warnings
|
|
|
|
if result.IsValid() {
|
|
log.Printf(validSpecMsg, swaggerDoc, specDoc.Version())
|
|
}
|
|
if result.HasWarnings() {
|
|
log.Printf(warningSpecMsg, swaggerDoc)
|
|
if !c.SkipWarnings {
|
|
log.Printf("See warnings below:\n")
|
|
for _, desc := range result.Warnings {
|
|
log.Printf("- WARNING: %s\n", desc.Error())
|
|
}
|
|
}
|
|
}
|
|
if result.HasErrors() {
|
|
str := fmt.Sprintf(invalidSpecMsg, swaggerDoc, specDoc.Version())
|
|
for _, desc := range result.Errors {
|
|
str += fmt.Sprintf("- %s\n", desc.Error())
|
|
}
|
|
return errors.New(str)
|
|
}
|
|
|
|
return nil
|
|
}
|