Switch Travis CI to GitHub Actions (cmu-db#161)

jkosh44 · web-flow · commit 5bbfdc17fc72 · 2021-08-31T13:36:05.000+08:00
diff --git a/.clang-tidy b/.clang-tidy
@@ -43,18 +43,17 @@ Checks:     '
             -readability-qualified-auto,
             -readability-redundant-access-specifiers,
             '
-# TODO(WAN): To be enabled in Fall 2020.
-#CheckOptions:
-#  - { key: readability-identifier-naming.ClassCase,           value: CamelCase  }
-#  - { key: readability-identifier-naming.EnumCase,            value: CamelCase  }
-#  - { key: readability-identifier-naming.FunctionCase,        value: CamelCase  }
-#  - { key: readability-identifier-naming.GlobalConstantCase,  value: UPPER_CASE }
-#  - { key: readability-identifier-naming.MemberCase,          value: lower_case }
-#  - { key: readability-identifier-naming.MemberSuffix,        value: _          }
-#  - { key: readability-identifier-naming.NamespaceCase,       value: lower_case }
-#  - { key: readability-identifier-naming.StructCase,          value: CamelCase  }
-#  - { key: readability-identifier-naming.UnionCase,           value: CamelCase  }
-#  - { key: readability-identifier-naming.VariableCase,        value: lower_case }
+CheckOptions:
+  - { key: readability-identifier-naming.ClassCase,           value: CamelCase  }
+  - { key: readability-identifier-naming.EnumCase,            value: CamelCase  }
+  - { key: readability-identifier-naming.FunctionCase,        value: CamelCase  }
+  - { key: readability-identifier-naming.GlobalConstantCase,  value: UPPER_CASE }
+  - { key: readability-identifier-naming.MemberCase,          value: lower_case }
+  - { key: readability-identifier-naming.MemberSuffix,        value: _          }
+  - { key: readability-identifier-naming.NamespaceCase,       value: lower_case }
+  - { key: readability-identifier-naming.StructCase,          value: CamelCase  }
+  - { key: readability-identifier-naming.UnionCase,           value: CamelCase  }
+  - { key: readability-identifier-naming.VariableCase,        value: lower_case }
 WarningsAsErrors: '*'
 HeaderFilterRegex: '/(src|test)/include'
 AnalyzeTemporaryDtors: true
diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -0,0 +1,90 @@
+name: CMake Build Matrix
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+env:
+  BUILD_TYPE: Debug
+
+jobs:
+  build:
+    name: ${{ matrix.config.name }}
+    runs-on: ${{ matrix.config.os }}
+
+    strategy:
+      fail-fast: true
+      matrix:
+        config:
+          - {
+            name: "Ubuntu Latest GCC",
+            os: ubuntu-latest,
+            cc: "/usr/bin/gcc",
+            cxx: "/usr/bin/g++",
+            format: "/usr/bin/clang-format-8",
+            tidy: "/usr/bin/clang-tidy-8"
+          }
+          - {
+            name: "Ubuntu Latest Clang",
+            os: ubuntu-latest,
+            cc: "/usr/bin/clang-8",
+            cxx: "/usr/bin/clang++8",
+            format: "/usr/bin/clang-format-8",
+            tidy: "/usr/bin/clang-tidy-8"
+          }
+          - {
+            name: "macOS Latest Clang",
+            os: macos-latest,
+            cc: "/usr/bin/clang",
+            cxx: "/usr/bin/clang++",
+            format: "/usr/local/opt/llvm@8/bin/clang-format",
+            tidy: "/usr/local/opt/llvm@8/bin/clang-tidy"
+          }
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Print env
+        run: |
+          echo github.event.action: ${{ github.event.action }}
+          echo github.event_name: ${{ github.event_name }}
+      - name: Install Dependencies (Ubuntu)
+        if: runner.os == 'Linux'
+        working-directory: ${{github.workspace}}
+        run: sudo bash ./build_support/packages.sh -y
+
+      - name: Install Dependencies (OSX)
+        if: runner.os == 'macOS'
+        working-directory: ${{github.workspace}}
+        run: bash ./build_support/packages.sh -y
+
+      - name: Configure CMake
+        run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DCC=${{matrix.config.cc}} -DCXX=${{matrix.config.cxx}} -DCLANG_FORMAT_BIN=${{matrix.config.format}} -DCLANG_TIDY_BIN=${{matrix.config.tidy}}
+
+      - name: Build
+        run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+
+      - name: Check Format
+        working-directory: ${{github.workspace}}/build
+        run: make check-format
+
+      - name: Check Lint
+        working-directory: ${{github.workspace}}/build
+        run: make check-lint
+
+      - name: Check Clang Tidy
+        working-directory: ${{github.workspace}}/build
+        run: make check-clang-tidy
+
+      - name: Check Tests (Ubuntu)
+        if: runner.os == 'Linux'
+        working-directory: ${{github.workspace}}/build
+        run: make check-tests
+
+      - name: Check Tests (OSX)
+        if: runner.os == 'macOS'
+        working-directory: ${{github.workspace}}/build
+        # Disable container overflow checks on OSX
+        run: ASAN_OPTIONS=detect_container_overflow=0 make check-tests
diff --git a/.travis.yml b/.travis.yml
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -32,19 +32,25 @@ set(BUSTUB_CLANG_SEARCH_PATH "/usr/local/bin" "/usr/bin" "/usr/local/opt/llvm/bi
 enable_testing()
 
 # clang-format
-find_program(CLANG_FORMAT_BIN
-        NAMES clang-format clang-format-8
-        HINTS ${BUSTUB_CLANG_SEARCH_PATH})
+if (NOT DEFINED CLANG_FORMAT_BIN)
+    # attempt to find the binary if user did not specify
+    find_program(CLANG_FORMAT_BIN
+            NAMES clang-format clang-format-8
+            HINTS ${BUSTUB_CLANG_SEARCH_PATH})
+endif()
 if ("${CLANG_FORMAT_BIN}" STREQUAL "CLANG_FORMAT_BIN-NOTFOUND")
     message(WARNING "BusTub/main couldn't find clang-format.")
 else()
     message(STATUS "BusTub/main found clang-format at ${CLANG_FORMAT_BIN}")
 endif()
 
 # clang-tidy
-find_program(CLANG_TIDY_BIN
-        NAMES clang-tidy clang-tidy-8
-        HINTS ${BUSTUB_CLANG_SEARCH_PATH})
+if (NOT DEFINED CLANG_TIDY_BIN)
+    # attempt to find the binary if user did not specify
+    find_program(CLANG_TIDY_BIN
+            NAMES clang-tidy clang-tidy-8
+            HINTS ${BUSTUB_CLANG_SEARCH_PATH})
+endif()
 if ("${CLANG_TIDY_BIN}" STREQUAL "CLANG_TIDY_BIN-NOTFOUND")
     message(WARNING "BusTub/main couldn't find clang-tidy.")
 else()
diff --git a/src/include/common/util/hash_util.h b/src/include/common/util/hash_util.h
@@ -26,7 +26,7 @@ using hash_t = std::size_t;
 
 class HashUtil {
  private:
-  static const hash_t prime_factor = 10000019;
+  static const hash_t PRIME_FACTOR = 10000019;
 
  public:
   static inline hash_t HashBytes(const char *bytes, size_t length) {
@@ -45,7 +45,7 @@ class HashUtil {
     return HashBytes(reinterpret_cast<char *>(both), sizeof(hash_t) * 2);
   }
 
-  static inline hash_t SumHashes(hash_t l, hash_t r) { return (l % prime_factor + r % prime_factor) % prime_factor; }
+  static inline hash_t SumHashes(hash_t l, hash_t r) { return (l % PRIME_FACTOR + r % PRIME_FACTOR) % PRIME_FACTOR; }
 
   template <typename T>
   static inline hash_t Hash(const T *ptr) {
diff --git a/src/include/execution/executors/aggregation_executor.h b/src/include/execution/executors/aggregation_executor.h
@@ -97,10 +97,10 @@ class SimpleAggregationHashTable {
    * @param agg_val the value to be inserted
    */
   void InsertCombine(const AggregateKey &agg_key, const AggregateValue &agg_val) {
-    if (ht.count(agg_key) == 0) {
-      ht.insert({agg_key, GenerateInitialAggregateValue()});
+    if (ht_.count(agg_key) == 0) {
+      ht_.insert({agg_key, GenerateInitialAggregateValue()});
     }
-    CombineAggregateValues(&ht[agg_key], agg_val);
+    CombineAggregateValues(&ht_[agg_key], agg_val);
   }
 
   /**
@@ -135,14 +135,14 @@ class SimpleAggregationHashTable {
   };
 
   /** @return iterator to the start of the hash table */
-  Iterator Begin() { return Iterator{ht.cbegin()}; }
+  Iterator Begin() { return Iterator{ht_.cbegin()}; }
 
   /** @return iterator to the end of the hash table */
-  Iterator End() { return Iterator{ht.cend()}; }
+  Iterator End() { return Iterator{ht_.cend()}; }
 
  private:
   /** The hash table is just a map from aggregate keys to aggregate values. */
-  std::unordered_map<AggregateKey, AggregateValue> ht{};
+  std::unordered_map<AggregateKey, AggregateValue> ht_{};
   /** The aggregate expressions that we have. */
   const std::vector<const AbstractExpression *> &agg_exprs_;
   /** The types of aggregations that we have. */
diff --git a/src/include/primer/p0_starter.h b/src/include/primer/p0_starter.h
@@ -29,7 +29,7 @@ class Matrix {
  protected:
   /**
    * TODO(P0): Add implementation
-   * 
+   *
    * Construct a new Matrix instance.
    * @param rows The number of rows
    * @param cols The number of columns
diff --git a/src/include/storage/index/b_plus_tree.h b/src/include/storage/index/b_plus_tree.h
@@ -55,9 +55,9 @@ class BPlusTree {
   bool GetValue(const KeyType &key, std::vector<ValueType> *result, Transaction *transaction = nullptr);
 
   // index iterator
-  INDEXITERATOR_TYPE begin();
+  INDEXITERATOR_TYPE Begin();
   INDEXITERATOR_TYPE Begin(const KeyType &key);
-  INDEXITERATOR_TYPE end();
+  INDEXITERATOR_TYPE End();
 
   void Print(BufferPoolManager *bpm) {
     ToString(reinterpret_cast<BPlusTreePage *>(bpm->FetchPage(root_page_id_)->GetData()), bpm);
diff --git a/src/include/storage/index/index_iterator.h b/src/include/storage/index/index_iterator.h
@@ -26,7 +26,7 @@ class IndexIterator {
   IndexIterator();
   ~IndexIterator();
 
-  bool isEnd();
+  bool IsEnd();
 
   const MappingType &operator*();
 
diff --git a/src/include/storage/page/b_plus_tree_internal_page.h b/src/include/storage/page/b_plus_tree_internal_page.h
@@ -61,6 +61,6 @@ class BPlusTreeInternalPage : public BPlusTreePage {
   void CopyNFrom(MappingType *items, int size, BufferPoolManager *buffer_pool_manager);
   void CopyLastFrom(const MappingType &pair, BufferPoolManager *buffer_pool_manager);
   void CopyFirstFrom(const MappingType &pair, BufferPoolManager *buffer_pool_manager);
-  MappingType array[0];
+  MappingType array_[0];
 };
 }  // namespace bustub
diff --git a/src/include/storage/page/b_plus_tree_leaf_page.h b/src/include/storage/page/b_plus_tree_leaf_page.h
@@ -68,6 +68,6 @@ class BPlusTreeLeafPage : public BPlusTreePage {
   void CopyLastFrom(const MappingType &item);
   void CopyFirstFrom(const MappingType &item);
   page_id_t next_page_id_;
-  MappingType array[0];
+  MappingType array_[0];
 };
 }  // namespace bustub
diff --git a/src/storage/index/b_plus_tree.cpp b/src/storage/index/b_plus_tree.cpp
@@ -185,7 +185,7 @@ bool BPLUSTREE_TYPE::AdjustRoot(BPlusTreePage *old_root_node) { return false; }
  * @return : index iterator
  */
 INDEX_TEMPLATE_ARGUMENTS
-INDEXITERATOR_TYPE BPLUSTREE_TYPE::begin() { return INDEXITERATOR_TYPE(); }
+INDEXITERATOR_TYPE BPLUSTREE_TYPE::Begin() { return INDEXITERATOR_TYPE(); }
 
 /*
  * Input parameter is low key, find the leaf page that contains the input key
@@ -201,7 +201,7 @@ INDEXITERATOR_TYPE BPLUSTREE_TYPE::Begin(const KeyType &key) { return INDEXITERA
  * @return : index iterator
  */
 INDEX_TEMPLATE_ARGUMENTS
-INDEXITERATOR_TYPE BPLUSTREE_TYPE::end() { return INDEXITERATOR_TYPE(); }
+INDEXITERATOR_TYPE BPLUSTREE_TYPE::End() { return INDEXITERATOR_TYPE(); }
 
 /*****************************************************************************
  * UTILITIES AND DEBUG
diff --git a/src/storage/index/b_plus_tree_index.cpp b/src/storage/index/b_plus_tree_index.cpp
@@ -49,13 +49,13 @@ void BPLUSTREE_INDEX_TYPE::ScanKey(const Tuple &key, std::vector<RID> *result, T
 }
 
 INDEX_TEMPLATE_ARGUMENTS
-INDEXITERATOR_TYPE BPLUSTREE_INDEX_TYPE::GetBeginIterator() { return container_.begin(); }
+INDEXITERATOR_TYPE BPLUSTREE_INDEX_TYPE::GetBeginIterator() { return container_.Begin(); }
 
 INDEX_TEMPLATE_ARGUMENTS
 INDEXITERATOR_TYPE BPLUSTREE_INDEX_TYPE::GetBeginIterator(const KeyType &key) { return container_.Begin(key); }
 
 INDEX_TEMPLATE_ARGUMENTS
-INDEXITERATOR_TYPE BPLUSTREE_INDEX_TYPE::GetEndIterator() { return container_.end(); }
+INDEXITERATOR_TYPE BPLUSTREE_INDEX_TYPE::GetEndIterator() { return container_.End(); }
 
 template class BPlusTreeIndex<GenericKey<4>, RID, GenericComparator<4>>;
 template class BPlusTreeIndex<GenericKey<8>, RID, GenericComparator<8>>;
diff --git a/src/storage/index/index_iterator.cpp b/src/storage/index/index_iterator.cpp
@@ -18,7 +18,7 @@ INDEX_TEMPLATE_ARGUMENTS
 INDEXITERATOR_TYPE::~IndexIterator() = default;
 
 INDEX_TEMPLATE_ARGUMENTS
-bool INDEXITERATOR_TYPE::isEnd() { throw std::runtime_error("unimplemented"); }
+bool INDEXITERATOR_TYPE::IsEnd() { throw std::runtime_error("unimplemented"); }
 
 INDEX_TEMPLATE_ARGUMENTS
 const MappingType &INDEXITERATOR_TYPE::operator*() { throw std::runtime_error("unimplemented"); }
diff --git a/src/storage/page/b_plus_tree_leaf_page.cpp b/src/storage/page/b_plus_tree_leaf_page.cpp
@@ -63,7 +63,7 @@ KeyType B_PLUS_TREE_LEAF_PAGE_TYPE::KeyAt(int index) const {
 INDEX_TEMPLATE_ARGUMENTS
 const MappingType &B_PLUS_TREE_LEAF_PAGE_TYPE::GetItem(int index) {
   // replace with your own code
-  return array[0];
+  return array_[0];
 }
 
 /*****************************************************************************
diff --git a/test/common/rwlatch_test.cpp b/test/common/rwlatch_test.cpp
@@ -22,21 +22,21 @@ class Counter {
  public:
   Counter() = default;
   void Add(int num) {
-    mutex.WLock();
+    mutex_.WLock();
     count_ += num;
-    mutex.WUnlock();
+    mutex_.WUnlock();
   }
   int Read() {
     int res;
-    mutex.RLock();
+    mutex_.RLock();
     res = count_;
-    mutex.RUnlock();
+    mutex_.RUnlock();
     return res;
   }
 
  private:
   int count_{0};
-  ReaderWriterLatch mutex{};
+  ReaderWriterLatch mutex_{};
 };
 
 // NOLINTNEXTLINE
diff --git a/test/concurrency/transaction_test.cpp b/test/concurrency/transaction_test.cpp
diff --git a/test/execution/executor_test.cpp b/test/execution/executor_test.cpp
diff --git a/test/storage/b_plus_tree_concurrent_test.cpp b/test/storage/b_plus_tree_concurrent_test.cpp
diff --git a/test/storage/b_plus_tree_delete_test.cpp b/test/storage/b_plus_tree_delete_test.cpp
diff --git a/test/storage/b_plus_tree_insert_test.cpp b/test/storage/b_plus_tree_insert_test.cpp
diff --git a/test/storage/b_plus_tree_print_test.cpp b/test/storage/b_plus_tree_print_test.cpp
