third_party.pigweed.src/pw_assert/light_test.cc
Keir Mierle 854adece94 pw_assert: Add new "light" PW_ASSERT macros
This introduces two new macros: PW_ASSERT() and PW_DASSERT(). These
exist to offer a lightweight assert that is safe to use in headers and
is safe for constexpr. Most of the time, these macros should not be
used, and instead the PW_CHECK() and PW_DCHECK() variants used instead.

Other changes:

- Renames PW_ASSERT_ENABLE_DCHECK to PW_ASSERT_ENABLE_DEBUG, to reflect
  that the setting applies to both PW_CHECK and PW_ASSERT.
- Updates Roadamp & Status documentation sections

Testing: Since currently it is not possible to test the PW_ASSERT macros
due to needing to swap the backend, this is manually tested by flipping
the #if in pw_assert/light_test.cc to 1, and verifying that it crashes
as expected.

Change-Id: I6d2c68f772da4280e61a52576bfb6ab60e280bdf
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/17462
Reviewed-by: Wyatt Hepler <hepler@google.com>
Commit-Queue: Keir Mierle <keir@google.com>
2020-09-25 20:14:31 +00:00

54 lines
1.5 KiB
C++

// Copyright 2020 The Pigweed Authors
//
// 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
//
// https://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.
#include "pw_assert/light.h"
#include "gtest/gtest.h"
#include "pw_assert/assert.h"
// PW_ASSERT() should always be enabled, and always evaluate the expression.
TEST(Light, AssertTrue) {
int evaluated = 1;
PW_ASSERT(++evaluated);
EXPECT_EQ(evaluated, 2);
}
// PW_DASSERT() might be disabled sometimes.
TEST(Light, DebugAssertTrue) {
int evaluated = 1;
PW_DASSERT(++evaluated);
if (PW_ASSERT_ENABLE_DEBUG == 1) {
EXPECT_EQ(evaluated, 2);
} else {
EXPECT_EQ(evaluated, 1);
}
}
// Unfortunately, we don't have the infrastructure to test failure handling
// automatically, since the harness crashes in the process of running this
// test. The unsatisfying alternative is to test the functionality manually,
// then disable the test.
TEST(Light, AssertFalse) {
if (0) {
PW_ASSERT(false);
}
}
TEST(Light, DebugAssertFalse) {
if (0) {
PW_DASSERT(false);
}
}