pax_global_header00006660000000000000000000000064140224753100014510gustar00rootroot0000000000000052 comment=9974e9ec57696378079ecc3accd3d6f29401b3a0 go-multierror-1.1.1/000077500000000000000000000000001402247531000143175ustar00rootroot00000000000000go-multierror-1.1.1/.circleci/000077500000000000000000000000001402247531000161525ustar00rootroot00000000000000go-multierror-1.1.1/.circleci/config.yml000066400000000000000000000114361402247531000201470ustar00rootroot00000000000000version: 2.1 orbs: win: circleci/windows@2.2.0 references: environment: &ENVIRONMENT TEST_RESULTS_PATH: &TEST_RESULTS_PATH /tmp/test-results WIN_TEST_RESULTS: &WIN_TEST_RESULTS c:\Users\circleci\AppData\Local\Temp\test-results commands: run-gotests: parameters: cmd: type: string platform: type: string steps: - run: name: "Run go tests" command: | PACKAGE_NAMES=$(go list ./... | circleci tests split --split-by=timings --timings-type=classname) echo "Running $(echo $PACKAGE_NAMES | wc -w) packages" echo $PACKAGE_NAMES << parameters.cmd >> --format=short-verbose --junitfile $TEST_RESULTS_PATH/go-multierror/gotestsum-report.xml -- -p 2 -cover -coverprofile=<< parameters.platform >>_cov_$CIRCLE_NODE_INDEX.part $PACKAGE_NAMES jobs: linux-tests: docker: - image: docker.mirror.hashicorp.services/circleci/golang:<< parameters.go-version >> parameters: go-version: type: string environment: <<: *ENVIRONMENT parallelism: 4 steps: - run: go version - checkout - attach_workspace: at: . - run: mkdir -p $TEST_RESULTS_PATH/go-multierror # Restore go module cache if there is one - restore_cache: keys: - linux-gomod-cache-v1-{{ checksum "go.mod" }} - run: go mod download # Save go module cache if the go.mod file has changed - save_cache: key: linux-gomod-cache-v1-{{ checksum "go.mod" }} paths: - "/go/pkg/mod" # Check go fmt output because it does not report non-zero when there are fmt changes - run: name: check go fmt command: | files=$(go fmt ./...) if [ -n "$files" ]; then echo "The following file(s) do not conform to go fmt:" echo "$files" exit 1 fi # Run go tests with gotestsum - run-gotests: cmd: "gotestsum" platform: "linux" # Save coverage report parts - persist_to_workspace: root: . paths: - linux_cov_*.part - store_test_results: path: *TEST_RESULTS_PATH - store_artifacts: path: *TEST_RESULTS_PATH windows-tests: executor: name: win/default shell: bash --login -eo pipefail environment: <<: *ENVIRONMENT working_directory: c:\gopath\src\github.com\hashicorp\go-multierror parameters: go-version: type: string gotestsum-version: type: string steps: - run: git config --global core.autocrlf false - checkout - attach_workspace: at: . - run: name: Setup (remove pre-installed go) command: | rm -rf "c:\Go" mkdir -p $TEST_RESULTS_PATH/go-multierror - restore_cache: keys: - win-golang-<< parameters.go-version >>-cache-v1 - win-gomod-cache-{{ checksum "go.mod" }}-v1 - run: name: Install go version << parameters.go-version >> command: | if [ ! -d "c:\go" ]; then echo "Cache not found, installing new version of go" curl --fail --location https://dl.google.com/go/go<< parameters.go-version >>.windows-amd64.zip --output go.zip unzip go.zip -d "/c" fi - run: command: go mod download - save_cache: key: win-golang-<< parameters.go-version >>-cache-v1 paths: - /go - save_cache: key: win-gomod-cache-{{ checksum "go.mod" }}-v1 paths: - c:\Windows\system32\config\systemprofile\go\pkg\mod - run: name: Install gotestsum command: | curl --fail --location https://github.com/gotestyourself/gotestsum/releases/download/v<< parameters.gotestsum-version >>/gotestsum_<< parameters.gotestsum-version >>_windows_amd64.tar.gz --output gotestsum.tar.gz tar -xvzf gotestsum.tar.gz - run-gotests: cmd: "./gotestsum.exe" platform: "win" # Save coverage report parts - persist_to_workspace: root: . paths: - win_cov_*.part - store_test_results: path: *WIN_TEST_RESULTS - store_artifacts: path: *WIN_TEST_RESULTS workflows: go-multierror: jobs: - linux-tests: matrix: parameters: go-version: ["1.13", "1.14", "1.15"] name: linux-test-go-<< matrix.go-version >> - windows-tests: matrix: parameters: go-version: ["1.13", "1.14", "1.15"] gotestsum-version: ["1.6.2"] name: win-test-go-<< matrix.go-version >> go-multierror-1.1.1/LICENSE000066400000000000000000000371501402247531000153320ustar00rootroot00000000000000Mozilla 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. go-multierror-1.1.1/Makefile000066400000000000000000000014651402247531000157650ustar00rootroot00000000000000TEST?=./... default: test # test runs the test suite and vets the code. test: generate @echo "==> Running tests..." @go list $(TEST) \ | grep -v "/vendor/" \ | xargs -n1 go test -timeout=60s -parallel=10 ${TESTARGS} # testrace runs the race checker testrace: generate @echo "==> Running tests (race)..." @go list $(TEST) \ | grep -v "/vendor/" \ | xargs -n1 go test -timeout=60s -race ${TESTARGS} # updatedeps installs all the dependencies needed to run and build. updatedeps: @sh -c "'${CURDIR}/scripts/deps.sh' '${NAME}'" # generate runs `go generate` to build the dynamically generated source files. generate: @echo "==> Generating..." @find . -type f -name '.DS_Store' -delete @go list ./... \ | grep -v "/vendor/" \ | xargs -n1 go generate .PHONY: default test testrace updatedeps generate go-multierror-1.1.1/README.md000066400000000000000000000112261402247531000156000ustar00rootroot00000000000000# go-multierror [![CircleCI](https://img.shields.io/circleci/build/github/hashicorp/go-multierror/master)](https://circleci.com/gh/hashicorp/go-multierror) [![Go Reference](https://pkg.go.dev/badge/github.com/hashicorp/go-multierror.svg)](https://pkg.go.dev/github.com/hashicorp/go-multierror) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/hashicorp/go-multierror) [circleci]: https://app.circleci.com/pipelines/github/hashicorp/go-multierror [godocs]: https://pkg.go.dev/github.com/hashicorp/go-multierror `go-multierror` is a package for Go that provides a mechanism for representing a list of `error` values as a single `error`. This allows a function in Go to return an `error` that might actually be a list of errors. If the caller knows this, they can unwrap the list and access the errors. If the caller doesn't know, the error formats to a nice human-readable format. `go-multierror` is fully compatible with the Go standard library [errors](https://golang.org/pkg/errors/) package, including the functions `As`, `Is`, and `Unwrap`. This provides a standardized approach for introspecting on error values. ## Installation and Docs Install using `go get github.com/hashicorp/go-multierror`. Full documentation is available at https://pkg.go.dev/github.com/hashicorp/go-multierror ### Requires go version 1.13 or newer `go-multierror` requires go version 1.13 or newer. Go 1.13 introduced [error wrapping](https://golang.org/doc/go1.13#error_wrapping), which this library takes advantage of. If you need to use an earlier version of go, you can use the [v1.0.0](https://github.com/hashicorp/go-multierror/tree/v1.0.0) tag, which doesn't rely on features in go 1.13. If you see compile errors that look like the below, it's likely that you're on an older version of go: ``` /go/src/github.com/hashicorp/go-multierror/multierror.go:112:9: undefined: errors.As /go/src/github.com/hashicorp/go-multierror/multierror.go:117:9: undefined: errors.Is ``` ## Usage go-multierror is easy to use and purposely built to be unobtrusive in existing Go applications/libraries that may not be aware of it. **Building a list of errors** The `Append` function is used to create a list of errors. This function behaves a lot like the Go built-in `append` function: it doesn't matter if the first argument is nil, a `multierror.Error`, or any other `error`, the function behaves as you would expect. ```go var result error if err := step1(); err != nil { result = multierror.Append(result, err) } if err := step2(); err != nil { result = multierror.Append(result, err) } return result ``` **Customizing the formatting of the errors** By specifying a custom `ErrorFormat`, you can customize the format of the `Error() string` function: ```go var result *multierror.Error // ... accumulate errors here, maybe using Append if result != nil { result.ErrorFormat = func([]error) string { return "errors!" } } ``` **Accessing the list of errors** `multierror.Error` implements `error` so if the caller doesn't know about multierror, it will work just fine. But if you're aware a multierror might be returned, you can use type switches to access the list of errors: ```go if err := something(); err != nil { if merr, ok := err.(*multierror.Error); ok { // Use merr.Errors } } ``` You can also use the standard [`errors.Unwrap`](https://golang.org/pkg/errors/#Unwrap) function. This will continue to unwrap into subsequent errors until none exist. **Extracting an error** The standard library [`errors.As`](https://golang.org/pkg/errors/#As) function can be used directly with a multierror to extract a specific error: ```go // Assume err is a multierror value err := somefunc() // We want to know if "err" has a "RichErrorType" in it and extract it. var errRich RichErrorType if errors.As(err, &errRich) { // It has it, and now errRich is populated. } ``` **Checking for an exact error value** Some errors are returned as exact errors such as the [`ErrNotExist`](https://golang.org/pkg/os/#pkg-variables) error in the `os` package. You can check if this error is present by using the standard [`errors.Is`](https://golang.org/pkg/errors/#Is) function. ```go // Assume err is a multierror value err := somefunc() if errors.Is(err, os.ErrNotExist) { // err contains os.ErrNotExist } ``` **Returning a multierror only if there are errors** If you build a `multierror.Error`, you can use the `ErrorOrNil` function to return an `error` implementation only if there are errors to return: ```go var result *multierror.Error // ... accumulate errors here // Return the `error` only if errors were added to the multierror, otherwise // return nil since there are no errors. return result.ErrorOrNil() ``` go-multierror-1.1.1/append.go000066400000000000000000000020421402247531000161130ustar00rootroot00000000000000package multierror // Append is a helper function that will append more errors // onto an Error in order to create a larger multi-error. // // If err is not a multierror.Error, then it will be turned into // one. If any of the errs are multierr.Error, they will be flattened // one level into err. // Any nil errors within errs will be ignored. If err is nil, a new // *Error will be returned. func Append(err error, errs ...error) *Error { switch err := err.(type) { case *Error: // Typed nils can reach here, so initialize if we are nil if err == nil { err = new(Error) } // Go through each error and flatten for _, e := range errs { switch e := e.(type) { case *Error: if e != nil { err.Errors = append(err.Errors, e.Errors...) } default: if e != nil { err.Errors = append(err.Errors, e) } } } return err default: newErrs := make([]error, 0, len(errs)+1) if err != nil { newErrs = append(newErrs, err) } newErrs = append(newErrs, errs...) return Append(&Error{}, newErrs...) } } go-multierror-1.1.1/append_test.go000066400000000000000000000034631402247531000171620ustar00rootroot00000000000000package multierror import ( "errors" "testing" ) func TestAppend_Error(t *testing.T) { original := &Error{ Errors: []error{errors.New("foo")}, } result := Append(original, errors.New("bar")) if len(result.Errors) != 2 { t.Fatalf("wrong len: %d", len(result.Errors)) } original = &Error{} result = Append(original, errors.New("bar")) if len(result.Errors) != 1 { t.Fatalf("wrong len: %d", len(result.Errors)) } // Test when a typed nil is passed var e *Error result = Append(e, errors.New("baz")) if len(result.Errors) != 1 { t.Fatalf("wrong len: %d", len(result.Errors)) } // Test flattening original = &Error{ Errors: []error{errors.New("foo")}, } result = Append(original, Append(nil, errors.New("foo"), errors.New("bar"))) if len(result.Errors) != 3 { t.Fatalf("wrong len: %d", len(result.Errors)) } } func TestAppend_NilError(t *testing.T) { var err error result := Append(err, errors.New("bar")) if len(result.Errors) != 1 { t.Fatalf("wrong len: %d", len(result.Errors)) } } func TestAppend_NilErrorArg(t *testing.T) { var err error var nilErr *Error result := Append(err, nilErr) if len(result.Errors) != 0 { t.Fatalf("wrong len: %d", len(result.Errors)) } } func TestAppend_NilErrorIfaceArg(t *testing.T) { var err error var nilErr error result := Append(err, nilErr) if len(result.Errors) != 0 { t.Fatalf("wrong len: %d", len(result.Errors)) } } func TestAppend_NonError(t *testing.T) { original := errors.New("foo") result := Append(original, errors.New("bar")) if len(result.Errors) != 2 { t.Fatalf("wrong len: %d", len(result.Errors)) } } func TestAppend_NonError_Error(t *testing.T) { original := errors.New("foo") result := Append(original, Append(nil, errors.New("bar"))) if len(result.Errors) != 2 { t.Fatalf("wrong len: %d", len(result.Errors)) } } go-multierror-1.1.1/flatten.go000066400000000000000000000010701402247531000163010ustar00rootroot00000000000000package multierror // Flatten flattens the given error, merging any *Errors together into // a single *Error. func Flatten(err error) error { // If it isn't an *Error, just return the error as-is if _, ok := err.(*Error); !ok { return err } // Otherwise, make the result and flatten away! flatErr := new(Error) flatten(err, flatErr) return flatErr } func flatten(err error, flatErr *Error) { switch err := err.(type) { case *Error: for _, e := range err.Errors { flatten(e, flatErr) } default: flatErr.Errors = append(flatErr.Errors, err) } } go-multierror-1.1.1/flatten_test.go000066400000000000000000000012541402247531000173440ustar00rootroot00000000000000package multierror import ( "errors" "fmt" "reflect" "testing" ) func TestFlatten(t *testing.T) { original := &Error{ Errors: []error{ errors.New("one"), &Error{ Errors: []error{ errors.New("two"), &Error{ Errors: []error{ errors.New("three"), }, }, }, }, }, } expected := `3 errors occurred: * one * two * three ` actual := fmt.Sprintf("%s", Flatten(original)) if expected != actual { t.Fatalf("expected: %s, got: %s", expected, actual) } } func TestFlatten_nonError(t *testing.T) { err := errors.New("foo") actual := Flatten(err) if !reflect.DeepEqual(actual, err) { t.Fatalf("bad: %#v", actual) } } go-multierror-1.1.1/format.go000066400000000000000000000012341402247531000161360ustar00rootroot00000000000000package multierror import ( "fmt" "strings" ) // ErrorFormatFunc is a function callback that is called by Error to // turn the list of errors into a string. type ErrorFormatFunc func([]error) string // ListFormatFunc is a basic formatter that outputs the number of errors // that occurred along with a bullet point list of the errors. func ListFormatFunc(es []error) string { if len(es) == 1 { return fmt.Sprintf("1 error occurred:\n\t* %s\n\n", es[0]) } points := make([]string, len(es)) for i, err := range es { points[i] = fmt.Sprintf("* %s", err) } return fmt.Sprintf( "%d errors occurred:\n\t%s\n\n", len(es), strings.Join(points, "\n\t")) } go-multierror-1.1.1/format_test.go000066400000000000000000000010371402247531000171760ustar00rootroot00000000000000package multierror import ( "errors" "testing" ) func TestListFormatFuncSingle(t *testing.T) { expected := `1 error occurred: * foo ` errors := []error{ errors.New("foo"), } actual := ListFormatFunc(errors) if actual != expected { t.Fatalf("bad: %#v", actual) } } func TestListFormatFuncMultiple(t *testing.T) { expected := `2 errors occurred: * foo * bar ` errors := []error{ errors.New("foo"), errors.New("bar"), } actual := ListFormatFunc(errors) if actual != expected { t.Fatalf("bad: %#v", actual) } } go-multierror-1.1.1/go.mod000066400000000000000000000001401402247531000154200ustar00rootroot00000000000000module github.com/hashicorp/go-multierror go 1.13 require github.com/hashicorp/errwrap v1.0.0 go-multierror-1.1.1/go.sum000066400000000000000000000002571402247531000154560ustar00rootroot00000000000000github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= go-multierror-1.1.1/group.go000066400000000000000000000013671402247531000160110ustar00rootroot00000000000000package multierror import "sync" // Group is a collection of goroutines which return errors that need to be // coalesced. type Group struct { mutex sync.Mutex err *Error wg sync.WaitGroup } // Go calls the given function in a new goroutine. // // If the function returns an error it is added to the group multierror which // is returned by Wait. func (g *Group) Go(f func() error) { g.wg.Add(1) go func() { defer g.wg.Done() if err := f(); err != nil { g.mutex.Lock() g.err = Append(g.err, err) g.mutex.Unlock() } }() } // Wait blocks until all function calls from the Go method have returned, then // returns the multierror. func (g *Group) Wait() *Error { g.wg.Wait() g.mutex.Lock() defer g.mutex.Unlock() return g.err } go-multierror-1.1.1/group_test.go000066400000000000000000000016011402247531000170370ustar00rootroot00000000000000package multierror import ( "errors" "strings" "testing" ) func TestGroup(t *testing.T) { err1 := errors.New("group_test: 1") err2 := errors.New("group_test: 2") cases := []struct { errs []error nilResult bool }{ {errs: []error{}, nilResult: true}, {errs: []error{nil}, nilResult: true}, {errs: []error{err1}}, {errs: []error{err1, nil}}, {errs: []error{err1, nil, err2}}, } for _, tc := range cases { var g Group for _, err := range tc.errs { err := err g.Go(func() error { return err }) } gErr := g.Wait() if gErr != nil { for i := range tc.errs { if tc.errs[i] != nil && !strings.Contains(gErr.Error(), tc.errs[i].Error()) { t.Fatalf("expected error to contain %q, actual: %v", tc.errs[i].Error(), gErr) } } } else if !tc.nilResult { t.Fatalf("Group.Wait() should not have returned nil for errs: %v", tc.errs) } } } go-multierror-1.1.1/multierror.go000066400000000000000000000065741402247531000170660ustar00rootroot00000000000000package multierror import ( "errors" "fmt" ) // Error is an error type to track multiple errors. This is used to // accumulate errors in cases and return them as a single "error". type Error struct { Errors []error ErrorFormat ErrorFormatFunc } func (e *Error) Error() string { fn := e.ErrorFormat if fn == nil { fn = ListFormatFunc } return fn(e.Errors) } // ErrorOrNil returns an error interface if this Error represents // a list of errors, or returns nil if the list of errors is empty. This // function is useful at the end of accumulation to make sure that the value // returned represents the existence of errors. func (e *Error) ErrorOrNil() error { if e == nil { return nil } if len(e.Errors) == 0 { return nil } return e } func (e *Error) GoString() string { return fmt.Sprintf("*%#v", *e) } // WrappedErrors returns the list of errors that this Error is wrapping. It is // an implementation of the errwrap.Wrapper interface so that multierror.Error // can be used with that library. // // This method is not safe to be called concurrently. Unlike accessing the // Errors field directly, this function also checks if the multierror is nil to // prevent a null-pointer panic. It satisfies the errwrap.Wrapper interface. func (e *Error) WrappedErrors() []error { if e == nil { return nil } return e.Errors } // Unwrap returns an error from Error (or nil if there are no errors). // This error returned will further support Unwrap to get the next error, // etc. The order will match the order of Errors in the multierror.Error // at the time of calling. // // The resulting error supports errors.As/Is/Unwrap so you can continue // to use the stdlib errors package to introspect further. // // This will perform a shallow copy of the errors slice. Any errors appended // to this error after calling Unwrap will not be available until a new // Unwrap is called on the multierror.Error. func (e *Error) Unwrap() error { // If we have no errors then we do nothing if e == nil || len(e.Errors) == 0 { return nil } // If we have exactly one error, we can just return that directly. if len(e.Errors) == 1 { return e.Errors[0] } // Shallow copy the slice errs := make([]error, len(e.Errors)) copy(errs, e.Errors) return chain(errs) } // chain implements the interfaces necessary for errors.Is/As/Unwrap to // work in a deterministic way with multierror. A chain tracks a list of // errors while accounting for the current represented error. This lets // Is/As be meaningful. // // Unwrap returns the next error. In the cleanest form, Unwrap would return // the wrapped error here but we can't do that if we want to properly // get access to all the errors. Instead, users are recommended to use // Is/As to get the correct error type out. // // Precondition: []error is non-empty (len > 0) type chain []error // Error implements the error interface func (e chain) Error() string { return e[0].Error() } // Unwrap implements errors.Unwrap by returning the next error in the // chain or nil if there are no more errors. func (e chain) Unwrap() error { if len(e) == 1 { return nil } return e[1:] } // As implements errors.As by attempting to map to the current value. func (e chain) As(target interface{}) bool { return errors.As(e[0], target) } // Is implements errors.Is by comparing the current value directly. func (e chain) Is(target error) bool { return errors.Is(e[0], target) } go-multierror-1.1.1/multierror_test.go000066400000000000000000000075571402247531000201270ustar00rootroot00000000000000package multierror import ( "errors" "fmt" "reflect" "testing" ) func TestError_Impl(t *testing.T) { var _ error = new(Error) } func TestErrorError_custom(t *testing.T) { errors := []error{ errors.New("foo"), errors.New("bar"), } fn := func(es []error) string { return "foo" } multi := &Error{Errors: errors, ErrorFormat: fn} if multi.Error() != "foo" { t.Fatalf("bad: %s", multi.Error()) } } func TestErrorError_default(t *testing.T) { expected := `2 errors occurred: * foo * bar ` errors := []error{ errors.New("foo"), errors.New("bar"), } multi := &Error{Errors: errors} if multi.Error() != expected { t.Fatalf("bad: %s", multi.Error()) } } func TestErrorErrorOrNil(t *testing.T) { err := new(Error) if err.ErrorOrNil() != nil { t.Fatalf("bad: %#v", err.ErrorOrNil()) } err.Errors = []error{errors.New("foo")} if v := err.ErrorOrNil(); v == nil { t.Fatal("should not be nil") } else if !reflect.DeepEqual(v, err) { t.Fatalf("bad: %#v", v) } } func TestErrorWrappedErrors(t *testing.T) { errors := []error{ errors.New("foo"), errors.New("bar"), } multi := &Error{Errors: errors} if !reflect.DeepEqual(multi.Errors, multi.WrappedErrors()) { t.Fatalf("bad: %s", multi.WrappedErrors()) } multi = nil if err := multi.WrappedErrors(); err != nil { t.Fatalf("bad: %#v", multi) } } func TestErrorUnwrap(t *testing.T) { t.Run("with errors", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), errors.New("bar"), errors.New("baz"), }} var current error = err for i := 0; i < len(err.Errors); i++ { current = errors.Unwrap(current) if !errors.Is(current, err.Errors[i]) { t.Fatal("should be next value") } } if errors.Unwrap(current) != nil { t.Fatal("should be nil at the end") } }) t.Run("with no errors", func(t *testing.T) { err := &Error{Errors: nil} if errors.Unwrap(err) != nil { t.Fatal("should be nil") } }) t.Run("with nil multierror", func(t *testing.T) { var err *Error if errors.Unwrap(err) != nil { t.Fatal("should be nil") } }) } func TestErrorIs(t *testing.T) { errBar := errors.New("bar") t.Run("with errBar", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), errBar, errors.New("baz"), }} if !errors.Is(err, errBar) { t.Fatal("should be true") } }) t.Run("with errBar wrapped by fmt.Errorf", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), fmt.Errorf("errorf: %w", errBar), errors.New("baz"), }} if !errors.Is(err, errBar) { t.Fatal("should be true") } }) t.Run("without errBar", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), errors.New("baz"), }} if errors.Is(err, errBar) { t.Fatal("should be false") } }) } func TestErrorAs(t *testing.T) { match := &nestedError{} t.Run("with the value", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), match, errors.New("baz"), }} var target *nestedError if !errors.As(err, &target) { t.Fatal("should be true") } if target == nil { t.Fatal("target should not be nil") } }) t.Run("with the value wrapped by fmt.Errorf", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), fmt.Errorf("errorf: %w", match), errors.New("baz"), }} var target *nestedError if !errors.As(err, &target) { t.Fatal("should be true") } if target == nil { t.Fatal("target should not be nil") } }) t.Run("without the value", func(t *testing.T) { err := &Error{Errors: []error{ errors.New("foo"), errors.New("baz"), }} var target *nestedError if errors.As(err, &target) { t.Fatal("should be false") } if target != nil { t.Fatal("target should be nil") } }) } // nestedError implements error and is used for tests. type nestedError struct{} func (*nestedError) Error() string { return "" } go-multierror-1.1.1/prefix.go000066400000000000000000000014321402247531000161430ustar00rootroot00000000000000package multierror import ( "fmt" "github.com/hashicorp/errwrap" ) // Prefix is a helper function that will prefix some text // to the given error. If the error is a multierror.Error, then // it will be prefixed to each wrapped error. // // This is useful to use when appending multiple multierrors // together in order to give better scoping. func Prefix(err error, prefix string) error { if err == nil { return nil } format := fmt.Sprintf("%s {{err}}", prefix) switch err := err.(type) { case *Error: // Typed nils can reach here, so initialize if we are nil if err == nil { err = new(Error) } // Wrap each of the errors for i, e := range err.Errors { err.Errors[i] = errwrap.Wrapf(format, e) } return err default: return errwrap.Wrapf(format, err) } } go-multierror-1.1.1/prefix_test.go000066400000000000000000000012161402247531000172020ustar00rootroot00000000000000package multierror import ( "errors" "testing" ) func TestPrefix_Error(t *testing.T) { original := &Error{ Errors: []error{errors.New("foo")}, } result := Prefix(original, "bar") if result.(*Error).Errors[0].Error() != "bar foo" { t.Fatalf("bad: %s", result) } } func TestPrefix_NilError(t *testing.T) { var err error result := Prefix(err, "bar") if result != nil { t.Fatalf("bad: %#v", result) } } func TestPrefix_NonError(t *testing.T) { original := errors.New("foo") result := Prefix(original, "bar") if result == nil { t.Fatal("error result was nil") } if result.Error() != "bar foo" { t.Fatalf("bad: %s", result) } } go-multierror-1.1.1/sort.go000066400000000000000000000007041402247531000156360ustar00rootroot00000000000000package multierror // Len implements sort.Interface function for length func (err Error) Len() int { return len(err.Errors) } // Swap implements sort.Interface function for swapping elements func (err Error) Swap(i, j int) { err.Errors[i], err.Errors[j] = err.Errors[j], err.Errors[i] } // Less implements sort.Interface function for determining order func (err Error) Less(i, j int) bool { return err.Errors[i].Error() < err.Errors[j].Error() } go-multierror-1.1.1/sort_test.go000066400000000000000000000012511402247531000166730ustar00rootroot00000000000000package multierror import ( "errors" "reflect" "sort" "testing" ) func TestSortSingle(t *testing.T) { errFoo := errors.New("foo") expected := []error{ errFoo, } err := &Error{ Errors: []error{ errFoo, }, } sort.Sort(err) if !reflect.DeepEqual(err.Errors, expected) { t.Fatalf("bad: %#v", err) } } func TestSortMultiple(t *testing.T) { errBar := errors.New("bar") errBaz := errors.New("baz") errFoo := errors.New("foo") expected := []error{ errBar, errBaz, errFoo, } err := &Error{ Errors: []error{ errFoo, errBar, errBaz, }, } sort.Sort(err) if !reflect.DeepEqual(err.Errors, expected) { t.Fatalf("bad: %#v", err) } }