Merge pull request #561 from LiZhenCheng9527/copyright-check

add Copyright check

.github/workflows/main.yml

@@ -28,6 +28,10 @@ jobs:
       run: |
         make gen-check
 
+    - name: Run Copyright-check
+      run : |
+        make ./hack/copyright-check.sh
+
     - name: Build Kmesh
       shell: bash
       run: |

bpf/kmesh/bpf2go/bpf2go.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

bpf/kmesh/probes/access_log.h

@@ -1,3 +1,6 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
+
 #ifndef __KMESH_BPF_ACCESS_LOG_H__
 #define __KMESH_BPF_ACCESS_LOG_H__
 

bpf/kmesh/probes/metrics.h

@@ -1,3 +1,6 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
+
 #ifndef __KMESH_BPF_METRICS_H__
 #define __KMESH_BPF_METRICS_H__
 #include "bpf_common.h"

bpf/kmesh/probes/probe.h

@@ -1,3 +1,6 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
+
 #ifndef __KMESH_BPF_PROBE_H__
 #define __KMESH_BPF_PROBE_H__
 

hack/copyright-check.sh

@@ -0,0 +1,127 @@
+#!/bin/bash
+
+ROOT_DIR=$(git rev-parse --show-toplevel)
+
+go_copyright_path=$ROOT_DIR/hack/copyright/apache.txt
+
+c_copyright_path1=$ROOT_DIR/hack/copyright/BSDandGPL1.txt
+c_copyright_path2=$ROOT_DIR/hack/copyright/BSDandGPL2.txt
+
+go_dirs="$ROOT_DIR/pkg"
+c_dirs="$ROOT_DIR/bpf"
+
+function check_go_copyright() {
+    target_file=$1
+    copyright_file=$go_copyright_path
+
+    if [ ! -f "$target_file" ]; then
+        echo "Target file $target_file does not exist."
+        exit 1
+    fi
+
+    if [ ! -f "$copyright_file" ]; then
+        echo "Copyright file $copyright_file does not exist."
+        exit 1
+    fi
+
+    all_lines_present=true
+    while IFS= read -r line; do
+        if ! grep -qF -- "$line" "$target_file"; then
+            all_lines_present=false
+            break
+        fi
+    done < "$copyright_file"
+
+    if [ "$all_lines_present" != true ]; then
+        echo "The target file does not contain all lines from the copyright file."
+        echo $target_file
+    fi
+}
+
+function check_c_copyright() {
+    target_file=$1
+    copyright_file1=$c_copyright_path1
+    copyright_file2=$c_copyright_path2
+
+    if [ ! -f "$target_file" ]; then
+        echo "Target file $target_file does not exist."
+        exit 1
+    fi
+
+    if [ ! -f "$copyright_file1" ]; then
+        echo "Copyright file $copyright_file1 does not exist."
+        exit 1
+    fi
+
+    if [ ! -f "$copyright_file2" ]; then
+        echo "Copyright file $copyright_file2 does not exist."
+        exit 1
+    fi
+
+    all_lines_present1=true
+    while IFS= read -r line; do
+        if ! grep -qF -- "$line" "$target_file"; then
+            all_lines_present1=false
+            break
+        fi
+    done < "$copyright_file1"
+
+    all_lines_present2=true
+    while IFS= read -r line; do
+        if ! grep -qF -- "$line" "$target_file"; then
+            all_lines_present2=false
+            break
+        fi
+    done < "$copyright_file2"
+
+    if [ "$all_lines_present1" != true ] && [ "$all_lines_present2" != true ]; then
+        echo "The target file does not contain all lines from the copyright file."
+        echo $target_file
+    fi  
+}
+
+function go_check_dir() {
+    dir=$1
+    find $dir -type f -name "*.go" | while read file; do
+        # echo $file
+        if ! echo $exclude_dirs | grep -q $(dirname $file); then
+            check_go_copyright $file
+        fi 
+    done
+}
+
+function c_check_dir() {
+    dir=$1
+    find $dir -type f -name "*.c" -o -name "*.h" | while read file; do
+        # echo $file
+        if ! echo $exclude_dirs | grep -q $(dirname $file); then
+            check_c_copyright $file
+        fi 
+    done
+}
+
+function copyright_check() {
+    for dir in ${go_dirs}; do
+        go_check_dir $dir
+    done
+
+    for dir in ${c_dirs}; do
+        c_check_dir $dir
+    done
+}
+
+# Confirmation of whether there are files with wrong copyright
+if [ -z "$1" -o "$1" == "-c" -o "$1" == "--check" ]; then
+    result=$(copyright_check | grep -c 'not contain')
+    if [ "$result" != 0 ]; then
+        echo "ERROR: Some files need to be update copyright, please run "./hack/copyright-check -g" and update and include any changed files in your PR"
+        exit 1
+    else
+        echo "pass copyright check"
+    fi
+fi
+
+# Obtaining the name of a file that with wrong copyright
+if [ "$1" == "-g" -o "$1" == "--get" ]; then
+    copyright_check
+fi

hack/copyright/BSDandGPL1.txt

@@ -0,0 +1,2 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */

hack/copyright/BSDandGPL2.txt

@@ -0,0 +1,2 @@
+/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
+/* Copyright Authors of Kmesh */

hack/copyright/apache.txt

@@ -0,0 +1,15 @@
+/*
+ * Copyright The Kmesh 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.
+ */

pkg/auth/policy_store.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/auth/policy_store_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/auth/rbac.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/auth/rbac_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/auth/xdp_auth_handler.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/bpf.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/bpf_kmesh.go

@@ -2,7 +2,7 @@
 // +build enhanced
 
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/bpf_kmesh_common.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/bpf_kmesh_l4.go

@@ -2,7 +2,7 @@
 // +build !enhanced
 
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/bpf_kmesh_l4_workload.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/bpf_kmesh_workload.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/bpf/pin.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/cluster.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/cluster_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/listener.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/listener_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/maps/cluster.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/maps/common.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/maps/listener.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/maps/route.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/route.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cache/v2/route_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cni/chained.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cni/chained_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cni/install.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cni/kubeconfig.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cni/plugin/plugin.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/cni/plugin/plugin_test.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

pkg/constants/constants.go

@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 The Kmesh Authors.
+ * Copyright The Kmesh Authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.