go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/clock/testclock/context.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package testclock
    16  
    17  import (
    18  	"context"
    19  	"time"
    20  
    21  	"go.chromium.org/luci/common/clock"
    22  )
    23  
    24  // TestTimeUTC is an arbitrary time point in UTC for testing.
    25  //
    26  // It corresponds to a negative Unix timestamp, so it might be inappropriate for
    27  // some tests. Use 'TestRecentTimeUTC' for more "real" test time in this case.
    28  var TestTimeUTC = time.Date(1, time.February, 3, 4, 5, 6, 7, time.UTC)
    29  
    30  // TestRecentTimeUTC is like TestTimeUTC, but in the recent past.
    31  var TestRecentTimeUTC = time.Date(2016, time.February, 3, 4, 5, 6, 7, time.UTC)
    32  
    33  // TestTimeLocal is an arbitrary time point in the 'Local' time zone for
    34  // testing.
    35  //
    36  // It corresponds to a negative Unix timestamp, so it might be inappropriate for
    37  // some tests. Use 'TestRecentTimeLocal' for more "real" test time in this case.
    38  var TestTimeLocal = time.Date(1, time.February, 3, 4, 5, 6, 7, time.Local)
    39  
    40  // TestRecentTimeLocal is like TestTimeLocal, but in the recent past.
    41  var TestRecentTimeLocal = time.Date(2016, time.February, 3, 4, 5, 6, 7, time.Local)
    42  
    43  // UseTime instantiates a TestClock and returns a Context that is configured to
    44  // use that clock, as well as the instantiated clock.
    45  func UseTime(ctx context.Context, now time.Time) (context.Context, TestClock) {
    46  	tc := New(now)
    47  	return clock.Set(ctx, tc), tc
    48  }