check copyright year and license type

Author: iyabchen

tools/license-check/cmd/root.go

@@ -5,11 +5,14 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
+	"time"
 
+	"github.com/google/go-licenses/licenses"
 	"github.com/spf13/cobra"
 )
 
 const rootCmdDesc = "Utilities for license check."
+const licenseConfidence = 0.9
 
 type rootOptions struct {
 	fileList []string
@@ -37,21 +40,22 @@ func (o *rootOptions) run() error {
 	}
 	foundErr := false
 	for _, file := range o.fileList {
-		b, err := os.ReadFile(file)
-		if err != nil {
-			return err
-		}
 		ext := filepath.Ext(file)
 		if ext != ".tmpl" && ext != ".go" && ext != ".yaml" {
 			continue
 		}
-		if !strings.Contains(string(b), `Licensed under the Apache License, Version 2.0 (the "License");`) {
-			fmt.Fprintf(os.Stderr, "File %s does not contain Apache License.\n", file)
+
+		if err := checkLicenseType(file); err != nil {
+			fmt.Fprintf(os.Stderr, "File %s failed to pass license check:  %s.\n", file, err)
+			foundErr = true
+		}
+		if err := checkCopyright(file, time.Now().Year()); err != nil {
+			fmt.Fprintf(os.Stderr, "File %s failed to pass license check: %s.\n", file, err)
 			foundErr = true
 		}
 	}
 	if foundErr {
-		return fmt.Errorf("found file missing license")
+		return fmt.Errorf("found file failing license license")
 	}
 	return nil
 }
@@ -72,3 +76,30 @@ func Execute() {
 		os.Exit(1)
 	}
 }
+
+func checkLicenseType(filePath string) error {
+	classifier, err := licenses.NewClassifier(licenseConfidence)
+	if err != nil {
+		return fmt.Errorf("failed to create license classifier: %w", err)
+	}
+	licenseName, _, err := classifier.Identify(filePath)
+	if err != nil {
+		return fmt.Errorf("failed to identify license for %s: %w", filePath, err)
+	}
+	if !strings.Contains(licenseName, "Apache") {
+		return fmt.Errorf("found license type %s, expect Apache", licenseName)
+	}
+	return nil
+}
+
+func checkCopyright(filePath string, year int) error {
+	b, err := os.ReadFile(filePath)
+	if err != nil {
+		return err
+	}
+	expectStr := fmt.Sprintf("Copyright %d Google", year)
+	if !strings.Contains(strings.ToLower(string(b)), strings.ToLower(expectStr)) {
+		return fmt.Errorf("expected copyright string %q not found", expectStr)
+	}
+	return nil
+}

tools/license-check/cmd/root_test.go

@@ -0,0 +1,95 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"testing"
+	"time"
+)
+
+const validApache2LicenseFormat string = `
+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.
+`
+const validCopyright string = "Copyright %d Google Inc\n"
+const invalidCopyright string = "Copyright 1900 Google Inc\n"
+const invalidLicense string = "not a license"
+
+func TestCheckLicenseType(t *testing.T) {
+	dir := t.TempDir()
+	tests := []struct {
+		name    string
+		content string
+		wantErr bool
+	}{
+		{
+			name:    "success",
+			content: fmt.Sprintf(validCopyright, time.Now().Year()) + validApache2LicenseFormat,
+		},
+		{
+			name:    "invalid license",
+			content: fmt.Sprintf(validCopyright, time.Now().Year()) + invalidLicense,
+			wantErr: true,
+		},
+	}
+	for _, tc := range tests {
+		f, err := os.CreateTemp(dir, "testfile")
+		if err != nil {
+			t.Fatal(err)
+		}
+		if _, err := f.WriteString(tc.content); err != nil {
+			t.Fatal(err)
+		}
+		err = checkLicenseType(f.Name())
+		if err == nil && tc.wantErr {
+			t.Errorf("checkLicenseType() want err, but got nil")
+		}
+		if err != nil && !tc.wantErr {
+			t.Errorf("checkLicenseType() got error %s", err)
+		}
+	}
+}
+
+func TestCheckCopyright(t *testing.T) {
+	dir := t.TempDir()
+	tests := []struct {
+		name    string
+		content string
+		wantErr bool
+	}{
+		{
+			name:    "success",
+			content: fmt.Sprintf(validCopyright, time.Now().Year()) + validApache2LicenseFormat,
+		},
+		{
+			name:    "wrong year copyright",
+			content: invalidCopyright + validApache2LicenseFormat,
+			wantErr: true,
+		},
+	}
+	for _, tc := range tests {
+		f, err := os.CreateTemp(dir, "testfile")
+		if err != nil {
+			t.Fatal(err)
+		}
+		if _, err := f.WriteString(tc.content); err != nil {
+			t.Fatal(err)
+		}
+		err = checkCopyright(f.Name(), time.Now().Year())
+		if err == nil && tc.wantErr {
+			t.Errorf("checkCopyright() want err, but got nil")
+		}
+		if err != nil && !tc.wantErr {
+			t.Errorf("checkCopyright() got error %s", err)
+		}
+	}
+}

tools/license-check/go.mod

@@ -4,9 +4,32 @@ go 1.23.0
 
 toolchain go1.23.1
 
-require github.com/spf13/cobra v1.9.1
+require (
+	github.com/google/go-licenses v1.6.0
+	github.com/spf13/cobra v1.9.1
+)
 
 require (
+	github.com/emirpasic/gods v1.12.0 // indirect
+	github.com/go-logr/logr v1.2.0 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/google/licenseclassifier v0.0.0-20210722185704-3043a050f148 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+	github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/sergi/go-diff v1.2.0 // indirect
 	github.com/spf13/pflag v1.0.6 // indirect
+	github.com/src-d/gcfg v1.4.0 // indirect
+	github.com/xanzy/ssh-agent v0.2.1 // indirect
+	go.opencensus.io v0.23.0 // indirect
+	golang.org/x/crypto v0.1.0 // indirect
+	golang.org/x/mod v0.7.0 // indirect
+	golang.org/x/net v0.5.0 // indirect
+	golang.org/x/sys v0.4.0 // indirect
+	golang.org/x/tools v0.5.0 // indirect
+	gopkg.in/src-d/go-billy.v4 v4.3.2 // indirect
+	gopkg.in/src-d/go-git.v4 v4.13.1 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
+	k8s.io/klog/v2 v2.80.1 // indirect
 )