chore: update the copyright header at a specific line (#17)

Signed-off-by: behnazh-w <[email protected]>

Author: behnazh-w

scripts/dev_scripts/copyright-checker.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# Copyright (c) 2022 - 2022, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2022 - 2023, Oracle and/or its affiliates. All rights reserved.
 # Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
 
 #
@@ -10,6 +10,7 @@
 files=$(git diff --cached --name-only)
 currentyear=$(date +"%Y")
 missing_copyright_files=()
+license_note="Licensed under the Universal Permissive License v 1.0 as shown at https:\/\/oss\.oracle\.com\/licenses\/upl\/\."
 
 
 for f in $files; do
@@ -29,25 +30,46 @@ done
 
 if [ ${#missing_copyright_files[@]} -ne 0 ]; then
     for f in "${missing_copyright_files[@]}"; do
+
+        # Don't allow this script to run on itself.
+        if [[ $0 == $f ]];then
+            echo "Cannot run the $0 on itself. Please fix the headers in this file manually."
+            exit 1
+        fi
+        missing_license_note=$(grep -i "$license_note" "$f")
         startyear=$(git log --format=%ad --date=format:%Y "$f" | tail -1)
         if [[ -z "${startyear// }" ]]; then
             startyear=$currentyear
         fi
         if [[ $f =~ .*\.(js$|java$|go$|dl$) ]]; then
             expected="\/\* Copyright \(c\) $startyear - $currentyear, Oracle and\/or its affiliates\. All rights reserved\. \*\/"
-            expected="$expected\n\/\* Licensed under the Universal Permissive License v 1.0 as shown at https:\/\/oss\.oracle\.com\/licenses\/upl\/\. \*\/"
+            if [ ${#missing_license_note} -eq 0 ]; then
+                expected="$expected\n\/\* $license_note \*\/"
+            fi
         elif [[ $f =~ .*\.(py$|tf$|sh$|yaml$) ]] || [[ "${f##*/}" = "Dockerfile" ]]; then
             expected="# Copyright \(c\) $startyear - $currentyear, Oracle and\/or its affiliates\. All rights reserved\."
-            expected="$expected\n# Licensed under the Universal Permissive License v 1.0 as shown at https:\/\/oss\.oracle\.com\/licenses\/upl\/\."
-
+            if [ ${#missing_license_note} -eq 0 ]; then
+                expected="$expected\n# $license_note"
+            fi
         fi
 
-        if ! grep -i -e "Copyright (c) .* Oracle and/or its affiliates. All rights reserved" "$f" 1>/dev/null;then
-            echo "Copyright header missing for $f"
-            sed -i "1s/^/$expected\n\n/" "$f"
+        # Find the first matching copyright line.
+        line_number=$(grep -m 1 -n -i -e "Copyright (c) .* Oracle and/or its affiliates. All rights reserved" "$f" | cut -d : -f 1)
+        if [[ -z "$line_number" ]]; then
+            echo "Copyright header missing for $f."
+
+            # Check for executable scripts and don't replace the first line starting with shebang.
+            shebang_line=$(grep -m 1 -n "#!" "$f")
+            if [[ -z "$shebang_line" ]];then
+                # If there is no shebang, insert at the first line.
+                sed -i "1s/^/$expected\n\n/" "$f"
+            else
+                # If there is a shebang, append to the end of the line.
+                sed -i "$(echo $shebang_line | cut -d : -f 1)""s/$/\n\n$expected/" "$f"
+            fi
         else
-            echo "Copyright header needs update for $f"
-            sed -i "1s/^.*/$expected/" "$f"
+            echo "Copyright header needs update for $f."
+            sed -i "$line_number""s/^.*/$expected/" "$f"
         fi
     done
     echo "Copyright headers have been automatically added/updated. Please review and stage the changes before running git commit again."