Added new type of unit test, RAW_UNIT_TEST_CASE, which is used for tests that can be flaky if run w…

runtime/vm/unit_test.h

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #ifndef RUNTIME_VM_UNIT_TEST_H_
 #define RUNTIME_VM_UNIT_TEST_H_
 
 #include "include/dart_native_api.h"
 
 #include "platform/globals.h"
 
 #include "vm/ast.h"
 #include "vm/dart.h"
 #include "vm/dart_api_state.h"
 #include "vm/globals.h"
 #include "vm/heap.h"
 #include "vm/isolate.h"
 #include "vm/longjump.h"
 #include "vm/object.h"
 #include "vm/object_store.h"
 #include "vm/simulator.h"
 #include "vm/zone.h"
 
-// The UNIT_TEST_CASE macro is used for tests that do not need any
+// The VM_UNIT_TEST_CASE macro is used for tests that do not need any
 // default isolate or zone functionality.
-#define UNIT_TEST_CASE(name)                                                   \
+#define VM_UNIT_TEST_CASE(name)                                                \
   void Dart_Test##name();                                                      \
   static const dart::TestCase kRegister##name(Dart_Test##name, #name);         \
   void Dart_Test##name()
 
-// The VM_TEST_CASE macro is used for tests that need an isolate and zone
-// in order to test its functionality. This macro is used for tests that
+// The UNIT_TEST_CASE macro is used for tests that do not require any
+// functionality provided by the VM. Tests declared using this macro will be run
+// after the VM is cleaned up.
+#define UNIT_TEST_CASE(name)                                                   \
+  void Dart_Test##name();                                                      \
+  static const dart::RawTestCase kRegister##name(Dart_Test##name, #name);      \
+  void Dart_Test##name()
+
+// The ISOLATE_UNIT_TEST_CASE macro is used for tests that need an isolate and
+// zone in order to test its functionality. This macro is used for tests that
 // are implemented using the VM code directly and do not use the Dart API
 // for calling into the VM. The safepoint execution state of threads using
 // this macro is transitioned from kThreadInNative to kThreadInVM.
-#define VM_TEST_CASE(name)                                                     \
+#define ISOLATE_UNIT_TEST_CASE(name)                                           \
   static void Dart_TestHelper##name(Thread* thread);                           \
-  UNIT_TEST_CASE(name) {                                                       \
+  VM_UNIT_TEST_CASE(name) {                                                    \
     TestIsolateScope __test_isolate__;                                         \
     Thread* __thread__ = Thread::Current();                                    \
     ASSERT(__thread__->isolate() == __test_isolate__.isolate());               \
     TransitionNativeToVM transition(__thread__);                               \
     StackZone __zone__(__thread__);                                            \
     HandleScope __hs__(__thread__);                                            \
     Dart_TestHelper##name(__thread__);                                         \
   }                                                                            \
   static void Dart_TestHelper##name(Thread* thread)
 
 // The TEST_CASE macro is used for tests that need an isolate and zone
 // in order to test its functionality. This macro is used for tests that
 // are implemented using the Dart API for calling into the VM. The safepoint
 // execution state of threads using this macro remains kThreadNative.
 #define TEST_CASE(name)                                                        \
   static void Dart_TestHelper##name(Thread* thread);                           \
-  UNIT_TEST_CASE(name) {                                                       \
+  VM_UNIT_TEST_CASE(name) {                                                    \
     TestIsolateScope __test_isolate__;                                         \
     Thread* __thread__ = Thread::Current();                                    \
     ASSERT(__thread__->isolate() == __test_isolate__.isolate());               \
     StackZone __zone__(__thread__);                                            \
     HandleScope __hs__(__thread__);                                            \
     Dart_TestHelper##name(__thread__);                                         \
   }                                                                            \
   static void Dart_TestHelper##name(Thread* thread)
 
 // The ASSEMBLER_TEST_GENERATE macro is used to generate a unit test
 // for the assembler.
 #define ASSEMBLER_TEST_GENERATE(name, assembler)                               \
   void AssemblerTestGenerate##name(Assembler* assembler)
 
 // The ASSEMBLER_TEST_EXTERN macro is used to declare a unit test
 // for the assembler.
 #define ASSEMBLER_TEST_EXTERN(name)                                            \
   extern void AssemblerTestGenerate##name(Assembler* assembler);
 
 // The ASSEMBLER_TEST_RUN macro is used to execute the assembler unit
 // test generated using the ASSEMBLER_TEST_GENERATE macro.
 // C++ callee-saved registers are not preserved. Arguments may be passed in.
 #define ASSEMBLER_TEST_RUN(name, test)                                         \
   static void AssemblerTestRun##name(AssemblerTest* test);                     \
-  VM_TEST_CASE(name) {                                                         \
+  ISOLATE_UNIT_TEST_CASE(name) {                                               \
     Assembler __assembler__;                                                   \
     AssemblerTest test("" #name, &__assembler__);                              \
     AssemblerTestGenerate##name(test.assembler());                             \
     test.Assemble();                                                           \
     AssemblerTestRun##name(&test);                                             \
   }                                                                            \
   static void AssemblerTestRun##name(AssemblerTest* test)
 
 // Populate node list with AST nodes.
 #define CODEGEN_TEST_GENERATE(name, test)                                      \
   static void CodeGenTestGenerate##name(CodeGenTest* test)
 
 // Populate node list with AST nodes, possibly using the provided function
 // object built by a previous CODEGEN_TEST_GENERATE.
 #define CODEGEN_TEST2_GENERATE(name, function, test)                           \
   static void CodeGenTestGenerate##name(const Function& function,              \
                                         CodeGenTest* test)
 
 
 // Pass the name of test and the expected results as RawObject.
 #define CODEGEN_TEST_RUN(name, expected)                                       \
   static void CodeGenTestRun##name(const Function& function);                  \
-  VM_TEST_CASE(name) {                                                         \
+  ISOLATE_UNIT_TEST_CASE(name) {                                               \
     CodeGenTest __test__("" #name);                                            \
     CodeGenTestGenerate##name(&__test__);                                      \
     __test__.Compile();                                                        \
     CodeGenTestRun##name(__test__.function());                                 \
   }                                                                            \
   static void CodeGenTestRun##name(const Function& function) {                 \
     Object& result = Object::Handle();                                         \
     result = DartEntry::InvokeFunction(function, Object::empty_array());       \
     EXPECT(!result.IsError());                                                 \
     Instance& actual = Instance::Handle();                                     \
     actual ^= result.raw();                                                    \
     EXPECT(actual.CanonicalizeEquals(Instance::Handle(expected)));             \
   }
 
 
 // Pass the name of test, and use the generated function to call it
 // and evaluate its result.
 #define CODEGEN_TEST_RAW_RUN(name, function)                                   \
   static void CodeGenTestRun##name(const Function& function);                  \
-  VM_TEST_CASE(name) {                                                         \
+  ISOLATE_UNIT_TEST_CASE(name) {                                               \
     CodeGenTest __test__("" #name);                                            \
     CodeGenTestGenerate##name(&__test__);                                      \
     __test__.Compile();                                                        \
     CodeGenTestRun##name(__test__.function());                                 \
   }                                                                            \
   static void CodeGenTestRun##name(const Function& function)
 
 
 // Generate code for two sequences of AST nodes and execute the first one.
 // The first one may reference the Function object generated by the second one.
 #define CODEGEN_TEST2_RUN(name1, name2, expected)                              \
   static void CodeGenTestRun##name1(const Function& function);                 \
-  VM_TEST_CASE(name1) {                                                        \
+  ISOLATE_UNIT_TEST_CASE(name1) {                                              \
     /* Generate code for name2 */                                              \
     CodeGenTest __test2__("" #name2);                                          \
     CodeGenTestGenerate##name2(&__test2__);                                    \
     __test2__.Compile();                                                       \
     /* Generate code for name1, providing function2 */                         \
     CodeGenTest __test1__("" #name1);                                          \
     CodeGenTestGenerate##name1(__test2__.function(), &__test1__);              \
     __test1__.Compile();                                                       \
     CodeGenTestRun##name1(__test1__.function());                               \
   }                                                                            \
@@ skipping 107 matching lines @@
  public:
   explicit TestCaseBase(const char* name);
   virtual ~TestCaseBase() {}
 
   const char* name() const { return name_; }
 
   virtual void Run() = 0;
   void RunTest();
 
   static void RunAll();
+  static void RunAllRaw();
+
+ protected:
+  bool raw_test_;
 
  private:
   static TestCaseBase* first_;
   static TestCaseBase* tail_;
 
   TestCaseBase* next_;
   const char* name_;
 
   DISALLOW_COPY_AND_ASSIGN(TestCaseBase);
 };
@@ skipping 42 matching lines @@
   static void AddTestLib(const char* url, const char* source);
   static const char* GetTestLib(const char* url);
 
  private:
   static Dart_Isolate CreateIsolate(const uint8_t* buffer, const char* name);
 
   RunEntry* const run_;
 };
 
 
+class RawTestCase : TestCaseBase {
+ public:
+  typedef void(RunEntry)();
+
+  RawTestCase(RunEntry* run, const char* name) : TestCaseBase(name), run_(run) {
+    raw_test_ = true;
+  }
+  virtual void Run();
+
+ private:
+  RunEntry* const run_;
+};
+
+
 class TestIsolateScope {
  public:
   TestIsolateScope() {
     isolate_ = reinterpret_cast<Isolate*>(TestCase::CreateTestIsolate());
     Dart_EnterScope();  // Create a Dart API scope for unit tests.
   }
   ~TestIsolateScope() {
     Dart_ExitScope();  // Exit the Dart API scope created for unit tests.
     ASSERT(isolate_ == Isolate::Current());
     Dart_ShutdownIsolate();
@@ skipping 278 matching lines @@
   ~SetFlagScope() { *flag_ = original_value_; }
 
  private:
   T* flag_;
   T original_value_;
 };
 
 }  // namespace dart
 
 #endif  // RUNTIME_VM_UNIT_TEST_H_