summaryrefslogtreecommitdiff
path: root/chromium/third_party/nearby/src/internal/platform/implementation/windows/count_down_latch_test.cc
blob: d3c3ddb11f737acba33df6904d615506fe07945e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
// Copyright 2020 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 "internal/platform/implementation/shared/count_down_latch.h"

#include <Windows.h>

#include "gtest/gtest.h"
#include "internal/platform/implementation/platform.h"

class CountDownLatchTests : public testing::Test {
 public:
  class TestData {
   public:
    std::unique_ptr<location::nearby::api::CountDownLatch>& countDownLatch;
    LONG volatile& count;
  };

  class CountDownLatchTest {
   public:
    static DWORD ThreadProcCountDown(LPVOID lpParam) {
      TestData* testData = static_cast<TestData*>(lpParam);

      Sleep(1);

      InterlockedIncrement(&testData->count);
      testData->countDownLatch->CountDown();
      return 0;
    }

    static DWORD ThreadProcAwait(LPVOID lpParam) {
      TestData* testData = static_cast<TestData*>(lpParam);

      Sleep(1);

      testData->countDownLatch->Await();
      InterlockedIncrement(&testData->count);

      return 0;
    }
  };

  CountDownLatchTests() {}
};

TEST_F(CountDownLatchTests, CountDownLatchAwaitSucceeds) {
  // Arrange
  LONG volatile count = 0;

  std::unique_ptr<location::nearby::api::CountDownLatch> countDownLatch =
      location::nearby::api::ImplementationPlatform::CreateCountDownLatch(3);

  HANDLE hThreads[3];
  DWORD dwThreadID;

  TestData testData{countDownLatch, count};

  // Setup 3 threads
  for (int i = 0; i < 3; i++) {
    // TODO: More complex scenarios may require use of a parameter
    //   to the thread procedure, such as an event per thread to
    //   be used for synchronization.
    hThreads[i] = CreateThread(
        NULL,                                     // default security
        0,                                        // default stack size
        CountDownLatchTest::ThreadProcCountDown,  // name of the thread function
        &testData,                                // no thread parameters
        0,                                        // default startup flags
        &dwThreadID);

    EXPECT_TRUE(hThreads[i] != NULL);
  }

  // Act
  location::nearby::Exception result = countDownLatch->Await();

  //
  // Assert
  EXPECT_EQ(result.value, location::nearby::Exception::kSuccess);
  EXPECT_EQ(count, 3);
}

TEST_F(CountDownLatchTests, CountDownLatchAwaitTimeoutTimesOut) {
  // Arrange
  LONG volatile count = 0;

  std::unique_ptr<location::nearby::api::CountDownLatch> countDownLatch =
      location::nearby::api::ImplementationPlatform::CreateCountDownLatch(3);

  // Act
  location::nearby::ExceptionOr<bool> result =
      countDownLatch->Await(absl::Milliseconds(5));

  Sleep(40);

  // Assert
  EXPECT_FALSE(result.GetResult());
  // TODO(jfcarroll)I think there's a bug in the shared version of this, it's
  // not returning a timeout exception, need to look at it some more.
  // EXPECT_EQ(result.GetException().value,
  // location::nearby::Exception::kTimeout);
}

TEST_F(CountDownLatchTests, CountDownLatchAwaitNoTimeoutSucceeds) {
  // Arrange
  LONG volatile count = 0;

  std::unique_ptr<location::nearby::api::CountDownLatch> countDownLatch =
      location::nearby::api::ImplementationPlatform::CreateCountDownLatch(3);

  TestData testData{countDownLatch, count};

  HANDLE hThreads[3];
  DWORD dwThreadID;

  // Setup 3 threads
  for (int i = 0; i < 3; i++) {
    // TODO: More complex scenarios may require use of a parameter
    //   to the thread procedure, such as an event per thread to
    //   be used for synchronization.
    hThreads[i] = CreateThread(
        NULL,                                     // default security
        0,                                        // default stack size
        CountDownLatchTest::ThreadProcCountDown,  // name of the thread function
        &testData,                                // no thread parameters
        0,                                        // default startup flags
        &dwThreadID);

    EXPECT_TRUE(hThreads[i] != NULL);
  }

  WaitForMultipleObjects(3, hThreads, true, INFINITE);
  // Act
  location::nearby::ExceptionOr<bool> result =
      countDownLatch->Await(absl::Milliseconds(100));

  // Assert
  EXPECT_TRUE(result.GetResult());
  EXPECT_EQ(result.GetException().value, location::nearby::Exception::kSuccess);
  EXPECT_EQ(count, 3);
}

TEST_F(CountDownLatchTests, CountDownLatchCountDownBeforeAwaitSucceeds) {
  // Arrange
  LONG volatile count = 0;
  std::unique_ptr<location::nearby::api::CountDownLatch> countDownLatch =
      location::nearby::api::ImplementationPlatform::CreateCountDownLatch(1);

  HANDLE hThread;
  DWORD dwThreadID;

  TestData testData{countDownLatch, count};

  hThread = CreateThread(
      NULL,                                 // default security
      0,                                    // default stack size
      CountDownLatchTest::ThreadProcAwait,  // name of the thread function
      &testData,                            // no thread parameters
      0,                                    // default startup flags
      &dwThreadID);

  EXPECT_TRUE(hThread != NULL);

  // Act
  countDownLatch->CountDown();  // This countdown occurs before the thread has a
                                // chance to run

  if (hThread != NULL) {
    WaitForSingleObject(hThread,
                        INFINITE);  // This will wait till the thread exits
  }

  // Assert
  EXPECT_EQ(count, 1);
}