Docker for compiling, linting, and testing

.clang-format

@@ -1,5 +1,122 @@
 ---
-BasedOnStyle: Google
-ColumnLimit: 100
-IndentWidth: '4'
+Language:        Cpp
+AlignAfterOpenBracket: Align
+AlignConsecutiveMacros: true
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlines: Left
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllArgumentsOnNextLine: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: Never
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Attach # Our guideline prefers Attach style
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: AfterColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: true
+BreakStringLiterals: true
+ColumnLimit:     100 # BARR C requires 80, but 100 is more presentable
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: false
+DeriveLineEnding: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: false
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Preserve
+IncludeCategories:
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+    SortPriority:    0
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+    SortPriority:    0
+  - Regex:           '.*'
+    Priority:        1
+    SortPriority:    0
+IncludeIsMainRegex: '(Test)?$'
+IncludeIsMainSourceRegex: ''
+IndentCaseLabels: true
+IndentCaseBlocks: true
+IndentGotoLabels: true
+IndentPPDirectives: None
+IndentWidth:     4
+IndentWrappedFunctionNames: false
+InsertBraces: true
+IndentAccessModifiers: true
+AccessModifierOffset: 0
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Auto
+ObjCBlockIndentWidth: 4
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: false
+PackConstructorInitializers: CurrentLine
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Right
+ReflowComments:  true
+SortIncludes:    false
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: true
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: Custom
+SpaceBeforeParensOptions:
+  AfterControlStatements: true
+  AfterFunctionDefinitionName: true
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyBlock: false
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInConditionalStatement: false
+SpacesInContainerLiterals: false
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+SpaceBeforeSquareBrackets: false
+Standard:        Latest
+StatementMacros:
+  - Q_UNUSED
+  - QT_REQUIRE_VERSION
+TabWidth:        8
+UseCRLF:         false
+UseTab:          Never
 ...

.clang-tidy

@@ -0,0 +1,164 @@
+---
+Checks:
+  - bugprone-assignment-in-if-condition
+  - bugprone-bool-pointer-implicit-conversion
+  - bugprone-branch-clone
+  - bugprone-empty-catch
+  - bugprone-inc-dec-in-conditions
+  - bugprone-incorrect-roundings
+  - bugprone-infinite-loop
+  - bugprone-integer-division
+  - bugprone-macro-parentheses
+  - bugprone-parent-virtual-call
+  - bugprone-redundant-branch-condition
+  - bugprone-shared-ptr-array-mismatch
+  - bugprone-sizeof-container
+  - bugprone-sizeof-expression
+  - bugprone-swapped-arguments
+  - bugprone-switch-missing-default-case
+  - bugprone-unique-ptr-array-mismatch
+  - bugprone-virtual-near-miss
+  - cppcoreguidelines-avoid-do-while
+  - cppcoreguidelines-avoid-goto
+  - cppcoreguidelines-avoid-non-const-global-variables
+  - cppcoreguidelines-init-variables
+  - cppcoreguidelines-narrowing-conversions
+  - cppcoreguidelines-no-malloc
+  - cppcoreguidelines-prefer-member-initializer
+  - cppcoreguidelines-pro-type-member-init
+  - cppcoreguidelines-virtual-class-destructor
+  - misc-definitions-in-headers
+  - misc-header-include-cycle
+  - misc-no-recursion
+  - misc-non-private-member-variables-in-classes
+  - misc-redundant-expression
+  - modernize-use-equals-default
+  - modernize-use-equals-delete
+  - modernize-use-nullptr
+  - modernize-use-override
+  - readability-avoid-const-params-in-decls
+  - readability-avoid-unconditional-preprocessor-if
+  - readability-braces-around-statements
+  - readability-const-return-type
+  - readability-delete-null-pointer
+  - readability-duplicate-include
+  - readability-else-after-return
+  - readability-identifier-naming
+  - readability-implicit-bool-conversion
+  - readability-inconsistent-declaration-parameter-name
+  - readability-misleading-indentation
+  - readability-redundant-access-specifiers
+  - readability-redundant-control-flow
+  - readability-redundant-declaration
+  - readability-redundant-function-ptr-dereference
+  - readability-redundant-member-init
+  - readability-redundant-preprocessor
+  - readability-simplify-boolean-expr
+  - readability-static-accessed-through-instance
+  - readability-static-definition-in-anonymous-namespace
+  - performance-type-promotion-in-math-fn
+  - performance-unnecessary-value-param
+WarningsAsErrors: ''
+HeaderFileExtensions:
+  - ''
+  - h
+  - hh
+  - hpp
+  - hxx
+ImplementationFileExtensions:
+  - c
+  - cc
+  - cpp
+  - cxx
+HeaderFilterRegex: ''
+FormatStyle:     none
+CheckOptions:
+  bugprone-empty-catch.AllowEmptyCatchForExceptions: ''
+  bugprone-empty-catch.IgnoreCatchWithKeywords: '@TODO;@FIXME'
+  bugprone-sizeof-expression.WarnOnSizeOfCompareToConstant: 'true'
+  bugprone-sizeof-expression.WarnOnSizeOfConstant: 'true'
+  bugprone-sizeof-expression.WarnOnSizeOfIntegerExpression: 'false'
+  bugprone-sizeof-expression.WarnOnSizeOfPointerToAggregate: 'true'
+  bugprone-sizeof-expression.WarnOnSizeOfThis: 'true'
+  cert-dcl16-c.NewSuffixes: 'L;LL;LU;LLU'
+  cert-err33-c.AllowCastToVoid: 'true'
+  cert-err33-c.CheckedFunctions: '::aligned_alloc;::asctime_s;::at_quick_exit;::atexit;::bsearch;::bsearch_s;::btowc;::c16rtomb;::c32rtomb;::calloc;::clock;::cnd_broadcast;::cnd_init;::cnd_signal;::cnd_timedwait;::cnd_wait;::ctime_s;::fclose;::fflush;::fgetc;::fgetpos;::fgets;::fgetwc;::fopen;::fopen_s;::fprintf;::fprintf_s;::fputc;::fputs;::fputwc;::fputws;::fread;::freopen;::freopen_s;::fscanf;::fscanf_s;::fseek;::fsetpos;::ftell;::fwprintf;::fwprintf_s;::fwrite;::fwscanf;::fwscanf_s;::getc;::getchar;::getenv;::getenv_s;::gets_s;::getwc;::getwchar;::gmtime;::gmtime_s;::localtime;::localtime_s;::malloc;::mbrtoc16;::mbrtoc32;::mbsrtowcs;::mbsrtowcs_s;::mbstowcs;::mbstowcs_s;::memchr;::mktime;::mtx_init;::mtx_lock;::mtx_timedlock;::mtx_trylock;::mtx_unlock;::printf_s;::putc;::putwc;::raise;::realloc;::remove;::rename;::scanf;::scanf_s;::setlocale;::setvbuf;::signal;::snprintf;::snprintf_s;::sprintf;::sprintf_s;::sscanf;::sscanf_s;::strchr;::strerror_s;::strftime;::strpbrk;::strrchr;::strstr;::strtod;::strtof;::strtoimax;::strtok;::strtok_s;::strtol;::strtold;::strtoll;::strtoul;::strtoull;::strtoumax;::strxfrm;::swprintf;::swprintf_s;::swscanf;::swscanf_s;::thrd_create;::thrd_detach;::thrd_join;::thrd_sleep;::time;::timespec_get;::tmpfile;::tmpfile_s;::tmpnam;::tmpnam_s;::tss_create;::tss_get;::tss_set;::ungetc;::ungetwc;::vfprintf;::vfprintf_s;::vfscanf;::vfscanf_s;::vfwprintf;::vfwprintf_s;::vfwscanf;::vfwscanf_s;::vprintf_s;::vscanf;::vscanf_s;::vsnprintf;::vsnprintf_s;::vsprintf;::vsprintf_s;::vsscanf;::vsscanf_s;::vswprintf;::vswprintf_s;::vswscanf;::vswscanf_s;::vwprintf_s;::vwscanf;::vwscanf_s;::wcrtomb;::wcschr;::wcsftime;::wcspbrk;::wcsrchr;::wcsrtombs;::wcsrtombs_s;::wcsstr;::wcstod;::wcstof;::wcstoimax;::wcstok;::wcstok_s;::wcstol;::wcstold;::wcstoll;::wcstombs;::wcstombs_s;::wcstoul;::wcstoull;::wcstoumax;::wcsxfrm;::wctob;::wctrans;::wctype;::wmemchr;::wprintf_s;::wscanf;::wscanf_s;'
+  cert-oop54-cpp.WarnOnlyIfThisHasSuspiciousField: 'false'
+  cert-str34-c.DiagnoseSignedUnsignedCharComparisons: 'false'
+  cppcoreguidelines-avoid-do-while.IgnoreMacros: 'false'
+  cppcoreguidelines-init-variables.IncludeStyle: llvm
+  cppcoreguidelines-init-variables.MathHeader: '<math.h>'
+  cppcoreguidelines-narrowing-conversions.IgnoreConversionFromTypes: ''
+  cppcoreguidelines-narrowing-conversions.PedanticMode: 'false'
+  cppcoreguidelines-narrowing-conversions.WarnOnEquivalentBitWidth: 'true'
+  cppcoreguidelines-narrowing-conversions.WarnOnFloatingPointNarrowingConversion: 'true'
+  cppcoreguidelines-narrowing-conversions.WarnOnIntegerNarrowingConversion: 'true'
+  cppcoreguidelines-narrowing-conversions.WarnOnIntegerToFloatingPointNarrowingConversion: 'true'
+  cppcoreguidelines-narrowing-conversions.WarnWithinTemplateInstantiation: 'false'
+  cppcoreguidelines-no-malloc.Allocations: '::malloc;::calloc'
+  cppcoreguidelines-no-malloc.Deallocations: '::free'
+  cppcoreguidelines-no-malloc.Reallocations: '::realloc'
+  cppcoreguidelines-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic: 'true'
+  cppcoreguidelines-prefer-member-initializer.UseAssignment: 'false'
+  cppcoreguidelines-pro-type-member-init.IgnoreArrays: 'false'
+  cppcoreguidelines-pro-type-member-init.UseAssignment: 'false'
+  google-readability-braces-around-statements.ShortStatementLines: '1'
+  google-readability-function-size.StatementThreshold: '800'
+  google-readability-namespace-comments.ShortNamespaceLines: '10'
+  google-readability-namespace-comments.SpacesBeforeComments: '2'
+  llvm-else-after-return.WarnOnConditionVariables: 'false'
+  llvm-else-after-return.WarnOnUnfixable: 'false'
+  llvm-qualified-auto.AddConstToQualified: 'false'
+  misc-definitions-in-headers.HeaderFileExtensions: ';h;hh;hpp;hxx'
+  misc-definitions-in-headers.UseHeaderFileExtension: 'true'
+  misc-header-include-cycle.IgnoredFilesList: ''
+  misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic: 'false'
+  misc-non-private-member-variables-in-classes.IgnorePublicMemberVariables: 'false'
+  modernize-use-equals-default.IgnoreMacros: 'true'
+  modernize-use-equals-delete.IgnoreMacros: 'true'
+  modernize-use-nullptr.IgnoredTypes: 'std::_CmpUnspecifiedParam::;^std::__cmp_cat::__unspec'
+  modernize-use-nullptr.NullMacros: 'NULL'
+  modernize-use-override.AllowOverrideAndFinal: 'false'
+  modernize-use-override.FinalSpelling: final
+  modernize-use-override.IgnoreDestructors: 'false'
+  modernize-use-override.IgnoreTemplateInstantiations: 'false'
+  modernize-use-override.OverrideSpelling: override
+  performance-type-promotion-in-math-fn.IncludeStyle: llvm
+  readability-avoid-const-params-in-decls.IgnoreMacros: 'true'
+  readability-braces-around-statements.ShortStatementLines: '0'
+  readability-const-return-type.IgnoreMacros: 'true'
+  readability-else-after-return.WarnOnConditionVariables: 'true'
+  readability-else-after-return.WarnOnUnfixable: 'true'
+  readability-identifier-naming.AggressiveDependentMemberLookup: 'false'
+  readability-identifier-naming.CheckAnonFieldInParent: 'false'
+  readability-identifier-naming.GetConfigPerFile: 'true'
+  readability-identifier-naming.IgnoreFailedSplit: 'false'
+  readability-identifier-naming.IgnoreMainLikeFunctions: 'false'
+  readability-identifier-naming.MacroDefinitionCase: 'UPPER_CASE'
+  readability-identifier-naming.VariableCase: 'camelBack'
+  readability-identifier-naming.StaticVariablePreffix: '_'
+  readability-identifier-naming.ConstantCase: 'UPPER_CASE'
+  readability-identifier-naming.ClassCase: 'CamelCase'
+  readability-identifier-naming.FunctionCase: 'camelBack'
+  readability-identifier-naming.MemberCase: 'camelBack'
+  readability-identifier-naming.MemberSuffix: '_'
+  readability-identifier-naming.StructCase: 'CamelCase'
+  readability-identifier-naming.TypedefCase: 'CamelCase'
+  readability-identifier-naming.TypedefSuffix: '_t'
+  readability-identifier-naming.EnumCase: 'CamelCase'
+  readability-identifier-naming.EnumSuffix: '_e'
+  readability-implicit-bool-conversion.AllowIntegerConditions: 'false'
+  readability-implicit-bool-conversion.AllowPointerConditions: 'false'
+  readability-inconsistent-declaration-parameter-name.IgnoreMacros: 'true'
+  readability-inconsistent-declaration-parameter-name.Strict: 'false'
+  readability-redundant-declaration.IgnoreMacros: 'true'
+  readability-redundant-member-init.IgnoreBaseInCopyConstructors: 'false'
+  readability-simplify-boolean-expr.ChainedConditionalAssignment: 'false'
+  readability-simplify-boolean-expr.ChainedConditionalReturn: 'false'
+  readability-simplify-boolean-expr.IgnoreMacros: 'false'
+  readability-simplify-boolean-expr.SimplifyDeMorgan: 'true'
+  readability-simplify-boolean-expr.SimplifyDeMorganRelaxed: 'false'
+  readability-static-accessed-through-instance.NameSpecifierNestingThreshold: '3'
+SystemHeaders:   false
+...
+

.github/workflows/compile_test.yaml

@@ -7,24 +7,12 @@ on:
 jobs:
   compile_test:
     runs-on: ubuntu-latest
-
-    env:
-      URL: developer.arm.com/-/media/Files/downloads/gnu/12.2.mpacbti-rel1/binrel
-      TOOLCHAIN_NAME: arm-gnu-toolchain-12.2.mpacbti-rel1-x86_64-arm-none-eabi
-
     steps:
-      - name: Install CMake, make, and wget
-        run: sudo apt-get -y install cmake make wget
-
-      - name: Install Arm Toolchain
-        working-directory: /opt
-        run: |
-          wget -nv $URL/$TOOLCHAIN_NAME.tar.xz 
-          tar -xf $TOOLCHAIN_NAME.tar.xz && rm -f $TOOLCHAIN_NAME.tar.xz 
-          ln -s $(pwd)/$TOOLCHAIN_NAME/bin/arm-none-eabi-* /usr/local/bin 
-
       - name: Checkout the repo
         uses: actions/checkout@v3
 
+      - name: Initialize Docker
+        run: bash ./tools/run_docker.bash init
+
       - name: Build project
-        run: bash ./Tools/tools.bash compile -t Firmware -c
+        run: bash ./tools/run_docker.bash compile

.github/workflows/lint.yaml

@@ -0,0 +1,27 @@
+name: Lint
+
+on:
+  pull_request:
+    type: [opened, synchronize]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repo
+        uses: actions/checkout@v3
+
+      - name: Initialize Docker
+        run: bash ./tools/run_docker.bash init
+
+      - name: Build project
+        run: bash ./tools/run_docker.bash compile
+
+      - name: Run clang-tidy
+        run: bash ./tools/run_docker.bash clang-tidy
+
+      - name: Run clang-format
+        run: bash ./tools/run_docker.bash clang-format
+
+      - name: Run cppcheck
+        run: bash ./tools/run_docker.bash cppcheck

.github/workflows/unit_test.yaml

@@ -6,29 +6,13 @@ on:
 
 jobs:
   unit_test:
-    runs-on: ubuntu-latest 
-
-    env:
-      URL: https://github.com/google/googletest.git
-      TAG: v1.13.0
-
-    steps:      
-      - name: Install CMake, make, and git
-        run: sudo apt-get -y install cmake make git
-
-      - name: Install GoogleTest
-        working-directory: /home/runner/work
-        run: |
-          git clone $URL -b $TAG
-          mkdir googletest/build && cd googletest/build
-          cmake -G "Unix Makefiles" ..
-          cmake --build . && sudo cmake --install .
-
-      - name: Checkout repo
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repo
         uses: actions/checkout@v3
 
-      - name: Build tests
-        run: bash ./Tools/tools.bash compile -t Testing -c
+      - name: Initialize Docker
+        run: bash ./tools/run_docker.bash init
 
-      - name: Run tests
-        run: bash ./Tools/tools.bash run
+      - name: Build and run tests
+        run: bash ./tools/run_docker.bash test

.gitignore

@@ -23,6 +23,8 @@
 
 .idea/
 .vscode/
-Tools/*/build/
+.DS_Store/
+tools/*/build
+tools/lint_output
 Debug/
 /.metadata/