[git] Add clang code formatting

Author: deniskoronchik

.clang-format

@@ -0,0 +1,162 @@
+Language:        Cpp
+# BasedOnStyle:  Google
+AccessModifierOffset: -2
+AlignAfterOpenBracket: AlwaysBreak
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: DontAlign
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortLambdasOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:   
+  AfterCaseLabel:  true
+  AfterClass:      true
+  AfterControlStatement: Always
+  AfterEnum:       true
+  AfterFunction:   true
+  AfterNamespace:  true
+  AfterObjCDeclaration: false
+  AfterStruct:     true
+  AfterUnion:      true
+  AfterExternBlock: true
+  BeforeCatch:     true
+  BeforeElse:      true
+  BeforeLambdaBody: true
+  BeforeWhile:     true
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: true
+BreakInheritanceList: BeforeComma
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeComma
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     120
+CommentPragmas:  '^\s*(\*)?\s*\\.+'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+# EmptyLineBeforeAccessModifier: Always
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:   
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^<(gtest|gmock)/.*'
+    Priority:        1
+
+  - Regex:           '^<sc-memory/*.*'
+    Priority:        11
+  
+  - Regex:           '^"sc_*.*'
+    Priority:        21
+  
+  - Regex:           '.*'
+    Priority:        100
+# IncludeIsMainRegex: '([-_](test|unittest))?$'
+IndentCaseLabels: false
+IndentPPDirectives: AfterHash
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000
+PenaltyReturnTypeOnItsOwnLine: 2000
+PointerAlignment: Middle
+RawStringFormats: 
+  - Language:        Cpp
+    Delimiters:      
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+  - Language:        TextProto
+    Delimiters:      
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions: 
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: true
+# SpaceAroundPointerQualifiers: After/Both
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Auto
+StatementMacros: 
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        2
+UseTab:          Never
+...

.github/workflows/main.yml

@@ -32,6 +32,19 @@ jobs:
           checkAllCommitMessages: true # optional, default is false
           # you must provide GITHUB_TOKEN to this input if checkAllCommitMessages is true
           accessToken: ${{ secrets.GITHUB_TOKEN }} # optional, default is false
+  
+  check_formatting:
+    name: Check code formatting
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Check
+        id: check_formatting
+        run: scripts/ci/check-formatting.sh
+
   run_tests:
     name: ${{matrix.config.name}}
     runs-on: ${{matrix.config.os}}

scripts/ci/check-formatting.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+# sudo apt-get update
+# sudo apt-get install -y clang-format
+
+python3 scripts/tools/format-code.py --check \
+sc-kpm \
+sc-memory \
+sc-network \
+sc-server \
+tools

scripts/ci/install-deps.sh

@@ -16,4 +16,4 @@ packagelist=(
   python3-setuptools
 )
 sudo apt-get update
-sudo apt-get install ${packagelist[@]}
+sudo apt-get install -y ${packagelist[@]}

scripts/format-code.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+python3 scripts/tools/format-code.py \
+sc-kpm \
+sc-memory \
+sc-network \
+sc-server \
+tools

scripts/tools/format-code.py

@@ -0,0 +1,133 @@
+import argparse
+import os
+import shutil
+import subprocess
+import sys
+
+import xml.etree.ElementTree as ET
+
+allowed_extensions = [
+  ".cpp",
+  ".hpp",
+  ".c"
+  ".h"
+]
+
+ignore_files = [
+  "json/json.hpp",
+  "sha256",
+  "tinyxml",
+]
+
+class Formatter:
+
+  Executable = "clang-format"
+
+  def __init__(self):
+    if shutil.which(Formatter.Executable) is None:
+      raise "clang-format is not exists"
+
+  def collect_files(self, paths):
+    files = []
+
+    def add_file(file_path):
+      need_ignore = False
+
+      for i in ignore_files:
+        if i.lower() in file_path:
+          need_ignore = True
+          break
+
+      if not need_ignore:
+        files.append(file_path)
+
+    for d in paths:
+      if not os.path.exists(d):
+        continue
+      if os.path.isdir(d):
+        for root, _, filenames in os.walk(d):
+          for filename in filenames:
+            _, ext = os.path.splitext(filename)
+            if ext in allowed_extensions:
+              add_file(os.path.join(root, filename))
+      elif os.path.splitext(d)[1] in allowed_extensions:
+        add_file(d)
+    return files
+
+  def format(self, search_paths):
+    files = self.collect_files(search_paths)
+
+    for f in files:
+      print("Format file {}".format(f))
+      cmd = "{} -i {}".format(Formatter.Executable, f)
+      process = subprocess.Popen(cmd, shell=True, cwd=os.getcwd(), stdout=None, stderr=None)
+      rc = process.wait()
+      if rc != 0:
+        raise "Error while formatting {}".format(f)
+
+  def check(self, search_paths) -> bool:
+    files = self.collect_files(search_paths)
+
+    final_result = True
+    non_formatted_files = []
+
+    for f in files:
+      print('Check {}'.format(f), end='')
+      cmd = "{} --output-replacements-xml {}".format(Formatter.Executable, f)
+
+      process = subprocess.Popen(cmd, shell=True, cwd=os.getcwd(), stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+      rc = process.wait()
+      output = process.communicate()[0]
+
+      passed = False
+
+      if rc == 0:
+
+        passed = True
+        # check if there are any replacements
+        s = output.decode("utf-8")
+        if len(s) > 0:
+          root = ET.fromstring(s)
+          replacements = root.findall("replacement")
+
+          if len(replacements) > 0:
+            passed = False
+      
+      if not passed:
+        final_result = False
+        non_formatted_files.append(f)
+
+      print (" - {}".format("ok" if passed else "fail"))
+
+    return (final_result, non_formatted_files)
+
+
+if __name__ == "__main__":
+
+  parser = argparse.ArgumentParser(description="Process some integers.")
+  parser.add_argument(
+    "files",
+    nargs="*",
+    help=
+    "List of input files or folders (relative to the working directory)",
+  )
+  parser.add_argument("--check", action="store_true")
+
+  args = parser.parse_args()
+
+  c = Formatter()
+  if args.check:
+    passed, files = c.check(args.files)
+    if not passed:
+      if len(files) > 0:
+        print ("-" * 10)
+        print("Files that need formatting:")
+        for f in files:
+          print(" {}".format(f))
+    else:
+      print ("-" * 10)
+      print ("All checks passed")
+
+    sys.exit(0 if passed else 1)
+  else:
+    c.format(args.files)