Initialize badges

Author: github-classroom[bot]

.clang-format

@@ -0,0 +1,73 @@
+BasedOnStyle: Google
+Language: Cpp
+Standard: c++17
+AccessModifierOffset: -1
+AlignOperands: Align
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: None
+BreakBeforeBinaryOperators: NonAssignment
+AllowAllArgumentsOnNextLine: false
+AllowAllConstructorInitializersOnNextLine: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: Always
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Empty
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLambdasOnASingleLine: All
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakTemplateDeclarations: Yes
+AlwaysBreakBeforeMultilineStrings: false
+BreakBeforeBraces: Custom
+BraceWrapping:
+  AfterCaseLabel: false
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterUnion: false
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+  SplitEmptyFunction: false
+  SplitEmptyRecord: true
+BreakBeforeTernaryOperators: false
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+BinPackParameters: true
+ColumnLimit: 120
+CompactNamespaces: false
+ContinuationIndentWidth: 4
+IndentCaseLabels: true
+IndentPPDirectives: BeforeHash
+IndentWidth: 2
+KeepEmptyLinesAtTheStartOfBlocks: true
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+MaxEmptyLinesToKeep: 1
+SortIncludes: Never
+NamespaceIndentation: All
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: false
+PointerAlignment: Right
+ReflowComments: false
+SpaceAfterCStyleCast: true
+SpaceAfterLogicalNot: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth: 4
+UseTab: Never
+AlignTrailingComments: true
+FixNamespaceComments: true

.clang-tidy

@@ -0,0 +1,5 @@
+---
+Checks: 'clang-analyzer-*,misc-*,google-*,performance-*,readability-*'
+WarningsAsErrors: '*'
+HeaderFilterRegex: ''
+FormatStyle: none

.github/badges/points-bar.svg

@@ -0,0 +1,34 @@
+{
+  "tests": [
+    {
+      "name": "This is an empty test-case!",
+      "setup": "echo \"Configuring... Wait a minute...\"",
+      "run": "echo \"Success! You got 1 point!\"",
+      "input": "",
+      "output": "",
+      "comparison": "exact",
+      "timeout": 1,
+      "points": 1
+    },
+    {
+      "name": "Passing test-case",
+      "setup": "",
+      "run": "ctest -VVV --output-on-failure --test-dir build -R \"Passing test-case\"",
+      "input": "",
+      "output": "",
+      "comparison": "exact",
+      "timeout": 1,
+      "points": 1
+    },
+    {
+      "name": "Failing test-case",
+      "setup": "",
+      "run": "ctest -VVV --output-on-failure --test-dir build -R \"Failing test-case\"",
+      "input": "",
+      "output": "",
+      "comparison": "exact",
+      "timeout": 1,
+      "points": 1
+    }
+  ]
+}

.github/classroom/autograding.json

@@ -0,0 +1,60 @@
+# For details refer https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions.
+name: GitHub Classroom
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ 'master', 'main' ]
+    paths: [ 'src/**', 'include/**' ]
+
+env:
+  # CMake build type: Release, Debug, RelWithDebInfo, etc.
+  BUILD_TYPE: Release
+
+defaults:
+  run: { shell: bash }
+
+jobs:
+  autograding:
+    name: Autograding
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with: { submodules: 'recursive', fetch-depth: 0 }
+
+      - name: Create Build Environment
+        run: cmake -E make_directory ${{github.workspace}}/build
+
+      - name: Configure CMake
+        working-directory: ${{github.workspace}}/build
+        run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
+
+      - name: CMake Build
+        working-directory: ${{github.workspace}}/build
+        run: cmake --build . --config $BUILD_TYPE
+
+      - name: GitHub Autograding
+        uses: education/autograding@v1
+        continue-on-error: true
+        id: autograder
+
+      # Add the badge with the current student's score.
+      - name: Checkout badges branch
+        run: git checkout badges || git checkout -b badges
+
+      - name: Generate badge with a score
+        uses: markpatterson27/points-bar@v1
+        with:
+          points: ${{ steps.autograder.outputs.points }}
+          path: '.github/badges/points-bar.svg'
+          label: 'Score'
+          type: badge
+
+      - name: Update badge with a score
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add '.github/badges/points-bar.svg'
+          git commit -m "Add/Update points bar" || exit 0
+          git push origin badges

.github/workflows/classroom.yml

@@ -0,0 +1,40 @@
+name: Check Memory Leaks
+
+on: [ workflow_dispatch ]
+
+defaults:
+  run: { shell: bash }
+
+env:
+  # Memory check requires Debug builds.
+  BUILD_TYPE: Debug
+
+jobs:
+  memcheck:
+    name: Check Memory Leakage
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with: { submodules: 'recursive' }
+
+      - name: Install valgrind
+        run: sudo apt-get -qq update && sudo apt-get install -qq valgrind
+
+      - name: Create Build Environment
+        run: cmake -E make_directory ${{github.workspace}}/build
+
+      - name: Configure CMake
+        working-directory: ${{github.workspace}}/build
+        run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DENABLE_MEMCHECK=ON
+
+      - name: CMake Build
+        working-directory: ${{github.workspace}}/build
+        run: cmake --build . --config $BUILD_TYPE
+
+      # See more https://cmake.org/cmake/help/latest/manual/ctest.1.html.
+      - name: Run CTest with MemCheck
+        working-directory: ${{github.workspace}}/build
+        run: >
+          ctest -VVV -C $BUILD_TYPE -D ExperimentalMemCheck --output-on-failure 
+          --overwrite MemoryCheckCommandOptions="--tool=memcheck --leak-check=full --error-exitcode=100"

.github/workflows/memcheck.yml

@@ -0,0 +1,16 @@
+# build files
+cmake-build*
+build*
+
+# IDE files
+.idea
+
+# Executables
+*.exe
+
+# Compiled Dynamic librarires
+*.so
+*.dll
+
+# Solutions
+src/solution

.gitignore

@@ -0,0 +1,3 @@
+[submodule "contrib/Catch2"]
+	path = contrib/Catch2
+	url = https://github.com/catchorg/Catch2.git

.gitmodules

@@ -0,0 +1,66 @@
+# This is the top-level CMakeLists.txt file
+
+cmake_minimum_required(VERSION 3.15 FATAL_ERROR)
+
+project(cpp_assignment CXX)
+
+# C++ standard specification
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_EXTENSIONS ON)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+# Helpers
+include(CMakePrintHelpers)
+include(cmake/MemCheck.cmake)
+include(cmake/CompilerWarnings.cmake)
+
+# Options
+option(BUILD_TESTS "Build assignment tests." ON)
+option(ENABLE_COMPILER_WARNINGS "Project compile warnings." ON)
+option(ENABLE_MEMCHECK "Configure project for memory checking." OFF)
+
+cmake_print_variables(CMAKE_BUILD_TYPE BUILD_TESTS ENABLE_COMPILER_WARNINGS ENABLE_MEMCHECK)
+
+# Library
+add_library(${PROJECT_NAME} STATIC)
+
+if (EXISTS ${PROJECT_SOURCE_DIR}/src/solution)
+    message(STATUS "Using solution code: yes")
+
+    file(GLOB CPP_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} src/solution/*.cpp)
+    target_sources(${PROJECT_NAME} PRIVATE ${CPP_SOURCES})
+else ()
+    message(STATUS "Using solution code: no")
+
+    file(GLOB CPP_SOURCES RELATIVE ${PROJECT_SOURCE_DIR} src/*.cpp)
+    target_sources(${PROJECT_NAME} PRIVATE ${CPP_SOURCES})
+endif ()
+
+target_include_directories(${PROJECT_NAME} PUBLIC include)
+
+# Executables
+add_executable(run_${PROJECT_NAME} main.cpp)
+target_link_libraries(run_${PROJECT_NAME} PRIVATE ${PROJECT_NAME})
+
+# Warnings
+if (ENABLE_COMPILER_WARNINGS)
+    message(STATUS "Compiler warnings: enabled")
+
+    add_library(project_warnings INTERFACE)
+    set_project_warnings(project_warnings)
+
+    target_link_libraries(${PROJECT_NAME} PRIVATE project_warnings)
+    target_link_libraries(run_${PROJECT_NAME} PRIVATE project_warnings)
+endif (ENABLE_COMPILER_WARNINGS)
+
+# Memory Check
+if (ENABLE_MEMCHECK)
+    enable_memcheck()
+endif (ENABLE_MEMCHECK)
+
+# Tests
+if (BUILD_TESTS)
+    enable_testing()
+    add_subdirectory(contrib)
+    add_subdirectory(tests)
+endif (BUILD_TESTS)

CMakeLists.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Intelligent Robotics Dept.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.