Added formatting checks for C/C++ and python code (#1348)

.bazelci/config.yaml

@@ -252,6 +252,6 @@ tasks:
     test_targets: *min_supported_targets
 
 buildifier:
-  version: "6.1.0"
+  version: "7.3.1"
   # keep this argument in sync with .pre-commit-config.yaml
   warnings: "all"

.clang-format

@@ -0,0 +1,4 @@
+---
+BasedOnStyle: Google
+IndentWidth: 4
+...

.github/workflows/formatting.yaml

@@ -0,0 +1,34 @@
+name: Formatting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  code-format-checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: DoozyX/clang-format-lint-action@v0.14
+        with:
+          source: '.'
+          extensions: 'h,c,cc,cpp,proto,java'
+          clangFormatVersion: 14
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          pip install 'black==24.10.0' 'isort==5.13.2'
+      - name: Run black
+        run: |
+          python -m black --check --diff ./
+      - name: Run isort
+        run: |
+          python -m isort --profile=black --check-only ./

.gitignore

@@ -38,6 +38,9 @@
 # CMake
 cmake-build-*/
 
+# Python
+/*venv/
+
 # Mongo Explorer plugin
 .idea/**/mongoSettings.xml
 

.pre-commit-config.yaml

@@ -21,7 +21,7 @@ repos:
       - id: check-yaml
 
   - repo: https://github.com/keith/pre-commit-buildifier
-    rev: 6.1.0.1
+    rev: 7.3.1.1
     hooks:
       - id: buildifier
         args: &args

examples/cmake_android/cpp/native-lib.cpp

@@ -1,13 +1,12 @@
 #include <jni.h>
+
 #include <string>
 
-extern "C"
-JNIEXPORT jstring
+extern "C" JNIEXPORT jstring
 
-JNICALL
-Java_com_example_android_bazel_MainActivity_stringFromJNI(
-        JNIEnv *env,
-        jobject /* this */) {
+    JNICALL
+    Java_com_example_android_bazel_MainActivity_stringFromJNI(
+        JNIEnv *env, jobject /* this */) {
     std::string hello = "Hello from C++";
     return env->NewStringUTF(hello.c_str());
 }

examples/cmake_android/hello_lib-example.cpp

@@ -1,8 +1,8 @@
 #include <stdio.h>
+
 #include "hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func();
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func();
+    return 0;
 }

examples/cmake_android/java/com/example/android/bazel/MainActivity.java

@@ -1,11 +1,10 @@
 package examples.cmake_android.java.com.example.android.bazel;
 
-import android.support.v7.app.AppCompatActivity;
 import android.os.Bundle;
+import android.support.v7.app.AppCompatActivity;
 import android.widget.TextView;
 
 public class MainActivity extends AppCompatActivity {
-
     static {
         System.loadLibrary("app");
     }

examples/cmake_android/zlib-example.cpp

@@ -1,13 +1,14 @@
 // Copied from https://gist.github.com/arq5x/5315739 for test purposes
 
+#include <assert.h>
 #include <stdio.h>
 #include <string.h>  // for strlen
-#include <assert.h>
+
 #include "zlib.h"
 
-// adapted from: http://stackoverflow.com/questions/7540259/deflate-and-inflate-zlib-h-in-c
-int main(int argc, char* argv[])
-{
+// adapted from:
+// http://stackoverflow.com/questions/7540259/deflate-and-inflate-zlib-h-in-c
+int main(int argc, char *argv[]) {
     // original string len = 36
     char a[50] = "Hello Hello Hello Hello Hello Hello!";
 
@@ -17,11 +18,9 @@ int main(int argc, char* argv[])
     // placeholder for the UNcompressed (inflated) version of "b"
     char c[50];
 
-
     printf("Uncompressed size is: %lu\n", strlen(a));
     printf("Uncompressed string is: %s\n", a);
 
-
     printf("\n----------\n\n");
 
     // STEP 1.
@@ -33,10 +32,11 @@ int main(int argc, char* argv[])
     defstream.zfree = Z_NULL;
     defstream.opaque = Z_NULL;
     // setup "a" as the input and "b" as the compressed output
-    defstream.avail_in = (uInt)strlen(a)+1; // size of input, string + terminator
-    defstream.next_in = (Bytef *)a; // input char array
-    defstream.avail_out = (uInt)sizeof(b); // size of output
-    defstream.next_out = (Bytef *)b; // output char array
+    defstream.avail_in =
+        (uInt)strlen(a) + 1;         // size of input, string + terminator
+    defstream.next_in = (Bytef *)a;  // input char array
+    defstream.avail_out = (uInt)sizeof(b);  // size of output
+    defstream.next_out = (Bytef *)b;        // output char array
 
     // the actual compression work.
     deflateInit(&defstream, Z_BEST_COMPRESSION);
@@ -47,10 +47,8 @@ int main(int argc, char* argv[])
     printf("Compressed size is: %lu\n", strlen(b));
     printf("Compressed string is: %s\n", b);
 
-
     printf("\n----------\n\n");
 
-
     // STEP 2.
     // inflate b into c
     // zlib struct
@@ -59,10 +57,11 @@ int main(int argc, char* argv[])
     infstream.zfree = Z_NULL;
     infstream.opaque = Z_NULL;
     // setup "b" as the input and "c" as the compressed output
-    infstream.avail_in = (uInt)((char*)defstream.next_out - b); // size of input
-    infstream.next_in = (Bytef *)b; // input char array
-    infstream.avail_out = (uInt)sizeof(c); // size of output
-    infstream.next_out = (Bytef *)c; // output char array
+    infstream.avail_in =
+        (uInt)((char *)defstream.next_out - b);  // size of input
+    infstream.next_in = (Bytef *)b;              // input char array
+    infstream.avail_out = (uInt)sizeof(c);       // size of output
+    infstream.next_out = (Bytef *)c;             // output char array
 
     // the actual DE-compression work.
     inflateInit(&infstream);
@@ -72,9 +71,8 @@ int main(int argc, char* argv[])
     printf("Uncompressed size is: %lu\n", strlen(c));
     printf("Uncompressed string is: %s\n", c);
 
-
     // make sure uncompressed is exactly equal to original.
-    assert(strcmp(a,c)==0);
+    assert(strcmp(a, c) == 0);
 
     return 0;
 }

examples/cmake_crosstool/hello.cc

@@ -18,6 +18,6 @@
 #include <iostream>
 
 int main(int argc, char* argv[]) {
-  std::cout << "Hello! sqrt(time) = " << std::sqrt(time(NULL)) << std::endl;
-  return EXIT_SUCCESS;
+    std::cout << "Hello! sqrt(time) = " << std::sqrt(time(NULL)) << std::endl;
+    return EXIT_SUCCESS;
 }

examples/cmake_crosstool/static/hello_client.c

@@ -1,7 +1,6 @@
 #include "hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func();
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func();
+    return 0;
 }

examples/cmake_crosstool/static/hello_client_version123.c

@@ -1,7 +1,6 @@
 #include "version123/hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func();
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func();
+    return 0;
 }

examples/cmake_crosstool/static/src/hello.c

@@ -1,7 +1,7 @@
 #include "hello.h"
 
 void hello_func(void) {
-	printf("Hello World!\n");
+    printf("Hello World!\n");
 
-	return;
+    return;
 }

examples/cmake_defines/lib_a/lib_a.cpp

@@ -6,14 +6,10 @@
 #define STR(x) #x
 #pragma message "The value of __TIME__: " XSTR(__TIME__)
 
-#define STATIC_ASSERT( condition, name )\
-    typedef char assert_failed_ ## name [ (condition) ? 1 : -1 ];
+#define STATIC_ASSERT(condition, name) \
+    typedef char assert_failed_##name[(condition) ? 1 : -1];
 
-void foo() {
-STATIC_ASSERT(__TIME__ == "redacted", time_must_be_redacted);
-}
+void foo() { STATIC_ASSERT(__TIME__ == "redacted", time_must_be_redacted); }
 
 // Should return "redacted"
-const char *getBuildTime(void) {
-    return __TIME__;
-}
+const char *getBuildTime(void) { return __TIME__; }

examples/cmake_hello_world_lib/binary/src/hello.c

@@ -1,5 +1,3 @@
 #include "hello.h"
 
-void hello_func(char* name) {
-	printf("Hello, %s!", name);
-}
+void hello_func(char* name) { printf("Hello, %s!", name); }

examples/cmake_hello_world_lib/binary/src/main.c

@@ -1,7 +1,6 @@
 #include "hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func(argv[1]);
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func(argv[1]);
+    return 0;
 }

examples/cmake_hello_world_lib/shared/hello_client.c

@@ -1,7 +1,6 @@
 #include "hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func();
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func();
+    return 0;
 }

examples/cmake_hello_world_lib/shared/src/hello.c

@@ -1,7 +1,7 @@
 #include "hello.h"
 
 void hello_func(void) {
-	printf("Hello World!\n");
+    printf("Hello World!\n");
 
-	return;
+    return;
 }

examples/cmake_hello_world_lib/static/hello_client.c

@@ -1,7 +1,6 @@
 #include "hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func();
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func();
+    return 0;
 }

examples/cmake_hello_world_lib/static/hello_client_version123.c

@@ -1,7 +1,6 @@
 #include "version123/hello.h"
 
-int main(int argc, char* argv[])
-{
-  hello_func();
-  return 0;
+int main(int argc, char* argv[]) {
+    hello_func();
+    return 0;
 }

examples/cmake_hello_world_lib/static/src/hello.c

@@ -1,7 +1,7 @@
 #include "hello.h"
 
 void hello_func(void) {
-	printf("Hello World!\n");
+    printf("Hello World!\n");
 
-	return;
+    return;
 }

examples/cmake_synthetic/liba/src/liba.cpp

@@ -1,5 +1,3 @@
 #include "liba.h"
 
-std::string hello_liba(void) {
-	return "Hello from LIBA!";
-}
+std::string hello_liba(void) { return "Hello from LIBA!"; }

examples/cmake_synthetic/liba/src/liba.h

@@ -2,6 +2,7 @@
 #define LIBA_H_ (1)
 
 #include <stdio.h>
+
 #include <string>
 
 std::string hello_liba(void);

examples/cmake_synthetic/libb/src/libb.cpp

@@ -1,5 +1,3 @@
 #include "libb.h"
 
-std::string hello_libb(void) {
-  return hello_liba() + " Hello from LIBB!";
-}
+std::string hello_libb(void) { return hello_liba() + " Hello from LIBB!"; }

examples/cmake_synthetic/libb/src/libb.h

@@ -2,7 +2,9 @@
 #define LIBB_H_ (1)
 
 #include <stdio.h>
+
 #include <string>
+
 #include "liba.h"
 
 std::string hello_libb(void);

examples/cmake_synthetic/libc/src/libc.cpp

@@ -1,5 +1,5 @@
 #include "libc.h"
 
 std::string hello_libc(void) {
-  return hello_liba() + " " + hello_libb() + " Hello from LIBC!";
+    return hello_liba() + " " + hello_libb() + " Hello from LIBC!";
 }

examples/cmake_synthetic/libc/src/libc.h

@@ -2,7 +2,9 @@
 #define LIBC_H_ (1)
 
 #include <stdio.h>
+
 #include <string>
+
 #include "liba.h"
 #include "libb.h"
 

examples/cmake_synthetic/test_libb.cpp

@@ -1,14 +1,13 @@
-#include "libb.h"
-
 #include <iostream>
 #include <stdexcept>
 #include <string>
 
-int main(int argc, char* argv[])
-{
-  std:: string result = hello_libb();
-  if (result != "Hello from LIBA! Hello from LIBB!") {
-    throw std::runtime_error("Wrong result: " + result);
-  }
-  std::cout << "Everything's fine!";
+#include "libb.h"
+
+int main(int argc, char* argv[]) {
+    std::string result = hello_libb();
+    if (result != "Hello from LIBA! Hello from LIBB!") {
+        throw std::runtime_error("Wrong result: " + result);
+    }
+    std::cout << "Everything's fine!";
 }