media/midi/midi_manager_unittest.cc

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "media/midi/midi_manager.h"
   6
   7 #include <vector>
   8
   9 #include "base/bind.h"
  10 #include "base/logging.h"
  11 #include "base/memory/scoped_ptr.h"
  12 #include "base/memory/scoped_vector.h"
  13 #include "base/message_loop/message_loop.h"
  14 #include "base/run_loop.h"
  15 #include "base/system_monitor/system_monitor.h"
  16 #include "testing/gtest/include/gtest/gtest.h"
  17
  18 namespace media {
  19
  20 namespace {
  21
  22 class FakeMidiManager : public MidiManager {
  23  public:
  24   FakeMidiManager() : start_initialization_is_called_(false) {}
  25   ~FakeMidiManager() override {}
  26
  27   // MidiManager implementation.
  28   void StartInitialization() override {
  29     start_initialization_is_called_ = true;
  30   }
  31
  32   void DispatchSendMidiData(MidiManagerClient* client,
  33                             uint32 port_index,
  34                             const std::vector<uint8>& data,
  35                             double timestamp) override {}
  36
  37   // Utility functions for testing.
  38   void CallCompleteInitialization(MidiResult result) {
  39     CompleteInitialization(result);
  40   }
  41
  42   size_t GetClientCount() const {
  43     return clients_size_for_testing();
  44   }
  45
  46   size_t GetPendingClientCount() const {
  47     return pending_clients_size_for_testing();
  48   }
  49
  50   bool start_initialization_is_called_;
  51
  52  private:
  53   DISALLOW_COPY_AND_ASSIGN(FakeMidiManager);
  54 };
  55
  56 class FakeMidiManagerClient : public MidiManagerClient {
  57  public:
  58   FakeMidiManagerClient()
  59       : result_(MIDI_NOT_SUPPORTED),
  60         wait_for_result_(true) {}
  61   ~FakeMidiManagerClient() override {}
  62
  63   // MidiManagerClient implementation.
  64   void AddInputPort(const MidiPortInfo& info) override {}
  65   void AddOutputPort(const MidiPortInfo& info) override {}
  66   void SetInputPortState(uint32 port_index, MidiPortState state) override {}
  67   void SetOutputPortState(uint32 port_index, MidiPortState state) override {}
  68
  69   void CompleteStartSession(MidiResult result) override {
  70     EXPECT_TRUE(wait_for_result_);
  71     result_ = result;
  72     wait_for_result_ = false;
  73   }
  74
  75   void ReceiveMidiData(uint32 port_index,
  76                        const uint8* data,
  77                        size_t size,
  78                        double timestamp) override {}
  79   void AccumulateMidiBytesSent(size_t size) override {}
  80
  81   MidiResult result() const { return result_; }
  82
  83   MidiResult WaitForResult() {
  84     while (wait_for_result_) {
  85       base::RunLoop run_loop;
  86       run_loop.RunUntilIdle();
  87     }
  88     return result();
  89   }
  90
  91  private:
  92   MidiResult result_;
  93   bool wait_for_result_;
  94
  95   DISALLOW_COPY_AND_ASSIGN(FakeMidiManagerClient);
  96 };
  97
  98 class MidiManagerTest : public ::testing::Test {
  99  public:
 100   MidiManagerTest()
 101       : manager_(new FakeMidiManager),
 102         message_loop_(new base::MessageLoop) {}
 103   ~MidiManagerTest() override {}
 104
 105  protected:
 106   void StartTheFirstSession(FakeMidiManagerClient* client) {
 107     EXPECT_FALSE(manager_->start_initialization_is_called_);
 108     EXPECT_EQ(0U, manager_->GetClientCount());
 109     EXPECT_EQ(0U, manager_->GetPendingClientCount());
 110     manager_->StartSession(client);
 111     EXPECT_EQ(0U, manager_->GetClientCount());
 112     EXPECT_EQ(1U, manager_->GetPendingClientCount());
 113     EXPECT_TRUE(manager_->start_initialization_is_called_);
 114     EXPECT_EQ(0U, manager_->GetClientCount());
 115     EXPECT_EQ(1U, manager_->GetPendingClientCount());
 116     EXPECT_TRUE(manager_->start_initialization_is_called_);
 117   }
 118
 119   void StartTheNthSession(FakeMidiManagerClient* client, size_t nth) {
 120     EXPECT_EQ(nth != 1, manager_->start_initialization_is_called_);
 121     EXPECT_EQ(0U, manager_->GetClientCount());
 122     EXPECT_EQ(nth - 1, manager_->GetPendingClientCount());
 123
 124     // StartInitialization() should not be called for the second and later
 125     // sessions.
 126     manager_->start_initialization_is_called_ = false;
 127     manager_->StartSession(client);
 128     EXPECT_EQ(nth == 1, manager_->start_initialization_is_called_);
 129     manager_->start_initialization_is_called_ = true;
 130   }
 131
 132   void EndSession(FakeMidiManagerClient* client, size_t before, size_t after) {
 133     EXPECT_EQ(before, manager_->GetClientCount());
 134     manager_->EndSession(client);
 135     EXPECT_EQ(after, manager_->GetClientCount());
 136   }
 137
 138   void CompleteInitialization(MidiResult result) {
 139     manager_->CallCompleteInitialization(result);
 140   }
 141
 142   void RunLoopUntilIdle() {
 143     base::RunLoop run_loop;
 144     run_loop.RunUntilIdle();
 145   }
 146
 147  protected:
 148   scoped_ptr<FakeMidiManager> manager_;
 149
 150  private:
 151   scoped_ptr<base::MessageLoop> message_loop_;
 152
 153   DISALLOW_COPY_AND_ASSIGN(MidiManagerTest);
 154 };
 155
 156 TEST_F(MidiManagerTest, StartAndEndSession) {
 157   scoped_ptr<FakeMidiManagerClient> client;
 158   client.reset(new FakeMidiManagerClient);
 159
 160   StartTheFirstSession(client.get());
 161   CompleteInitialization(MIDI_OK);
 162   EXPECT_EQ(MIDI_OK, client->WaitForResult());
 163   EndSession(client.get(), 1U, 0U);
 164 }
 165
 166 TEST_F(MidiManagerTest, StartAndEndSessionWithError) {
 167   scoped_ptr<FakeMidiManagerClient> client;
 168   client.reset(new FakeMidiManagerClient);
 169
 170   StartTheFirstSession(client.get());
 171   CompleteInitialization(MIDI_INITIALIZATION_ERROR);
 172   EXPECT_EQ(MIDI_INITIALIZATION_ERROR, client->WaitForResult());
 173   EndSession(client.get(), 0U, 0U);
 174 }
 175
 176 TEST_F(MidiManagerTest, StartMultipleSessions) {
 177   scoped_ptr<FakeMidiManagerClient> client1;
 178   scoped_ptr<FakeMidiManagerClient> client2;
 179   scoped_ptr<FakeMidiManagerClient> client3;
 180   client1.reset(new FakeMidiManagerClient);
 181   client2.reset(new FakeMidiManagerClient);
 182   client3.reset(new FakeMidiManagerClient);
 183
 184   StartTheFirstSession(client1.get());
 185   StartTheNthSession(client2.get(), 2);
 186   StartTheNthSession(client3.get(), 3);
 187   CompleteInitialization(MIDI_OK);
 188   EXPECT_EQ(MIDI_OK, client1->WaitForResult());
 189   EXPECT_EQ(MIDI_OK, client2->WaitForResult());
 190   EXPECT_EQ(MIDI_OK, client3->WaitForResult());
 191   EndSession(client1.get(), 3U, 2U);
 192   EndSession(client2.get(), 2U, 1U);
 193   EndSession(client3.get(), 1U, 0U);
 194 }
 195
 196 // TODO(toyoshim): Add a test for a MidiManagerClient that has multiple
 197 // sessions with multiple client_id.
 198
 199 TEST_F(MidiManagerTest, TooManyPendingSessions) {
 200   // Push as many client requests for starting session as possible.
 201   ScopedVector<FakeMidiManagerClient> many_existing_clients;
 202   many_existing_clients.resize(MidiManager::kMaxPendingClientCount);
 203   for (size_t i = 0; i < MidiManager::kMaxPendingClientCount; ++i) {
 204     many_existing_clients[i] = new FakeMidiManagerClient;
 205     StartTheNthSession(many_existing_clients[i], i + 1);
 206   }
 207
 208   // Push the last client that should be rejected for too many pending requests.
 209   scoped_ptr<FakeMidiManagerClient> additional_client(
 210       new FakeMidiManagerClient);
 211   manager_->start_initialization_is_called_ = false;
 212   manager_->StartSession(additional_client.get());
 213   EXPECT_FALSE(manager_->start_initialization_is_called_);
 214   EXPECT_EQ(MIDI_INITIALIZATION_ERROR, additional_client->result());
 215
 216   // Other clients still should not receive a result.
 217   RunLoopUntilIdle();
 218   for (size_t i = 0; i < many_existing_clients.size(); ++i)
 219     EXPECT_EQ(MIDI_NOT_SUPPORTED, many_existing_clients[i]->result());
 220
 221   // The result MIDI_OK should be distributed to other clients.
 222   CompleteInitialization(MIDI_OK);
 223   for (size_t i = 0; i < many_existing_clients.size(); ++i)
 224     EXPECT_EQ(MIDI_OK, many_existing_clients[i]->WaitForResult());
 225
 226   // Close all successful sessions in FIFO order.
 227   size_t sessions = many_existing_clients.size();
 228   for (size_t i = 0; i < many_existing_clients.size(); ++i, --sessions)
 229     EndSession(many_existing_clients[i], sessions, sessions - 1);
 230 }
 231
 232 TEST_F(MidiManagerTest, AbortSession) {
 233   // A client starting a session can be destructed while an asynchronous
 234   // initialization is performed.
 235   scoped_ptr<FakeMidiManagerClient> client;
 236   client.reset(new FakeMidiManagerClient);
 237
 238   StartTheFirstSession(client.get());
 239   EndSession(client.get(), 0, 0);
 240   client.reset();
 241
 242   // Following function should not call the destructed |client| function.
 243   CompleteInitialization(MIDI_OK);
 244   base::RunLoop run_loop;
 245   run_loop.RunUntilIdle();
 246 }
 247
 248 TEST_F(MidiManagerTest, CreateMidiManager) {
 249   // SystemMonitor is needed on Windows.
 250   base::SystemMonitor system_monitor;
 251
 252   scoped_ptr<FakeMidiManagerClient> client;
 253   client.reset(new FakeMidiManagerClient);
 254
 255   scoped_ptr<MidiManager> manager(MidiManager::Create());
 256   manager->StartSession(client.get());
 257
 258   MidiResult result = client->WaitForResult();
 259   // This #ifdef needs to be identical to the one in media/midi/midi_manager.cc.
 260   // Do not change the condition for disabling this test.
 261 #if !defined(OS_MACOSX) && !defined(OS_WIN) && !defined(USE_ALSA) && \
 262     !defined(OS_ANDROID) && !defined(OS_CHROMEOS)
 263   EXPECT_EQ(MIDI_NOT_SUPPORTED, result);
 264 #elif defined(USE_ALSA)
 265   // Temporary until http://crbug.com/371230 is resolved.
 266   EXPECT_TRUE((result == MIDI_OK) || (result == MIDI_INITIALIZATION_ERROR));
 267 #else
 268   EXPECT_EQ(MIDI_OK, result);
 269 #endif
 270 }
 271
 272 }  // namespace
 273
 274 }  // namespace media