NIFI-13455 Added Apache RAT License Checking

Signed-off-by: David Handermann <[email protected]>

.asf.yaml

@@ -1,18 +1,5 @@
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you 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.
+# SPDX-License-Identifier: Apache-2.0
+
 github:
   description: "Apache NiFi Python Extensions"
   homepage: https://nifi.apache.org/

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,15 +1,4 @@
-<!-- Licensed to the Apache Software Foundation (ASF) under one or more -->
-<!-- contributor license agreements.  See the NOTICE file distributed with -->
-<!-- this work for additional information regarding copyright ownership. -->
-<!-- The ASF licenses this file to You 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. -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
 
 # Summary
 

.github/workflows/build.yml

@@ -1,18 +1,5 @@
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you 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.
+# SPDX-License-Identifier: Apache-2.0
+
 name: build
 
 on:
@@ -46,6 +33,8 @@ jobs:
     steps:
       - name: Checkout Sources
         uses: actions/checkout@v4
+      - name: Check Licenses
+        run: sh check-licenses.sh
       - name: Setup Python ${{ matrix.python }}
         uses: actions/setup-python@v5
         with:

.gitignore

@@ -1,18 +1,4 @@
-# Licensed to the Apache Software Foundation (ASF) under one
-# or more contributor license agreements.  See the NOTICE file
-# distributed with this work for additional information
-# regarding copyright ownership.  The ASF licenses this file
-# to you 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.
+# SPDX-License-Identifier: Apache-2.0
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.ratignore

@@ -0,0 +1,16 @@
+# SPDX-License-Identifier: Apache-2.0
+__pycache__/*
+build/*
+dist/*
+downloads/*
+eggs/*
+lib/*
+lib64/*
+parts/*
+sdist/*
+var/*
+wheels/*
+share/python-wheels/*
+.idea/*
+.git/*
+.cache/*

check-licenses.sh

@@ -0,0 +1,60 @@
+#!/bin/sh
+# SPDX-License-Identifier: Apache-2.0
+
+APACHE_RAT_VERSION="0.16.1"
+APACHE_RAT_JAR="apache-rat-$APACHE_RAT_VERSION.jar"
+APACHE_RAT_JAR_URL="https://repo1.maven.org/maven2/org/apache/rat/apache-rat/$APACHE_RAT_VERSION/$APACHE_RAT_JAR"
+CACHE_DIRECTORY=".cache"
+APACHE_RAT_JAR_PATH="$CACHE_DIRECTORY/$APACHE_RAT_JAR"
+APACHE_RAT_EXCLUDE_FILE=".ratignore"
+
+# Set Java command
+if [ -n "${JAVA_HOME-}" ]; then
+  JAVACMD="$JAVA_HOME/bin/java"
+  if [ ! -x "$JAVACMD" ]; then
+    die "Java command [$JAVACMD}] not found"
+  fi
+elif command -v java > /dev/null; then
+  JAVACMD=$(command -v java)
+else
+  die "Environment variable [JAVA_HOME] and command [java] not found"
+fi
+
+# Set curl command
+if command -v curl > /dev/null; then
+  CURLCMD=$(command -v curl)
+else
+  die "Command [curl] not found"
+fi
+
+# Download Apache Rat JAR
+if [ ! -d $CACHE_DIRECTORY ]; then
+  mkdir $CACHE_DIRECTORY
+fi
+if [ ! -f $APACHE_RAT_JAR_PATH ]; then
+  echo "Downloading Apache Rat from [$APACHE_RAT_JAR_URL]"
+  CURL_RESULTS=$(exec $CURLCMD -f --silent --show-error -o "$APACHE_RAT_JAR_PATH" "$APACHE_RAT_JAR_URL")
+  if [ $? -ne 0 ]; then
+    echo "Failed to download Apache Rat from [$APACHE_RAT_JAR_URL]"
+    exit $?
+  fi
+fi
+
+# Run Apache Rat
+REPORT_RESULTS=$(exec $JAVACMD -jar $APACHE_RAT_JAR_PATH --scan-hidden-directories --exclude-file $APACHE_RAT_EXCLUDE_FILE --dir . 2>&1)
+if [ $? -ne 0 ]; then
+  echo "$REPORT_RESULTS"
+  exit $?
+fi
+
+UNKNOWN_LICENSES_FOUND=$(echo "$REPORT_RESULTS" | grep --count "??")
+echo "Unknown Licenses Found: $UNKNOWN_LICENSES_FOUND"
+
+if [ $UNKNOWN_LICENSES_FOUND -eq 0 ]; then
+  RESULT_CODE=0
+else
+  RESULT_CODE=1
+  echo "$REPORT_RESULTS"
+fi
+
+exit $RESULT_CODE