diff --git a/go.mod b/go.mod index b44beb7b..28e61f22 100644 --- a/go.mod +++ b/go.mod @@ -36,6 +36,7 @@ require ( github.com/go-playground/locales v0.14.1 // indirect github.com/go-playground/universal-translator v0.18.1 // indirect github.com/go-playground/validator/v10 v10.26.0 // indirect + github.com/goaux/timer v1.1.0 // indirect github.com/goccy/go-json v0.10.5 // indirect github.com/golang/snappy v1.0.0 // indirect github.com/huandu/go-clone v1.6.0 // indirect diff --git a/go.sum b/go.sum index 9674086d..e696c07e 100644 --- a/go.sum +++ b/go.sum @@ -37,6 +37,8 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= github.com/go-playground/validator/v10 v10.26.0 h1:SP05Nqhjcvz81uJaRfEV0YBSSSGMc/iMaVtFbr3Sw2k= github.com/go-playground/validator/v10 v10.26.0/go.mod h1:I5QpIEbmr8On7W0TktmJAumgzX4CA1XNl4ZmDuVHKKo= +github.com/goaux/timer v1.1.0 h1:Aj633zx1V/XN5hVI3lDBpHPZI8L1HEFsTfaNymXjyc4= +github.com/goaux/timer v1.1.0/go.mod h1:kAhAdGb1hZBiwYfzCmNYukcLMdsWgvESW1wrBbq7B54= github.com/goccy/go-json v0.10.5 h1:Fq85nIqj+gXn/S5ahsiTlK3TmC85qgirsdTP/+DeaC4= github.com/goccy/go-json v0.10.5/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M= github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= diff --git a/internal/verifier/check.go b/internal/verifier/check.go index bd64874f..13b2f1e7 100644 --- a/internal/verifier/check.go +++ b/internal/verifier/check.go @@ -11,6 +11,7 @@ import ( "github.com/10gen/migration-verifier/internal/util" "github.com/10gen/migration-verifier/mslices" mapset "github.com/deckarep/golang-set/v2" + "github.com/goaux/timer" "github.com/pkg/errors" "go.mongodb.org/mongo-driver/v2/bson" "go.mongodb.org/mongo-driver/v2/mongo" @@ -119,15 +120,18 @@ func (verifier *Verifier) CheckWorker(ctxIn context.Context) error { var finishedAllTasks bool + inProgressDone := make(chan struct{}) go func() { + defer close(inProgressDone) + delay := 30 * time.Second - time.Sleep(delay) + for { + if err := timer.SleepCause(cancelableCtx, delay); err != nil { + return + } - for cancelableCtx.Err() == nil { verifier.PrintVerificationSummary(cancelableCtx, GenerationInProgress) - - time.Sleep(delay) } }() @@ -154,9 +158,13 @@ func (verifier *Verifier) CheckWorker(ctxIn context.Context) error { time.Sleep(verifier.verificationStatusCheckInterval) } else { finishedAllTasks = true - verifier.PrintVerificationSummary(ctx, GenerationComplete) + // Stop the thread that prints in-progress notifications. canceler(errors.Errorf("generation %d finished", generation)) + <-inProgressDone + + verifier.PrintVerificationSummary(ctx, GenerationComplete) + return nil } } diff --git a/vendor/github.com/goaux/timer/.gitignore b/vendor/github.com/goaux/timer/.gitignore new file mode 100644 index 00000000..6f6f5e6a --- /dev/null +++ b/vendor/github.com/goaux/timer/.gitignore @@ -0,0 +1,22 @@ +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work +go.work.sum diff --git a/vendor/github.com/goaux/timer/LICENSE b/vendor/github.com/goaux/timer/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/vendor/github.com/goaux/timer/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/vendor/github.com/goaux/timer/README.md b/vendor/github.com/goaux/timer/README.md new file mode 100644 index 00000000..94305e7f --- /dev/null +++ b/vendor/github.com/goaux/timer/README.md @@ -0,0 +1,65 @@ +# timer +The `timer` module provides a context-aware Sleep function for Go applications. + +[![Go Reference](https://pkg.go.dev/badge/github.com/goaux/timer.svg)](https://pkg.go.dev/github.com/goaux/timer) +[![Go Report Card](https://goreportcard.com/badge/github.com/goaux/timer)](https://goreportcard.com/report/github.com/goaux/timer) + +## Installation + +To install the `timer` module, use the following command: + + go get github.com/goaux/timer + +## Usage + +Here's a basic example of how to use the `Sleep` function: + + package main + + import ( + "fmt" + "os" + "os/signal" + "time" + + "github.com/goaux/timer" + ) + + func main() { + // Create a context that will be canceled when SIGINT is received + ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt) + defer stop() + + fmt.Println("Starting sleep for 10 seconds. Press Ctrl+C to interrupt.") + + // Try to sleep for 10 seconds + err := timer.SleepCause(ctx, 10*time.Second) + + if err != nil { + fmt.Printf("Sleep interrupted: %v\n", err) + } else { + fmt.Println("Sleep completed successfully") + } + + // Note: The actual output may vary depending on whether + // the user interrupts the program or not. + // Example output if interrupted: + // Starting sleep for 10 seconds. Press Ctrl+C to interrupt. + // Sleep interrupted: context canceled + } + +## Function + +### SleepCause + + func SleepCause(ctx context.Context, d time.Duration) error + +`SleepCause` pauses the current goroutine for the specified duration or until the context is canceled. +It returns `nil` if the sleep completes normally, or the cause of the context cancellation (as returned by `context.Cause`) if canceled. + +### Sleep + + func Sleep(ctx context.Context, d time.Duration) error + +`Sleep` pauses the current goroutine for the specified duration or until the context is canceled. +It returns `nil` if the sleep completes normally, or the context's error if the context is canceled before the duration elapses. diff --git a/vendor/github.com/goaux/timer/sleep.go b/vendor/github.com/goaux/timer/sleep.go new file mode 100644 index 00000000..c0beb8b7 --- /dev/null +++ b/vendor/github.com/goaux/timer/sleep.go @@ -0,0 +1,43 @@ +// Package timer provides a context-aware Sleep function. +// +// It offers a way to pause execution for a specified duration, +// while respecting context cancellation. +package timer + +import ( + "context" + "time" +) + +// Sleep pauses the current goroutine for the specified duration or until the +// context is canceled. +// +// It returns nil if the sleep completes normally, or the context's error if +// the context is canceled before the duration elapses. +func Sleep(ctx context.Context, d time.Duration) error { + t := time.NewTimer(d) + defer t.Stop() + select { + case <-t.C: + return nil + case <-ctx.Done(): + return ctx.Err() + } +} + +// SleepCause pauses the current goroutine for the specified duration or until the +// context is canceled. It returns nil if the sleep completes normally, or the +// cause of the context cancellation (as returned by [context.Cause]) if canceled. +// +// This function requires Go 1.20+ to use [context.Cause]. +// It provides more detailed error information compared to [Sleep]. +func SleepCause(ctx context.Context, d time.Duration) error { + t := time.NewTimer(d) + defer t.Stop() + select { + case <-t.C: + return nil + case <-ctx.Done(): + return context.Cause(ctx) + } +} diff --git a/vendor/modules.txt b/vendor/modules.txt index d2c4c601..e7543b12 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -93,6 +93,9 @@ github.com/go-playground/universal-translator # github.com/go-playground/validator/v10 v10.26.0 ## explicit; go 1.20 github.com/go-playground/validator/v10 +# github.com/goaux/timer v1.1.0 +## explicit; go 1.20 +github.com/goaux/timer # github.com/goccy/go-json v0.10.5 ## explicit; go 1.19 github.com/goccy/go-json @@ -150,8 +153,6 @@ github.com/modern-go/concurrent # github.com/modern-go/reflect2 v1.0.2 ## explicit; go 1.12 github.com/modern-go/reflect2 -# github.com/montanaflynn/stats v0.7.1 -## explicit; go 1.13 # github.com/olekukonko/tablewriter v0.0.5 ## explicit; go 1.12 github.com/olekukonko/tablewriter