status_macros.h

// Copyright 2024 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.
#pragma once
 
#include "lib/stdcompat/type_traits.h"
#include "pw_status/status.h"
 
#define PW_TEST_EXPECT_OK(expr)                     \
  if (cpp20::is_constant_evaluated()) {             \
    ::pw::unit_test::internal::Constexpr_EXPECT_OK( \
        ::pw::internal::ConvertToStatus(expr));     \
  } else                                            \
    EXPECT_EQ(::pw::internal::ConvertToStatus(expr), ::pw::OkStatus())
 
#define PW_TEST_ASSERT_OK(expr)                          \
  if (cpp20::is_constant_evaluated()) {                  \
    if (!::pw::unit_test::internal::Constexpr_EXPECT_OK( \
            ::pw::internal::ConvertToStatus(expr))) {    \
      return;                                            \
    }                                                    \
  } else                                                 \
    ASSERT_EQ(::pw::internal::ConvertToStatus(expr), ::pw::OkStatus())
 
#define PW_TEST_ASSERT_OK_AND_ASSIGN(lhs, rexpr) \
  _PW_TEST_ASSERT_OK_AND_ASSIGN_DETAIL(          \
      _PW_UNIQUE_IDENTIFIER_DETAIL(__LINE__), lhs, rexpr)
 
#define _PW_TEST_ASSERT_OK_AND_ASSIGN_DETAIL(result, lhs, rexpr) \
  auto result = (rexpr);                                         \
  PW_TEST_ASSERT_OK(result);                                     \
  lhs = ::pw::internal::ConvertToValue(result)
 
#define _PW_UNIQUE_IDENTIFIER_DETAIL(line) \
  _PW_UNIQUE_IDENTIFIER_EXPANDED_DETAIL(line)
#define _PW_UNIQUE_IDENTIFIER_EXPANDED_DETAIL(line) \
  _assert_pw_test_assert_ok_and_assign_unique_name_##line
 
namespace pw::unit_test::internal {
 
// Functions for PW_CONSTEXPR_TEST compatibility. See pw_unit_test/constexpr.h.
bool EXPECT_OK_FAILED();
 
constexpr bool Constexpr_EXPECT_OK(Status status) {
  return status.ok() ? true : EXPECT_OK_FAILED();
}
 
}  // namespace pw::unit_test::internal