Add copyright check to CI/CD pipeline

.github/workflows/ci.yml

@@ -1,7 +1,7 @@
 name: CI
 
 on:
-    push: 
+    push:
     pull_request:
         types: [opened, synchronize, reopened]
 
@@ -19,41 +19,44 @@ jobs:
 
         steps:
             - name: Checkout sources
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
 
             - name: Install stable toolchain
               uses: actions-rs/toolchain@v1
               with:
-                  toolchain: stable
+                  toolchain: 1.75.0
                   profile: minimal
                   override: true
                   components: rustfmt
-                  
+
             - name: Setup cache
               uses: Swatinem/rust-cache@v2
 
+            - name: Check for copyright statements
+              run: |
+                  ./tools/check-copyright.sh --check
             - name: Check formatting
               uses: actions-rs/cargo@v1
               with:
                   command: fmt
                   args: --check
-                  
+
     lint:
         name: Lint
         runs-on: ubuntu-latest
 
         steps:
             - name: Checkout sources
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
 
             - name: Install stable toolchain
               uses: actions-rs/toolchain@v1
               with:
-                  toolchain: stable
+                  toolchain: 1.75.0
                   profile: minimal
                   override: true
                   components: clippy
-                  
+
             - name: Setup cache
               uses: Swatinem/rust-cache@v2
 
@@ -69,15 +72,15 @@ jobs:
 
         steps:
             - name: Checkout sources
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
 
             - name: Install stable toolchain
               uses: actions-rs/toolchain@v1
               with:
-                  toolchain: stable
+                  toolchain: 1.75.0
                   profile: minimal
                   override: true
-                  
+
             - name: Setup cache
               uses: Swatinem/rust-cache@v2
 
@@ -91,7 +94,7 @@ jobs:
               with:
                   command: tarpaulin
                   args: --release --all-features --engine llvm --out xml
-                        
+
             - name: Upload to codecov.io
               uses: codecov/codecov-action@v2
               with:

src/network_management/network_manager.rs

@@ -158,7 +158,7 @@ impl NetworkManager {
                     self.get_control_function_address_by_name(destination.get_name()),
                     priority,
                 )
-                .unwrap_or(CanId::default());
+                .unwrap_or_default();
 
                 if message_id.raw() != CanId::default().raw() {
                     self.enqueue_can_message(

src/object_pool/colour.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 #[derive(Debug, Clone, Copy, PartialEq)]
 #[non_exhaustive]
 pub struct Colour {

src/object_pool/mod.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 pub mod colour;
 pub mod reader;
 pub mod writer;

src/object_pool/object.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use crate::network_management::name::NAME;
 use crate::object_pool::object_attributes::{
     Alignment, AnimationOptions, ButtonOptions, ColorFormat, ColourPaletteOptions,
@@ -12,6 +13,7 @@ use crate::object_pool::object_id::ObjectId;
 use crate::object_pool::{Colour, ObjectType};
 
 #[derive(Debug)]
+#[allow(clippy::enum_variant_names)]
 pub enum Object {
     WorkingSet(WorkingSet),
     DataMask(DataMask),

src/object_pool/object_attributes.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use crate::object_pool::object_id::ObjectId;
 use bitvec::field::BitField;
 use bitvec::order::{Lsb0, Msb0};

src/object_pool/object_id.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use crate::object_pool::ParseError;
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]

src/object_pool/object_pool.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use crate::object_pool::colour::Colour;
 use crate::object_pool::object::{
     AlarmMask, Button, Container, DataMask, GraphicsContext, InputBoolean, InputList, InputNumber,

src/object_pool/object_type.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use crate::object_pool::ParseError;
 use crate::object_pool::ParseError::UnknownObjectType;
 

src/object_pool/reader.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use super::*;
 use crate::object_pool::colour::Colour;
 use crate::object_pool::object::*;

src/object_pool/vt_version.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use crate::object_pool::ParseError;
 use crate::object_pool::ParseError::UnknownObjectType;
 

src/object_pool/writer.rs

@@ -1,3 +1,4 @@
+// Copyright 2024 Raven Industries inc
 use super::*;
 use crate::object_pool::colour::Colour;
 use crate::object_pool::object::{

tools/check-copyright.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+set -o errexit
+set -o pipefail
+set -o nounset
+set -o noclobber
+
+REPO_DIRECTORY="$(git rev-parse --show-toplevel)"
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+RESET='\033[0m'
+
+usage() {
+    echo "Usage: $0 [--help]"
+    echo
+    echo "Ensures that each source file has a copyright comment as per the project license"
+    echo
+    echo "  --help, -h      Show this help and exit"
+    echo "  --check, -c     Do not modify the source files, exit with failure if any notices are missing"
+}
+
+check_source_file() {
+    local source="$1"
+    local read_only="$2"
+    local failed_check="false"
+
+    if ! head "$source" | grep -i -E "// Copyright 20[0-9]{2} Raven Industries inc" >&/dev/null; then
+        failed_check="true"
+        if [[ "$read_only" = "false" ]]; then
+            local year
+            year="$(date +%Y)"
+            sed -i "1s;^;// Copyright $year Raven Industries inc\n;" "$source"
+        fi
+    fi
+
+    if [[ "$failed_check" = "true" ]]; then
+        return 1
+    fi
+}
+
+check_sources() {
+    local read_only="$1"
+    local failed_check="false"
+
+    shopt -s globstar
+    for source in "$REPO_DIRECTORY"/src/**/*.rs; do
+        echo -n "Checking '$source' for copyright statement ... "
+        if ! check_source_file "$source" "$read_only"; then
+            failed_check="true"
+            echo -e " ${RED}FAIL${RESET}"
+        else
+            echo -e " ${GREEN}ok${RESET}"
+        fi
+    done
+    if [[ "$failed_check" = "true" ]]; then
+        return 1
+    fi
+}
+
+main() {
+    local read_only="false"
+
+    while [[ $# -gt 0 ]]; do
+        case "$1" in
+        --help | -h)
+            usage
+            exit 0
+            ;;
+        --check | -c)
+            read_only="true"
+            ;;
+        -*)
+            echo "Unexpected option: $1" >&2
+            exit 1
+            ;;
+        *)
+            echo "Unexpected positional argument: $1" >&2
+            exit 1
+            ;;
+        esac
+        shift
+    done
+
+    check_sources "$read_only"
+}
+
+main "$@"