nearby/presence/implementation/broadcast_manager_test.cc

// Copyright 2022 Google LLC
//
// 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 "presence/implementation/broadcast_manager.h"

#include <memory>
#include <string>

#include "gmock/gmock.h"
#include "protobuf-matchers/protocol-buffer-matchers.h"
#include "gtest/gtest.h"
#include "internal/platform/count_down_latch.h"
#include "internal/platform/feature_flags.h"
#include "internal/platform/future.h"
#include "internal/platform/medium_environment.h"
#include "internal/proto/credential.pb.h"
#include "presence/implementation/credential_manager_impl.h"
#include "presence/implementation/mediums/mediums.h"

namespace nearby {
namespace presence {
namespace {

using FeatureFlags = ::nearby::FeatureFlags::Flags;
using internal::IdentityType;
using ::nearby::CountDownLatch;
using ::nearby::MediumEnvironment;
using ::testing::status::StatusIs;

constexpr FeatureFlags kTestCases[] = {
    FeatureFlags{},
};

constexpr absl::string_view kAccountName = "Test account";
constexpr int8_t kTxPower = 30;

BroadcastRequest CreateBroadcastRequest(IdentityType identity) {
  PresenceBroadcast::BroadcastSection section = {
      .identity = identity,
      .extended_properties = {DataElement(
          DataElement(ActionBit::kActiveUnlockAction))},
      .account_name = std::string(kAccountName)};
  PresenceBroadcast presence_request = {.sections = {section}};
  BroadcastRequest request = {.tx_power = kTxPower,
                              .variant = presence_request};
  return request;
}

class MediumEnvironmentStarter {
 public:
  MediumEnvironmentStarter() { MediumEnvironment::Instance().Start(); }
  ~MediumEnvironmentStarter() { MediumEnvironment::Instance().Stop(); }
};

class BroadcastManagerTest : public testing::TestWithParam<FeatureFlags> {
 protected:
  void TearDown() override {
    MediumEnvironment::Instance().Sync();
    // Finish pending tasks before destroying BroadcastManager
    executor_.Shutdown();
  }
  bool IsAdvertising() {
    WaitForServiceControllerTasks();
    MediumEnvironment::Instance().Sync();
    return MediumEnvironment::Instance()
        .GetBleV2MediumStatus(*mediums_.GetBle().GetImpl())
        ->is_advertising;
  }
  BroadcastCallback CreateBroadcastCallback() {
    return BroadcastCallback{.start_broadcast_cb = [this](absl::Status status) {
      start_broadcast_status_.Set(status);
    }};
  }

  void WaitForServiceControllerTasks() {
    CountDownLatch latch(1);
    executor_.Execute([&]() { latch.CountDown(); });
    latch.Await();
  }

  // The medium environment must be initialized (started) before the service
  // controller.
  MediumEnvironmentStarter env_;
  nearby::Future<absl::Status> start_broadcast_status_;
  BroadcastCallback broadcast_callback_{
      .start_broadcast_cb = [this](absl::Status status) {
        start_broadcast_status_.Set(status);
      }};
  Mediums mediums_;
  SingleThreadExecutor executor_;
  CredentialManagerImpl credential_manager_{&executor_};
  BroadcastManager broadcast_manager_{mediums_, credential_manager_, executor_};
};

INSTANTIATE_TEST_SUITE_P(ParametrisedBroadcastManagerTest, BroadcastManagerTest,
                         testing::ValuesIn(kTestCases));

TEST_P(BroadcastManagerTest, StartBroadcastPublicIdentity) {
  absl::StatusOr<BroadcastSessionId> session =
      broadcast_manager_.StartBroadcast(
          CreateBroadcastRequest(internal::IDENTITY_TYPE_PUBLIC),
          CreateBroadcastCallback());

  EXPECT_OK(session);
  EXPECT_TRUE(start_broadcast_status_.Get().ok());
  EXPECT_OK(start_broadcast_status_.Get().GetResult());
  EXPECT_TRUE(IsAdvertising());
}

TEST_P(BroadcastManagerTest, StartAndStopBroadcast) {
  absl::StatusOr<BroadcastSessionId> session =
      broadcast_manager_.StartBroadcast(
          CreateBroadcastRequest(internal::IDENTITY_TYPE_PUBLIC),
          CreateBroadcastCallback());
  ASSERT_OK(session);
  EXPECT_TRUE(IsAdvertising());

  broadcast_manager_.StopBroadcast(*session);
  EXPECT_FALSE(IsAdvertising());
}

TEST_P(BroadcastManagerTest, StopBroadcastTwiceNoSideEffects) {
  absl::StatusOr<BroadcastSessionId> session =
      broadcast_manager_.StartBroadcast(
          CreateBroadcastRequest(internal::IDENTITY_TYPE_PUBLIC),
          CreateBroadcastCallback());
  ASSERT_OK(session);
  EXPECT_TRUE(IsAdvertising());

  broadcast_manager_.StopBroadcast(*session);
  broadcast_manager_.StopBroadcast(*session);
}

TEST_P(BroadcastManagerTest, StopBroadcastInvalidSessionNoSideEffects) {
  broadcast_manager_.StopBroadcast(123456);
}

TEST_P(BroadcastManagerTest, StartBroadcastInvalidRequestFails) {
  absl::StatusOr<BroadcastSessionId> session =
      broadcast_manager_.StartBroadcast(BroadcastRequest{},
                                        CreateBroadcastCallback());

  EXPECT_THAT(session, StatusIs(absl::StatusCode::kInvalidArgument));
  EXPECT_TRUE(start_broadcast_status_.Get().ok());
  EXPECT_THAT(start_broadcast_status_.Get().GetResult(),
              StatusIs(absl::StatusCode::kInvalidArgument));
  EXPECT_FALSE(IsAdvertising());
}

TEST_P(BroadcastManagerTest, StartBroadcastPrivateIdentityFails) {
  // TODO(b/256249404): Support private identity.
  absl::StatusOr<BroadcastSessionId> session =
      broadcast_manager_.StartBroadcast(
          CreateBroadcastRequest(internal::IDENTITY_TYPE_PRIVATE),
          CreateBroadcastCallback());

  ASSERT_OK(session);
  EXPECT_TRUE(start_broadcast_status_.Get().ok());
  EXPECT_THAT(start_broadcast_status_.Get().GetResult(),
              StatusIs(absl::StatusCode::kNotFound));
  EXPECT_FALSE(IsAdvertising());
}

}  // namespace
}  // namespace presence
}  // namespace nearby