From 035027cff15160e5b9067b98c0c9e2eb3fd12e31 Mon Sep 17 00:00:00 2001 From: "Yasin, Siraj (SY495P)" Date: Mon, 15 Jun 2020 10:27:38 -0500 Subject: [PATCH] Imitating the license header check from airshipctl * script to check copyright Syntax: ./tools/check_copyright * script to add license on missing files Syntax: ./tools/add_license.sh * copied templates and scripts to check/add license header to file (go/yaml/yml/sh) * Scripts can be customized for airshipui if required. Change-Id: If14ee88c90c8a893fc1ab564a271a3e3337a4bf0 --- playbooks/airshipui-lint/run.yaml | 12 +++++++ playbooks/airshipui-test/run.yaml | 12 +++++++ playbooks/install-go.yaml | 12 +++++++ tools/add_license.sh | 59 +++++++++++++++++++++++++++++++ tools/check_copyright | 45 +++++++++++++++++++++++ tools/license_bash.txt | 13 +++++++ tools/license_go.txt | 14 ++++++++ tools/license_yaml.txt | 12 +++++++ 8 files changed, 179 insertions(+) create mode 100755 tools/add_license.sh create mode 100755 tools/check_copyright create mode 100644 tools/license_bash.txt create mode 100644 tools/license_go.txt create mode 100644 tools/license_yaml.txt diff --git a/playbooks/airshipui-lint/run.yaml b/playbooks/airshipui-lint/run.yaml index 3e6edfb..60e284e 100644 --- a/playbooks/airshipui-lint/run.yaml +++ b/playbooks/airshipui-lint/run.yaml @@ -1,3 +1,15 @@ +# 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. + --- - hosts: all name: Run linter diff --git a/playbooks/airshipui-test/run.yaml b/playbooks/airshipui-test/run.yaml index a34942b..a133c4b 100644 --- a/playbooks/airshipui-test/run.yaml +++ b/playbooks/airshipui-test/run.yaml @@ -1,3 +1,15 @@ +# 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. + --- - hosts: all name: Run tests diff --git a/playbooks/install-go.yaml b/playbooks/install-go.yaml index a63b176..734a61b 100644 --- a/playbooks/install-go.yaml +++ b/playbooks/install-go.yaml @@ -1,3 +1,15 @@ +# 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. + --- - hosts: all name: Install Go diff --git a/tools/add_license.sh b/tools/add_license.sh new file mode 100755 index 0000000..7aae2b8 --- /dev/null +++ b/tools/add_license.sh @@ -0,0 +1,59 @@ +#!/bin/bash + +# 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. + +set -e + +# Find all files of given format and add license if missing +add_license() { + ext=$1 + template=$2 + # skipping license for testdata and manifests folders + FILES=$(find -L . -name "*.${ext}" | grep -v "testdata" | grep -v "manifests") + + for each in $FILES + do + if ! grep -Eq 'Apache License|License-Identifier: Apache' $each + then + echo "Adding license header to $each" + cat tools/${template} $each >$each.new + mv $each.new $each + fi + done +} + +add_license_to_bash() { + template=$1 + FILES=$(find -L . -name "*.sh" ) + NUM_OF_LINES=$(< "tools/$template" wc -l) + + for each in $FILES + do + if ! grep -Eq 'Apache License|License-Identifier: Apache' $each + then + if head -1 $each | grep '^#!' > /dev/null + then + echo "Adding license header to $each" + head -n 1 $each >>$each.new + head -n $NUM_OF_LINES tools/$template >>$each.new + tail -n+2 $each >>$each.new + mv $each.new $each + fi + fi + done +} + +add_license 'go' 'license_go.txt' +add_license 'yaml' 'license_yaml.txt' +add_license 'yml' 'license_yaml.txt' +add_license_to_bash 'license_bash.txt' diff --git a/tools/check_copyright b/tools/check_copyright new file mode 100755 index 0000000..eb99ca8 --- /dev/null +++ b/tools/check_copyright @@ -0,0 +1,45 @@ +#!/bin/bash + +# 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. + +declare FILES_MISSING_COPYRIGHT=() + +# Find all files of given format and add license if missing +check_license() { + ext=$1 + # skipping license for testdata and manifests folders + FILES=$(find -L . -name "*.${ext}" | grep -v "testdata" | grep -v "manifests") + + for each in $FILES + do + if ! grep -Eq 'Apache License|License-Identifier: Apache' $each + then + FILES_MISSING_COPYRIGHT+=($each) + fi + done +} + +check_license 'go' +check_license 'yaml' +check_license 'yml' +check_license 'sh' + +if [ ${#FILES_MISSING_COPYRIGHT[@]} -gt 0 ] +then + echo "Copyright header missing for these files: ${FILES_MISSING_COPYRIGHT[@]}" + echo "please run make add-copyright" + exit 1 +else + echo "no file with missing copyright header detected, make target completed successfully" +fi + diff --git a/tools/license_bash.txt b/tools/license_bash.txt new file mode 100644 index 0000000..cc66ca5 --- /dev/null +++ b/tools/license_bash.txt @@ -0,0 +1,13 @@ + +# 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. + diff --git a/tools/license_go.txt b/tools/license_go.txt new file mode 100644 index 0000000..27fb01c --- /dev/null +++ b/tools/license_go.txt @@ -0,0 +1,14 @@ +/* + 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 + + https://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. +*/ + diff --git a/tools/license_yaml.txt b/tools/license_yaml.txt new file mode 100644 index 0000000..6f610ac --- /dev/null +++ b/tools/license_yaml.txt @@ -0,0 +1,12 @@ +# 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. +