Add license header check/update tasks and updpdate existing headers (k…

…ubernetes#2027)

build/check.js

@@ -15,9 +15,13 @@
 /**
  * @fileoverview Gulp tasks for checking and validating the code or a commit.
  */
+import fs from 'fs';
 import gulp from 'gulp';
 import gulpClangFormat from 'gulp-clang-format';
 import gulpEslint from 'gulp-eslint';
+import filter from 'gulp-filter';
+import license from 'gulp-header-license';
+import licenseCheck from 'gulp-license-check';
 import gulpSassLint from 'gulp-sass-lint';
 import beautify from 'js-beautify';
 import path from 'path';
@@ -38,7 +42,7 @@ const htmlBeautify = beautify.html;
  *
  * This task should be used prior to publishing a change.
  **/
-gulp.task('check', ['lint', 'test', 'integration-test:prod']);
+gulp.task('check', ['check-license-headers', 'lint', 'test', 'integration-test:prod']);
 
 /**
  * Checks the code quality (integration tests only) of Dashboard. In addition a local kubernetes
@@ -133,6 +137,70 @@ gulp.task('format-go', function(doneFn) {
       doneFn);
 });
 
+/**
+ * Checks and prints all source files for presence of up-to-date license headers.
+ * License header templates are stored in 'license' directory.
+ */
+gulp.task('check-license-headers', () => {
+  const HEADER_NOT_PRESENT = 'Header not present';
+  const commonFilter = filter('**/*.{js,go}', {restore: true});
+  const htmlFilter = filter('**/*.html', {restore: true});
+
+  let hasErrors = false;
+  const handleLogEvent = (event) => {
+    if (!hasErrors && event.msg.startsWith(HEADER_NOT_PRESENT)) {
+      hasErrors = true;
+    }
+  };
+
+  const handleEndEvent = () => {
+    if (hasErrors) {
+      throw new Error('License headers need to be present in all files.');
+    }
+  };
+
+  return gulp.src([path.join(conf.paths.src, '**/*.{js,go,html}')], {base: conf.paths.base})
+      .pipe(commonFilter)
+      .pipe(licenseCheck(licenseConfig('license/header.txt')).on('log', handleLogEvent))
+      .pipe(commonFilter.restore)
+      .pipe(htmlFilter)
+      .pipe(licenseCheck(licenseConfig('license/header_html.txt')).on('log', handleLogEvent))
+      .pipe(htmlFilter.restore)
+      .on('end', handleEndEvent);
+});
+
+/**
+ * Returns config object for gulp-license-check plugin.
+ * @param {string} licenseFilePath
+ * @return {Object}
+ */
+function licenseConfig(licenseFilePath) {
+  return {
+    path: licenseFilePath,
+    blocking: false,
+    logInfo: false,
+    logError: true,
+  };
+}
+
+/**
+ * Updates license headers in all source files based on templates stored in 'license' directory.
+ */
+gulp.task('update-license-headers', () => {
+  const commonFilter = filter('**/*.{js,go}', {restore: true});
+  const htmlFilter = filter('**/*.html', {restore: true});
+  const matchRate = 0.9;
+
+  gulp.src([path.join(conf.paths.src, '**/*.{js,go,html}')], {base: conf.paths.base})
+      .pipe(commonFilter)
+      .pipe(license(fs.readFileSync('license/header.txt', 'utf8'), {}, matchRate))
+      .pipe(commonFilter.restore)
+      .pipe(htmlFilter)
+      .pipe(license(fs.readFileSync('license/header_html.txt', 'utf8'), {}, matchRate))
+      .pipe(htmlFilter.restore)
+      .pipe(gulp.dest(conf.paths.base));
+});
+
 /**
  * Can be used as gulp pipe function to format HTML files.
  *

license/header.txt

@@ -0,0 +1,13 @@
+// Copyright 2017 The Kubernetes Dashboard 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.

license/header_html.txt

@@ -0,0 +1,15 @@
+<!--
+Copyright 2017 The Kubernetes Dashboard 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.
+-->

package.json

@@ -33,10 +33,13 @@
     "gulp-concat": "~2.6.1",
     "gulp-css-url-adjuster": "^0.2.3",
     "gulp-eslint": "~3.0.1",
+    "gulp-filter": "^5.0.0",
     "gulp-flatten": "~0.3.1",
+    "gulp-header-license": "^1.0.9",
     "gulp-htmlmin": "~3.0.0",
     "gulp-if": "~2.0.2",
     "gulp-inject": "~4.2.0",
+    "gulp-license-check": "^1.2.1",
     "gulp-minify-css": "~1.2.4",
     "gulp-modify": "~0.1.1",
     "gulp-protractor": "~4.1.0",

src/app/backend/api/types.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/api/types_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/client/manager.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/client/manager_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/client/verber.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/client/verber_test.go

@@ -1,3 +1,17 @@
+// Copyright 2017 The Kubernetes Dashboard 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.
+
 package client
 
 import (

src/app/backend/dashboard.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/handler/apihandler.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/handler/apihandler_test.go

@@ -1,3 +1,17 @@
+// Copyright 2017 The Kubernetes Dashboard 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.
+
 package handler
 
 import (

src/app/backend/handler/confighandler.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/handler/filter.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/handler/gziphandler.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/handler/localehandler.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/handler/localehandler_test.go

@@ -1,3 +1,17 @@
+// Copyright 2017 The Kubernetes Dashboard 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.
+
 package handler
 
 import (

src/app/backend/handler/metrics.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/integration/metric/heapster/client.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/cluster/cluster.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/condition.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/endpoint.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/endpoint_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/errors.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/errors_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/event.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/namespace.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/namespace_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/pod.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/pod_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/podinfo.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/podinfo_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/podmetrics.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/podmetrics_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/resourcechannels.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/service.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/service_test.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

src/app/backend/resource/common/serviceport.go

@@ -1,4 +1,4 @@
-// Copyright 2015 Google Inc. All Rights Reserved.
+// Copyright 2017 The Kubernetes Dashboard Authors.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.