run_ort.sh

#!/bin/bash

###########################################################################
# Copyright (c) 2022 The Eclipse Foundation.
#
# This program and the accompanying materials are made available under
# the terms of the Eclipse Public License 2.0 which accompanies this
# distribution, and is available at https://www.eclipse.org/legal/epl-2.0
#
# SPDX-License-Identifier: EPL-2.0
###########################################################################

# Get the path of the scripts/ directory.
ORT_ECLIPSE_SCRIPTS=$(dirname $(readlink -f "$0"))

# Check parameters
die () {
    echo >&2 "$@"
    echo "Usage: $0 <dir_project> <repo> <dir_results>"
    exit 1
}
[ "$#" -eq 3 ] || die "3 arguments required, $# provided."

PROJECT_IN=$1
[ -d $PROJECT_IN ] || die "[$PROJECT_IN] is not a directory."
REPO_IN=$2
[ -d $PROJECT_IN/$REPO_IN ] || die "[$REPO_IN] is not a directory."
DIR_IN=${PROJECT_IN}/${REPO_IN}

DIR_OUT_BASE=$3
[ -d $DIR_OUT_BASE ] || die "[$DIR_OUT_BASE] is not a directory."


# Compute directory vars
PROJECT=$(basename $PROJECT_IN)
REPO=$REPO_IN
DATE_RUN=$(date +'%Y%m%d%H%M')
DIR_OUT="${DIR_OUT_BASE%/}/${PROJECT%/}/${REPO%/}/${DATE_RUN}"
LOG="${DIR_OUT_BASE%/}/${PROJECT%/}/${REPO%/}/${PROJECT%/}_${REPO%/}_${DATE_RUN}.log"
mkdir -p "${DIR_OUT_BASE%/}/${PROJECT%/}/${REPO%/}/"

# Debug: uncomment following line to set conf directory.
#ORT_CONFIG_DIR=~/Projects/00_eclipse/eclipsefdn-ort/conf

# Check if env vars are set, otherwise optionally set defaults.
if [[ -z "$ORT_CONFIG_DIR" ]]; then
    echo "Please set ORT_CONFIG_DIR env var to point to the conf directory."
    die "Cannot find ORT_CONFIG_DIR directory."
fi

if [[ -z "$JAVA_HOME" ]]; then
    # This is the default on debian
    export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64
fi


# Use for debug purpose - these should be normally defined in the PATH.
#export PATH=/opt/ort/cli/build/install/ort/bin/:$PATH
#export PATH=/opt/scancode-toolkit-30.1.0/:$PATH

echo "Start scan at $(date +"%Y-%m-%d %H:%M")" | tee -a $LOG
echo "- Using ort from [ort]." | tee -a $LOG
echo "- Log written to [$LOG]." | tee -a $LOG
echo "- Working on project [$DIR_IN]." | tee -a $LOG
echo "" | tee -a $LOG

echo "* Start analyzer at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG
time ort analyze -f JSON  \
    --package-curations-dir ${ORT_CONFIG_DIR}/curations/ \
    -i $DIR_IN -o $DIR_OUT | tee -a $LOG
echo "* Finish analyzer at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG

 
echo "* Start scanner at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG
time ort scan -f JSON \
    -s ScanCode \
    -i $DIR_OUT/analyzer-result.json -o $DIR_OUT | tee -a $LOG
echo "* Finish scanner at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG


echo "* Start evaluator at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG
time ort evaluate -f JSON \
    --rules-file ${ORT_CONFIG_DIR}/evaluator.rules.kts \
    --license-classifications-file ${ORT_CONFIG_DIR}/licenses_ort_eclipse.yml \
    --package-curations-dir ${ORT_CONFIG_DIR}/curations/ \
    -i $DIR_OUT/scan-result.json -o $DIR_OUT | tee -a $LOG
echo "* Finish evaluator at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG

# Parse JSON evaluation report, get clearlydefined data and create curations file.
$ORT_ECLIPSE_SCRIPTS/curate_clearlydefined.py -i $DIR_OUT/evaluation-result.json -o ${ORT_CONFIG_DIR}/curations/clearlydefined_curations.yml

echo "* Start reporter at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG
time ort report \
    -f NoticeTemplate,SpdxDocument,CycloneDx,StaticHtml,WebApp \
    -i $DIR_OUT/evaluation-result.json -o $DIR_OUT | tee -a $LOG
echo "* Finish reporter at $(date +'%Y-%m-%d %H:%M')" | tee -a $LOG

# Clean up /tmp directory, remove all directories at level 1
# that belong to us and that have not been modified for at least 12 hours
find /tmp/ -maxdepth 1 -type d -mmin +720 -exec rm -rf {} \;