gateway/manta: Bump manta dependencies (#5414)
Internally, triton-go, what manta minio is built on, changed it's internal error handling. This means we no longer need to unwrap specific error types This doesn't change any manta minio functionality - it just changes how errors are handled internally and adds a wrapper for a 404 errormaster
Paul Stack
7 years ago
committed by
kannappanr
parent
3f09c17bfe
commit
a020a70484
@ -1,354 +0,0 @@ |
||||
Mozilla Public License, version 2.0 |
||||
|
||||
1. Definitions |
||||
|
||||
1.1. “Contributor” |
||||
|
||||
means each individual or legal entity that creates, contributes to the |
||||
creation of, or owns Covered Software. |
||||
|
||||
1.2. “Contributor Version” |
||||
|
||||
means the combination of the Contributions of others (if any) used by a |
||||
Contributor and that particular Contributor’s Contribution. |
||||
|
||||
1.3. “Contribution” |
||||
|
||||
means Covered Software of a particular Contributor. |
||||
|
||||
1.4. “Covered Software” |
||||
|
||||
means Source Code Form to which the initial Contributor has attached the |
||||
notice in Exhibit A, the Executable Form of such Source Code Form, and |
||||
Modifications of such Source Code Form, in each case including portions |
||||
thereof. |
||||
|
||||
1.5. “Incompatible With Secondary Licenses” |
||||
means |
||||
|
||||
a. that the initial Contributor has attached the notice described in |
||||
Exhibit B to the Covered Software; or |
||||
|
||||
b. that the Covered Software was made available under the terms of version |
||||
1.1 or earlier of the License, but not also under the terms of a |
||||
Secondary License. |
||||
|
||||
1.6. “Executable Form” |
||||
|
||||
means any form of the work other than Source Code Form. |
||||
|
||||
1.7. “Larger Work” |
||||
|
||||
means a work that combines Covered Software with other material, in a separate |
||||
file or files, that is not Covered Software. |
||||
|
||||
1.8. “License” |
||||
|
||||
means this document. |
||||
|
||||
1.9. “Licensable” |
||||
|
||||
means having the right to grant, to the maximum extent possible, whether at the |
||||
time of the initial grant or subsequently, any and all of the rights conveyed by |
||||
this License. |
||||
|
||||
1.10. “Modifications” |
||||
|
||||
means any of the following: |
||||
|
||||
a. any file in Source Code Form that results from an addition to, deletion |
||||
from, or modification of the contents of Covered Software; or |
||||
|
||||
b. any new file in Source Code Form that contains any Covered Software. |
||||
|
||||
1.11. “Patent Claims” of a Contributor |
||||
|
||||
means any patent claim(s), including without limitation, method, process, |
||||
and apparatus claims, in any patent Licensable by such Contributor that |
||||
would be infringed, but for the grant of the License, by the making, |
||||
using, selling, offering for sale, having made, import, or transfer of |
||||
either its Contributions or its Contributor Version. |
||||
|
||||
1.12. “Secondary License” |
||||
|
||||
means either the GNU General Public License, Version 2.0, the GNU Lesser |
||||
General Public License, Version 2.1, the GNU Affero General Public |
||||
License, Version 3.0, or any later versions of those licenses. |
||||
|
||||
1.13. “Source Code Form” |
||||
|
||||
means the form of the work preferred for making modifications. |
||||
|
||||
1.14. “You” (or “Your”) |
||||
|
||||
means an individual or a legal entity exercising rights under this |
||||
License. For legal entities, “You” includes any entity that controls, is |
||||
controlled by, or is under common control with You. For purposes of this |
||||
definition, “control” means (a) the power, direct or indirect, to cause |
||||
the direction or management of such entity, whether by contract or |
||||
otherwise, or (b) ownership of more than fifty percent (50%) of the |
||||
outstanding shares or beneficial ownership of such entity. |
||||
|
||||
|
||||
2. License Grants and Conditions |
||||
|
||||
2.1. Grants |
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free, |
||||
non-exclusive license: |
||||
|
||||
a. under intellectual property rights (other than patent or trademark) |
||||
Licensable by such Contributor to use, reproduce, make available, |
||||
modify, display, perform, distribute, and otherwise exploit its |
||||
Contributions, either on an unmodified basis, with Modifications, or as |
||||
part of a Larger Work; and |
||||
|
||||
b. under Patent Claims of such Contributor to make, use, sell, offer for |
||||
sale, have made, import, and otherwise transfer either its Contributions |
||||
or its Contributor Version. |
||||
|
||||
2.2. Effective Date |
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution become |
||||
effective for each Contribution on the date the Contributor first distributes |
||||
such Contribution. |
||||
|
||||
2.3. Limitations on Grant Scope |
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under this |
||||
License. No additional rights or licenses will be implied from the distribution |
||||
or licensing of Covered Software under this License. Notwithstanding Section |
||||
2.1(b) above, no patent license is granted by a Contributor: |
||||
|
||||
a. for any code that a Contributor has removed from Covered Software; or |
||||
|
||||
b. for infringements caused by: (i) Your and any other third party’s |
||||
modifications of Covered Software, or (ii) the combination of its |
||||
Contributions with other software (except as part of its Contributor |
||||
Version); or |
||||
|
||||
c. under Patent Claims infringed by Covered Software in the absence of its |
||||
Contributions. |
||||
|
||||
This License does not grant any rights in the trademarks, service marks, or |
||||
logos of any Contributor (except as may be necessary to comply with the |
||||
notice requirements in Section 3.4). |
||||
|
||||
2.4. Subsequent Licenses |
||||
|
||||
No Contributor makes additional grants as a result of Your choice to |
||||
distribute the Covered Software under a subsequent version of this License |
||||
(see Section 10.2) or under the terms of a Secondary License (if permitted |
||||
under the terms of Section 3.3). |
||||
|
||||
2.5. Representation |
||||
|
||||
Each Contributor represents that the Contributor believes its Contributions |
||||
are its original creation(s) or it has sufficient rights to grant the |
||||
rights to its Contributions conveyed by this License. |
||||
|
||||
2.6. Fair Use |
||||
|
||||
This License is not intended to limit any rights You have under applicable |
||||
copyright doctrines of fair use, fair dealing, or other equivalents. |
||||
|
||||
2.7. Conditions |
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted in |
||||
Section 2.1. |
||||
|
||||
|
||||
3. Responsibilities |
||||
|
||||
3.1. Distribution of Source Form |
||||
|
||||
All distribution of Covered Software in Source Code Form, including any |
||||
Modifications that You create or to which You contribute, must be under the |
||||
terms of this License. You must inform recipients that the Source Code Form |
||||
of the Covered Software is governed by the terms of this License, and how |
||||
they can obtain a copy of this License. You may not attempt to alter or |
||||
restrict the recipients’ rights in the Source Code Form. |
||||
|
||||
3.2. Distribution of Executable Form |
||||
|
||||
If You distribute Covered Software in Executable Form then: |
||||
|
||||
a. such Covered Software must also be made available in Source Code Form, |
||||
as described in Section 3.1, and You must inform recipients of the |
||||
Executable Form how they can obtain a copy of such Source Code Form by |
||||
reasonable means in a timely manner, at a charge no more than the cost |
||||
of distribution to the recipient; and |
||||
|
||||
b. You may distribute such Executable Form under the terms of this License, |
||||
or sublicense it under different terms, provided that the license for |
||||
the Executable Form does not attempt to limit or alter the recipients’ |
||||
rights in the Source Code Form under this License. |
||||
|
||||
3.3. Distribution of a Larger Work |
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice, |
||||
provided that You also comply with the requirements of this License for the |
||||
Covered Software. If the Larger Work is a combination of Covered Software |
||||
with a work governed by one or more Secondary Licenses, and the Covered |
||||
Software is not Incompatible With Secondary Licenses, this License permits |
||||
You to additionally distribute such Covered Software under the terms of |
||||
such Secondary License(s), so that the recipient of the Larger Work may, at |
||||
their option, further distribute the Covered Software under the terms of |
||||
either this License or such Secondary License(s). |
||||
|
||||
3.4. Notices |
||||
|
||||
You may not remove or alter the substance of any license notices (including |
||||
copyright notices, patent notices, disclaimers of warranty, or limitations |
||||
of liability) contained within the Source Code Form of the Covered |
||||
Software, except that You may alter any license notices to the extent |
||||
required to remedy known factual inaccuracies. |
||||
|
||||
3.5. Application of Additional Terms |
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support, |
||||
indemnity or liability obligations to one or more recipients of Covered |
||||
Software. However, You may do so only on Your own behalf, and not on behalf |
||||
of any Contributor. You must make it absolutely clear that any such |
||||
warranty, support, indemnity, or liability obligation is offered by You |
||||
alone, and You hereby agree to indemnify every Contributor for any |
||||
liability incurred by such Contributor as a result of warranty, support, |
||||
indemnity or liability terms You offer. You may include additional |
||||
disclaimers of warranty and limitations of liability specific to any |
||||
jurisdiction. |
||||
|
||||
4. Inability to Comply Due to Statute or Regulation |
||||
|
||||
If it is impossible for You to comply with any of the terms of this License |
||||
with respect to some or all of the Covered Software due to statute, judicial |
||||
order, or regulation then You must: (a) comply with the terms of this License |
||||
to the maximum extent possible; and (b) describe the limitations and the code |
||||
they affect. Such description must be placed in a text file included with all |
||||
distributions of the Covered Software under this License. Except to the |
||||
extent prohibited by statute or regulation, such description must be |
||||
sufficiently detailed for a recipient of ordinary skill to be able to |
||||
understand it. |
||||
|
||||
5. Termination |
||||
|
||||
5.1. The rights granted under this License will terminate automatically if You |
||||
fail to comply with any of its terms. However, if You become compliant, |
||||
then the rights granted under this License from a particular Contributor |
||||
are reinstated (a) provisionally, unless and until such Contributor |
||||
explicitly and finally terminates Your grants, and (b) on an ongoing basis, |
||||
if such Contributor fails to notify You of the non-compliance by some |
||||
reasonable means prior to 60 days after You have come back into compliance. |
||||
Moreover, Your grants from a particular Contributor are reinstated on an |
||||
ongoing basis if such Contributor notifies You of the non-compliance by |
||||
some reasonable means, this is the first time You have received notice of |
||||
non-compliance with this License from such Contributor, and You become |
||||
compliant prior to 30 days after Your receipt of the notice. |
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent |
||||
infringement claim (excluding declaratory judgment actions, counter-claims, |
||||
and cross-claims) alleging that a Contributor Version directly or |
||||
indirectly infringes any patent, then the rights granted to You by any and |
||||
all Contributors for the Covered Software under Section 2.1 of this License |
||||
shall terminate. |
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all end user |
||||
license agreements (excluding distributors and resellers) which have been |
||||
validly granted by You or Your distributors under this License prior to |
||||
termination shall survive termination. |
||||
|
||||
6. Disclaimer of Warranty |
||||
|
||||
Covered Software is provided under this License on an “as is” basis, without |
||||
warranty of any kind, either expressed, implied, or statutory, including, |
||||
without limitation, warranties that the Covered Software is free of defects, |
||||
merchantable, fit for a particular purpose or non-infringing. The entire |
||||
risk as to the quality and performance of the Covered Software is with You. |
||||
Should any Covered Software prove defective in any respect, You (not any |
||||
Contributor) assume the cost of any necessary servicing, repair, or |
||||
correction. This disclaimer of warranty constitutes an essential part of this |
||||
License. No use of any Covered Software is authorized under this License |
||||
except under this disclaimer. |
||||
|
||||
7. Limitation of Liability |
||||
|
||||
Under no circumstances and under no legal theory, whether tort (including |
||||
negligence), contract, or otherwise, shall any Contributor, or anyone who |
||||
distributes Covered Software as permitted above, be liable to You for any |
||||
direct, indirect, special, incidental, or consequential damages of any |
||||
character including, without limitation, damages for lost profits, loss of |
||||
goodwill, work stoppage, computer failure or malfunction, or any and all |
||||
other commercial damages or losses, even if such party shall have been |
||||
informed of the possibility of such damages. This limitation of liability |
||||
shall not apply to liability for death or personal injury resulting from such |
||||
party’s negligence to the extent applicable law prohibits such limitation. |
||||
Some jurisdictions do not allow the exclusion or limitation of incidental or |
||||
consequential damages, so this exclusion and limitation may not apply to You. |
||||
|
||||
8. Litigation |
||||
|
||||
Any litigation relating to this License may be brought only in the courts of |
||||
a jurisdiction where the defendant maintains its principal place of business |
||||
and such litigation shall be governed by laws of that jurisdiction, without |
||||
reference to its conflict-of-law provisions. Nothing in this Section shall |
||||
prevent a party’s ability to bring cross-claims or counter-claims. |
||||
|
||||
9. Miscellaneous |
||||
|
||||
This License represents the complete agreement concerning the subject matter |
||||
hereof. If any provision of this License is held to be unenforceable, such |
||||
provision shall be reformed only to the extent necessary to make it |
||||
enforceable. Any law or regulation which provides that the language of a |
||||
contract shall be construed against the drafter shall not be used to construe |
||||
this License against a Contributor. |
||||
|
||||
|
||||
10. Versions of the License |
||||
|
||||
10.1. New Versions |
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section |
||||
10.3, no one other than the license steward has the right to modify or |
||||
publish new versions of this License. Each version will be given a |
||||
distinguishing version number. |
||||
|
||||
10.2. Effect of New Versions |
||||
|
||||
You may distribute the Covered Software under the terms of the version of |
||||
the License under which You originally received the Covered Software, or |
||||
under the terms of any subsequent version published by the license |
||||
steward. |
||||
|
||||
10.3. Modified Versions |
||||
|
||||
If you create software not governed by this License, and you want to |
||||
create a new license for such software, you may create and use a modified |
||||
version of this License if you rename the license and remove any |
||||
references to the name of the license steward (except to note that such |
||||
modified license differs from this License). |
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses |
||||
If You choose to distribute Source Code Form that is Incompatible With |
||||
Secondary Licenses under the terms of this version of the License, the |
||||
notice described in Exhibit B of this License must be attached. |
||||
|
||||
Exhibit A - Source Code Form License Notice |
||||
|
||||
This Source Code Form is subject to the |
||||
terms of the Mozilla Public License, v. |
||||
2.0. If a copy of the MPL was not |
||||
distributed with this file, You can |
||||
obtain one at |
||||
http://mozilla.org/MPL/2.0/. |
||||
|
||||
If it is not possible or desirable to put the notice in a particular file, then |
||||
You may include the notice in a location (such as a LICENSE file in a relevant |
||||
directory) where a recipient would be likely to look for such a notice. |
||||
|
||||
You may add additional accurate notices of copyright ownership. |
||||
|
||||
Exhibit B - “Incompatible With Secondary Licenses” Notice |
||||
|
||||
This Source Code Form is “Incompatible |
||||
With Secondary Licenses”, as defined by |
||||
the Mozilla Public License, v. 2.0. |
||||
|
||||
@ -1,89 +0,0 @@ |
||||
# errwrap |
||||
|
||||
`errwrap` is a package for Go that formalizes the pattern of wrapping errors |
||||
and checking if an error contains another error. |
||||
|
||||
There is a common pattern in Go of taking a returned `error` value and |
||||
then wrapping it (such as with `fmt.Errorf`) before returning it. The problem |
||||
with this pattern is that you completely lose the original `error` structure. |
||||
|
||||
Arguably the _correct_ approach is that you should make a custom structure |
||||
implementing the `error` interface, and have the original error as a field |
||||
on that structure, such [as this example](http://golang.org/pkg/os/#PathError). |
||||
This is a good approach, but you have to know the entire chain of possible |
||||
rewrapping that happens, when you might just care about one. |
||||
|
||||
`errwrap` formalizes this pattern (it doesn't matter what approach you use |
||||
above) by giving a single interface for wrapping errors, checking if a specific |
||||
error is wrapped, and extracting that error. |
||||
|
||||
## Installation and Docs |
||||
|
||||
Install using `go get github.com/hashicorp/errwrap`. |
||||
|
||||
Full documentation is available at |
||||
http://godoc.org/github.com/hashicorp/errwrap |
||||
|
||||
## Usage |
||||
|
||||
#### Basic Usage |
||||
|
||||
Below is a very basic example of its usage: |
||||
|
||||
```go |
||||
// A function that always returns an error, but wraps it, like a real |
||||
// function might. |
||||
func tryOpen() error { |
||||
_, err := os.Open("/i/dont/exist") |
||||
if err != nil { |
||||
return errwrap.Wrapf("Doesn't exist: {{err}}", err) |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
func main() { |
||||
err := tryOpen() |
||||
|
||||
// We can use the Contains helpers to check if an error contains |
||||
// another error. It is safe to do this with a nil error, or with |
||||
// an error that doesn't even use the errwrap package. |
||||
if errwrap.Contains(err, ErrNotExist) { |
||||
// Do something |
||||
} |
||||
if errwrap.ContainsType(err, new(os.PathError)) { |
||||
// Do something |
||||
} |
||||
|
||||
// Or we can use the associated `Get` functions to just extract |
||||
// a specific error. This would return nil if that specific error doesn't |
||||
// exist. |
||||
perr := errwrap.GetType(err, new(os.PathError)) |
||||
} |
||||
``` |
||||
|
||||
#### Custom Types |
||||
|
||||
If you're already making custom types that properly wrap errors, then |
||||
you can get all the functionality of `errwraps.Contains` and such by |
||||
implementing the `Wrapper` interface with just one function. Example: |
||||
|
||||
```go |
||||
type AppError { |
||||
Code ErrorCode |
||||
Err error |
||||
} |
||||
|
||||
func (e *AppError) WrappedErrors() []error { |
||||
return []error{e.Err} |
||||
} |
||||
``` |
||||
|
||||
Now this works: |
||||
|
||||
```go |
||||
err := &AppError{Err: fmt.Errorf("an error")} |
||||
if errwrap.ContainsType(err, fmt.Errorf("")) { |
||||
// This will work! |
||||
} |
||||
``` |
||||
@ -1,169 +0,0 @@ |
||||
// Package errwrap implements methods to formalize error wrapping in Go.
|
||||
//
|
||||
// All of the top-level functions that take an `error` are built to be able
|
||||
// to take any error, not just wrapped errors. This allows you to use errwrap
|
||||
// without having to type-check and type-cast everywhere.
|
||||
package errwrap |
||||
|
||||
import ( |
||||
"errors" |
||||
"reflect" |
||||
"strings" |
||||
) |
||||
|
||||
// WalkFunc is the callback called for Walk.
|
||||
type WalkFunc func(error) |
||||
|
||||
// Wrapper is an interface that can be implemented by custom types to
|
||||
// have all the Contains, Get, etc. functions in errwrap work.
|
||||
//
|
||||
// When Walk reaches a Wrapper, it will call the callback for every
|
||||
// wrapped error in addition to the wrapper itself. Since all the top-level
|
||||
// functions in errwrap use Walk, this means that all those functions work
|
||||
// with your custom type.
|
||||
type Wrapper interface { |
||||
WrappedErrors() []error |
||||
} |
||||
|
||||
// Wrap defines that outer wraps inner, returning an error type that
|
||||
// can be cleanly used with the other methods in this package, such as
|
||||
// Contains, GetAll, etc.
|
||||
//
|
||||
// This function won't modify the error message at all (the outer message
|
||||
// will be used).
|
||||
func Wrap(outer, inner error) error { |
||||
return &wrappedError{ |
||||
Outer: outer, |
||||
Inner: inner, |
||||
} |
||||
} |
||||
|
||||
// Wrapf wraps an error with a formatting message. This is similar to using
|
||||
// `fmt.Errorf` to wrap an error. If you're using `fmt.Errorf` to wrap
|
||||
// errors, you should replace it with this.
|
||||
//
|
||||
// format is the format of the error message. The string '{{err}}' will
|
||||
// be replaced with the original error message.
|
||||
func Wrapf(format string, err error) error { |
||||
outerMsg := "<nil>" |
||||
if err != nil { |
||||
outerMsg = err.Error() |
||||
} |
||||
|
||||
outer := errors.New(strings.Replace( |
||||
format, "{{err}}", outerMsg, -1)) |
||||
|
||||
return Wrap(outer, err) |
||||
} |
||||
|
||||
// Contains checks if the given error contains an error with the
|
||||
// message msg. If err is not a wrapped error, this will always return
|
||||
// false unless the error itself happens to match this msg.
|
||||
func Contains(err error, msg string) bool { |
||||
return len(GetAll(err, msg)) > 0 |
||||
} |
||||
|
||||
// ContainsType checks if the given error contains an error with
|
||||
// the same concrete type as v. If err is not a wrapped error, this will
|
||||
// check the err itself.
|
||||
func ContainsType(err error, v interface{}) bool { |
||||
return len(GetAllType(err, v)) > 0 |
||||
} |
||||
|
||||
// Get is the same as GetAll but returns the deepest matching error.
|
||||
func Get(err error, msg string) error { |
||||
es := GetAll(err, msg) |
||||
if len(es) > 0 { |
||||
return es[len(es)-1] |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// GetType is the same as GetAllType but returns the deepest matching error.
|
||||
func GetType(err error, v interface{}) error { |
||||
es := GetAllType(err, v) |
||||
if len(es) > 0 { |
||||
return es[len(es)-1] |
||||
} |
||||
|
||||
return nil |
||||
} |
||||
|
||||
// GetAll gets all the errors that might be wrapped in err with the
|
||||
// given message. The order of the errors is such that the outermost
|
||||
// matching error (the most recent wrap) is index zero, and so on.
|
||||
func GetAll(err error, msg string) []error { |
||||
var result []error |
||||
|
||||
Walk(err, func(err error) { |
||||
if err.Error() == msg { |
||||
result = append(result, err) |
||||
} |
||||
}) |
||||
|
||||
return result |
||||
} |
||||
|
||||
// GetAllType gets all the errors that are the same type as v.
|
||||
//
|
||||
// The order of the return value is the same as described in GetAll.
|
||||
func GetAllType(err error, v interface{}) []error { |
||||
var result []error |
||||
|
||||
var search string |
||||
if v != nil { |
||||
search = reflect.TypeOf(v).String() |
||||
} |
||||
Walk(err, func(err error) { |
||||
var needle string |
||||
if err != nil { |
||||
needle = reflect.TypeOf(err).String() |
||||
} |
||||
|
||||
if needle == search { |
||||
result = append(result, err) |
||||
} |
||||
}) |
||||
|
||||
return result |
||||
} |
||||
|
||||
// Walk walks all the wrapped errors in err and calls the callback. If
|
||||
// err isn't a wrapped error, this will be called once for err. If err
|
||||
// is a wrapped error, the callback will be called for both the wrapper
|
||||
// that implements error as well as the wrapped error itself.
|
||||
func Walk(err error, cb WalkFunc) { |
||||
if err == nil { |
||||
return |
||||
} |
||||
|
||||
switch e := err.(type) { |
||||
case *wrappedError: |
||||
cb(e.Outer) |
||||
Walk(e.Inner, cb) |
||||
case Wrapper: |
||||
cb(err) |
||||
|
||||
for _, err := range e.WrappedErrors() { |
||||
Walk(err, cb) |
||||
} |
||||
default: |
||||
cb(err) |
||||
} |
||||
} |
||||
|
||||
// wrappedError is an implementation of error that has both the
|
||||
// outer and inner errors.
|
||||
type wrappedError struct { |
||||
Outer error |
||||
Inner error |
||||
} |
||||
|
||||
func (w *wrappedError) Error() string { |
||||
return w.Outer.Error() |
||||
} |
||||
|
||||
func (w *wrappedError) WrappedErrors() []error { |
||||
return []error{w.Outer, w.Inner} |
||||
} |
||||
@ -1,190 +0,0 @@ |
||||
package client |
||||
|
||||
import ( |
||||
"fmt" |
||||
|
||||
"github.com/hashicorp/errwrap" |
||||
) |
||||
|
||||
// ClientError represents an error code and message along with the status code
|
||||
// of the HTTP request which resulted in the error message.
|
||||
type ClientError struct { |
||||
StatusCode int |
||||
Code string |
||||
Message string |
||||
} |
||||
|
||||
// Error implements interface Error on the TritonError type.
|
||||
func (e ClientError) Error() string { |
||||
return fmt.Sprintf("%s: %s", e.Code, e.Message) |
||||
} |
||||
|
||||
// MantaError represents an error code and message along with
|
||||
// the status code of the HTTP request which resulted in the error
|
||||
// message. Error codes used by the Manta API are listed at
|
||||
// https://apidocs.joyent.com/manta/api.html#errors
|
||||
type MantaError struct { |
||||
StatusCode int |
||||
Code string `json:"code"` |
||||
Message string `json:"message"` |
||||
} |
||||
|
||||
// Error implements interface Error on the MantaError type.
|
||||
func (e MantaError) Error() string { |
||||
return fmt.Sprintf("%s: %s", e.Code, e.Message) |
||||
} |
||||
|
||||
// TritonError represents an error code and message along with
|
||||
// the status code of the HTTP request which resulted in the error
|
||||
// message. Error codes used by the Triton API are listed at
|
||||
// https://apidocs.joyent.com/cloudapi/#cloudapi-http-responses
|
||||
type TritonError struct { |
||||
StatusCode int |
||||
Code string `json:"code"` |
||||
Message string `json:"message"` |
||||
} |
||||
|
||||
// Error implements interface Error on the TritonError type.
|
||||
func (e TritonError) Error() string { |
||||
return fmt.Sprintf("%s: %s", e.Code, e.Message) |
||||
} |
||||
|
||||
func IsAuthSchemeError(err error) bool { |
||||
return isSpecificError(err, "AuthScheme") |
||||
} |
||||
func IsAuthorizationError(err error) bool { |
||||
return isSpecificError(err, "Authorization") |
||||
} |
||||
func IsBadRequestError(err error) bool { |
||||
return isSpecificError(err, "BadRequest") |
||||
} |
||||
func IsChecksumError(err error) bool { |
||||
return isSpecificError(err, "Checksum") |
||||
} |
||||
func IsConcurrentRequestError(err error) bool { |
||||
return isSpecificError(err, "ConcurrentRequest") |
||||
} |
||||
func IsContentLengthError(err error) bool { |
||||
return isSpecificError(err, "ContentLength") |
||||
} |
||||
func IsContentMD5MismatchError(err error) bool { |
||||
return isSpecificError(err, "ContentMD5Mismatch") |
||||
} |
||||
func IsEntityExistsError(err error) bool { |
||||
return isSpecificError(err, "EntityExists") |
||||
} |
||||
func IsInvalidArgumentError(err error) bool { |
||||
return isSpecificError(err, "InvalidArgument") |
||||
} |
||||
func IsInvalidAuthTokenError(err error) bool { |
||||
return isSpecificError(err, "InvalidAuthToken") |
||||
} |
||||
func IsInvalidCredentialsError(err error) bool { |
||||
return isSpecificError(err, "InvalidCredentials") |
||||
} |
||||
func IsInvalidDurabilityLevelError(err error) bool { |
||||
return isSpecificError(err, "InvalidDurabilityLevel") |
||||
} |
||||
func IsInvalidKeyIdError(err error) bool { |
||||
return isSpecificError(err, "InvalidKeyId") |
||||
} |
||||
func IsInvalidJobError(err error) bool { |
||||
return isSpecificError(err, "InvalidJob") |
||||
} |
||||
func IsInvalidLinkError(err error) bool { |
||||
return isSpecificError(err, "InvalidLink") |
||||
} |
||||
func IsInvalidLimitError(err error) bool { |
||||
return isSpecificError(err, "InvalidLimit") |
||||
} |
||||
func IsInvalidSignatureError(err error) bool { |
||||
return isSpecificError(err, "InvalidSignature") |
||||
} |
||||
func IsInvalidUpdateError(err error) bool { |
||||
return isSpecificError(err, "InvalidUpdate") |
||||
} |
||||
func IsDirectoryDoesNotExistError(err error) bool { |
||||
return isSpecificError(err, "DirectoryDoesNotExist") |
||||
} |
||||
func IsDirectoryExistsError(err error) bool { |
||||
return isSpecificError(err, "DirectoryExists") |
||||
} |
||||
func IsDirectoryNotEmptyError(err error) bool { |
||||
return isSpecificError(err, "DirectoryNotEmpty") |
||||
} |
||||
func IsDirectoryOperationError(err error) bool { |
||||
return isSpecificError(err, "DirectoryOperation") |
||||
} |
||||
func IsInternalError(err error) bool { |
||||
return isSpecificError(err, "Internal") |
||||
} |
||||
func IsJobNotFoundError(err error) bool { |
||||
return isSpecificError(err, "JobNotFound") |
||||
} |
||||
func IsJobStateError(err error) bool { |
||||
return isSpecificError(err, "JobState") |
||||
} |
||||
func IsKeyDoesNotExistError(err error) bool { |
||||
return isSpecificError(err, "KeyDoesNotExist") |
||||
} |
||||
func IsNotAcceptableError(err error) bool { |
||||
return isSpecificError(err, "NotAcceptable") |
||||
} |
||||
func IsNotEnoughSpaceError(err error) bool { |
||||
return isSpecificError(err, "NotEnoughSpace") |
||||
} |
||||
func IsLinkNotFoundError(err error) bool { |
||||
return isSpecificError(err, "LinkNotFound") |
||||
} |
||||
func IsLinkNotObjectError(err error) bool { |
||||
return isSpecificError(err, "LinkNotObject") |
||||
} |
||||
func IsLinkRequiredError(err error) bool { |
||||
return isSpecificError(err, "LinkRequired") |
||||
} |
||||
func IsParentNotDirectoryError(err error) bool { |
||||
return isSpecificError(err, "ParentNotDirectory") |
||||
} |
||||
func IsPreconditionFailedError(err error) bool { |
||||
return isSpecificError(err, "PreconditionFailed") |
||||
} |
||||
func IsPreSignedRequestError(err error) bool { |
||||
return isSpecificError(err, "PreSignedRequest") |
||||
} |
||||
func IsRequestEntityTooLargeError(err error) bool { |
||||
return isSpecificError(err, "RequestEntityTooLarge") |
||||
} |
||||
func IsResourceNotFoundError(err error) bool { |
||||
return isSpecificError(err, "ResourceNotFound") |
||||
} |
||||
func IsRootDirectoryError(err error) bool { |
||||
return isSpecificError(err, "RootDirectory") |
||||
} |
||||
func IsServiceUnavailableError(err error) bool { |
||||
return isSpecificError(err, "ServiceUnavailable") |
||||
} |
||||
func IsSSLRequiredError(err error) bool { |
||||
return isSpecificError(err, "SSLRequired") |
||||
} |
||||
func IsUploadTimeoutError(err error) bool { |
||||
return isSpecificError(err, "UploadTimeout") |
||||
} |
||||
func IsUserDoesNotExistError(err error) bool { |
||||
return isSpecificError(err, "UserDoesNotExist") |
||||
} |
||||
|
||||
// isSpecificError checks whether the error represented by err wraps
|
||||
// an underlying MantaError with code errorCode.
|
||||
func isSpecificError(err error, errorCode string) bool { |
||||
tritonErrorInterface := errwrap.GetType(err.(error), &MantaError{}) |
||||
if tritonErrorInterface == nil { |
||||
return false |
||||
} |
||||
|
||||
tritonErr := tritonErrorInterface.(*MantaError) |
||||
if tritonErr.Code == errorCode { |
||||
return true |
||||
} |
||||
|
||||
return false |
||||
} |
||||
@ -0,0 +1,297 @@ |
||||
//
|
||||
// Copyright (c) 2018, Joyent, Inc. All rights reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
|
||||
package errors |
||||
|
||||
import ( |
||||
"fmt" |
||||
"net/http" |
||||
"strings" |
||||
|
||||
"github.com/pkg/errors" |
||||
) |
||||
|
||||
// APIError represents an error code and message along with
|
||||
// the status code of the HTTP request which resulted in the error
|
||||
// message. Error codes used by the Triton API are listed at
|
||||
// https://apidocs.joyent.com/cloudapi/#cloudapi-http-responses
|
||||
// Error codes used by the Manta API are listed at
|
||||
// https://apidocs.joyent.com/manta/api.html#errors
|
||||
type APIError struct { |
||||
StatusCode int |
||||
Code string `json:"code"` |
||||
Message string `json:"message"` |
||||
} |
||||
|
||||
// Error implements interface Error on the APIError type.
|
||||
func (e APIError) Error() string { |
||||
return strings.Trim(fmt.Sprintf("%+q", e.Code), `"`) + ": " + strings.Trim(fmt.Sprintf("%+q", e.Message), `"`) |
||||
} |
||||
|
||||
// ClientError represents an error code and message returned
|
||||
// when connecting to the triton-go client
|
||||
type ClientError struct { |
||||
StatusCode int |
||||
Code string `json:"code"` |
||||
Message string `json:"message"` |
||||
} |
||||
|
||||
// Error implements interface Error on the ClientError type.
|
||||
func (e ClientError) Error() string { |
||||
return strings.Trim(fmt.Sprintf("%+q", e.Code), `"`) + ": " + strings.Trim(fmt.Sprintf("%+q", e.Message), `"`) |
||||
} |
||||
|
||||
func IsAuthSchemeError(err error) bool { |
||||
return IsSpecificError(err, "AuthScheme") |
||||
} |
||||
|
||||
func IsAuthorizationError(err error) bool { |
||||
return IsSpecificError(err, "Authorization") |
||||
} |
||||
|
||||
func IsBadRequestError(err error) bool { |
||||
return IsSpecificError(err, "BadRequest") |
||||
} |
||||
|
||||
func IsChecksumError(err error) bool { |
||||
return IsSpecificError(err, "Checksum") |
||||
} |
||||
|
||||
func IsConcurrentRequestError(err error) bool { |
||||
return IsSpecificError(err, "ConcurrentRequest") |
||||
} |
||||
|
||||
func IsContentLengthError(err error) bool { |
||||
return IsSpecificError(err, "ContentLength") |
||||
} |
||||
|
||||
func IsContentMD5MismatchError(err error) bool { |
||||
return IsSpecificError(err, "ContentMD5Mismatch") |
||||
} |
||||
|
||||
func IsEntityExistsError(err error) bool { |
||||
return IsSpecificError(err, "EntityExists") |
||||
} |
||||
|
||||
func IsInvalidArgumentError(err error) bool { |
||||
return IsSpecificError(err, "InvalidArgument") |
||||
} |
||||
|
||||
func IsInvalidAuthTokenError(err error) bool { |
||||
return IsSpecificError(err, "InvalidAuthToken") |
||||
} |
||||
|
||||
func IsInvalidCredentialsError(err error) bool { |
||||
return IsSpecificError(err, "InvalidCredentials") |
||||
} |
||||
|
||||
func IsInvalidDurabilityLevelError(err error) bool { |
||||
return IsSpecificError(err, "InvalidDurabilityLevel") |
||||
} |
||||
|
||||
func IsInvalidKeyIdError(err error) bool { |
||||
return IsSpecificError(err, "InvalidKeyId") |
||||
} |
||||
|
||||
func IsInvalidJobError(err error) bool { |
||||
return IsSpecificError(err, "InvalidJob") |
||||
} |
||||
|
||||
func IsInvalidLinkError(err error) bool { |
||||
return IsSpecificError(err, "InvalidLink") |
||||
} |
||||
|
||||
func IsInvalidLimitError(err error) bool { |
||||
return IsSpecificError(err, "InvalidLimit") |
||||
} |
||||
|
||||
func IsInvalidSignatureError(err error) bool { |
||||
return IsSpecificError(err, "InvalidSignature") |
||||
} |
||||
|
||||
func IsInvalidUpdateError(err error) bool { |
||||
return IsSpecificError(err, "InvalidUpdate") |
||||
} |
||||
|
||||
func IsDirectoryDoesNotExistError(err error) bool { |
||||
return IsSpecificError(err, "DirectoryDoesNotExist") |
||||
} |
||||
|
||||
func IsDirectoryExistsError(err error) bool { |
||||
return IsSpecificError(err, "DirectoryExists") |
||||
} |
||||
|
||||
func IsDirectoryNotEmptyError(err error) bool { |
||||
return IsSpecificError(err, "DirectoryNotEmpty") |
||||
} |
||||
|
||||
func IsDirectoryOperationError(err error) bool { |
||||
return IsSpecificError(err, "DirectoryOperation") |
||||
} |
||||
|
||||
func IsInternalError(err error) bool { |
||||
return IsSpecificError(err, "Internal") |
||||
} |
||||
|
||||
func IsJobNotFoundError(err error) bool { |
||||
return IsSpecificError(err, "JobNotFound") |
||||
} |
||||
|
||||
func IsJobStateError(err error) bool { |
||||
return IsSpecificError(err, "JobState") |
||||
} |
||||
|
||||
func IsKeyDoesNotExistError(err error) bool { |
||||
return IsSpecificError(err, "KeyDoesNotExist") |
||||
} |
||||
|
||||
func IsNotAcceptableError(err error) bool { |
||||
return IsSpecificError(err, "NotAcceptable") |
||||
} |
||||
|
||||
func IsNotEnoughSpaceError(err error) bool { |
||||
return IsSpecificError(err, "NotEnoughSpace") |
||||
} |
||||
|
||||
func IsLinkNotFoundError(err error) bool { |
||||
return IsSpecificError(err, "LinkNotFound") |
||||
} |
||||
|
||||
func IsLinkNotObjectError(err error) bool { |
||||
return IsSpecificError(err, "LinkNotObject") |
||||
} |
||||
|
||||
func IsLinkRequiredError(err error) bool { |
||||
return IsSpecificError(err, "LinkRequired") |
||||
} |
||||
|
||||
func IsParentNotDirectoryError(err error) bool { |
||||
return IsSpecificError(err, "ParentNotDirectory") |
||||
} |
||||
|
||||
func IsPreconditionFailedError(err error) bool { |
||||
return IsSpecificError(err, "PreconditionFailed") |
||||
} |
||||
|
||||
func IsPreSignedRequestError(err error) bool { |
||||
return IsSpecificError(err, "PreSignedRequest") |
||||
} |
||||
|
||||
func IsRequestEntityTooLargeError(err error) bool { |
||||
return IsSpecificError(err, "RequestEntityTooLarge") |
||||
} |
||||
|
||||
func IsResourceNotFoundError(err error) bool { |
||||
return IsSpecificError(err, "ResourceNotFound") |
||||
} |
||||
|
||||
func IsRootDirectoryError(err error) bool { |
||||
return IsSpecificError(err, "RootDirectory") |
||||
} |
||||
|
||||
func IsServiceUnavailableError(err error) bool { |
||||
return IsSpecificError(err, "ServiceUnavailable") |
||||
} |
||||
|
||||
func IsSSLRequiredError(err error) bool { |
||||
return IsSpecificError(err, "SSLRequired") |
||||
} |
||||
|
||||
func IsUploadTimeoutError(err error) bool { |
||||
return IsSpecificError(err, "UploadTimeout") |
||||
} |
||||
|
||||
func IsUserDoesNotExistError(err error) bool { |
||||
return IsSpecificError(err, "UserDoesNotExist") |
||||
} |
||||
|
||||
func IsBadRequest(err error) bool { |
||||
return IsSpecificError(err, "BadRequest") |
||||
} |
||||
|
||||
func IsInUseError(err error) bool { |
||||
return IsSpecificError(err, "InUseError") |
||||
} |
||||
|
||||
func IsInvalidArgument(err error) bool { |
||||
return IsSpecificError(err, "InvalidArgument") |
||||
} |
||||
|
||||
func IsInvalidCredentials(err error) bool { |
||||
return IsSpecificError(err, "InvalidCredentials") |
||||
} |
||||
|
||||
func IsInvalidHeader(err error) bool { |
||||
return IsSpecificError(err, "InvalidHeader") |
||||
} |
||||
|
||||
func IsInvalidVersion(err error) bool { |
||||
return IsSpecificError(err, "InvalidVersion") |
||||
} |
||||
|
||||
func IsMissingParameter(err error) bool { |
||||
return IsSpecificError(err, "MissingParameter") |
||||
} |
||||
|
||||
func IsNotAuthorized(err error) bool { |
||||
return IsSpecificError(err, "NotAuthorized") |
||||
} |
||||
|
||||
func IsRequestThrottled(err error) bool { |
||||
return IsSpecificError(err, "RequestThrottled") |
||||
} |
||||
|
||||
func IsRequestTooLarge(err error) bool { |
||||
return IsSpecificError(err, "RequestTooLarge") |
||||
} |
||||
|
||||
func IsRequestMoved(err error) bool { |
||||
return IsSpecificError(err, "RequestMoved") |
||||
} |
||||
|
||||
func IsResourceFound(err error) bool { |
||||
return IsSpecificError(err, "ResourceFound") |
||||
} |
||||
|
||||
func IsResourceNotFound(err error) bool { |
||||
return IsSpecificError(err, "ResourceNotFound") |
||||
} |
||||
|
||||
func IsUnknownError(err error) bool { |
||||
return IsSpecificError(err, "UnknownError") |
||||
} |
||||
|
||||
func IsEmptyResponse(err error) bool { |
||||
return IsSpecificError(err, "EmptyResponse") |
||||
} |
||||
|
||||
func IsStatusNotFoundCode(err error) bool { |
||||
return IsSpecificStatusCode(err, http.StatusNotFound) |
||||
} |
||||
|
||||
func IsSpecificError(myError error, errorCode string) bool { |
||||
switch err := errors.Cause(myError).(type) { |
||||
case *APIError: |
||||
if err.Code == errorCode { |
||||
return true |
||||
} |
||||
} |
||||
|
||||
return false |
||||
} |
||||
|
||||
func IsSpecificStatusCode(myError error, statusCode int) bool { |
||||
switch err := errors.Cause(myError).(type) { |
||||
case *APIError: |
||||
if err.StatusCode == statusCode { |
||||
return true |
||||
} |
||||
} |
||||
|
||||
return false |
||||
} |
||||
@ -0,0 +1,32 @@ |
||||
//
|
||||
// Copyright (c) 2018, Joyent, Inc. All rights reserved.
|
||||
//
|
||||
// This Source Code Form is subject to the terms of the Mozilla Public
|
||||
// License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
//
|
||||
|
||||
package triton |
||||
|
||||
import ( |
||||
"fmt" |
||||
"runtime" |
||||
) |
||||
|
||||
// The main version number of the current released Triton-go SDK.
|
||||
const Version = "0.9.0" |
||||
|
||||
// A pre-release marker for the version. If this is "" (empty string)
|
||||
// then it means that it is a final release. Otherwise, this is a pre-release
|
||||
// such as "dev" (in development), "beta", "rc1", etc.
|
||||
var Prerelease = "" |
||||
|
||||
func UserAgent() string { |
||||
if Prerelease != "" { |
||||
return fmt.Sprintf("triton-go/%s-%s (%s-%s; %s)", Version, Prerelease, runtime.GOARCH, runtime.GOOS, runtime.Version()) |
||||
} else { |
||||
return fmt.Sprintf("triton-go/%s (%s-%s; %s)", Version, runtime.GOARCH, runtime.GOOS, runtime.Version()) |
||||
} |
||||
} |
||||
|
||||
const CloudAPIMajorVersion = "8" |
||||
@ -0,0 +1,23 @@ |
||||
Copyright (c) 2015, Dave Cheney <dave@cheney.net> |
||||
All rights reserved. |
||||
|
||||
Redistribution and use in source and binary forms, with or without |
||||
modification, are permitted provided that the following conditions are met: |
||||
|
||||
* Redistributions of source code must retain the above copyright notice, this |
||||
list of conditions and the following disclaimer. |
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice, |
||||
this list of conditions and the following disclaimer in the documentation |
||||
and/or other materials provided with the distribution. |
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
||||
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
||||
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
||||
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
||||
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
||||
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
@ -0,0 +1,52 @@ |
||||
# errors [](https://travis-ci.org/pkg/errors) [](https://ci.appveyor.com/project/davecheney/errors/branch/master) [](http://godoc.org/github.com/pkg/errors) [](https://goreportcard.com/report/github.com/pkg/errors) [](https://sourcegraph.com/github.com/pkg/errors?badge) |
||||
|
||||
Package errors provides simple error handling primitives. |
||||
|
||||
`go get github.com/pkg/errors` |
||||
|
||||
The traditional error handling idiom in Go is roughly akin to |
||||
```go |
||||
if err != nil { |
||||
return err |
||||
} |
||||
``` |
||||
which applied recursively up the call stack results in error reports without context or debugging information. The errors package allows programmers to add context to the failure path in their code in a way that does not destroy the original value of the error. |
||||
|
||||
## Adding context to an error |
||||
|
||||
The errors.Wrap function returns a new error that adds context to the original error. For example |
||||
```go |
||||
_, err := ioutil.ReadAll(r) |
||||
if err != nil { |
||||
return errors.Wrap(err, "read failed") |
||||
} |
||||
``` |
||||
## Retrieving the cause of an error |
||||
|
||||
Using `errors.Wrap` constructs a stack of errors, adding context to the preceding error. Depending on the nature of the error it may be necessary to reverse the operation of errors.Wrap to retrieve the original error for inspection. Any error value which implements this interface can be inspected by `errors.Cause`. |
||||
```go |
||||
type causer interface { |
||||
Cause() error |
||||
} |
||||
``` |
||||
`errors.Cause` will recursively retrieve the topmost error which does not implement `causer`, which is assumed to be the original cause. For example: |
||||
```go |
||||
switch err := errors.Cause(err).(type) { |
||||
case *MyError: |
||||
// handle specifically |
||||
default: |
||||
// unknown error |
||||
} |
||||
``` |
||||
|
||||
[Read the package documentation for more information](https://godoc.org/github.com/pkg/errors). |
||||
|
||||
## Contributing |
||||
|
||||
We welcome pull requests, bug fixes and issue reports. With that said, the bar for adding new symbols to this package is intentionally set high. |
||||
|
||||
Before proposing a change, please discuss your change by raising an issue. |
||||
|
||||
## License |
||||
|
||||
BSD-2-Clause |
||||
@ -0,0 +1,32 @@ |
||||
version: build-{build}.{branch} |
||||
|
||||
clone_folder: C:\gopath\src\github.com\pkg\errors |
||||
shallow_clone: true # for startup speed |
||||
|
||||
environment: |
||||
GOPATH: C:\gopath |
||||
|
||||
platform: |
||||
- x64 |
||||
|
||||
# http://www.appveyor.com/docs/installed-software |
||||
install: |
||||
# some helpful output for debugging builds |
||||
- go version |
||||
- go env |
||||
# pre-installed MinGW at C:\MinGW is 32bit only |
||||
# but MSYS2 at C:\msys64 has mingw64 |
||||
- set PATH=C:\msys64\mingw64\bin;%PATH% |
||||
- gcc --version |
||||
- g++ --version |
||||
|
||||
build_script: |
||||
- go install -v ./... |
||||
|
||||
test_script: |
||||
- set PATH=C:\gopath\bin;%PATH% |
||||
- go test -v ./... |
||||
|
||||
#artifacts: |
||||
# - path: '%GOPATH%\bin\*.exe' |
||||
deploy: off |
||||
@ -0,0 +1,269 @@ |
||||
// Package errors provides simple error handling primitives.
|
||||
//
|
||||
// The traditional error handling idiom in Go is roughly akin to
|
||||
//
|
||||
// if err != nil {
|
||||
// return err
|
||||
// }
|
||||
//
|
||||
// which applied recursively up the call stack results in error reports
|
||||
// without context or debugging information. The errors package allows
|
||||
// programmers to add context to the failure path in their code in a way
|
||||
// that does not destroy the original value of the error.
|
||||
//
|
||||
// Adding context to an error
|
||||
//
|
||||
// The errors.Wrap function returns a new error that adds context to the
|
||||
// original error by recording a stack trace at the point Wrap is called,
|
||||
// and the supplied message. For example
|
||||
//
|
||||
// _, err := ioutil.ReadAll(r)
|
||||
// if err != nil {
|
||||
// return errors.Wrap(err, "read failed")
|
||||
// }
|
||||
//
|
||||
// If additional control is required the errors.WithStack and errors.WithMessage
|
||||
// functions destructure errors.Wrap into its component operations of annotating
|
||||
// an error with a stack trace and an a message, respectively.
|
||||
//
|
||||
// Retrieving the cause of an error
|
||||
//
|
||||
// Using errors.Wrap constructs a stack of errors, adding context to the
|
||||
// preceding error. Depending on the nature of the error it may be necessary
|
||||
// to reverse the operation of errors.Wrap to retrieve the original error
|
||||
// for inspection. Any error value which implements this interface
|
||||
//
|
||||
// type causer interface {
|
||||
// Cause() error
|
||||
// }
|
||||
//
|
||||
// can be inspected by errors.Cause. errors.Cause will recursively retrieve
|
||||
// the topmost error which does not implement causer, which is assumed to be
|
||||
// the original cause. For example:
|
||||
//
|
||||
// switch err := errors.Cause(err).(type) {
|
||||
// case *MyError:
|
||||
// // handle specifically
|
||||
// default:
|
||||
// // unknown error
|
||||
// }
|
||||
//
|
||||
// causer interface is not exported by this package, but is considered a part
|
||||
// of stable public API.
|
||||
//
|
||||
// Formatted printing of errors
|
||||
//
|
||||
// All error values returned from this package implement fmt.Formatter and can
|
||||
// be formatted by the fmt package. The following verbs are supported
|
||||
//
|
||||
// %s print the error. If the error has a Cause it will be
|
||||
// printed recursively
|
||||
// %v see %s
|
||||
// %+v extended format. Each Frame of the error's StackTrace will
|
||||
// be printed in detail.
|
||||
//
|
||||
// Retrieving the stack trace of an error or wrapper
|
||||
//
|
||||
// New, Errorf, Wrap, and Wrapf record a stack trace at the point they are
|
||||
// invoked. This information can be retrieved with the following interface.
|
||||
//
|
||||
// type stackTracer interface {
|
||||
// StackTrace() errors.StackTrace
|
||||
// }
|
||||
//
|
||||
// Where errors.StackTrace is defined as
|
||||
//
|
||||
// type StackTrace []Frame
|
||||
//
|
||||
// The Frame type represents a call site in the stack trace. Frame supports
|
||||
// the fmt.Formatter interface that can be used for printing information about
|
||||
// the stack trace of this error. For example:
|
||||
//
|
||||
// if err, ok := err.(stackTracer); ok {
|
||||
// for _, f := range err.StackTrace() {
|
||||
// fmt.Printf("%+s:%d", f)
|
||||
// }
|
||||
// }
|
||||
//
|
||||
// stackTracer interface is not exported by this package, but is considered a part
|
||||
// of stable public API.
|
||||
//
|
||||
// See the documentation for Frame.Format for more details.
|
||||
package errors |
||||
|
||||
import ( |
||||
"fmt" |
||||
"io" |
||||
) |
||||
|
||||
// New returns an error with the supplied message.
|
||||
// New also records the stack trace at the point it was called.
|
||||
func New(message string) error { |
||||
return &fundamental{ |
||||
msg: message, |
||||
stack: callers(), |
||||
} |
||||
} |
||||
|
||||
// Errorf formats according to a format specifier and returns the string
|
||||
// as a value that satisfies error.
|
||||
// Errorf also records the stack trace at the point it was called.
|
||||
func Errorf(format string, args ...interface{}) error { |
||||
return &fundamental{ |
||||
msg: fmt.Sprintf(format, args...), |
||||
stack: callers(), |
||||
} |
||||
} |
||||
|
||||
// fundamental is an error that has a message and a stack, but no caller.
|
||||
type fundamental struct { |
||||
msg string |
||||
*stack |
||||
} |
||||
|
||||
func (f *fundamental) Error() string { return f.msg } |
||||
|
||||
func (f *fundamental) Format(s fmt.State, verb rune) { |
||||
switch verb { |
||||
case 'v': |
||||
if s.Flag('+') { |
||||
io.WriteString(s, f.msg) |
||||
f.stack.Format(s, verb) |
||||
return |
||||
} |
||||
fallthrough |
||||
case 's': |
||||
io.WriteString(s, f.msg) |
||||
case 'q': |
||||
fmt.Fprintf(s, "%q", f.msg) |
||||
} |
||||
} |
||||
|
||||
// WithStack annotates err with a stack trace at the point WithStack was called.
|
||||
// If err is nil, WithStack returns nil.
|
||||
func WithStack(err error) error { |
||||
if err == nil { |
||||
return nil |
||||
} |
||||
return &withStack{ |
||||
err, |
||||
callers(), |
||||
} |
||||
} |
||||
|
||||
type withStack struct { |
||||
error |
||||
*stack |
||||
} |
||||
|
||||
func (w *withStack) Cause() error { return w.error } |
||||
|
||||
func (w *withStack) Format(s fmt.State, verb rune) { |
||||
switch verb { |
||||
case 'v': |
||||
if s.Flag('+') { |
||||
fmt.Fprintf(s, "%+v", w.Cause()) |
||||
w.stack.Format(s, verb) |
||||
return |
||||
} |
||||
fallthrough |
||||
case 's': |
||||
io.WriteString(s, w.Error()) |
||||
case 'q': |
||||
fmt.Fprintf(s, "%q", w.Error()) |
||||
} |
||||
} |
||||
|
||||
// Wrap returns an error annotating err with a stack trace
|
||||
// at the point Wrap is called, and the supplied message.
|
||||
// If err is nil, Wrap returns nil.
|
||||
func Wrap(err error, message string) error { |
||||
if err == nil { |
||||
return nil |
||||
} |
||||
err = &withMessage{ |
||||
cause: err, |
||||
msg: message, |
||||
} |
||||
return &withStack{ |
||||
err, |
||||
callers(), |
||||
} |
||||
} |
||||
|
||||
// Wrapf returns an error annotating err with a stack trace
|
||||
// at the point Wrapf is call, and the format specifier.
|
||||
// If err is nil, Wrapf returns nil.
|
||||
func Wrapf(err error, format string, args ...interface{}) error { |
||||
if err == nil { |
||||
return nil |
||||
} |
||||
err = &withMessage{ |
||||
cause: err, |
||||
msg: fmt.Sprintf(format, args...), |
||||
} |
||||
return &withStack{ |
||||
err, |
||||
callers(), |
||||
} |
||||
} |
||||
|
||||
// WithMessage annotates err with a new message.
|
||||
// If err is nil, WithMessage returns nil.
|
||||
func WithMessage(err error, message string) error { |
||||
if err == nil { |
||||
return nil |
||||
} |
||||
return &withMessage{ |
||||
cause: err, |
||||
msg: message, |
||||
} |
||||
} |
||||
|
||||
type withMessage struct { |
||||
cause error |
||||
msg string |
||||
} |
||||
|
||||
func (w *withMessage) Error() string { return w.msg + ": " + w.cause.Error() } |
||||
func (w *withMessage) Cause() error { return w.cause } |
||||
|
||||
func (w *withMessage) Format(s fmt.State, verb rune) { |
||||
switch verb { |
||||
case 'v': |
||||
if s.Flag('+') { |
||||
fmt.Fprintf(s, "%+v\n", w.Cause()) |
||||
io.WriteString(s, w.msg) |
||||
return |
||||
} |
||||
fallthrough |
||||
case 's', 'q': |
||||
io.WriteString(s, w.Error()) |
||||
} |
||||
} |
||||
|
||||
// Cause returns the underlying cause of the error, if possible.
|
||||
// An error value has a cause if it implements the following
|
||||
// interface:
|
||||
//
|
||||
// type causer interface {
|
||||
// Cause() error
|
||||
// }
|
||||
//
|
||||
// If the error does not implement Cause, the original error will
|
||||
// be returned. If the error is nil, nil will be returned without further
|
||||
// investigation.
|
||||
func Cause(err error) error { |
||||
type causer interface { |
||||
Cause() error |
||||
} |
||||
|
||||
for err != nil { |
||||
cause, ok := err.(causer) |
||||
if !ok { |
||||
break |
||||
} |
||||
err = cause.Cause() |
||||
} |
||||
return err |
||||
} |
||||
@ -0,0 +1,187 @@ |
||||
package errors |
||||
|
||||
import ( |
||||
"fmt" |
||||
"io" |
||||
"path" |
||||
"runtime" |
||||
"strings" |
||||
) |
||||
|
||||
// Frame represents a program counter inside a stack frame.
|
||||
type Frame uintptr |
||||
|
||||
// pc returns the program counter for this frame;
|
||||
// multiple frames may have the same PC value.
|
||||
func (f Frame) pc() uintptr { return uintptr(f) - 1 } |
||||
|
||||
// file returns the full path to the file that contains the
|
||||
// function for this Frame's pc.
|
||||
func (f Frame) file() string { |
||||
fn := runtime.FuncForPC(f.pc()) |
||||
if fn == nil { |
||||
return "unknown" |
||||
} |
||||
file, _ := fn.FileLine(f.pc()) |
||||
return file |
||||
} |
||||
|
||||
// line returns the line number of source code of the
|
||||
// function for this Frame's pc.
|
||||
func (f Frame) line() int { |
||||
fn := runtime.FuncForPC(f.pc()) |
||||
if fn == nil { |
||||
return 0 |
||||
} |
||||
_, line := fn.FileLine(f.pc()) |
||||
return line |
||||
} |
||||
|
||||
// Format formats the frame according to the fmt.Formatter interface.
|
||||
//
|
||||
// %s source file
|
||||
// %d source line
|
||||
// %n function name
|
||||
// %v equivalent to %s:%d
|
||||
//
|
||||
// Format accepts flags that alter the printing of some verbs, as follows:
|
||||
//
|
||||
// %+s function name and path of source file relative to the compile time
|
||||
// GOPATH separated by \n\t (<funcname>\n\t<path>)
|
||||
// %+v equivalent to %+s:%d
|
||||
func (f Frame) Format(s fmt.State, verb rune) { |
||||
switch verb { |
||||
case 's': |
||||
switch { |
||||
case s.Flag('+'): |
||||
pc := f.pc() |
||||
fn := runtime.FuncForPC(pc) |
||||
if fn == nil { |
||||
io.WriteString(s, "unknown") |
||||
} else { |
||||
file, _ := fn.FileLine(pc) |
||||
fmt.Fprintf(s, "%s\n\t%s", fn.Name(), file) |
||||
} |
||||
default: |
||||
io.WriteString(s, path.Base(f.file())) |
||||
} |
||||
case 'd': |
||||
fmt.Fprintf(s, "%d", f.line()) |
||||
case 'n': |
||||
name := runtime.FuncForPC(f.pc()).Name() |
||||
io.WriteString(s, funcname(name)) |
||||
case 'v': |
||||
f.Format(s, 's') |
||||
io.WriteString(s, ":") |
||||
f.Format(s, 'd') |
||||
} |
||||
} |
||||
|
||||
// StackTrace is stack of Frames from innermost (newest) to outermost (oldest).
|
||||
type StackTrace []Frame |
||||
|
||||
// Format formats the stack of Frames according to the fmt.Formatter interface.
|
||||
//
|
||||
// %s lists source files for each Frame in the stack
|
||||
// %v lists the source file and line number for each Frame in the stack
|
||||
//
|
||||
// Format accepts flags that alter the printing of some verbs, as follows:
|
||||
//
|
||||
// %+v Prints filename, function, and line number for each Frame in the stack.
|
||||
func (st StackTrace) Format(s fmt.State, verb rune) { |
||||
switch verb { |
||||
case 'v': |
||||
switch { |
||||
case s.Flag('+'): |
||||
for _, f := range st { |
||||
fmt.Fprintf(s, "\n%+v", f) |
||||
} |
||||
case s.Flag('#'): |
||||
fmt.Fprintf(s, "%#v", []Frame(st)) |
||||
default: |
||||
fmt.Fprintf(s, "%v", []Frame(st)) |
||||
} |
||||
case 's': |
||||
fmt.Fprintf(s, "%s", []Frame(st)) |
||||
} |
||||
} |
||||
|
||||
// stack represents a stack of program counters.
|
||||
type stack []uintptr |
||||
|
||||
func (s *stack) Format(st fmt.State, verb rune) { |
||||
switch verb { |
||||
case 'v': |
||||
switch { |
||||
case st.Flag('+'): |
||||
for _, pc := range *s { |
||||
f := Frame(pc) |
||||
fmt.Fprintf(st, "\n%+v", f) |
||||
} |
||||
} |
||||
} |
||||
} |
||||
|
||||
func (s *stack) StackTrace() StackTrace { |
||||
f := make([]Frame, len(*s)) |
||||
for i := 0; i < len(f); i++ { |
||||
f[i] = Frame((*s)[i]) |
||||
} |
||||
return f |
||||
} |
||||
|
||||
func callers() *stack { |
||||
const depth = 32 |
||||
var pcs [depth]uintptr |
||||
n := runtime.Callers(3, pcs[:]) |
||||
var st stack = pcs[0:n] |
||||
return &st |
||||
} |
||||
|
||||
// funcname removes the path prefix component of a function's name reported by func.Name().
|
||||
func funcname(name string) string { |
||||
i := strings.LastIndex(name, "/") |
||||
name = name[i+1:] |
||||
i = strings.Index(name, ".") |
||||
return name[i+1:] |
||||
} |
||||
|
||||
func trimGOPATH(name, file string) string { |
||||
// Here we want to get the source file path relative to the compile time
|
||||
// GOPATH. As of Go 1.6.x there is no direct way to know the compiled
|
||||
// GOPATH at runtime, but we can infer the number of path segments in the
|
||||
// GOPATH. We note that fn.Name() returns the function name qualified by
|
||||
// the import path, which does not include the GOPATH. Thus we can trim
|
||||
// segments from the beginning of the file path until the number of path
|
||||
// separators remaining is one more than the number of path separators in
|
||||
// the function name. For example, given:
|
||||
//
|
||||
// GOPATH /home/user
|
||||
// file /home/user/src/pkg/sub/file.go
|
||||
// fn.Name() pkg/sub.Type.Method
|
||||
//
|
||||
// We want to produce:
|
||||
//
|
||||
// pkg/sub/file.go
|
||||
//
|
||||
// From this we can easily see that fn.Name() has one less path separator
|
||||
// than our desired output. We count separators from the end of the file
|
||||
// path until it finds two more than in the function name and then move
|
||||
// one character forward to preserve the initial path segment without a
|
||||
// leading separator.
|
||||
const sep = "/" |
||||
goal := strings.Count(name, sep) + 2 |
||||
i := len(file) |
||||
for n := 0; n < goal; n++ { |
||||
i = strings.LastIndex(file[:i], sep) |
||||
if i == -1 { |
||||
// not enough separators found, set i so that the slice expression
|
||||
// below leaves file unmodified
|
||||
i = -len(sep) |
||||
break |
||||
} |
||||
} |
||||
// get back to 0 or trim the leading separator
|
||||
file = file[i+len(sep):] |
||||
return file |
||||
} |
||||
Loading…
Reference in new issue