Merge pull request #1203 from rafalste/copyright_header_check_improvements

Copyright header check improvements
This commit is contained in:
Robert Baldyga 2022-09-08 13:27:30 +02:00 committed by GitHub
commit bea1f22684
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
69 changed files with 121 additions and 111 deletions

View File

@ -5,20 +5,32 @@
# SPDX-License-Identifier: BSD-3-Clause
#
# COPYRIGHT_REGEX is lowercase, because the whole line is
# converted to lowercase before test against this regex.
COPYRIGHT_REGEX="(copyright|\(c\))\s*([0-9]{4}(\s*-\s*([0-9]{4}))?)"
LICENSE_REGEX="SPDX-License-Identifier: BSD-3-Clause$"
YEAR=$(date +"%Y")
REGEX="Copyright\(c\) [0-9]{4}-([0-9]{4}) |Copyright\(c\) ([0-9]{4}) "
while read -r line; do
if [[ "$line" =~ $REGEX ]]; then
echo ${BASH_REMATCH[0]}
if [[ $YEAR == ${BASH_REMATCH[1]} || $YEAR == ${BASH_REMATCH[2]} ]]; then
echo $1 have appropriate license header
exit 0
fi
echo $1 have wrong license header year
exit 1
fi
unset copyright_header license_header
# Read lines until proper copyright and license headers are found.
while read -r line && [[ ! "$copyright_header" || ! "$license_header" ]]; do
if [[ "${line,,}" =~ $COPYRIGHT_REGEX ]]; then
# If the fourth regex group (from year range) doesn't exist,
# use the second regex group instead (from a single year).
copyright_year=${BASH_REMATCH[4]:-${BASH_REMATCH[2]}}
if [[ $copyright_year == $YEAR ]]; then
copyright_header="correct_copyright_header_found"
fi
elif [[ "$line" =~ $LICENSE_REGEX ]]; then
license_header="correct_license_header_found"
fi
done < "$1"
echo $1 does not contain appropriate license header
# Proper copyright and license info were found - all good.
[[ "$copyright_header" && "$license_header" ]] && exit 0
[[ ! "$copyright_header" ]] && echo >&2 "error: file '$1' does not contain any appropriate copyright info"
[[ ! "$license_header" ]] && echo >&2 "error: file '$1' does not contain appropriate license identifier"
exit 1

View File

@ -3,9 +3,10 @@ on:
pull_request:
branches:
- master
env:
EXTENSIONS: "c h cpp py go sh"
EXTENSIONS: "c h cpp py go sh mk spec service"
FILES: "configure configure.d/* *Makefile utils/casctl tools/pckgen.d/deb/debian/rules"
jobs:
verify-date:
runs-on: ubuntu-latest
@ -23,15 +24,16 @@ jobs:
files_to_check=(${{ steps.changed-files.outputs.added_files }})
files_to_check+=(${{ steps.changed-files.outputs.modified_files }})
for FILE in ${files_to_check[@]}; do
REGEX=".*\.(.*)"
if [[ "$FILE" =~ $REGEX ]]
then
EXTENSION=${BASH_REMATCH[1]}
EXTENSIONS_LIST=($EXTENSIONS)
if [[ " ${EXTENSIONS_LIST[*]} " =~ " ${EXTENSION} " ]]
then
.github/verify_header.sh $FILE
fi
for file in ${files_to_check[@]}; do
for file_in_list in $FILES; do
if [[ "$file" == $file_in_list ]]; then
.github/verify_header.sh "$file"
continue 2
fi
done
extension=${file##*.}
if [[ "$EXTENSIONS" =~ $extension ]]; then
.github/verify_header.sh "$file"
fi
done

View File

@ -27,16 +27,16 @@ endif
endif
archives:
@tools/pckgen $(PWD) tar zip
@tools/pckgen.sh $(PWD) tar zip
rpm:
@tools/pckgen $(PWD) rpm --debug
@tools/pckgen.sh $(PWD) rpm --debug
srpm:
@tools/pckgen $(PWD) srpm
@tools/pckgen.sh $(PWD) srpm
deb:
@tools/pckgen $(PWD) deb --debug
@tools/pckgen.sh $(PWD) deb --debug
dsc:
@tools/pckgen $(PWD) dsc
@tools/pckgen.sh $(PWD) dsc

4
configure vendored
View File

@ -1,6 +1,6 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
@ -79,7 +79,7 @@ fi
# Run version generator with 'build' flag to
# indicate that we are in the build process
(cd tools && ./cas_version_gen build)
(cd tools && ./cas_version_gen.sh build)
if [ $? -ne 0 ]; then
echo "Error: failed to obtain CAS version" >&2
exit 1

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
# RHEL8.5 kernel 4.18 subversion targeted for the workaround is 348.7.1.
# The workaround is needed starting this version and up.

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
# RHEL 7.3
check() {

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
# submit_bio() can be defined in "bio.h" or in "fs.h"
# If it is defind in fs.h, three possibilities are available:

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -1,10 +1,10 @@
#!/bin/bash
#
# Copyright(c) 2012-2021 Intel Corporation
# Copyright(c) 2012-2022 Intel Corporation
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -4,7 +4,7 @@
# SPDX-License-Identifier: BSD-3-Clause
#
. $(dirname $3)/conf_framework
. $(dirname $3)/conf_framework.sh
check() {
cur_name=$(basename $2)

View File

@ -14,12 +14,7 @@ from api.cas.installer import (
rsync_opencas_sources,
)
from core.test_run import TestRun
from test_tools.fs_utils import (
FilesPermissions,
find_all_files,
find_all_dirs,
find_all_items,
)
from test_tools.fs_utils import FilesPermissions, find_all_items
repo_files_perms_exceptions = {
@ -61,8 +56,8 @@ repo_files_perms_exceptions = {
"test/smoke_test/run_tests": 755,
"test/smoke_test/write_back/01": 755,
"test/smoke_test/write_back/02": 755,
"tools/cas_version_gen": 755,
"tools/pckgen": 755,
"tools/cas_version_gen.sh": 755,
"tools/pckgen.sh": 755,
"tools/pckgen.d/deb/debian/rules": 755,
"tools/version2sha": 755,
"utils/casctl": 755,

View File

@ -2,7 +2,7 @@
./modules/* usr/src/<CAS_NAME>-modules-<CAS_VERSION>/modules/
./ocf/* usr/src/<CAS_NAME>-modules-<CAS_VERSION>/ocf/
./utils/* usr/src/<CAS_NAME>-modules-<CAS_VERSION>/utils/
./tools/cas_version_gen usr/src/<CAS_NAME>-modules-<CAS_VERSION>/tools/
./tools/cas_version_gen.sh usr/src/<CAS_NAME>-modules-<CAS_VERSION>/tools/
./tools/helpers.mk usr/src/<CAS_NAME>-modules-<CAS_VERSION>/tools/
./configure.d/* usr/src/<CAS_NAME>-modules-<CAS_VERSION>/configure.d/
./configure usr/src/<CAS_NAME>-modules-<CAS_VERSION>/

View File

@ -1,6 +1,6 @@
<CAS_NAME> (<CAS_VERSION>-1) trusty; urgency=medium
* pckgen: automated package generation
* pckgen.sh: automated package generation
-- <PACKAGE_MAINTAINER> <PACKAGE_DATE>

View File

@ -3,5 +3,5 @@ Upstream-Name: Intel Corporation
Source: <CAS_GIT>
Files: *
Copyright: 2019-2021 Intel Corporation
Copyright: 2019-<YEAR> Intel Corporation
License: <CAS_LICENSE_NAME>

View File

@ -13,7 +13,7 @@
override_dh_auto_configure:
override_dh_auto_build:
(cd tools/; ./cas_version_gen build)
(cd tools/; ./cas_version_gen.sh build)
<MAKE_BUILD>
override_dh_auto_install:
@ -21,7 +21,7 @@ override_dh_auto_install:
(cd utils; make install_files DESTDIR="$(shell pwd)/debian/tmp")
# clean and generate version again before installing sources for DKMS
make distclean
(cd tools/; ./cas_version_gen)
(cd tools/; ./cas_version_gen.sh)
override_dh_dkms:
dh_dkms -V $(DEB_VERSION_UPSTREAM)

View File

@ -137,7 +137,7 @@ fi
/etc/dracut.conf.d/opencas.conf
/var/lib/opencas/cas_version
/lib/opencas/casctl
/lib/opencas/open-cas-loader
/lib/opencas/open-cas-loader.py
/lib/opencas/opencas.py
/lib/udev/rules.d/60-persistent-storage-cas-load.rules
/lib/udev/rules.d/60-persistent-storage-cas.rules

View File

@ -354,6 +354,7 @@ deb_control_files_prepare() {
sed -i "s/<CAS_GIT>/${CAS_GIT//\//\\/}/g" "$file"
sed -i "s/<PACKAGE_MAINTAINER>/$PACKAGE_MAINTAINER/g" "$file"
sed -i "s/<PACKAGE_DATE>/$PACKAGE_DATE/g" "$file"
sed -i "s/<YEAR>/$(date +%Y)/g" "$file"
done
if [ "$DEBUG" ]; then
@ -545,7 +546,7 @@ DEB_BUILD_DIR="$TEMP_DIR/debuild"
# Version file location:
VERSION_FILE="$SOURCES_DIR/.metadata/cas_version"
# CAS version generator location:
CAS_VERSION_GEN="$SOURCES_DIR/tools/cas_version_gen"
CAS_VERSION_GEN="$SOURCES_DIR/tools/cas_version_gen.sh"
check_version

View File

@ -1,6 +1,6 @@
ACTION=="remove", GOTO="cas_loader_end"
SUBSYSTEM!="block", GOTO="cas_loader_end"
RUN+="/lib/opencas/open-cas-loader /dev/$name"
RUN+="/lib/opencas/open-cas-loader.py /dev/$name"
LABEL="cas_loader_end"

View File

@ -41,7 +41,7 @@ install_files:
@install -m 644 -D opencas.py $(DESTDIR)$(CASCTL_DIR)/opencas.py
@install -m 755 -D casctl $(DESTDIR)$(CASCTL_DIR)/casctl
@install -m 755 -D open-cas-loader $(DESTDIR)$(CASCTL_DIR)/open-cas-loader
@install -m 755 -D open-cas-loader.py $(DESTDIR)$(CASCTL_DIR)/open-cas-loader.py
@install -m 644 -D etc/dracut.conf.d/opencas.conf $(DESTDIR)/etc/dracut.conf.d/opencas.conf
@ -70,7 +70,7 @@ uninstall:
$(call remove-file,$(DESTDIR)$(CASCTL_DIR)/opencas.py)
$(call remove-file,$(DESTDIR)$(CASCTL_DIR)/casctl)
$(call remove-file,$(DESTDIR)$(CASCTL_DIR)/open-cas-loader)
$(call remove-file,$(DESTDIR)$(CASCTL_DIR)/open-cas-loader.py)
$(call remove-directory,$(DESTDIR)$(CASCTL_DIR))
$(call remove-file,$(DESTDIR)/etc/dracut.conf.d/opencas.conf)