Fix copyright in the codegen

The script validates the copyright of every go file that we own as a
codegen target. I think the most logical place to do this is in the make
lint, however auto generated files inject a copyright from a static
file, so we need to modify the auto generated code before the linting.

So I see two options:
1- Verify everything in the codegen
2- Replace the autogenerated parts in the codegen and verify everything
in the lint.

Since the lint depends on the codegen, I decided that the simplicity of
having just one script with just one call was more worthy than the
correctness.

Co-authored-by: Tom Wieczorek <[email protected]>
Signed-off-by: Juan Luis de Sousa-Valadas Castaño <[email protected]>

Author: juanluisvaladas

.github/workflows/lint.yaml

@@ -35,6 +35,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Prepare build environment
         run: .github/workflows/prepare-build-env.sh

.go-header.txt

@@ -1,4 +1,4 @@
-Copyright 2022 k0s authors
+Copyright {{YEAR}} k0s authors
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

.golangci.yml

@@ -26,6 +26,9 @@ linters-settings:
     min-confidence: 0
   goheader:
     template-path: .go-header.txt
+    values:
+      regexp:
+        year: 202[0-9]
 
 issues:
   max-issues-per-linter: 0

Makefile

@@ -118,15 +118,15 @@ codegen_targets += pkg/apis/autopilot.k0sproject.io/v1beta2/.controller-gen.stam
 pkg/apis/autopilot.k0sproject.io/v1beta2/.controller-gen.stamp: $(shell find pkg/apis/autopilot.k0sproject.io/v1beta2/ -maxdepth 1 -type f -name \*.go)
 pkg/apis/autopilot.k0sproject.io/v1beta2/.controller-gen.stamp: gen_output_dir = autopilot
 
-pkg/apis/%/.controller-gen.stamp: .k0sbuild.docker-image.k0s hack/tools/Makefile.variables
+pkg/apis/%/.controller-gen.stamp: .k0sbuild.docker-image.k0s hack/tools/boilerplate.go.txt hack/tools/Makefile.variables
 	rm -rf 'static/manifests/$(gen_output_dir)/CustomResourceDefinition'
 	rm -f -- '$(dir $@)'zz_*.go
 	CGO_ENABLED=0 $(GO) install sigs.k8s.io/controller-tools/cmd/controller-gen@v$(controller-gen_version)
 	$(GO_ENV) controller-gen \
 	  crd \
 	  paths="./$(dir $@)..." \
 	  output:crd:artifacts:config=./static/manifests/$(gen_output_dir)/CustomResourceDefinition \
-	  object
+	  object:headerFile=hack/tools/boilerplate.go.txt
 	touch -- '$@'
 
 # Note: k0s.k0sproject.io omits the version from the output directory, so this needs
@@ -153,6 +153,7 @@ pkg/apis/%/.client-gen.stamp: .k0sbuild.docker-image.k0s hack/tools/boilerplate.
 	  --output-package=github.com/k0sproject/k0s/pkg/apis/$(gen_output_dir)/
 	touch -- '$@'
 
+
 codegen_targets += static/zz_generated_assets.go
 static_asset_dirs := static/manifests static/misc
 static/zz_generated_assets.go: .k0sbuild.docker-image.k0s hack/tools/Makefile.variables
@@ -212,6 +213,7 @@ bindata: static/zz_generated_assets.go pkg/assets/zz_generated_offsets_$(TARGET_
 .PHONY: lint
 lint: GOLANGCI_LINT_FLAGS ?=
 lint: .k0sbuild.docker-image.k0s go.sum codegen
+	hack/copyright.sh
 	CGO_ENABLED=0 $(GO) install github.com/golangci/golangci-lint/cmd/golangci-lint@v$(golangci-lint_version)
 	$(GO_ENV) golangci-lint run --verbose $(GOLANGCI_LINT_FLAGS) $(GO_DIRS)
 
@@ -277,6 +279,7 @@ clean: clean-gocache clean-docker-image clean-airgap-image-bundles
 	-rm -f pkg/assets/zz_generated_offsets_*.go k0s k0s.exe .bins.*stamp bindata* static/zz_generated_assets.go
 	-rm -rf $(K0S_GO_BUILD_CACHE) 
 	-find pkg/apis -type f \( -name .client-gen.stamp -or -name .controller-gen.stamp \) -delete
+	-rm -f hack/.copyright.stamp
 	-$(MAKE) -C docs clean
 	-$(MAKE) -C embedded-bins clean
 	-$(MAKE) -C inttest clean

hack/copyright.sh

@@ -0,0 +1,76 @@
+#!/usr/bin/env bash
+
+# Copyright 2023 k0s 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.
+
+set -eu
+
+RESULT=0
+FIX=${FIX:=n}
+
+get_year(){
+    # The -1 has to be added because if a file has been added, removed and added
+    # again we'll get two lines with both dates. We only pick the newest one.
+    YEAR=$(git log -1 --diff-filter=A --pretty=format:%ad --date=format:%Y -- "$1")
+    if [ -z "$YEAR" ]; then
+	echo "FATAL!! $1 doesn't seem to be commited in the repo" 1>&2
+        exit 1
+    fi
+    echo $YEAR
+}
+
+has_basic_copyright(){
+	FILE=$1
+	grep -q -F "Copyright k0s authors" "$FILE"
+}
+
+has_date_copyright(){
+	DATE=$1
+	FILE=$2
+	grep -q -F "Copyright $DATE k0s authors" "$FILE"
+}
+
+# Deliberately do not search in docs as the date of the matches for the
+# Copyright notice aren't related to the date of the document.
+for i in $(find cmd hack internal inttest pkg static -type f -name '*.go' -not -name 'zz_generated*'); do
+    DATE=$(get_year $i)
+
+    # codegen gets the header from a static file, so instead we'll replace it every time.
+    # Also fix every file if FIX=y
+    if [[ "$FIX" == 'y' ]] ; then
+        sed -i "s/Copyright 20../Copyright $DATE/" "$i"
+    fi
+
+    if [[ $i == "pkg/apis/k0s.k0sproject.io/clientset/"* ]] || [[ $i == "pkg/apis/autopilot.k0sproject.io/v1beta2/clientset/"* ]]; then
+        if ! has_basic_copyright "$i"; then
+            echo "ERROR: $i doesn't have a proper copyright notice" 1>&2
+            RESULT=1
+        fi
+    else
+        if ! has_date_copyright "$DATE" "$i"; then
+            echo "ERROR: $i doesn't have a proper copyright notice" 1>&2
+            RESULT=1
+        fi
+    fi
+done
+
+if [[ "$RESULT" != 0 ]]; then
+    if [[ "$FIX" == 'y' ]]; then
+        echo "hack/copyright.sh can't fix the problem automatically. Manual intervention is required"
+    else
+        echo "Retry running the script with FIX=y hack/copyright.sh to see if can be fixed automatically"
+    fi
+fi
+
+exit $RESULT

hack/tools/boilerplate.go.txt

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