Merge pull request #830 from jpflueger/validate-copyright-headers

Validate copyright headers
Azure · Mar 30, 2020 · 44df320 · 44df320
2 parents c57ebcf + de99987
commit 44df320
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 62 deletions.
diff --git a/Makefile b/Makefile
@@ -111,6 +111,10 @@ delete:
 	kubectl delete -f config/crd/bases
 	kustomize build config/default | kubectl delete -f -
 
+# Validate copyright headers
+validate-copyright-headers:
+	@./scripts/validate-copyright-headers.sh
+
 # Generate manifests for helm and package them up
 helm-chart-manifests: manifests
 	kustomize build ./config/default -o ./charts/azure-service-operator/templates
@@ -128,7 +132,7 @@ fmt:
 	go fmt ./...
 
 # Run go vet against code
-vet:
+vet: 
 	go vet ./...
 
 # Generate code

diff --git a/devops/azure-pipelines.yaml b/devops/azure-pipelines.yaml
@@ -99,6 +99,12 @@ steps:
 #     REQUEUE_AFTER: $(REQUEUE_AFTER)
 #   workingDirectory: '$(MODULE_PATH)'
 
+- script: |
+    make validate-copyright-headers
+  continueOnError: 'false'
+  displayName: 'Validate Copyright Headers'
+  workingDirectory: '$(MODULE_PATH)'
+
 - script: |
     set -e
     GO111MODULE="on" go get sigs.k8s.io/kind@v0.4.0
@@ -136,7 +142,7 @@ steps:
     REQUEUE_AFTER: $(REQUEUE_AFTER)
     KUBEBUILDER_ASSETS: $(MODULE_PATH)/bin
     BUILD_ID: $(Build.BuildId)
-  workingDirectory: '$(MODULE_PATH)'      
+  workingDirectory: '$(MODULE_PATH)'
 
 - task: AzureCLI@2
   displayName: 'Clean up Azure Resources'

diff --git a/pkg/helpers/rand.go b/pkg/helpers/rand.go
@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
 // copied from github.com/Azure/open-service-broker-azure/
 package helpers
 

diff --git a/pkg/resourcemanager/apim/apimgmt/apimgmt.go b/pkg/resourcemanager/apim/apimgmt/apimgmt.go
@@ -1,18 +1,5 @@
-/*
-MIT License
-
-Copyright (c) Microsoft Corporation. All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-*/
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
 
 package apimgmt
 

diff --git a/pkg/resourcemanager/apim/apimgmt/apimgmt_test.go b/pkg/resourcemanager/apim/apimgmt/apimgmt_test.go
@@ -1,19 +1,6 @@
-/*
-MIT License
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
 
-Copyright (c) Microsoft Corporation. All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-*/
-// +build all apimgmt
 package apimgmt
 
 import (

diff --git a/pkg/resourcemanager/apim/apimgmt/manager.go b/pkg/resourcemanager/apim/apimgmt/manager.go
@@ -1,18 +1,5 @@
-/*
-MIT License
-
-Copyright (c) Microsoft Corporation. All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-*/
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
 
 package apimgmt
 

diff --git a/pkg/resourcemanager/apim/apimgmt/suite_test.go b/pkg/resourcemanager/apim/apimgmt/suite_test.go
@@ -1,18 +1,5 @@
-/*
-MIT License
-
-Copyright (c) Microsoft Corporation. All rights reserved.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-*/
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
 
 package apimgmt
 

diff --git a/scripts/validate-copyright-headers.sh b/scripts/validate-copyright-headers.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+#
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT license.
+
+set -euo pipefail
+
+echo "==> Checking copyright headers <=="
+
+regx="(Copyright.*Microsoft.*Licensed.*MIT)|(generated)"
+files=$(find . -type f -iname '*.go' ! -path './vendor/*' ! -path './hack/tools/*' ! -path './test/e2e/vendor/*')
+licRes=$(for file in $files; do
+           head -4 "$file" | tr -d '\n' | grep -Eiq "$regx" || echo "$file";
+         done)
+
+if [ -n "$licRes" ]; then
+        echo "Copyright header check failed:";
+        echo "${licRes}";
+        exit 1;
+fi