pw_status/status_test.cc

// 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.

// Make sure status works if these macros are defined.
// TODO(pwbug/268): Remove these macros after migrating from these aliases.
#define OK Uh oh, this macro is defined !
#define CANCELLED Uh oh, this macro is defined !
#define UNKNOWN Uh oh, this macro is defined !
#define INVALID_ARGUMENT Uh oh, this macro is defined !
#define DEADLINE_EXCEEDED Uh oh, this macro is defined !
#define NOT_FOUND Uh oh, this macro is defined !
#define ALREADY_EXISTS Uh oh, this macro is defined !
#define PERMISSION_DENIED Uh oh, this macro is defined !
#define UNAUTHENTICATED Uh oh, this macro is defined !
#define RESOURCE_EXHAUSTED Uh oh, this macro is defined !
#define FAILED_PRECONDITION Uh oh, this macro is defined !
#define ABORTED Uh oh, this macro is defined !
#define OUT_OF_RANGE Uh oh, this macro is defined !
#define UNIMPLEMENTED Uh oh, this macro is defined !
#define INTERNAL Uh oh, this macro is defined !
#define UNAVAILABLE Uh oh, this macro is defined !
#define DATA_LOSS Uh oh, this macro is defined !

#include "pw_status/status.h"

#include "gtest/gtest.h"

namespace pw {
namespace {

constexpr Status::Code kInvalidCode = static_cast<Status::Code>(30);

TEST(Status, Default) {
  constexpr Status status;
  static_assert(status.ok());
  static_assert(Status() == status);
}

TEST(Status, ConstructWithStatusCode) {
  constexpr Status status(PW_STATUS_ABORTED);
  static_assert(Status::Aborted() == status);
}

TEST(Status, AssignFromStatusCode) {
  Status status;
  status = PW_STATUS_INTERNAL;
  EXPECT_EQ(Status::Internal(), status);
}

TEST(Status, Ok_OkIsTrue) {
  static_assert(Status().ok());
  static_assert(Status(PW_STATUS_OK).ok());
  static_assert(Status::Ok().ok());
}

TEST(Status, NotOk_OkIsFalse) {
  static_assert(!Status::DataLoss().ok());
  static_assert(!Status(kInvalidCode).ok());
}

TEST(Status, EqualCodes) {
  static_assert(PW_STATUS_OK == Status());
  static_assert(PW_STATUS_OK == Status::Ok());
  static_assert(PW_STATUS_CANCELLED == Status::Cancelled());
  static_assert(PW_STATUS_UNKNOWN == Status::Unknown());
  static_assert(PW_STATUS_INVALID_ARGUMENT == Status::InvalidArgument());
  static_assert(PW_STATUS_DEADLINE_EXCEEDED == Status::DeadlineExceeded());
  static_assert(PW_STATUS_NOT_FOUND == Status::NotFound());
  static_assert(PW_STATUS_ALREADY_EXISTS == Status::AlreadyExists());
  static_assert(PW_STATUS_PERMISSION_DENIED == Status::PermissionDenied());
  static_assert(PW_STATUS_RESOURCE_EXHAUSTED == Status::ResourceExhausted());
  static_assert(PW_STATUS_FAILED_PRECONDITION == Status::FailedPrecondition());
  static_assert(PW_STATUS_ABORTED == Status::Aborted());
  static_assert(PW_STATUS_OUT_OF_RANGE == Status::OutOfRange());
  static_assert(PW_STATUS_UNIMPLEMENTED == Status::Unimplemented());
  static_assert(PW_STATUS_INTERNAL == Status::Internal());
  static_assert(PW_STATUS_UNAVAILABLE == Status::Unavailable());
  static_assert(PW_STATUS_DATA_LOSS == Status::DataLoss());
  static_assert(PW_STATUS_UNAUTHENTICATED == Status::Unauthenticated());
}

TEST(Status, Strings) {
  EXPECT_STREQ("OK", Status().str());
  EXPECT_STREQ("OK", Status::Ok().str());
  EXPECT_STREQ("CANCELLED", Status::Cancelled().str());
  EXPECT_STREQ("UNKNOWN", Status::Unknown().str());
  EXPECT_STREQ("INVALID_ARGUMENT", Status::InvalidArgument().str());
  EXPECT_STREQ("DEADLINE_EXCEEDED", Status::DeadlineExceeded().str());
  EXPECT_STREQ("NOT_FOUND", Status::NotFound().str());
  EXPECT_STREQ("ALREADY_EXISTS", Status::AlreadyExists().str());
  EXPECT_STREQ("PERMISSION_DENIED", Status::PermissionDenied().str());
  EXPECT_STREQ("RESOURCE_EXHAUSTED", Status::ResourceExhausted().str());
  EXPECT_STREQ("FAILED_PRECONDITION", Status::FailedPrecondition().str());
  EXPECT_STREQ("ABORTED", Status::Aborted().str());
  EXPECT_STREQ("OUT_OF_RANGE", Status::OutOfRange().str());
  EXPECT_STREQ("UNIMPLEMENTED", Status::Unimplemented().str());
  EXPECT_STREQ("INTERNAL", Status::Internal().str());
  EXPECT_STREQ("UNAVAILABLE", Status::Unavailable().str());
  EXPECT_STREQ("DATA_LOSS", Status::DataLoss().str());
  EXPECT_STREQ("UNAUTHENTICATED", Status::Unauthenticated().str());
}

TEST(Status, UnknownString) {
  EXPECT_STREQ("INVALID STATUS", Status(kInvalidCode).str());
}

TEST(Status, DeprecatedAliases) {
  // TODO(pwbug/268): Remove this test after migrating from these aliases.
  static_assert(PW_STATUS_OK == Status::OK);
  static_assert(PW_STATUS_CANCELLED == Status::CANCELLED);
  static_assert(PW_STATUS_UNKNOWN == Status::UNKNOWN);
  static_assert(PW_STATUS_INVALID_ARGUMENT == Status::INVALID_ARGUMENT);
  static_assert(PW_STATUS_DEADLINE_EXCEEDED == Status::DEADLINE_EXCEEDED);
  static_assert(PW_STATUS_NOT_FOUND == Status::NOT_FOUND);
  static_assert(PW_STATUS_ALREADY_EXISTS == Status::ALREADY_EXISTS);
  static_assert(PW_STATUS_PERMISSION_DENIED == Status::PERMISSION_DENIED);
  static_assert(PW_STATUS_RESOURCE_EXHAUSTED == Status::RESOURCE_EXHAUSTED);
  static_assert(PW_STATUS_FAILED_PRECONDITION == Status::FAILED_PRECONDITION);
  static_assert(PW_STATUS_ABORTED == Status::ABORTED);
  static_assert(PW_STATUS_OUT_OF_RANGE == Status::OUT_OF_RANGE);
  static_assert(PW_STATUS_UNIMPLEMENTED == Status::UNIMPLEMENTED);
  static_assert(PW_STATUS_INTERNAL == Status::INTERNAL);
  static_assert(PW_STATUS_UNAVAILABLE == Status::UNAVAILABLE);
  static_assert(PW_STATUS_DATA_LOSS == Status::DATA_LOSS);
  static_assert(PW_STATUS_UNAUTHENTICATED == Status::UNAUTHENTICATED);
}

// Functions for executing the C pw_Status tests.
extern "C" {

Status::Code PassStatusFromC(Status status);

Status::Code PassStatusFromCpp(Status status) { return status; }

int TestStatusFromC(void);

int TestStatusStringsFromC(void);

}  // extern "C"

TEST(StatusCLinkage, CallCFunctionWithStatus) {
  EXPECT_EQ(Status::Aborted(), PassStatusFromC(PW_STATUS_ABORTED));
  EXPECT_EQ(Status::Unknown(), PassStatusFromC(Status::Unknown()));

  EXPECT_EQ(Status::NotFound(), PassStatusFromC(PW_STATUS_NOT_FOUND));
  EXPECT_EQ(Status::Ok(), PassStatusFromC(Status::Ok()));
}

TEST(StatusCLinkage, TestStatusFromC) { EXPECT_EQ(0, TestStatusFromC()); }

TEST(StatusCLinkage, TestStatusStringsFromC) {
  EXPECT_EQ(0, TestStatusStringsFromC());
}

}  // namespace
}  // namespace pw