folly/test/SynchronizedTestLib.h

   1 /*
   2  * Copyright 2016 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #pragma once
  18
  19 // We have mutex types outside of folly that we want to test with Synchronized.
  20 // Make it easy for mutex implementators to test their classes with
  21 // Synchronized by just having a test like:
  22 //
  23 // class MyMutex { ... };
  24 //
  25 // TEST(Synchronized, Basic) {
  26 //   testBasic<MyMutex>();
  27 // }
  28 //
  29 // ... similar for testConcurrency, testDualLocking, etc.
  30
  31 namespace folly {
  32 namespace sync_tests {
  33 template <class Mutex> void testBasic();
  34 template <class Mutex> void testConcurrency();
  35 template <class Mutex> void testDualLocking();
  36 template <class Mutex> void testDualLockingWithConst();
  37 template <class Mutex> void testTimedSynchronized();
  38 template <class Mutex> void testTimedSynchronizedWithConst();
  39 template <class Mutex> void testConstCopy();
  40 template <class Mutex> void testInPlaceConstruction();
  41 }
  42 }
  43
  44 #include <folly/test/SynchronizedTestLib-inl.h>