Merge pull request #932 from yuluo-yx/0929-yuluo/add-license-check

infra(ci): update copyright check ci
kmesh-net · Oct 8, 2024 · 1fb823f · 1fb823f
2 parents bff5b9a + dc26806
commit 1fb823f
Show file tree

Hide file tree

Showing 25 changed files with 73 additions and 106 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -34,7 +34,7 @@ jobs:
 
     - name: Run Copyright-check
       run : |
-        make ./hack/copyright-check.sh
+        make copyright-check
 
     - name: Build Kmesh
       shell: bash

diff --git a/Makefile b/Makefile
@@ -117,6 +117,10 @@ gen: tidy\
 gen-check: gen
 	hack/gen-check.sh
 
+.PHONY: copyright-check
+copyright-check:
+	hack/copyright-check.sh
+
 .PHONY: install
 install:
 	$(QUIET) make install -C api/v2-c

diff --git a/cniplugin/main.go b/cniplugin/main.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.
@@ -12,7 +12,9 @@
  * 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.
+ */
 
+/*
  * Author: bitcoffee
  * Create: 2023-11-19
  */

diff --git a/config/kmesh_marcos_def.h b/config/kmesh_marcos_def.h
@@ -1,18 +1,5 @@
-/*
- * Copyright 2023 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.
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
 
 /* When the two ends use loopback addresses for communication, there is a
  * low probability that link conflicts occur. The namespace cookie

diff --git a/daemon/main.go b/daemon/main.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.

diff --git a/daemon/manager/manager.go b/daemon/manager/manager.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.

diff --git a/daemon/manager/version/version.go b/daemon/manager/version/version.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.

diff --git a/daemon/options/bpf.go b/daemon/options/bpf.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.

diff --git a/daemon/options/bypass.go b/daemon/options/bypass.go
@@ -1,4 +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.

diff --git a/daemon/options/cni.go b/daemon/options/cni.go
@@ -1,4 +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.

diff --git a/daemon/options/options.go b/daemon/options/options.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.

diff --git a/daemon/options/secret_manager.go b/daemon/options/secret_manager.go
@@ -1,4 +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.

diff --git a/depends/include/bpf_helper_defs_ext.h b/depends/include/bpf_helper_defs_ext.h
@@ -1,18 +1,5 @@
-/*
- * Copyright 2023 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.
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
 
 /*
  * Note: when compiling kmesh, the helper function IDs listed in this

diff --git a/hack/copyright-check.sh b/hack/copyright-check.sh
@@ -7,9 +7,6 @@ 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
@@ -84,7 +81,8 @@ 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
+        exclude_dirs=$(jq -r '.exclude_dirs[]' $ROOT_DIR/hack/copyright/copyright_scan_dir.json)
+        if ! echo $ROOT_DIR$exclude_dirs | grep -q $(dirname $file); then
             check_go_copyright $file
         fi 
     done
@@ -94,19 +92,24 @@ 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
+        exclude_dirs=$(jq -r '.exclude_dirs[]' $ROOT_DIR/hack/copyright/copyright_scan_dir.json)
+        if ! echo $ROOT_DIR$exclude_dirs | grep -q $(dirname $file); then
             check_c_copyright $file
         fi 
     done
 }
 
 function copyright_check() {
+
+    go_dirs=$(jq -r '.go_dirs[]' $ROOT_DIR/hack/copyright/copyright_scan_dir.json)
+    c_dirs=$(jq -r '.c_dirs[]' $ROOT_DIR/hack/copyright/copyright_scan_dir.json)
+
     for dir in ${go_dirs}; do
-        go_check_dir $dir
+        go_check_dir "$ROOT_DIR$dir"
     done
 
     for dir in ${c_dirs}; do
-        c_check_dir $dir
+        c_check_dir "$ROOT_DIR$dir"
     done
 }
 

diff --git a/hack/copyright/copyright_scan_dir.json b/hack/copyright/copyright_scan_dir.json
@@ -0,0 +1,17 @@
+{
+  "go_dirs": [
+    "/pkg",
+    "/cniplugin",
+    "/ctl",
+    "/daemon",
+    "/test"
+  ],
+  "c_dirs": [
+    "/bpf",
+    "/config",
+    "/depends",
+    "/kernel",
+    "/oncn-mda"
+  ],
+  "exclude_dirs": []
+}
diff --git a/hack/gen-check.sh b/hack/gen-check.sh
@@ -5,4 +5,4 @@ if [[ -n $(git status --porcelain) ]]; then
   git diff
   echo "ERROR: Some files need to be updated, please run 'make gen' and include any changed files in your PR"
   exit 1
-fi
+fi
diff --git a/kernel/ko_src/kmesh/defer_connect.c b/kernel/ko_src/kmesh/defer_connect.c
@@ -1,12 +1,5 @@
-/*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
- * Author: liuxin
- * Create: 2022-08-24
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
 
 #include "../../../config/kmesh_marcos_def.h"
 #include <linux/init.h>

diff --git a/kernel/ko_src/kmesh/defer_connect.h b/kernel/ko_src/kmesh/defer_connect.h
@@ -1,12 +1,5 @@
-/*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
- * Author: liuxin
- * Create: 2022-08-24
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
 
 #ifndef KMESH_DEFER_CONN_H
 #define KMESH_DEFER_CONN_H

diff --git a/kernel/ko_src/kmesh/kmesh_main.c b/kernel/ko_src/kmesh/kmesh_main.c
@@ -1,12 +1,5 @@
-/*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
- * Author: liuxin
- * Create: 2022-08-24
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
 
 #define pr_fmt(fmt) "Kmesh_main: " fmt
 

diff --git a/kernel/ko_src/kmesh/kmesh_parse_http_1_1.c b/kernel/ko_src/kmesh/kmesh_parse_http_1_1.c
@@ -1,12 +1,6 @@
-/*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
- * Author: liuxin
- * Create: 2022-08-24
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
+
 #include "kmesh_parse_http_1_1.h"
 
 #define LF          (char)'\n'

diff --git a/kernel/ko_src/kmesh/kmesh_parse_http_1_1.h b/kernel/ko_src/kmesh/kmesh_parse_http_1_1.h
@@ -1,12 +1,5 @@
-/*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
- * Author: liuxin
- * Create: 2022-08-24
- */
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
 
 #ifndef KMESH_REGISTER_HTTP_1_1_H
 #define KMESH_REGISTER_HTTP_1_1_H

diff --git a/kernel/ko_src/kmesh/kmesh_parse_protocol_data.c b/kernel/ko_src/kmesh/kmesh_parse_protocol_data.c
@@ -1,12 +1,11 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
+
 /*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
  * Author: liuxin
  * Create: 2022-08-24
  */
+
 #include "kmesh_parse_protocol_data.h"
 
 struct rb_root __percpu *g_kmesh_data_root;

diff --git a/kernel/ko_src/kmesh/kmesh_parse_protocol_data.h b/kernel/ko_src/kmesh/kmesh_parse_protocol_data.h
@@ -1,9 +1,7 @@
+// SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+/* Copyright Authors of Kmesh */
+
 /*
- * Copyright 2023 The Kmesh Authors.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2 as
- * published by the Free Software Foundation
  * Author: liuxin
  * Create: 2022-08-24
  */

diff --git a/pkg/utils/kernel_version.go b/pkg/utils/kernel_version.go
@@ -2,7 +2,7 @@
 // +build linux
 
 /*
-* Copyright 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.
@@ -15,7 +15,8 @@
  * 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.
-*/
+ */
+
 package utils
 
 import (

diff --git a/test/e2e/restart_test.go b/test/e2e/restart_test.go
@@ -2,7 +2,7 @@
 // +build integ
 
 /*
- * 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.