Add hack/update-godep-licenses.sh to generate Godeps/LICENSES.md

.travis.yml

@@ -1,4 +1,11 @@
-sudo: false
+sudo: required
+
+# trusty required for docker
+# https://github.com/travis-ci/travis-ci/issues/5448
+dist: trusty
+
+services:
+  - docker
 
 language: go
 

Makefile

@@ -52,6 +52,7 @@ verify:
 	hack/verify-linkcheck.sh
 	hack/verify-flags-underscore.py
 	hack/verify-godeps.sh $(BRANCH)
+	hack/verify-godep-licenses.sh $(BRANCH)
 .PHONY: verify
 
 # Build and run tests.

docs/devel/development.md

@@ -219,7 +219,7 @@ _If `go get -u path/to/dependency` fails with compilation errors, instead try `g
 to fetch the dependencies without compiling them.  This can happen when updating the cadvisor dependency._
 
 
-5) Before sending your PR, it's a good idea to sanity check that your Godeps.json file is ok by running hack/verify-godeps.sh
+5) Before sending your PR, it's a good idea to sanity check that your Godeps.json file is ok by running `hack/verify-godeps.sh`
 
 _If hack/verify-godeps.sh fails after a `godep update`, it is possible that a transitive dependency was added or removed but not
 updated by godeps.  It then may be necessary to perform a `godep save ./...` to pick up the transitive dependency changes._
@@ -228,6 +228,10 @@ It is sometimes expedient to manually fix the /Godeps/godeps.json file to minimi
 
 Please send dependency updates in separate commits within your PR, for easier reviewing.
 
+6) If you updated the Godeps, please also update `Godeps/LICENSES.md` by running `hack/update-godep-licenses.sh`.
+
+_If Godep does not automatically vendor the proper license file for a new dependency, be sure to add an exception entry to `hack/update-godep-licenses.sh`._
+
 ## Unit tests
 
 ```sh

hack/update-godep-licenses.sh

@@ -0,0 +1,44 @@
+#!/bin/bash
+
+# Copyright 2015 The Kubernetes Authors All rights reserved.
+#
+# 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.
+
+# Update the Godeps/LICENSES.md document.
+# Generates a table of Godep dependencies and their license.
+# Requires:
+#    docker
+#    mesosphere/godep-licenses (docker image) - source: https://github.com/mesosphere/godep-licenses
+# Usage:
+#    Run every time a license file is added/modified within /Godeps to update /Godeps/LICENSES.md.
+#    Add exceptions (-e <repo>:<license>) for any dependency (project) vendored by Godep
+#      that has a known license that isn't vendored by Godep or can't be found by godep-licenses.
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+KUBE_ROOT="${KUBE_ROOT:-$(cd "$(dirname "${BASH_SOURCE}")/.." && pwd -P)}"
+
+cd "${KUBE_ROOT}"
+
+exec docker run --rm -i -v "${KUBE_ROOT}:/repo" mesosphere/godep-licenses:latest -p /repo \
+  -e github.com/abbot/go-http-auth:Apache-2 \
+  -e github.com/beorn7/perks/quantile:MIT? \
+  -e github.com/daviddengcn/go-colortext:BSD? \
+  -e github.com/docker/docker/pkg/symlink:spdxBSD3 \
+  -e github.com/shurcooL/sanitized_anchor_name:MIT? \
+  -e github.com/spf13/cobra:Apache-2 \
+  -e github.com/stretchr/objx:MIT? \
+  -e github.com/stretchr/testify:MIT? \
+  -o md > Godeps/LICENSES.md

hack/verify-all.sh

@@ -60,7 +60,7 @@ if $SILENT ; then
 fi
 
 # remove protobuf until it is part of direct generation
-EXCLUDE="verify-godeps.sh verify-generated-protobuf.sh"
+EXCLUDE="verify-godeps.sh verify-godep-licenses.sh verify-generated-protobuf.sh"
 
 ret=0
 for t in `ls $KUBE_ROOT/hack/verify-*.sh`

hack/verify-godep-licenses.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+
+# Copyright 2015 The Kubernetes Authors All rights reserved.
+#
+# 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 -o errexit
+set -o nounset
+set -o pipefail
+
+KUBE_ROOT="$(cd "$(dirname "${BASH_SOURCE}")/.." && pwd -P)"
+
+branch="${1:-master}"
+# notice this uses ... to find the first shared ancestor
+if ! git diff origin/"${branch}"...HEAD | grep 'Godeps/' > /dev/null; then
+  exit 0
+fi
+
+# create a nice clean place to put our new godeps
+# must be in the user dir (e.g. KUBE_ROOT) in order for the docker volume mount to work with docker-machine on macs
+_tmpdir="$(mktemp -d "${KUBE_ROOT}/kube-godep-licenses.XXXXXX")"
+echo "Created workspace: ${_tmpdir}"
+function cleanup {
+  echo "Removing workspace: ${_tmpdir}"
+  rm -rf "${_tmpdir}"
+}
+trap cleanup EXIT
+
+cp -r "${KUBE_ROOT}/Godeps" "${_tmpdir}/Godeps"
+
+# Update Godep Licenses
+KUBE_ROOT="${_tmpdir}" "${KUBE_ROOT}/hack/update-godep-licenses.sh"
+
+# Compare Godep Licenses
+if ! _out="$(diff -Naupr ${KUBE_ROOT}/Godeps/LICENSES.md ${_tmpdir}/Godeps/LICENSES.md)"; then
+  echo "Your godep licenses file is out of date. Run hack/update-godep-licenses.sh and commit the results."
+  echo "${_out}"
+  exit 1
+fi

hooks/pre-commit

@@ -28,6 +28,16 @@ if [[ "${#files[@]}" -ne 0 ]]; then
     echo "${green}OK"
   fi
   echo "${reset}"
+
+  echo -ne "Check if Godep licesnses are up to date..."
+  if ! OUT=$("hack/verify-godep-licenses.sh" 2>&1); then
+    echo
+    echo "${red}${OUT}"
+    exit_code=1
+  else
+    echo "${green}OK"
+  fi
+  echo "${reset}"
 fi
 
 echo -ne "Checking for files that need gofmt... "

shippable.yml

@@ -49,6 +49,7 @@ install:
   - ./hack/verify-description.sh
   - ./hack/verify-flags-underscore.py
   - ./hack/verify-godeps.sh ${BASE_BRANCH}
+  - ./hack/verify-godep-licenses.sh ${BASE_BRANCH}
   - ./hack/travis/install-std-race.sh
   - ./hack/verify-generated-conversions.sh
   - ./hack/verify-generated-deep-copies.sh