├── README.md ├── rfc2822time.go ├── provider_test.go ├── provider.go └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | **This repo is deprecated, functionality has moved to http://github.com/mailgun/holster (See Clock)** 2 | 3 | timetools 4 | ========= 5 | 6 | Go library with various time utilities used at Mailgun. 7 | -------------------------------------------------------------------------------- /rfc2822time.go: -------------------------------------------------------------------------------- 1 | package timetools 2 | 3 | import ( 4 | "strconv" 5 | "time" 6 | 7 | "gopkg.in/mgo.v2/bson" 8 | ) 9 | 10 | // We use RFC2822 format for timestamps everywhere ('Thu, 13 Oct 2011 18:02:00 GMT'), but 11 | // by default Go's JSON package uses another format when decoding/encoding timestamps. 12 | // That's why we declare our own timestamp type and implement its marshal/unmarshal methods 13 | // so JSON package decodes/encodes it properly. 14 | type RFC2822Time time.Time 15 | 16 | func NewRFC2822Time(timestamp int64) RFC2822Time { 17 | return RFC2822Time(time.Unix(timestamp, 0).UTC()) 18 | } 19 | 20 | func (t RFC2822Time) Unix() int64 { 21 | return time.Time(t).Unix() 22 | } 23 | 24 | func (t RFC2822Time) IsZero() bool { 25 | return time.Time(t).IsZero() 26 | } 27 | 28 | func (t RFC2822Time) MarshalJSON() ([]byte, error) { 29 | return []byte(strconv.Quote(time.Time(t).Format(time.RFC1123))), nil 30 | } 31 | 32 | func (t *RFC2822Time) UnmarshalJSON(s []byte) error { 33 | q, err := strconv.Unquote(string(s)) 34 | if err != nil { 35 | return err 36 | } 37 | if *(*time.Time)(t), err = time.Parse(time.RFC1123, q); err != nil { 38 | return err 39 | } 40 | return nil 41 | } 42 | 43 | func (t RFC2822Time) GetBSON() (interface{}, error) { 44 | return time.Time(t), nil 45 | } 46 | 47 | func (t *RFC2822Time) SetBSON(raw bson.Raw) error { 48 | var result time.Time 49 | err := raw.Unmarshal(&result) 50 | if err != nil { 51 | return err 52 | } 53 | *t = RFC2822Time(result) 54 | return nil 55 | } 56 | 57 | func (t RFC2822Time) String() string { 58 | return time.Time(t).Format(time.RFC1123) 59 | } 60 | -------------------------------------------------------------------------------- /provider_test.go: -------------------------------------------------------------------------------- 1 | package timetools 2 | 3 | import ( 4 | "fmt" 5 | "testing" 6 | "time" 7 | ) 8 | 9 | var _ = fmt.Printf // for testing 10 | 11 | func TestRealTimeUtcNow(t *testing.T) { 12 | rt := RealTime{} 13 | 14 | rtNow := rt.UtcNow() 15 | atNow := time.Now().UTC() 16 | 17 | // times shouldn't be exact 18 | if rtNow.Equal(atNow) { 19 | t.Errorf("rt.UtcNow() = time.Now.UTC(), %v = %v, should be slightly different", rtNow, atNow) 20 | } 21 | 22 | rtNowPlusOne := atNow.Add(1 * time.Second) 23 | rtNowMinusOne := atNow.Add(-1 * time.Second) 24 | 25 | // but should be pretty close 26 | if atNow.After(rtNowPlusOne) || atNow.Before(rtNowMinusOne) { 27 | t.Errorf("timedelta between rt.UtcNow() and time.Now.UTC() greater than 2 seconds, %v, %v", rtNow, atNow) 28 | } 29 | } 30 | 31 | func TestFreezeTimeUtcNow(t *testing.T) { 32 | tm := time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC) 33 | ft := FreezedTime{tm} 34 | 35 | if !tm.Equal(ft.UtcNow()) { 36 | t.Errorf("ft.UtcNow() != time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC), %v, %v", tm, ft) 37 | } 38 | } 39 | 40 | func itTicks(c <-chan time.Time) bool { 41 | select { 42 | case <-c: 43 | return true 44 | case <-time.After(time.Millisecond): 45 | return false 46 | } 47 | } 48 | 49 | func TestSleepableTime(t *testing.T) { 50 | tm := time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC) 51 | st := SleepProvider(tm) 52 | 53 | if !tm.Equal(st.UtcNow()) { 54 | t.Errorf("st.UtcNow() != time.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC), %v, %v", tm, st) 55 | } 56 | 57 | // Check After with no AdvanceTimeBy 58 | if itTicks(st.After(time.Nanosecond)) { 59 | t.Error("Got tick from After before calling AdvanceTimeBy") 60 | } 61 | 62 | // Check After with one call to AdvanceTimeBy 63 | c0 := st.After(time.Hour) 64 | AdvanceTimeBy(st, 2*time.Hour) 65 | if !itTicks(c0) { 66 | t.Error("Didn't get tick from After after calling AdvanceTimeBy") 67 | } 68 | 69 | // Check After with multiple calls to AdvanceTimeBy 70 | c0 = st.After(time.Hour) 71 | AdvanceTimeBy(st, 20*time.Minute) 72 | if itTicks(c0) { 73 | t.Error("Got tick from After before we AdvanceTimeBy'd enough") 74 | } 75 | AdvanceTimeBy(st, 20*time.Minute) 76 | if itTicks(c0) { 77 | t.Error("Got tick from After before we AdvanceTimeBy'd enough") 78 | } 79 | AdvanceTimeBy(st, 40*time.Minute) 80 | if !itTicks(c0) { 81 | t.Error("Didn't get tick from After after we AdvanceTimeBy'd enough") 82 | } 83 | 84 | // Check Sleep with no AdvanceTimeBy 85 | c1 := make(chan time.Time) 86 | go func() { 87 | st.Sleep(time.Nanosecond) 88 | c1 <- st.UtcNow() 89 | }() 90 | if itTicks(c1) { 91 | t.Error("Sleep returned before we called AdvanceTimeBy") 92 | } 93 | } 94 | -------------------------------------------------------------------------------- /provider.go: -------------------------------------------------------------------------------- 1 | package timetools 2 | 3 | import ( 4 | "sync" 5 | "time" 6 | ) 7 | 8 | // TimeProvider is an interface we use to mock time in tests. 9 | type TimeProvider interface { 10 | UtcNow() time.Time 11 | Sleep(time.Duration) 12 | After(time.Duration) <-chan time.Time 13 | } 14 | 15 | // RealTime is a real clock time, used in production. 16 | type RealTime struct { 17 | } 18 | 19 | func (*RealTime) UtcNow() time.Time { 20 | return time.Now().UTC() 21 | } 22 | 23 | func (*RealTime) Sleep(d time.Duration) { 24 | time.Sleep(d) 25 | } 26 | 27 | func (*RealTime) After(d time.Duration) <-chan time.Time { 28 | return time.After(d) 29 | } 30 | 31 | // FreezedTime is manually controlled time for use in tests. 32 | type FreezedTime struct { 33 | CurrentTime time.Time 34 | } 35 | 36 | func (t *FreezedTime) UtcNow() time.Time { 37 | return t.CurrentTime 38 | } 39 | 40 | func (t *FreezedTime) Sleep(d time.Duration) { 41 | t.CurrentTime = t.CurrentTime.Add(d) 42 | } 43 | 44 | func (t *FreezedTime) After(d time.Duration) <-chan time.Time { 45 | t.Sleep(d) 46 | c := make(chan time.Time, 1) 47 | c <- t.CurrentTime 48 | return c 49 | } 50 | 51 | type sleepableTime struct { 52 | currentTime time.Time 53 | waiters map[time.Time][]chan time.Time 54 | mu sync.Mutex 55 | } 56 | 57 | // SleepProvider returns a TimeProvider that has good fakes for 58 | // time.Sleep and time.After. Both functions will behave as if 59 | // time is frozen until you call AdvanceTimeBy, at which point 60 | // any calls to time.Sleep that should return do return and 61 | // any ticks from time.After that should happen do happen. 62 | func SleepProvider(currentTime time.Time) TimeProvider { 63 | return &sleepableTime{ 64 | currentTime: currentTime, 65 | waiters: make(map[time.Time][]chan time.Time), 66 | } 67 | } 68 | 69 | func (t *sleepableTime) UtcNow() time.Time { 70 | return t.currentTime 71 | } 72 | 73 | func (t *sleepableTime) Sleep(d time.Duration) { 74 | <-t.After(d) 75 | } 76 | 77 | func (t *sleepableTime) After(d time.Duration) <-chan time.Time { 78 | t.mu.Lock() 79 | defer t.mu.Unlock() 80 | 81 | c := make(chan time.Time, 1) 82 | until := t.currentTime.Add(d) 83 | t.waiters[until] = append(t.waiters[until], c) 84 | return c 85 | } 86 | 87 | // AdvanceTimeBy simulates advancing time by some time.Duration d. 88 | // This function panics if st is not the result of a call to 89 | // SleepProvider. 90 | func AdvanceTimeBy(st TimeProvider, d time.Duration) { 91 | t := st.(*sleepableTime) 92 | t.mu.Lock() 93 | defer t.mu.Unlock() 94 | 95 | t.currentTime = t.currentTime.Add(d) 96 | for k, v := range t.waiters { 97 | if k.Before(t.currentTime) { 98 | for _, c := range v { 99 | c <- t.currentTime 100 | } 101 | delete(t.waiters, k) 102 | } 103 | } 104 | } 105 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------