123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249 |
- // Copyright 2021 Google Inc. All rights reserved.
- //
- // 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.
- package android
- import (
- "fmt"
- "reflect"
- "regexp"
- "strings"
- "testing"
- )
- // This file contains general purpose test assert functions.
- // AssertSame checks if the expected and actual values are equal and if they are not then
- // it reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertSame(t *testing.T, message string, expected interface{}, actual interface{}) {
- t.Helper()
- if actual != expected {
- t.Errorf("%s: expected:\n%#v\nactual:\n%#v", message, expected, actual)
- }
- }
- // AssertBoolEquals checks if the expected and actual values are equal and if they are not then it
- // reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertBoolEquals(t *testing.T, message string, expected bool, actual bool) {
- t.Helper()
- if actual != expected {
- t.Errorf("%s: expected %t, actual %t", message, expected, actual)
- }
- }
- // AssertIntEquals checks if the expected and actual values are equal and if they are not then it
- // reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertIntEquals(t *testing.T, message string, expected int, actual int) {
- t.Helper()
- if actual != expected {
- t.Errorf("%s: expected %d, actual %d", message, expected, actual)
- }
- }
- // AssertStringEquals checks if the expected and actual values are equal and if they are not then
- // it reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertStringEquals(t *testing.T, message string, expected string, actual string) {
- t.Helper()
- if actual != expected {
- t.Errorf("%s: expected %s, actual %s", message, expected, actual)
- }
- }
- // AssertPathRelativeToTopEquals checks if the expected value is equal to the result of calling
- // PathRelativeToTop on the actual Path.
- func AssertPathRelativeToTopEquals(t *testing.T, message string, expected string, actual Path) {
- t.Helper()
- AssertStringEquals(t, message, expected, PathRelativeToTop(actual))
- }
- // AssertPathsRelativeToTopEquals checks if the expected value is equal to the result of calling
- // PathsRelativeToTop on the actual Paths.
- func AssertPathsRelativeToTopEquals(t *testing.T, message string, expected []string, actual Paths) {
- t.Helper()
- AssertDeepEquals(t, message, expected, PathsRelativeToTop(actual))
- }
- // AssertStringPathRelativeToTopEquals checks if the expected value is equal to the result of calling
- // StringPathRelativeToTop on the actual string path.
- func AssertStringPathRelativeToTopEquals(t *testing.T, message string, config Config, expected string, actual string) {
- t.Helper()
- AssertStringEquals(t, message, expected, StringPathRelativeToTop(config.soongOutDir, actual))
- }
- // AssertStringPathsRelativeToTopEquals checks if the expected value is equal to the result of
- // calling StringPathsRelativeToTop on the actual string paths.
- func AssertStringPathsRelativeToTopEquals(t *testing.T, message string, config Config, expected []string, actual []string) {
- t.Helper()
- AssertDeepEquals(t, message, expected, StringPathsRelativeToTop(config.soongOutDir, actual))
- }
- // AssertErrorMessageEquals checks if the error is not nil and has the expected message. If it does
- // not then this reports an error prefixed with the supplied message and including a reason for why
- // it failed.
- func AssertErrorMessageEquals(t *testing.T, message string, expected string, actual error) {
- t.Helper()
- if actual == nil {
- t.Errorf("Expected error but was nil")
- } else if actual.Error() != expected {
- t.Errorf("%s: expected %s, actual %s", message, expected, actual.Error())
- }
- }
- // AssertTrimmedStringEquals checks if the expected and actual values are the same after trimming
- // leading and trailing spaces from them both. If they are not then it reports an error prefixed
- // with the supplied message and including a reason for why it failed.
- func AssertTrimmedStringEquals(t *testing.T, message string, expected string, actual string) {
- t.Helper()
- AssertStringEquals(t, message, strings.TrimSpace(expected), strings.TrimSpace(actual))
- }
- // AssertStringDoesContain checks if the string contains the expected substring. If it does not
- // then it reports an error prefixed with the supplied message and including a reason for why it
- // failed.
- func AssertStringDoesContain(t *testing.T, message string, s string, expectedSubstring string) {
- t.Helper()
- if !strings.Contains(s, expectedSubstring) {
- t.Errorf("%s: could not find %q within %q", message, expectedSubstring, s)
- }
- }
- // AssertStringDoesNotContain checks if the string contains the expected substring. If it does then
- // it reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertStringDoesNotContain(t *testing.T, message string, s string, unexpectedSubstring string) {
- t.Helper()
- if strings.Contains(s, unexpectedSubstring) {
- t.Errorf("%s: unexpectedly found %q within %q", message, unexpectedSubstring, s)
- }
- }
- // AssertStringContainsEquals checks if the string contains or does not contain the substring, given
- // the value of the expected bool. If the expectation does not hold it reports an error prefixed with
- // the supplied message and including a reason for why it failed.
- func AssertStringContainsEquals(t *testing.T, message string, s string, substring string, expected bool) {
- if expected {
- AssertStringDoesContain(t, message, s, substring)
- } else {
- AssertStringDoesNotContain(t, message, s, substring)
- }
- }
- // AssertStringMatches checks if the string matches the given regular expression. If it does not match,
- // then an error is reported with the supplied message including a reason for why it failed.
- func AssertStringMatches(t *testing.T, message, s, expectedRex string) {
- t.Helper()
- ok, err := regexp.MatchString(expectedRex, s)
- if err != nil {
- t.Fatalf("regexp failure trying to match %s against `%s` expression: %s", s, expectedRex, err)
- return
- }
- if !ok {
- t.Errorf("%s does not match regular expression %s", s, expectedRex)
- }
- }
- // AssertStringListContains checks if the list of strings contains the expected string. If it does
- // not then it reports an error prefixed with the supplied message and including a reason for why it
- // failed.
- func AssertStringListContains(t *testing.T, message string, list []string, s string) {
- t.Helper()
- if !InList(s, list) {
- t.Errorf("%s: could not find %q within %q", message, s, list)
- }
- }
- // AssertStringListDoesNotContain checks if the list of strings contains the expected string. If it does
- // then it reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertStringListDoesNotContain(t *testing.T, message string, list []string, s string) {
- t.Helper()
- if InList(s, list) {
- t.Errorf("%s: unexpectedly found %q within %q", message, s, list)
- }
- }
- // AssertStringContainsEquals checks if the string contains or does not contain the substring, given
- // the value of the expected bool. If the expectation does not hold it reports an error prefixed with
- // the supplied message and including a reason for why it failed.
- func AssertStringListContainsEquals(t *testing.T, message string, list []string, s string, expected bool) {
- t.Helper()
- if expected {
- AssertStringListContains(t, message, list, s)
- } else {
- AssertStringListDoesNotContain(t, message, list, s)
- }
- }
- // AssertArrayString checks if the expected and actual values are equal and if they are not then it
- // reports an error prefixed with the supplied message and including a reason for why it failed.
- func AssertArrayString(t *testing.T, message string, expected, actual []string) {
- t.Helper()
- if len(actual) != len(expected) {
- t.Errorf("%s: expected %d (%q), actual (%d) %q", message, len(expected), expected, len(actual), actual)
- return
- }
- for i := range actual {
- if actual[i] != expected[i] {
- t.Errorf("%s: expected %d-th, %q (%q), actual %q (%q)",
- message, i, expected[i], expected, actual[i], actual)
- return
- }
- }
- }
- // Asserts that each of the Paths in actual end with the corresponding string
- // from expected. Useful to test that output paths contain expected items without
- // hard-coding where intermediate files might be located.
- func AssertPathsEndWith(t *testing.T, message string, expected []string, actual []Path) {
- t.Helper()
- if len(expected) != len(actual) {
- t.Errorf("%s (length): expected %d, actual %d", message, len(expected), len(actual))
- return
- }
- for i := range expected {
- if !strings.HasSuffix(actual[i].String(), expected[i]) {
- t.Errorf("%s (item %d): expected '%s', actual '%s'", message, i, expected[i], actual[i].String())
- }
- }
- }
- // AssertDeepEquals checks if the expected and actual values are equal using reflect.DeepEqual and
- // if they are not then it reports an error prefixed with the supplied message and including a
- // reason for why it failed.
- func AssertDeepEquals(t *testing.T, message string, expected interface{}, actual interface{}) {
- t.Helper()
- if !reflect.DeepEqual(actual, expected) {
- t.Errorf("%s: expected:\n %#v\n got:\n %#v", message, expected, actual)
- }
- }
- // AssertPanicMessageContains checks that the supplied function panics as expected and the message
- // obtained by formatting the recovered value as a string contains the expected contents.
- func AssertPanicMessageContains(t *testing.T, message, expectedMessageContents string, funcThatShouldPanic func()) {
- t.Helper()
- panicked := false
- var recovered interface{}
- func() {
- defer func() {
- if recovered = recover(); recovered != nil {
- panicked = true
- }
- }()
- funcThatShouldPanic()
- }()
- if !panicked {
- t.Errorf("%s: did not panic", message)
- }
- panicMessage := fmt.Sprintf("%s", recovered)
- AssertStringDoesContain(t, fmt.Sprintf("%s: panic message", message), panicMessage, expectedMessageContents)
- }
|