pax_global_header00006660000000000000000000000064141107757540014525gustar00rootroot0000000000000052 comment=b4f29f3f18d54326c4d11651cddc38465e0e100c errors-0.20.1/000077500000000000000000000000001411077575400131215ustar00rootroot00000000000000errors-0.20.1/.github/000077500000000000000000000000001411077575400144615ustar00rootroot00000000000000errors-0.20.1/.github/CONTRIBUTING.md000066400000000000000000000114601411077575400167140ustar00rootroot00000000000000## Contribution Guidelines ### Pull requests are always welcome We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it. If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve. We're trying very hard to keep go-swagger lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. However, there might be a way to implement that feature *on top of* go-swagger. ### Conventions Fork the repo and make changes on your fork in a feature branch: - If it's a bugfix branch, name it XXX-something where XXX is the number of the issue - If it's a feature branch, create an enhancement issue to announce your intentions, and name it XXX-something where XXX is the number of the issue. Submit unit tests for your changes. Go has a great test framework built in; use it! Take a look at existing tests for inspiration. Run the full test suite on your branch before submitting a pull request. Update the documentation when creating or modifying features. Test your documentation changes for clarity, concision, and correctness, as well as a clean documentation build. See ``docs/README.md`` for more information on building the docs and how docs get released. Write clean code. Universally formatted code promotes ease of writing, reading, and maintenance. Always run `gofmt -s -w file.go` on each changed file before committing your changes. Most editors have plugins that do this automatically. Pull requests descriptions should be as clear as possible and include a reference to all the issues that they address. Pull requests must not contain commits from other users or branches. Commit messages must start with a capitalized and short summary (max. 50 chars) written in the imperative, followed by an optional, more detailed explanatory text which is separated from the summary by an empty line. Code review comments may be added to your pull request. Discuss, then make the suggested modifications and push additional commits to your feature branch. Be sure to post a comment after pushing. The new commits will show up in the pull request automatically, but the reviewers will not be notified unless you comment. Before the pull request is merged, make sure that you squash your commits into logical units of work using `git rebase -i` and `git push -f`. After every commit the test suite should be passing. Include documentation changes in the same commit so that a revert would remove all traces of the feature or fix. Commits that fix or close an issue should include a reference like `Closes #XXX` or `Fixes #XXX`, which will automatically close the issue when merged. ### Sign your work The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from [developercertificate.org](http://developercertificate.org/)): ``` Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 660 York Street, Suite 102, San Francisco, CA 94110 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. ``` then you just add a line to every git commit message: Signed-off-by: Joe Smith using your real name (sorry, no pseudonyms or anonymous contributions.) You can add the sign off when creating the git commit via `git commit -s`. errors-0.20.1/.gitignore000066400000000000000000000000311411077575400151030ustar00rootroot00000000000000secrets.yml coverage.out errors-0.20.1/.golangci.yml000066400000000000000000000012431411077575400155050ustar00rootroot00000000000000linters-settings: govet: check-shadowing: true golint: min-confidence: 0 gocyclo: min-complexity: 30 maligned: suggest-new: true dupl: threshold: 100 goconst: min-len: 2 min-occurrences: 4 linters: enable-all: true disable: - maligned - lll - gochecknoglobals - godox - gocognit - whitespace - wsl - funlen - gochecknoglobals - gochecknoinits - scopelint - wrapcheck - exhaustivestruct - exhaustive - nlreturn - testpackage - gci - gofumpt - goerr113 - gomnd - tparallel - nestif - godot - errorlint - paralleltest - tparallel errors-0.20.1/.travis.yml000066400000000000000000000025131411077575400152330ustar00rootroot00000000000000after_success: - bash <(curl -s https://codecov.io/bash) go: - 1.14.x - 1.x arch: - amd64 jobs: include: # only run fast tests on ppc64le - go: 1.x arch: ppc64le script: - gotestsum -f short-verbose -- ./... # include linting job, but only for latest go version and amd64 arch - go: 1.x arch: amd64 install: go get github.com/golangci/golangci-lint/cmd/golangci-lint script: - golangci-lint run --new-from-rev master install: - GO111MODULE=off go get -u gotest.tools/gotestsum language: go notifications: slack: secure: gZGp9NaHxi7zawlXJXKY92BGeDR1x0tbIcTyU5nMKLq0fhIaiEBJEeALwZ4VgqsSv3DytSSF5mLH8fevAM3ixE6hxjKQ+lQuf7V/w3btCN1CSWgoua5LOh1kTnqZQtJuRvO4pzoJcT3bJWBsVZ07VGNVzzJEy/zAKCHFqBUCXShw7QemlLBcYWFNqveTlvDIfCzvouoLnPoXwxEpkjxe9uz/ZKZgAnup/fXjC8RFctmgCnkCyvJTk0Y/fZCsufixJrJhshBWTnlrFCzRmgNkz2d+i1Ls3+MJ5EJJ2Tx/A5S63dL49J1f9Kr0AKHADmulSy8JNzIckKwbyFMYUecrsW+Lsu9DhnVMy1jj5pKsJDLRi2iIU3fXTMWbcyQbXjbbnBO2mPdP3Tzme75y4D9fc8hUPeyqVv2BU26NEbQ7EF2pKJ93OXvci7HlwRBgdJa8j6mP2LEDClcPQW00g7N/OZe0cTOMa8L5AwiBlbArwqt9wv6YLJoTG0wpDhzWsFvbCg5bJxe28Yn3fIDD0Lk1I7iSnBbp/5gzF19jmxqvcT8tHRkDL4xfjbENFTZjA5uB4Z4pj4WSyWQILLV/Jwhe3fi9uQwdviFHfj5pnVrmNUiGSOQL672K5wl2c3E9mGwejvsu2dfEz28n7Y/FUnOpY3/cBS0n27JJaerS0zMKNLE= script: - gotestsum -f short-verbose -- -race -coverprofile=coverage.txt -covermode=atomic ./... errors-0.20.1/CODE_OF_CONDUCT.md000066400000000000000000000062411411077575400157230ustar00rootroot00000000000000# Contributor Covenant Code of Conduct ## Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. ## Scope This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ivan+abuse@flanders.co.nz. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] [homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/ errors-0.20.1/LICENSE000066400000000000000000000261361411077575400141360ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] 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. errors-0.20.1/README.md000066400000000000000000000017031411077575400144010ustar00rootroot00000000000000# OpenAPI errors [![Build Status](https://travis-ci.org/go-openapi/errors.svg?branch=master)](https://travis-ci.org/go-openapi/errors) [![codecov](https://codecov.io/gh/go-openapi/errors/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/errors) [![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io) [![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/errors/master/LICENSE) [![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/errors.svg)](https://pkg.go.dev/github.com/go-openapi/errors) [![GolangCI](https://golangci.com/badges/github.com/go-openapi/errors.svg)](https://golangci.com) [![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/errors)](https://goreportcard.com/report/github.com/go-openapi/errors) Shared errors and error interface used throughout the various libraries found in the go-openapi toolkit. errors-0.20.1/api.go000066400000000000000000000114741411077575400142300ustar00rootroot00000000000000// 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 errors import ( "encoding/json" "fmt" "net/http" "reflect" "strings" ) // DefaultHTTPCode is used when the error Code cannot be used as an HTTP code. var DefaultHTTPCode = http.StatusUnprocessableEntity // Error represents a error interface all swagger framework errors implement type Error interface { error Code() int32 } type apiError struct { code int32 message string } func (a *apiError) Error() string { return a.message } func (a *apiError) Code() int32 { return a.code } // MarshalJSON implements the JSON encoding interface func (a apiError) MarshalJSON() ([]byte, error) { return json.Marshal(map[string]interface{}{ "code": a.code, "message": a.message, }) } // New creates a new API error with a code and a message func New(code int32, message string, args ...interface{}) Error { if len(args) > 0 { return &apiError{code, fmt.Sprintf(message, args...)} } return &apiError{code, message} } // NotFound creates a new not found error func NotFound(message string, args ...interface{}) Error { if message == "" { message = "Not found" } return New(http.StatusNotFound, fmt.Sprintf(message, args...)) } // NotImplemented creates a new not implemented error func NotImplemented(message string) Error { return New(http.StatusNotImplemented, message) } // MethodNotAllowedError represents an error for when the path matches but the method doesn't type MethodNotAllowedError struct { code int32 Allowed []string message string } func (m *MethodNotAllowedError) Error() string { return m.message } // Code the error code func (m *MethodNotAllowedError) Code() int32 { return m.code } // MarshalJSON implements the JSON encoding interface func (m MethodNotAllowedError) MarshalJSON() ([]byte, error) { return json.Marshal(map[string]interface{}{ "code": m.code, "message": m.message, "allowed": m.Allowed, }) } func errorAsJSON(err Error) []byte { b, _ := json.Marshal(struct { Code int32 `json:"code"` Message string `json:"message"` }{err.Code(), err.Error()}) return b } func flattenComposite(errs *CompositeError) *CompositeError { var res []error for _, er := range errs.Errors { switch e := er.(type) { case *CompositeError: if len(e.Errors) > 0 { flat := flattenComposite(e) if len(flat.Errors) > 0 { res = append(res, flat.Errors...) } } default: if e != nil { res = append(res, e) } } } return CompositeValidationError(res...) } // MethodNotAllowed creates a new method not allowed error func MethodNotAllowed(requested string, allow []string) Error { msg := fmt.Sprintf("method %s is not allowed, but [%s] are", requested, strings.Join(allow, ",")) return &MethodNotAllowedError{code: http.StatusMethodNotAllowed, Allowed: allow, message: msg} } // ServeError the error handler interface implementation func ServeError(rw http.ResponseWriter, r *http.Request, err error) { rw.Header().Set("Content-Type", "application/json") switch e := err.(type) { case *CompositeError: er := flattenComposite(e) // strips composite errors to first element only if len(er.Errors) > 0 { ServeError(rw, r, er.Errors[0]) } else { // guard against empty CompositeError (invalid construct) ServeError(rw, r, nil) } case *MethodNotAllowedError: rw.Header().Add("Allow", strings.Join(err.(*MethodNotAllowedError).Allowed, ",")) rw.WriteHeader(asHTTPCode(int(e.Code()))) if r == nil || r.Method != http.MethodHead { _, _ = rw.Write(errorAsJSON(e)) } case Error: value := reflect.ValueOf(e) if value.Kind() == reflect.Ptr && value.IsNil() { rw.WriteHeader(http.StatusInternalServerError) _, _ = rw.Write(errorAsJSON(New(http.StatusInternalServerError, "Unknown error"))) return } rw.WriteHeader(asHTTPCode(int(e.Code()))) if r == nil || r.Method != http.MethodHead { _, _ = rw.Write(errorAsJSON(e)) } case nil: rw.WriteHeader(http.StatusInternalServerError) _, _ = rw.Write(errorAsJSON(New(http.StatusInternalServerError, "Unknown error"))) default: rw.WriteHeader(http.StatusInternalServerError) if r == nil || r.Method != http.MethodHead { _, _ = rw.Write(errorAsJSON(New(http.StatusInternalServerError, err.Error()))) } } } func asHTTPCode(input int) int { if input >= 600 { return DefaultHTTPCode } return input } errors-0.20.1/api_test.go000066400000000000000000000212251411077575400152620ustar00rootroot00000000000000// 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 errors import ( "fmt" "net/http" "net/http/httptest" "strings" "testing" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) type customError struct { apiError } func TestServeError(t *testing.T) { // method not allowed wins // err abides by the Error interface err := MethodNotAllowed("GET", []string{"POST", "PUT"}) recorder := httptest.NewRecorder() ServeError(recorder, nil, err) assert.Equal(t, http.StatusMethodNotAllowed, recorder.Code) assert.Equal(t, "POST,PUT", recorder.Header().Get("Allow")) // assert.Equal(t, "application/json", recorder.Header().Get("content-type")) assert.Equal(t, `{"code":405,"message":"method GET is not allowed, but [POST,PUT] are"}`, recorder.Body.String()) // renders status code from error when present err = NotFound("") recorder = httptest.NewRecorder() ServeError(recorder, nil, err) assert.Equal(t, http.StatusNotFound, recorder.Code) // assert.Equal(t, "application/json", recorder.Header().Get("content-type")) assert.Equal(t, `{"code":404,"message":"Not found"}`, recorder.Body.String()) // renders mapped status code from error when present err = InvalidTypeName("someType") recorder = httptest.NewRecorder() ServeError(recorder, nil, err) assert.Equal(t, http.StatusUnprocessableEntity, recorder.Code) // assert.Equal(t, "application/json", recorder.Header().Get("content-type")) assert.Equal(t, `{"code":601,"message":"someType is an invalid type name"}`, recorder.Body.String()) // same, but override DefaultHTTPCode func() { oldDefaultHTTPCode := DefaultHTTPCode defer func() { DefaultHTTPCode = oldDefaultHTTPCode }() DefaultHTTPCode = http.StatusBadRequest err = InvalidTypeName("someType") recorder = httptest.NewRecorder() ServeError(recorder, nil, err) assert.Equal(t, http.StatusBadRequest, recorder.Code) // assert.Equal(t, "application/json", recorder.Header().Get("content-type")) assert.Equal(t, `{"code":601,"message":"someType is an invalid type name"}`, recorder.Body.String()) }() // defaults to internal server error simpleErr := fmt.Errorf("some error") recorder = httptest.NewRecorder() ServeError(recorder, nil, simpleErr) assert.Equal(t, http.StatusInternalServerError, recorder.Code) // assert.Equal(t, "application/json", recorder.Header().Get("content-type")) assert.Equal(t, `{"code":500,"message":"some error"}`, recorder.Body.String()) // composite errors // unrecognized: return internal error with first error only - the second error is ignored compositeErr := &CompositeError{ Errors: []error{ fmt.Errorf("firstError"), fmt.Errorf("anotherError"), }, } recorder = httptest.NewRecorder() ServeError(recorder, nil, compositeErr) assert.Equal(t, http.StatusInternalServerError, recorder.Code) assert.Equal(t, `{"code":500,"message":"firstError"}`, recorder.Body.String()) // recognized: return internal error with first error only - the second error is ignored compositeErr = &CompositeError{ Errors: []error{ New(600, "myApiError"), New(601, "myOtherApiError"), }, } recorder = httptest.NewRecorder() ServeError(recorder, nil, compositeErr) assert.Equal(t, CompositeErrorCode, recorder.Code) assert.Equal(t, `{"code":600,"message":"myApiError"}`, recorder.Body.String()) // recognized API Error, flattened compositeErr = &CompositeError{ Errors: []error{ &CompositeError{ Errors: []error{ New(600, "myApiError"), New(601, "myOtherApiError"), }, }, }, } recorder = httptest.NewRecorder() ServeError(recorder, nil, compositeErr) assert.Equal(t, CompositeErrorCode, recorder.Code) assert.Equal(t, `{"code":600,"message":"myApiError"}`, recorder.Body.String()) // check guard against empty CompositeError (e.g. nil Error interface) compositeErr = &CompositeError{ Errors: []error{ &CompositeError{ Errors: []error{}, }, }, } recorder = httptest.NewRecorder() ServeError(recorder, nil, compositeErr) assert.Equal(t, http.StatusInternalServerError, recorder.Code) assert.Equal(t, `{"code":500,"message":"Unknown error"}`, recorder.Body.String()) // check guard against nil type recorder = httptest.NewRecorder() ServeError(recorder, nil, nil) assert.Equal(t, http.StatusInternalServerError, recorder.Code) assert.Equal(t, `{"code":500,"message":"Unknown error"}`, recorder.Body.String()) recorder = httptest.NewRecorder() var z *customError ServeError(recorder, nil, z) assert.Equal(t, http.StatusInternalServerError, recorder.Code) assert.Equal(t, `{"code":500,"message":"Unknown error"}`, recorder.Body.String()) } func TestAPIErrors(t *testing.T) { err := New(402, "this failed %s", "yada") assert.Error(t, err) assert.EqualValues(t, 402, err.Code()) assert.EqualValues(t, "this failed yada", err.Error()) err = NotFound("this failed %d", 1) assert.Error(t, err) assert.EqualValues(t, http.StatusNotFound, err.Code()) assert.EqualValues(t, "this failed 1", err.Error()) err = NotFound("") assert.Error(t, err) assert.EqualValues(t, http.StatusNotFound, err.Code()) assert.EqualValues(t, "Not found", err.Error()) err = NotImplemented("not implemented") assert.Error(t, err) assert.EqualValues(t, http.StatusNotImplemented, err.Code()) assert.EqualValues(t, "not implemented", err.Error()) err = MethodNotAllowed("GET", []string{"POST", "PUT"}) assert.Error(t, err) assert.EqualValues(t, http.StatusMethodNotAllowed, err.Code()) assert.EqualValues(t, "method GET is not allowed, but [POST,PUT] are", err.Error()) err = InvalidContentType("application/saml", []string{"application/json", "application/x-yaml"}) assert.Error(t, err) assert.EqualValues(t, http.StatusUnsupportedMediaType, err.Code()) assert.EqualValues(t, "unsupported media type \"application/saml\", only [application/json application/x-yaml] are allowed", err.Error()) err = InvalidResponseFormat("application/saml", []string{"application/json", "application/x-yaml"}) assert.Error(t, err) assert.EqualValues(t, http.StatusNotAcceptable, err.Code()) assert.EqualValues(t, "unsupported media type requested, only [application/json application/x-yaml] are available", err.Error()) } func TestValidateName(t *testing.T) { v := &Validation{Name: "myValidation", message: "myMessage"} // unchanged vv := v.ValidateName("") assert.EqualValues(t, "myValidation", vv.Name) assert.EqualValues(t, "myMessage", vv.message) // unchanged vv = v.ValidateName("myNewName") assert.EqualValues(t, "myValidation", vv.Name) assert.EqualValues(t, "myMessage", vv.message) v.Name = "" // unchanged vv = v.ValidateName("") assert.EqualValues(t, "", vv.Name) assert.EqualValues(t, "myMessage", vv.message) // forced vv = v.ValidateName("myNewName") assert.EqualValues(t, "myNewName", vv.Name) assert.EqualValues(t, "myNewNamemyMessage", vv.message) } func TestMarshalJSON(t *testing.T) { const ( expectedCode = http.StatusUnsupportedMediaType value = "myValue" ) list := []string{"a", "b"} e := InvalidContentType(value, list) jazon, err := e.MarshalJSON() require.NoError(t, err) expectedMessage := strings.ReplaceAll(fmt.Sprintf(contentTypeFail, value, list), `"`, `\"`) expectedJSON := fmt.Sprintf( `{"code":%d,"message":"%s","name":"Content-Type","in":"header","value":"%s","values":["a","b"]}`, expectedCode, expectedMessage, value, ) assert.JSONEq(t, expectedJSON, string(jazon)) a := apiError{code: 1, message: "a"} jazon, err = a.MarshalJSON() require.NoError(t, err) assert.JSONEq(t, `{"code":1,"message":"a"}`, string(jazon)) m := MethodNotAllowedError{code: 1, message: "a", Allowed: []string{"POST"}} jazon, err = m.MarshalJSON() require.NoError(t, err) assert.JSONEq(t, `{"code":1,"message":"a","allowed":["POST"]}`, string(jazon)) c := CompositeError{Errors: []error{e}, code: 1, message: "a"} jazon, err = c.MarshalJSON() require.NoError(t, err) assert.JSONEq(t, fmt.Sprintf(`{"code":1,"message":"a","errors":[%s]}`, expectedJSON), string(jazon)) p := ParseError{code: 1, message: "x", Name: "a", In: "b", Value: "c", Reason: fmt.Errorf("d")} jazon, err = p.MarshalJSON() require.NoError(t, err) assert.JSONEq(t, `{"code":1,"message":"x","name":"a","in":"b","value":"c","reason":"d"}`, string(jazon)) } errors-0.20.1/auth.go000066400000000000000000000014431411077575400144130ustar00rootroot00000000000000// 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 errors import "net/http" // Unauthenticated returns an unauthenticated error func Unauthenticated(scheme string) Error { return New(http.StatusUnauthorized, "unauthenticated for %s", scheme) } errors-0.20.1/auth_test.go000066400000000000000000000015241411077575400154520ustar00rootroot00000000000000// 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 errors import ( "testing" "github.com/stretchr/testify/assert" ) func TestUnauthenticated(t *testing.T) { err := Unauthenticated("basic") assert.EqualValues(t, 401, err.Code()) assert.Equal(t, "unauthenticated for basic", err.Error()) } errors-0.20.1/doc.go000066400000000000000000000016761411077575400142270ustar00rootroot00000000000000// 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 errors provides an Error interface and several concrete types implementing this interface to manage API errors and JSON-schema validation errors. A middleware handler ServeError() is provided to serve the errors types it defines. It is used throughout the various go-openapi toolkit libraries (https://github.com/go-openapi). */ package errors errors-0.20.1/go.mod000066400000000000000000000006021411077575400142250ustar00rootroot00000000000000module github.com/go-openapi/errors go 1.14 require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/kr/text v0.2.0 // indirect github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect github.com/stretchr/testify v1.6.1 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f // indirect gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c // indirect ) errors-0.20.1/go.sum000066400000000000000000000045141411077575400142600ustar00rootroot00000000000000github.com/creack/pty v1.1.9 h1:uDmaGzcdjhF4i/plgjmEsriH11Y0o7RKapEf/LDaM3w= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/kr/pty v1.1.1 h1:VkoXIwSboBpnk99O/KFauAEILuNHv5DVFKZMBN/gUgw= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU= gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c h1:grhR+C34yXImVGp7EzNk+DTIk+323eIUWOmEevy6bDo= gopkg.in/yaml.v3 v3.0.0-20200605160147-a5ece683394c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= errors-0.20.1/headers.go000066400000000000000000000051541411077575400150700ustar00rootroot00000000000000// 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 errors import ( "encoding/json" "fmt" "net/http" ) // Validation represents a failure of a precondition type Validation struct { code int32 Name string In string Value interface{} message string Values []interface{} } func (e *Validation) Error() string { return e.message } // Code the error code func (e *Validation) Code() int32 { return e.code } // MarshalJSON implements the JSON encoding interface func (e Validation) MarshalJSON() ([]byte, error) { return json.Marshal(map[string]interface{}{ "code": e.code, "message": e.message, "in": e.In, "name": e.Name, "value": e.Value, "values": e.Values, }) } // ValidateName sets the name for a validation or updates it for a nested property func (e *Validation) ValidateName(name string) *Validation { if name != "" { if e.Name == "" { e.Name = name e.message = name + e.message } else { e.Name = name + "." + e.Name e.message = name + "." + e.message } } return e } const ( contentTypeFail = `unsupported media type %q, only %v are allowed` responseFormatFail = `unsupported media type requested, only %v are available` ) // InvalidContentType error for an invalid content type func InvalidContentType(value string, allowed []string) *Validation { values := make([]interface{}, 0, len(allowed)) for _, v := range allowed { values = append(values, v) } return &Validation{ code: http.StatusUnsupportedMediaType, Name: "Content-Type", In: "header", Value: value, Values: values, message: fmt.Sprintf(contentTypeFail, value, allowed), } } // InvalidResponseFormat error for an unacceptable response format request func InvalidResponseFormat(value string, allowed []string) *Validation { values := make([]interface{}, 0, len(allowed)) for _, v := range allowed { values = append(values, v) } return &Validation{ code: http.StatusNotAcceptable, Name: "Accept", In: "header", Value: value, Values: values, message: fmt.Sprintf(responseFormatFail, allowed), } } errors-0.20.1/middleware.go000066400000000000000000000030761411077575400155730ustar00rootroot00000000000000// 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 errors import ( "bytes" "fmt" "strings" ) // APIVerificationFailed is an error that contains all the missing info for a mismatched section // between the api registrations and the api spec type APIVerificationFailed struct { Section string `json:"section,omitempty"` MissingSpecification []string `json:"missingSpecification,omitempty"` MissingRegistration []string `json:"missingRegistration,omitempty"` } // func (v *APIVerificationFailed) Error() string { buf := bytes.NewBuffer(nil) hasRegMissing := len(v.MissingRegistration) > 0 hasSpecMissing := len(v.MissingSpecification) > 0 if hasRegMissing { buf.WriteString(fmt.Sprintf("missing [%s] %s registrations", strings.Join(v.MissingRegistration, ", "), v.Section)) } if hasRegMissing && hasSpecMissing { buf.WriteString("\n") } if hasSpecMissing { buf.WriteString(fmt.Sprintf("missing from spec file [%s] %s", strings.Join(v.MissingSpecification, ", "), v.Section)) } return buf.String() } errors-0.20.1/middleware_test.go000066400000000000000000000021461411077575400166270ustar00rootroot00000000000000// 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 errors import ( "testing" "github.com/stretchr/testify/assert" ) func TestAPIVerificationFailed(t *testing.T) { err := &APIVerificationFailed{ Section: "consumer", MissingSpecification: []string{"application/json", "application/x-yaml"}, MissingRegistration: []string{"text/html", "application/xml"}, } expected := `missing [text/html, application/xml] consumer registrations missing from spec file [application/json, application/x-yaml] consumer` assert.Equal(t, expected, err.Error()) } errors-0.20.1/parsing.go000066400000000000000000000035721411077575400151220ustar00rootroot00000000000000// 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 errors import ( "encoding/json" "fmt" ) // ParseError represents a parsing error type ParseError struct { code int32 Name string In string Value string Reason error message string } func (e *ParseError) Error() string { return e.message } // Code returns the http status code for this error func (e *ParseError) Code() int32 { return e.code } // MarshalJSON implements the JSON encoding interface func (e ParseError) MarshalJSON() ([]byte, error) { var reason string if e.Reason != nil { reason = e.Reason.Error() } return json.Marshal(map[string]interface{}{ "code": e.code, "message": e.message, "in": e.In, "name": e.Name, "value": e.Value, "reason": reason, }) } const ( parseErrorTemplContent = `parsing %s %s from %q failed, because %s` parseErrorTemplContentNoIn = `parsing %s from %q failed, because %s` ) // NewParseError creates a new parse error func NewParseError(name, in, value string, reason error) *ParseError { var msg string if in == "" { msg = fmt.Sprintf(parseErrorTemplContentNoIn, name, value, reason) } else { msg = fmt.Sprintf(parseErrorTemplContent, name, in, value, reason) } return &ParseError{ code: 400, Name: name, In: in, Value: value, Reason: reason, message: msg, } } errors-0.20.1/parsing_test.go000066400000000000000000000022741411077575400161570ustar00rootroot00000000000000// 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 errors import ( "errors" "testing" "github.com/stretchr/testify/assert" ) func TestParseError(t *testing.T) { err := NewParseError("Content-Type", "header", "application(", errors.New("unable to parse")) assert.EqualValues(t, 400, err.Code()) assert.Equal(t, "parsing Content-Type header from \"application(\" failed, because unable to parse", err.Error()) err = NewParseError("Content-Type", "", "application(", errors.New("unable to parse")) assert.EqualValues(t, 400, err.Code()) assert.Equal(t, "parsing Content-Type from \"application(\" failed, because unable to parse", err.Error()) } errors-0.20.1/schema.go000066400000000000000000000401531411077575400147130ustar00rootroot00000000000000// 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 errors import ( "encoding/json" "fmt" "strings" ) const ( invalidType = "%s is an invalid type name" typeFail = "%s in %s must be of type %s" typeFailWithData = "%s in %s must be of type %s: %q" typeFailWithError = "%s in %s must be of type %s, because: %s" requiredFail = "%s in %s is required" readOnlyFail = "%s in %s is readOnly" tooLongMessage = "%s in %s should be at most %d chars long" tooShortMessage = "%s in %s should be at least %d chars long" patternFail = "%s in %s should match '%s'" enumFail = "%s in %s should be one of %v" multipleOfFail = "%s in %s should be a multiple of %v" maxIncFail = "%s in %s should be less than or equal to %v" maxExcFail = "%s in %s should be less than %v" minIncFail = "%s in %s should be greater than or equal to %v" minExcFail = "%s in %s should be greater than %v" uniqueFail = "%s in %s shouldn't contain duplicates" maxItemsFail = "%s in %s should have at most %d items" minItemsFail = "%s in %s should have at least %d items" typeFailNoIn = "%s must be of type %s" typeFailWithDataNoIn = "%s must be of type %s: %q" typeFailWithErrorNoIn = "%s must be of type %s, because: %s" requiredFailNoIn = "%s is required" readOnlyFailNoIn = "%s is readOnly" tooLongMessageNoIn = "%s should be at most %d chars long" tooShortMessageNoIn = "%s should be at least %d chars long" patternFailNoIn = "%s should match '%s'" enumFailNoIn = "%s should be one of %v" multipleOfFailNoIn = "%s should be a multiple of %v" maxIncFailNoIn = "%s should be less than or equal to %v" maxExcFailNoIn = "%s should be less than %v" minIncFailNoIn = "%s should be greater than or equal to %v" minExcFailNoIn = "%s should be greater than %v" uniqueFailNoIn = "%s shouldn't contain duplicates" maxItemsFailNoIn = "%s should have at most %d items" minItemsFailNoIn = "%s should have at least %d items" noAdditionalItems = "%s in %s can't have additional items" noAdditionalItemsNoIn = "%s can't have additional items" tooFewProperties = "%s in %s should have at least %d properties" tooFewPropertiesNoIn = "%s should have at least %d properties" tooManyProperties = "%s in %s should have at most %d properties" tooManyPropertiesNoIn = "%s should have at most %d properties" unallowedProperty = "%s.%s in %s is a forbidden property" unallowedPropertyNoIn = "%s.%s is a forbidden property" failedAllPatternProps = "%s.%s in %s failed all pattern properties" failedAllPatternPropsNoIn = "%s.%s failed all pattern properties" multipleOfMustBePositive = "factor MultipleOf declared for %s must be positive: %v" ) // All code responses can be used to differentiate errors for different handling // by the consuming program const ( // CompositeErrorCode remains 422 for backwards-compatibility // and to separate it from validation errors with cause CompositeErrorCode = 422 // InvalidTypeCode is used for any subclass of invalid types InvalidTypeCode = 600 + iota RequiredFailCode TooLongFailCode TooShortFailCode PatternFailCode EnumFailCode MultipleOfFailCode MaxFailCode MinFailCode UniqueFailCode MaxItemsFailCode MinItemsFailCode NoAdditionalItemsCode TooFewPropertiesCode TooManyPropertiesCode UnallowedPropertyCode FailedAllPatternPropsCode MultipleOfMustBePositiveCode ReadOnlyFailCode ) // CompositeError is an error that groups several errors together type CompositeError struct { Errors []error code int32 message string } // Code for this error func (c *CompositeError) Code() int32 { return c.code } func (c *CompositeError) Error() string { if len(c.Errors) > 0 { msgs := []string{c.message + ":"} for _, e := range c.Errors { msgs = append(msgs, e.Error()) } return strings.Join(msgs, "\n") } return c.message } // MarshalJSON implements the JSON encoding interface func (c CompositeError) MarshalJSON() ([]byte, error) { return json.Marshal(map[string]interface{}{ "code": c.code, "message": c.message, "errors": c.Errors, }) } // CompositeValidationError an error to wrap a bunch of other errors func CompositeValidationError(errors ...error) *CompositeError { return &CompositeError{ code: CompositeErrorCode, Errors: append([]error{}, errors...), message: "validation failure list", } } // ValidateName recursively sets the name for all validations or updates them for nested properties func (c *CompositeError) ValidateName(name string) *CompositeError { for i, e := range c.Errors { if ve, ok := e.(*Validation); ok { c.Errors[i] = ve.ValidateName(name) } else if ce, ok := e.(*CompositeError); ok { c.Errors[i] = ce.ValidateName(name) } } return c } // FailedAllPatternProperties an error for when the property doesn't match a pattern func FailedAllPatternProperties(name, in, key string) *Validation { msg := fmt.Sprintf(failedAllPatternProps, name, key, in) if in == "" { msg = fmt.Sprintf(failedAllPatternPropsNoIn, name, key) } return &Validation{ code: FailedAllPatternPropsCode, Name: name, In: in, Value: key, message: msg, } } // PropertyNotAllowed an error for when the property doesn't match a pattern func PropertyNotAllowed(name, in, key string) *Validation { msg := fmt.Sprintf(unallowedProperty, name, key, in) if in == "" { msg = fmt.Sprintf(unallowedPropertyNoIn, name, key) } return &Validation{ code: UnallowedPropertyCode, Name: name, In: in, Value: key, message: msg, } } // TooFewProperties an error for an object with too few properties func TooFewProperties(name, in string, n int64) *Validation { msg := fmt.Sprintf(tooFewProperties, name, in, n) if in == "" { msg = fmt.Sprintf(tooFewPropertiesNoIn, name, n) } return &Validation{ code: TooFewPropertiesCode, Name: name, In: in, Value: n, message: msg, } } // TooManyProperties an error for an object with too many properties func TooManyProperties(name, in string, n int64) *Validation { msg := fmt.Sprintf(tooManyProperties, name, in, n) if in == "" { msg = fmt.Sprintf(tooManyPropertiesNoIn, name, n) } return &Validation{ code: TooManyPropertiesCode, Name: name, In: in, Value: n, message: msg, } } // AdditionalItemsNotAllowed an error for invalid additional items func AdditionalItemsNotAllowed(name, in string) *Validation { msg := fmt.Sprintf(noAdditionalItems, name, in) if in == "" { msg = fmt.Sprintf(noAdditionalItemsNoIn, name) } return &Validation{ code: NoAdditionalItemsCode, Name: name, In: in, message: msg, } } // InvalidCollectionFormat another flavor of invalid type error func InvalidCollectionFormat(name, in, format string) *Validation { return &Validation{ code: InvalidTypeCode, Name: name, In: in, Value: format, message: fmt.Sprintf("the collection format %q is not supported for the %s param %q", format, in, name), } } // InvalidTypeName an error for when the type is invalid func InvalidTypeName(typeName string) *Validation { return &Validation{ code: InvalidTypeCode, Value: typeName, message: fmt.Sprintf(invalidType, typeName), } } // InvalidType creates an error for when the type is invalid func InvalidType(name, in, typeName string, value interface{}) *Validation { var message string if in != "" { switch value.(type) { case string: message = fmt.Sprintf(typeFailWithData, name, in, typeName, value) case error: message = fmt.Sprintf(typeFailWithError, name, in, typeName, value) default: message = fmt.Sprintf(typeFail, name, in, typeName) } } else { switch value.(type) { case string: message = fmt.Sprintf(typeFailWithDataNoIn, name, typeName, value) case error: message = fmt.Sprintf(typeFailWithErrorNoIn, name, typeName, value) default: message = fmt.Sprintf(typeFailNoIn, name, typeName) } } return &Validation{ code: InvalidTypeCode, Name: name, In: in, Value: value, message: message, } } // DuplicateItems error for when an array contains duplicates func DuplicateItems(name, in string) *Validation { msg := fmt.Sprintf(uniqueFail, name, in) if in == "" { msg = fmt.Sprintf(uniqueFailNoIn, name) } return &Validation{ code: UniqueFailCode, Name: name, In: in, message: msg, } } // TooManyItems error for when an array contains too many items func TooManyItems(name, in string, max int64, value interface{}) *Validation { msg := fmt.Sprintf(maxItemsFail, name, in, max) if in == "" { msg = fmt.Sprintf(maxItemsFailNoIn, name, max) } return &Validation{ code: MaxItemsFailCode, Name: name, In: in, Value: value, message: msg, } } // TooFewItems error for when an array contains too few items func TooFewItems(name, in string, min int64, value interface{}) *Validation { msg := fmt.Sprintf(minItemsFail, name, in, min) if in == "" { msg = fmt.Sprintf(minItemsFailNoIn, name, min) } return &Validation{ code: MinItemsFailCode, Name: name, In: in, Value: value, message: msg, } } // ExceedsMaximumInt error for when maximum validation fails func ExceedsMaximumInt(name, in string, max int64, exclusive bool, value interface{}) *Validation { var message string if in == "" { m := maxIncFailNoIn if exclusive { m = maxExcFailNoIn } message = fmt.Sprintf(m, name, max) } else { m := maxIncFail if exclusive { m = maxExcFail } message = fmt.Sprintf(m, name, in, max) } return &Validation{ code: MaxFailCode, Name: name, In: in, Value: value, message: message, } } // ExceedsMaximumUint error for when maximum validation fails func ExceedsMaximumUint(name, in string, max uint64, exclusive bool, value interface{}) *Validation { var message string if in == "" { m := maxIncFailNoIn if exclusive { m = maxExcFailNoIn } message = fmt.Sprintf(m, name, max) } else { m := maxIncFail if exclusive { m = maxExcFail } message = fmt.Sprintf(m, name, in, max) } return &Validation{ code: MaxFailCode, Name: name, In: in, Value: value, message: message, } } // ExceedsMaximum error for when maximum validation fails func ExceedsMaximum(name, in string, max float64, exclusive bool, value interface{}) *Validation { var message string if in == "" { m := maxIncFailNoIn if exclusive { m = maxExcFailNoIn } message = fmt.Sprintf(m, name, max) } else { m := maxIncFail if exclusive { m = maxExcFail } message = fmt.Sprintf(m, name, in, max) } return &Validation{ code: MaxFailCode, Name: name, In: in, Value: value, message: message, } } // ExceedsMinimumInt error for when minimum validation fails func ExceedsMinimumInt(name, in string, min int64, exclusive bool, value interface{}) *Validation { var message string if in == "" { m := minIncFailNoIn if exclusive { m = minExcFailNoIn } message = fmt.Sprintf(m, name, min) } else { m := minIncFail if exclusive { m = minExcFail } message = fmt.Sprintf(m, name, in, min) } return &Validation{ code: MinFailCode, Name: name, In: in, Value: value, message: message, } } // ExceedsMinimumUint error for when minimum validation fails func ExceedsMinimumUint(name, in string, min uint64, exclusive bool, value interface{}) *Validation { var message string if in == "" { m := minIncFailNoIn if exclusive { m = minExcFailNoIn } message = fmt.Sprintf(m, name, min) } else { m := minIncFail if exclusive { m = minExcFail } message = fmt.Sprintf(m, name, in, min) } return &Validation{ code: MinFailCode, Name: name, In: in, Value: value, message: message, } } // ExceedsMinimum error for when minimum validation fails func ExceedsMinimum(name, in string, min float64, exclusive bool, value interface{}) *Validation { var message string if in == "" { m := minIncFailNoIn if exclusive { m = minExcFailNoIn } message = fmt.Sprintf(m, name, min) } else { m := minIncFail if exclusive { m = minExcFail } message = fmt.Sprintf(m, name, in, min) } return &Validation{ code: MinFailCode, Name: name, In: in, Value: value, message: message, } } // NotMultipleOf error for when multiple of validation fails func NotMultipleOf(name, in string, multiple, value interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(multipleOfFailNoIn, name, multiple) } else { msg = fmt.Sprintf(multipleOfFail, name, in, multiple) } return &Validation{ code: MultipleOfFailCode, Name: name, In: in, Value: value, message: msg, } } // EnumFail error for when an enum validation fails func EnumFail(name, in string, value interface{}, values []interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(enumFailNoIn, name, values) } else { msg = fmt.Sprintf(enumFail, name, in, values) } return &Validation{ code: EnumFailCode, Name: name, In: in, Value: value, Values: values, message: msg, } } // Required error for when a value is missing func Required(name, in string, value interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(requiredFailNoIn, name) } else { msg = fmt.Sprintf(requiredFail, name, in) } return &Validation{ code: RequiredFailCode, Name: name, In: in, Value: value, message: msg, } } // ReadOnly error for when a value is present in request func ReadOnly(name, in string, value interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(readOnlyFailNoIn, name) } else { msg = fmt.Sprintf(readOnlyFail, name, in) } return &Validation{ code: ReadOnlyFailCode, Name: name, In: in, Value: value, message: msg, } } // TooLong error for when a string is too long func TooLong(name, in string, max int64, value interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(tooLongMessageNoIn, name, max) } else { msg = fmt.Sprintf(tooLongMessage, name, in, max) } return &Validation{ code: TooLongFailCode, Name: name, In: in, Value: value, message: msg, } } // TooShort error for when a string is too short func TooShort(name, in string, min int64, value interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(tooShortMessageNoIn, name, min) } else { msg = fmt.Sprintf(tooShortMessage, name, in, min) } return &Validation{ code: TooShortFailCode, Name: name, In: in, Value: value, message: msg, } } // FailedPattern error for when a string fails a regex pattern match // the pattern that is returned is the ECMA syntax version of the pattern not the golang version. func FailedPattern(name, in, pattern string, value interface{}) *Validation { var msg string if in == "" { msg = fmt.Sprintf(patternFailNoIn, name, pattern) } else { msg = fmt.Sprintf(patternFail, name, in, pattern) } return &Validation{ code: PatternFailCode, Name: name, In: in, Value: value, message: msg, } } // MultipleOfMustBePositive error for when a // multipleOf factor is negative func MultipleOfMustBePositive(name, in string, factor interface{}) *Validation { return &Validation{ code: MultipleOfMustBePositiveCode, Name: name, In: in, Value: factor, message: fmt.Sprintf(multipleOfMustBePositive, name, factor), } } errors-0.20.1/schema_test.go000066400000000000000000000410531411077575400157520ustar00rootroot00000000000000// 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 errors import ( "errors" "fmt" "testing" "github.com/stretchr/testify/assert" ) func TestSchemaErrors(t *testing.T) { err := InvalidType("confirmed", "query", "boolean", nil) assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "confirmed in query must be of type boolean", err.Error()) err = InvalidType("confirmed", "", "boolean", nil) assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "confirmed must be of type boolean", err.Error()) err = InvalidType("confirmed", "query", "boolean", "hello") assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "confirmed in query must be of type boolean: \"hello\"", err.Error()) err = InvalidType("confirmed", "query", "boolean", errors.New("hello")) assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "confirmed in query must be of type boolean, because: hello", err.Error()) err = InvalidType("confirmed", "", "boolean", "hello") assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "confirmed must be of type boolean: \"hello\"", err.Error()) err = InvalidType("confirmed", "", "boolean", errors.New("hello")) assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "confirmed must be of type boolean, because: hello", err.Error()) err = DuplicateItems("uniques", "query") assert.Error(t, err) assert.EqualValues(t, UniqueFailCode, err.Code()) assert.Equal(t, "uniques in query shouldn't contain duplicates", err.Error()) err = DuplicateItems("uniques", "") assert.Error(t, err) assert.EqualValues(t, UniqueFailCode, err.Code()) assert.Equal(t, "uniques shouldn't contain duplicates", err.Error()) err = TooManyItems("something", "query", 5, 6) assert.Error(t, err) assert.EqualValues(t, MaxItemsFailCode, err.Code()) assert.Equal(t, "something in query should have at most 5 items", err.Error()) assert.Equal(t, 6, err.Value) err = TooManyItems("something", "", 5, 6) assert.Error(t, err) assert.EqualValues(t, MaxItemsFailCode, err.Code()) assert.Equal(t, "something should have at most 5 items", err.Error()) assert.Equal(t, 6, err.Value) err = TooFewItems("something", "", 5, 4) assert.Error(t, err) assert.EqualValues(t, MinItemsFailCode, err.Code()) assert.Equal(t, "something should have at least 5 items", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMaximumInt("something", "query", 5, false, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something in query should be less than or equal to 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumInt("something", "", 5, false, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something should be less than or equal to 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumInt("something", "query", 5, true, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something in query should be less than 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumInt("something", "", 5, true, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something should be less than 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumUint("something", "query", 5, false, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something in query should be less than or equal to 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumUint("something", "", 5, false, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something should be less than or equal to 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumUint("something", "query", 5, true, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something in query should be less than 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximumUint("something", "", 5, true, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something should be less than 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximum("something", "query", 5, false, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something in query should be less than or equal to 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximum("something", "", 5, false, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something should be less than or equal to 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximum("something", "query", 5, true, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something in query should be less than 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMaximum("something", "", 5, true, 6) assert.Error(t, err) assert.EqualValues(t, MaxFailCode, err.Code()) assert.Equal(t, "something should be less than 5", err.Error()) assert.Equal(t, 6, err.Value) err = ExceedsMinimumInt("something", "query", 5, false, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something in query should be greater than or equal to 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumInt("something", "", 5, false, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something should be greater than or equal to 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumInt("something", "query", 5, true, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something in query should be greater than 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumInt("something", "", 5, true, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something should be greater than 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumUint("something", "query", 5, false, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something in query should be greater than or equal to 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumUint("something", "", 5, false, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something should be greater than or equal to 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumUint("something", "query", 5, true, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something in query should be greater than 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimumUint("something", "", 5, true, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something should be greater than 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimum("something", "query", 5, false, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something in query should be greater than or equal to 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimum("something", "", 5, false, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something should be greater than or equal to 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimum("something", "query", 5, true, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something in query should be greater than 5", err.Error()) assert.Equal(t, 4, err.Value) err = ExceedsMinimum("something", "", 5, true, 4) assert.Error(t, err) assert.EqualValues(t, MinFailCode, err.Code()) assert.Equal(t, "something should be greater than 5", err.Error()) assert.Equal(t, 4, err.Value) err = NotMultipleOf("something", "query", 5, 1) assert.Error(t, err) assert.EqualValues(t, MultipleOfFailCode, err.Code()) assert.Equal(t, "something in query should be a multiple of 5", err.Error()) assert.Equal(t, 1, err.Value) err = NotMultipleOf("something", "query", float64(5), float64(1)) assert.Error(t, err) assert.EqualValues(t, MultipleOfFailCode, err.Code()) assert.Equal(t, "something in query should be a multiple of 5", err.Error()) assert.Equal(t, float64(1), err.Value) err = NotMultipleOf("something", "query", uint64(5), uint64(1)) assert.Error(t, err) assert.EqualValues(t, MultipleOfFailCode, err.Code()) assert.Equal(t, "something in query should be a multiple of 5", err.Error()) assert.Equal(t, uint64(1), err.Value) err = NotMultipleOf("something", "", 5, 1) assert.Error(t, err) assert.EqualValues(t, MultipleOfFailCode, err.Code()) assert.Equal(t, "something should be a multiple of 5", err.Error()) assert.Equal(t, 1, err.Value) err = EnumFail("something", "query", "yada", []interface{}{"hello", "world"}) assert.Error(t, err) assert.EqualValues(t, EnumFailCode, err.Code()) assert.Equal(t, "something in query should be one of [hello world]", err.Error()) assert.Equal(t, "yada", err.Value) err = EnumFail("something", "", "yada", []interface{}{"hello", "world"}) assert.Error(t, err) assert.EqualValues(t, EnumFailCode, err.Code()) assert.Equal(t, "something should be one of [hello world]", err.Error()) assert.Equal(t, "yada", err.Value) err = Required("something", "query", nil) assert.Error(t, err) assert.EqualValues(t, RequiredFailCode, err.Code()) assert.Equal(t, "something in query is required", err.Error()) assert.Equal(t, nil, err.Value) err = Required("something", "", nil) assert.Error(t, err) assert.EqualValues(t, RequiredFailCode, err.Code()) assert.Equal(t, "something is required", err.Error()) assert.Equal(t, nil, err.Value) err = ReadOnly("something", "query", nil) assert.Error(t, err) assert.EqualValues(t, ReadOnlyFailCode, err.Code()) assert.Equal(t, "something in query is readOnly", err.Error()) assert.Equal(t, nil, err.Value) err = ReadOnly("something", "", nil) assert.Error(t, err) assert.EqualValues(t, ReadOnlyFailCode, err.Code()) assert.Equal(t, "something is readOnly", err.Error()) assert.Equal(t, nil, err.Value) err = TooLong("something", "query", 5, "abcdef") assert.Error(t, err) assert.EqualValues(t, TooLongFailCode, err.Code()) assert.Equal(t, "something in query should be at most 5 chars long", err.Error()) assert.Equal(t, "abcdef", err.Value) err = TooLong("something", "", 5, "abcdef") assert.Error(t, err) assert.EqualValues(t, TooLongFailCode, err.Code()) assert.Equal(t, "something should be at most 5 chars long", err.Error()) assert.Equal(t, "abcdef", err.Value) err = TooShort("something", "query", 5, "a") assert.Error(t, err) assert.EqualValues(t, TooShortFailCode, err.Code()) assert.Equal(t, "something in query should be at least 5 chars long", err.Error()) assert.Equal(t, "a", err.Value) err = TooShort("something", "", 5, "a") assert.Error(t, err) assert.EqualValues(t, TooShortFailCode, err.Code()) assert.Equal(t, "something should be at least 5 chars long", err.Error()) assert.Equal(t, "a", err.Value) err = FailedPattern("something", "query", "\\d+", "a") assert.Error(t, err) assert.EqualValues(t, PatternFailCode, err.Code()) assert.Equal(t, "something in query should match '\\d+'", err.Error()) assert.Equal(t, "a", err.Value) err = FailedPattern("something", "", "\\d+", "a") assert.Error(t, err) assert.EqualValues(t, PatternFailCode, err.Code()) assert.Equal(t, "something should match '\\d+'", err.Error()) assert.Equal(t, "a", err.Value) err = InvalidTypeName("something") assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "something is an invalid type name", err.Error()) err = AdditionalItemsNotAllowed("something", "query") assert.Error(t, err) assert.EqualValues(t, NoAdditionalItemsCode, err.Code()) assert.Equal(t, "something in query can't have additional items", err.Error()) err = AdditionalItemsNotAllowed("something", "") assert.Error(t, err) assert.EqualValues(t, NoAdditionalItemsCode, err.Code()) assert.Equal(t, "something can't have additional items", err.Error()) err = InvalidCollectionFormat("something", "query", "yada") assert.Error(t, err) assert.EqualValues(t, InvalidTypeCode, err.Code()) assert.Equal(t, "the collection format \"yada\" is not supported for the query param \"something\"", err.Error()) err2 := CompositeValidationError() assert.Error(t, err2) assert.EqualValues(t, CompositeErrorCode, err2.Code()) assert.Equal(t, "validation failure list", err2.Error()) err2 = CompositeValidationError(fmt.Errorf("first error"), fmt.Errorf("second error")) assert.Error(t, err2) assert.EqualValues(t, CompositeErrorCode, err2.Code()) assert.Equal(t, "validation failure list:\nfirst error\nsecond error", err2.Error()) // func MultipleOfMustBePositive(name, in string, factor interface{}) *Validation { err = MultipleOfMustBePositive("path", "body", float64(-10)) assert.Error(t, err) assert.EqualValues(t, MultipleOfMustBePositiveCode, err.Code()) assert.Equal(t, `factor MultipleOf declared for path must be positive: -10`, err.Error()) assert.Equal(t, float64(-10), err.Value) err = MultipleOfMustBePositive("path", "body", int64(-10)) assert.Error(t, err) assert.EqualValues(t, MultipleOfMustBePositiveCode, err.Code()) assert.Equal(t, `factor MultipleOf declared for path must be positive: -10`, err.Error()) assert.Equal(t, int64(-10), err.Value) // func PropertyNotAllowed(name, in, key string) *Validation { err = PropertyNotAllowed("path", "body", "key") assert.Error(t, err) assert.EqualValues(t, UnallowedPropertyCode, err.Code()) // unallowedProperty = "%s.%s in %s is a forbidden property" assert.Equal(t, "path.key in body is a forbidden property", err.Error()) err = PropertyNotAllowed("path", "", "key") assert.Error(t, err) assert.EqualValues(t, UnallowedPropertyCode, err.Code()) // unallowedPropertyNoIn = "%s.%s is a forbidden property" assert.Equal(t, "path.key is a forbidden property", err.Error()) // func TooManyProperties(name, in string, n int64) *Validation { err = TooManyProperties("path", "body", 10) assert.Error(t, err) assert.EqualValues(t, TooManyPropertiesCode, err.Code()) // tooManyProperties = "%s in %s should have at most %d properties" assert.Equal(t, "path in body should have at most 10 properties", err.Error()) err = TooManyProperties("path", "", 10) assert.Error(t, err) assert.EqualValues(t, TooManyPropertiesCode, err.Code()) // tooManyPropertiesNoIn = "%s should have at most %d properties" assert.Equal(t, "path should have at most 10 properties", err.Error()) err = TooFewProperties("path", "body", 10) // func TooFewProperties(name, in string, n int64) *Validation { assert.Error(t, err) assert.EqualValues(t, TooFewPropertiesCode, err.Code()) // tooFewProperties = "%s in %s should have at least %d properties" assert.Equal(t, "path in body should have at least 10 properties", err.Error()) err = TooFewProperties("path", "", 10) // func TooFewProperties(name, in string, n int64) *Validation { assert.Error(t, err) assert.EqualValues(t, TooFewPropertiesCode, err.Code()) // tooFewPropertiesNoIn = "%s should have at least %d properties" assert.Equal(t, "path should have at least 10 properties", err.Error()) // func FailedAllPatternProperties(name, in, key string) *Validation { err = FailedAllPatternProperties("path", "body", "key") assert.Error(t, err) assert.EqualValues(t, FailedAllPatternPropsCode, err.Code()) // failedAllPatternProps = "%s.%s in %s failed all pattern properties" assert.Equal(t, "path.key in body failed all pattern properties", err.Error()) err = FailedAllPatternProperties("path", "", "key") assert.Error(t, err) assert.EqualValues(t, FailedAllPatternPropsCode, err.Code()) // failedAllPatternPropsNoIn = "%s.%s failed all pattern properties" assert.Equal(t, "path.key failed all pattern properties", err.Error()) }