Replace license checker with global notices 54/20454/1
authorVratko Polak <vrpolak@cisco.com>
Tue, 2 Jul 2019 10:56:10 +0000 (12:56 +0200)
committerVratko Polak <vrpolak@cisco.com>
Tue, 2 Jul 2019 10:56:10 +0000 (12:56 +0200)
Caring about per-file notices is too distracting.

Change-Id: I3f07a9fd1d3a4350135dd3d14f4944647af39a0b
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
LICENSE [new file with mode: 0644]
NOTICE [new file with mode: 0644]
resources/libraries/bash/entry/check/copyright.sh [deleted file]
tox.ini

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.
diff --git a/NOTICE b/NOTICE
new file mode 100644 (file)
index 0000000..85ca5b3
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,25 @@
+
+All new inbound code contributions to the Project must be made
+using the Apache License, Version 2.0
+(available here: https://www.apache.org/licenses/LICENSE-2.0)
+(the “Project License”).
+
+All new inbound code contributions must also be accompanied
+by a Developer Certificate of Origin (http://developercertificate.org)
+sign-off in the source code system that is submitted through
+a TSC-approved contribution process which will bind the authorized contributor
+and, if not self-employed, their employer to the applicable license;
+
+All outbound code will be made available under the Project License.
+
+Documentation will be received and made available by the Project
+under the Creative Commons Attribution 4.0 International License
+(available at http://creativecommons.org/licenses/by/4.0/).
+
+The Project may seek to integrate and contribute back to other
+open source projects (“Upstream Projects”). In such cases,
+the Project will conform to all license requirements of the Upstream Projects,
+including dependencies, leveraged by the Project. Upstream Project
+code contributions not stored within the Project’s main code repository
+will comply with the contribution process and license terms
+for the applicable Upstream Project.
diff --git a/resources/libraries/bash/entry/check/copyright.sh b/resources/libraries/bash/entry/check/copyright.sh
deleted file mode 100644 (file)
index 91e89bd..0000000
+++ /dev/null
@@ -1,106 +0,0 @@
-# Copyright (c) 2019 Cisco and/or its affiliates.
-# 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 -exuo pipefail
-
-# This file should be executed from tox, as the assumed working directory
-# is different from where this file is located.
-# This file does not have executable flag nor shebang,
-# to dissuade non-tox callers.
-
-# This script examines any file edited since HEAD~ (filtered by extension),
-# and fails if no line with "Copyright" and the current year is found.
-# The list of offending files is written to copyright.log (overwriting).
-# The log also specifies whether the copyright is missing or outdated.
-
-# As copyright notice usually gives readers also a license to use it,
-# any file without copyright is potentially unusable (by non-authors).
-# In the interest of open source code reuse, CSIT wants any content
-# to be available under appropriate license, which depends on whether the file
-# is deemed "code" (Apache License, Version 2.0), "documentation"
-# (Creative Commons Attribution 4.0 International), or something else.
-# Note that this checker does not check licenses,
-# it assumes any copyright notice includes the correct data
-# (all contributing people/organizations, all applicabe licenses).
-
-# Unfortunately, some file types are not designed to hold copyright notice,
-# or at least the correct way to include it is not known yet.
-# Or the file in question is processed by code which is not ready
-# for (otherwise allowed) comment lines holding the copyright.
-# That is why currently we need to explicitly whitelist filename patterns.
-
-# TODO: Figure out how to add copyright notice into .svg files.
-#       Do the usual .xml style comments work?
-# TODO: Make the code processing text files (example: VPP_REPO_URL)
-#       tolerate comment lines.
-# TODO: Verify more extensions are safe to whitelist (.virl)
-#       and that tools processing some format allows comments (.json).
-# TODO: Ultimately remove filtering to start checking every file.
-
-# "set -eu" handles failures from the following two lines.
-BASH_CHECKS_DIR="$(dirname $(readlink -e "${BASH_SOURCE[0]}"))"
-BASH_FUNCTION_DIR="$(readlink -e "${BASH_CHECKS_DIR}/../../function")"
-source "${BASH_FUNCTION_DIR}/common.sh" || {
-    echo "Source failed." >&2
-    exit 1
-}
-
-fulldate=$(date)
-year="${fulldate##* }"
-# Regexp selecting only files we expect to allow copyright.
-# Start from an array, each item is to be prepended by ., appended by $,
-# and joined by |.
-extensions_array=("gitgnore" "ini" "md" "py" "robot" "rst" "sh" "txt" "yaml")
-pattern=""
-for extension in "${extensions_array[@]}"; do
-    pattern+="\.${extension}"'$'"\|"
-done
-# One more "extension" just to avoid trailing pipe.
-pattern+="/Dockerfile"'$'
-# Get array of edited files.
-# Commands to expand, pipe has to be left out.
-cmd1="git diff --name-only HEAD~"
-cmd2="grep \"${pattern}\""
-# When calling, commands has to be without quotes.
-readarray -t file_array <<<$(${cmd1} | ${cmd2}) || {
-    # We need to tolerate changes that only edit other files.
-    errors=$(${cmd1} | ${cmd2} 2>&1 || true)
-    if [[ "${errors}" ]]; then
-        # TODO: do we need to echo errors?
-        die "Failure at getting list of files to check copyright in."
-    fi
-    # Empty file array is accepted.
-    # Accidentally, if "git diff" fails, we still proceed with empty array.
-}
-logfile="copyright.log"
-truncate --size 0 "${logfile}" || die "truncate failed"
-# Temporary +x so big changes do not spam.
-set +x
-for filename in "${file_array[@]}"; do
-    if ! fgrep -q "Copyright" "${filename}"; then
-        echo "No copyright found in file: ${filename}" >> "${logfile}"
-    elif ! fgrep "Copyright" "${filename}" | fgrep -q "${year}"; then
-        echo "No year ${year} copyright found in: ${filename}" >> "${logfile}"
-    fi
-done
-set -x
-if [ -s "${logfile}" ]; then
-    warn "Copyright violations detected."
-    # TODO: Disable when output size does more harm than good.
-    cat "${logfile}" >&2
-    warn
-    warn "Copyright checker: FAIL"
-    exit 1
-fi
-warn
-warn "Copyright checker: PASS"
diff --git a/tox.ini b/tox.ini
index a09a90f..3d4f01a 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -25,7 +25,7 @@
 # will execute only checks defined in "pylint" tox environment.
 
 [tox]
-envlist = copyright, new_line_length, line_length, autogen, pylint
+envlist = new_line_length, line_length, autogen, pylint
 # The following is needed as tox requires setup.py by default.
 skipsdist = true
 # Just a shorthand to avoid long lines.
@@ -56,10 +56,6 @@ whitelist_externals = /bin/bash
 # the checker has to remain non-voting.
 commands = bash -c "bash {[tox]checker_dir}/new_line.sh || true"
 
-[testenv:copyright]
-whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/copyright.sh
-
 [testenv:autogen]
 whitelist_externals = /bin/bash
 setenv = PYTHONPATH = {toxinidir}