mirror of
https://github.com/wahyd4/cert-manager.git
synced 2026-08-09 05:06:38 +10:00
irbekrm
7a7d853d9f
Also shift the correct number of params and remove and unused def. Signed-off-by: irbekrm <irbekrm@gmail.com>
295 lines
9.0 KiB
Bash
Executable File
295 lines
9.0 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
# +skip_license_check
|
|
|
|
# Copyright 2015 The Kubernetes 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.
|
|
|
|
# Update the LICENSES document.
|
|
# Generates a table of Go dependencies and their licenses.
|
|
#
|
|
# Usage:
|
|
# $0 [--create-missing] [/path/to/licenses]
|
|
#
|
|
# --create-missing will write the files that only exist upstream, locally.
|
|
# This option is mostly used for testing as we cannot check-in any of the
|
|
# additionally created files into the vendor auto-generated tree.
|
|
#
|
|
# Run every time a license file is added/modified within /vendor to
|
|
# update /LICENSES
|
|
|
|
set -o errexit
|
|
set -o nounset
|
|
set -o pipefail
|
|
|
|
export LANG=C
|
|
export LC_ALL=C
|
|
|
|
if [[ -n "${BUILD_WORKSPACE_DIRECTORY:-}" ]]; then # Running inside bazel
|
|
echo "Updating dependency licenses file..." >&2
|
|
elif ! command -v bazel &>/dev/null; then
|
|
echo "Install bazel at https://bazel.build" >&2
|
|
exit 1
|
|
else
|
|
(
|
|
set -o xtrace
|
|
bazel run //hack:update-deps-licenses -- "$@"
|
|
)
|
|
exit 0
|
|
fi
|
|
|
|
go=$(realpath "$1")
|
|
export PATH=$(dirname "$go"):$PATH
|
|
|
|
shift 1
|
|
REPO_ROOT="$BUILD_WORKSPACE_DIRECTORY"
|
|
LICENSE_ROOT="$REPO_ROOT"
|
|
|
|
###############################################################################
|
|
# Process package content
|
|
#
|
|
# @param package The incoming package name
|
|
# @param type The type of content (LICENSE, COPYRIGHT or COPYING)
|
|
#
|
|
process_content () {
|
|
local package=$1
|
|
local type=$2
|
|
|
|
local package_root
|
|
local ensure_pattern
|
|
local dir_root
|
|
local find_maxdepth
|
|
local find_names
|
|
local -a local_files=()
|
|
|
|
# Necessary to expand {}
|
|
case ${type} in
|
|
LICENSE) find_names=(-iname 'licen[sc]e*')
|
|
find_maxdepth=1
|
|
# Sadly inconsistent in the wild, but mostly license files
|
|
# containing copyrights, but no readme/notice files containing
|
|
# licenses (except to "see license file")
|
|
ensure_pattern="license|copyright"
|
|
;;
|
|
# We search READMEs for copyrights and this includes notice files as well
|
|
# Look in as many places as we find files matching
|
|
COPYRIGHT) find_names=(-iname 'notice*' -o -iname 'readme*')
|
|
find_maxdepth=3
|
|
ensure_pattern="copyright"
|
|
;;
|
|
COPYING) find_names=(-iname 'copying*')
|
|
find_maxdepth=1
|
|
ensure_pattern="license|copyright"
|
|
;;
|
|
esac
|
|
|
|
# Start search at package root
|
|
case ${package} in
|
|
github.com/*|golang.org/*|bitbucket.org/*|gonum.org/*)
|
|
package_root=$(echo "${package}" |awk -F/ '{ print $1"/"$2"/"$3 }')
|
|
;;
|
|
go4.org/*)
|
|
package_root=$(echo "${package}" |awk -F/ '{ print $1 }')
|
|
;;
|
|
gopkg.in/*)
|
|
# Root of gopkg.in package always ends with '.v(number)' and my contain
|
|
# more than two path elements. For example:
|
|
# - gopkg.in/yaml.v2
|
|
# - gopkg.in/inf.v0
|
|
# - gopkg.in/square/go-jose.v2
|
|
package_root=$(echo "${package}" |grep -oh '.*\.v[0-9]')
|
|
;;
|
|
*/*)
|
|
package_root=$(echo "${package}" |awk -F/ '{ print $1"/"$2 }')
|
|
;;
|
|
*)
|
|
package_root="${package}"
|
|
;;
|
|
esac
|
|
|
|
# Find files - only root and package level
|
|
local_files=()
|
|
IFS=" " read -r -a local_files <<< "$(
|
|
for dir_root in ${package} ${package_root}; do
|
|
[[ -d ${DEPS_DIR}/${dir_root} ]] || continue
|
|
|
|
# One (set) of these is fine
|
|
find "${DEPS_DIR}/${dir_root}" \
|
|
-xdev -follow -maxdepth ${find_maxdepth} \
|
|
-type f "${find_names[@]}"
|
|
done | sort -u)"
|
|
|
|
local index
|
|
local f
|
|
index="${package}-${type}"
|
|
if [[ -z "${CONTENT[${index}]-}" ]]; then
|
|
for f in "${local_files[@]-}"; do
|
|
if [[ -z "$f" ]]; then
|
|
# Set the default value and then check it to prevent
|
|
# accessing potentially empty array
|
|
continue
|
|
fi
|
|
# Find some copyright info in any file and break
|
|
if grep -E -i -wq "${ensure_pattern}" "${f}"; then
|
|
CONTENT[${index}]="${f}"
|
|
break
|
|
fi
|
|
done
|
|
fi
|
|
}
|
|
|
|
|
|
#############################################################################
|
|
# MAIN
|
|
#############################################################################
|
|
|
|
# use modules, and use module info rather than the vendor dir for computing dependencies
|
|
export GO111MODULE=on
|
|
export GOFLAGS=-mod=mod
|
|
|
|
# Check bash version
|
|
if (( BASH_VERSINFO[0] < 4 )); then
|
|
echo
|
|
echo "ERROR: Bash v4+ required."
|
|
echo
|
|
exit 9
|
|
fi
|
|
|
|
cd "${LICENSE_ROOT}"
|
|
VENDOR_LICENSE_FILE="LICENSES"
|
|
TMP_LICENSE_FILE="/tmp/CM.LICENSES.$$"
|
|
DEPS_DIR="vendor"
|
|
declare -Ag CONTENT
|
|
|
|
cleanup_vendor () {
|
|
echo "Deleting temporarily generated vendor/ directory..."
|
|
rm -rf "${REPO_ROOT}/${DEPS_DIR}"
|
|
}
|
|
trap cleanup_vendor EXIT
|
|
echo "Populating vendor/ directory..."
|
|
"$go" mod vendor
|
|
|
|
# Put the K8S LICENSE on top
|
|
if [ -f "${LICENSE_ROOT}/LICENSE" ]; then
|
|
(
|
|
echo "================================================================================"
|
|
echo "= cert-manager licensed under: ="
|
|
echo
|
|
cat "${LICENSE_ROOT}/LICENSE"
|
|
echo
|
|
echo "= LICENSE $(md5sum < "${LICENSE_ROOT}/LICENSE" | awk '{print $1}')"
|
|
echo "================================================================================"
|
|
) > "${TMP_LICENSE_FILE}"
|
|
fi
|
|
|
|
# only_contains_submodules will check whether a package is empty of files
|
|
# and its subdirectories are all modules, which indicates we do not need
|
|
# a LICENSE for this module as it is an indirect transitive dependency.
|
|
only_contains_submodules () {
|
|
package="$1"
|
|
if [[ -z "$(find "${DEPS_DIR}/${package}/" -mindepth 1 -maxdepth 1 -type f)" ]]; then
|
|
# If the package does not contain files, check whether all subdirectories
|
|
# only contain modules.
|
|
while read -d "" -r SUBDIR; do
|
|
# Because we have a trailing '/' on the 'find' command's argument, we
|
|
# must strip off two '/' from the end of the package path before the
|
|
# sub-packages name.
|
|
subpackage="${package}/${SUBDIR#"${DEPS_DIR}/${package}//"}"
|
|
|
|
# If the subdirectory is already a module, don't recurse into deeper
|
|
# subdirectories of this subpackage.
|
|
if go list -m "${subpackage}" 2>&1 > /dev/null; then
|
|
continue
|
|
fi
|
|
|
|
# If the subdirectory is not a module, check if the subdirectory only_contains_submodules
|
|
if only_contains_submodules "${subpackage}"; then
|
|
continue
|
|
fi
|
|
|
|
# If the subdirectory is not a module, and its subdirectories contain files and
|
|
# are not themselves (or their parents) modules, then this package does not
|
|
# contain only submodules
|
|
return 1
|
|
done < <(find "${DEPS_DIR}/${package}/" -mindepth 1 -maxdepth 1 -type d -print0)
|
|
else
|
|
# If the package contains files, it does not only contain submodules.
|
|
return 1
|
|
fi
|
|
|
|
# Otherwise, this package only contains submodules
|
|
return 0
|
|
}
|
|
|
|
# Loop through every vendored package
|
|
for PACKAGE in $("$go" list -m -f '{{.Path}}' all | sort -f); do
|
|
if [[ -e "staging/src/${PACKAGE}" ]]; then
|
|
echo "${PACKAGE} is a staging package, skipping" >&2
|
|
continue
|
|
fi
|
|
if [[ ! -e "${DEPS_DIR}/${PACKAGE}" ]]; then
|
|
echo "${PACKAGE} doesn't exist in ${DEPS_DIR}, skipping" >&2
|
|
continue
|
|
fi
|
|
# Skip a directory if 1) it has no files and 2) all its non-empty subdirectories are modules
|
|
if only_contains_submodules "${PACKAGE}"; then
|
|
echo "${PACKAGE} has no files, skipping" >&2
|
|
continue
|
|
fi
|
|
|
|
echo "${PACKAGE}"
|
|
|
|
process_content "${PACKAGE}" LICENSE
|
|
process_content "${PACKAGE}" COPYRIGHT
|
|
process_content "${PACKAGE}" COPYING
|
|
|
|
# copy content and throw error message
|
|
{
|
|
echo
|
|
echo "================================================================================"
|
|
echo "= ${DEPS_DIR}/${PACKAGE} licensed under: ="
|
|
echo
|
|
|
|
file=""
|
|
if [[ -n "${CONTENT[${PACKAGE}-LICENSE]-}" ]]; then
|
|
file="${CONTENT[${PACKAGE}-LICENSE]-}"
|
|
elif [[ -n "${CONTENT[${PACKAGE}-COPYRIGHT]-}" ]]; then
|
|
file="${CONTENT[${PACKAGE}-COPYRIGHT]-}"
|
|
elif [[ -n "${CONTENT[${PACKAGE}-COPYING]-}" ]]; then
|
|
file="${CONTENT[${PACKAGE}-COPYING]-}"
|
|
fi
|
|
if [[ -z "${file}" ]]; then
|
|
cat >&2 << __EOF__
|
|
No license could be found for ${PACKAGE} - aborting.
|
|
|
|
Options:
|
|
1. Check if the upstream repository has a newer version with LICENSE, COPYRIGHT and/or
|
|
COPYING files.
|
|
2. Contact the author of the package to ensure there is a LICENSE, COPYRIGHT and/or
|
|
COPYING file present.
|
|
3. Do not use this package in Kubernetes.
|
|
__EOF__
|
|
exit 9
|
|
fi
|
|
|
|
cat "${file}"
|
|
echo
|
|
echo "= ${file} $(md5sum "${file}" | awk '{print $1}')"
|
|
echo "================================================================================"
|
|
echo
|
|
} >> "${TMP_LICENSE_FILE}"
|
|
done
|
|
|
|
cat ${TMP_LICENSE_FILE} > ${VENDOR_LICENSE_FILE}
|