Add script and CI job to check license headers in Rust files

Co-authored-by: simongdavies <[email protected]>
Signed-off-by: Simon Davies <[email protected]>

Author: Copilot

.github/workflows/ValidatePullRequest.yml

@@ -67,6 +67,14 @@ jobs:
     - name: Spell Check Repo
       uses: crate-ci/[email protected]
 
+  license-headers:
+    name: check license headers
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Check License Headers
+      run: ./dev/check-license-headers.sh
+
   # Gate PR merges on this specific "join-job" which requires all other
   # jobs to run first. We need this job since we cannot gate on particular jobs
   # in the workflow, since they can sometimes be skipped (e.g. if the PR only touches docs).
@@ -77,6 +85,7 @@ jobs:
       - rust
       - fuzzing
       - spelling
+      - license-headers
     if: always()
     runs-on: ubuntu-latest
     steps:

dev/check-license-headers.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+# This script checks for the presence of the required license header in Rust source files.
+
+# Get the repository root
+REPO_ROOT="$(git rev-parse --show-toplevel)"
+cd "$REPO_ROOT" || exit 1
+
+# Define the license header pattern to look for
+LICENSE_PATTERN="Copyright .* The Hyperlight Authors..*Licensed under the Apache License, Version 2.0"
+
+# Initialize a variable to track missing headers
+MISSING_HEADERS=0
+MISSING_FILES=""
+
+# Find all Rust files, excluding target directory
+while IFS= read -r file; do
+    # Skip auto-generated files
+    if grep -q "@generated" "$file" || grep -q "Automatically generated" "$file"; then
+        continue
+    fi
+
+    # Check if the file has the license header (allowing for multi-line matching)
+    if ! grep -q -z "$LICENSE_PATTERN" "$file"; then
+        echo "Missing or invalid license header in $file"
+        MISSING_FILES="$MISSING_FILES\n  $file"
+        MISSING_HEADERS=$((MISSING_HEADERS + 1))
+    fi
+done < <(find src -name "*.rs" -type f)
+
+if [ $MISSING_HEADERS -gt 0 ]; then
+    echo "Found $MISSING_HEADERS files with missing or invalid license headers:"
+    echo -e "$MISSING_FILES"
+    exit 1
+else
+    echo "All Rust files have the required license header"
+    exit 0
+fi

src/hyperlight_host/src/func/utils.rs

@@ -1,3 +1,19 @@
+/*
+Copyright 2024 The Hyperlight Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 /// An utility macro to execute a macro for each tuple of parameters
 /// up to 32 parameters. This is useful to implement traits on functions
 /// for may parameter tuples.

src/hyperlight_host/src/hypervisor/crashdump.rs

@@ -1,3 +1,19 @@
+/*
+Copyright 2024 The Hyperlight Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
 use std::io::Write;
 
 use tempfile::NamedTempFile;