go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/testing/assert/should/equal.go (about)

     1  // Copyright 2024 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 should
    16  
    17  import (
    18  	"reflect"
    19  
    20  	"go.chromium.org/luci/common/testing/assert/results"
    21  )
    22  
    23  // Equal checks whether two objects are equal.
    24  func Equal[T any](expected T) results.Comparison[any] {
    25  	cmpName := "should.Equal"
    26  	rtype := reflect.TypeOf(expected)
    27  
    28  	return func(actual any) (ret *results.Result) {
    29  		if reflect.TypeOf(actual) != rtype {
    30  			return results.NewResultBuilder().
    31  				SetName(cmpName, rtype).
    32  				Because("Type of actual does not match (is `%T`)", actual).
    33  				Result()
    34  		}
    35  		if reflect.DeepEqual(actual, expected) {
    36  			return nil
    37  		}
    38  
    39  		return results.NewResultBuilder().
    40  			SetName(cmpName, rtype).
    41  			Actual(actual).
    42  			Expected(expected).
    43  			Result()
    44  	}
    45  }