go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/gae/service/user/testable.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 user
    16  
    17  // Testable is the interface that test implimentations will provide.
    18  type Testable interface {
    19  	// SetUser sets the user to a pre-populated User object.
    20  	SetUser(*User)
    21  
    22  	// Login will generate and set a new User object with values derived from
    23  	// email clientID, and admin values. If clientID is provided, the User will
    24  	// look like they logged in with OAuth. If it's empty, then this will look
    25  	// like they logged in via the cookie auth method.
    26  	Login(email, clientID string, admin bool)
    27  
    28  	// Equivalent to SetUser(nil), but a bit more obvious to read in the code :).
    29  	Logout()
    30  }