2020-06-29 10:55:59 -04:00
|
|
|
#!/usr/bin/env bash
|
|
|
|
|
|
|
|
|
|
################################################################################
|
|
|
|
|
################################################################################
|
|
|
|
|
########### Super-Linter linting Functions @admiralawkbar ######################
|
|
|
|
|
################################################################################
|
|
|
|
|
################################################################################
|
|
|
|
|
########################## FUNCTION CALLS BELOW ################################
|
|
|
|
|
################################################################################
|
|
|
|
|
################################################################################
|
|
|
|
|
#### Function LintCodebase #####################################################
|
|
|
|
|
function LintCodebase()
|
|
|
|
|
{
|
|
|
|
|
####################
|
|
|
|
|
# Pull in the vars #
|
|
|
|
|
####################
|
|
|
|
|
FILE_TYPE="$1" && shift # Pull the variable and remove from array path (Example: JSON)
|
|
|
|
|
LINTER_NAME="$1" && shift # Pull the variable and remove from array path (Example: jsonlint)
|
|
|
|
|
LINTER_COMMAND="$1" && shift # Pull the variable and remove from array path (Example: jsonlint -c ConfigFile /path/to/file)
|
|
|
|
|
FILE_EXTENSIONS="$1" && shift # Pull the variable and remove from array path (Example: *.json)
|
|
|
|
|
FILE_ARRAY=("$@") # Array of files to validate (Example: $FILE_ARRAY_JSON)
|
|
|
|
|
|
|
|
|
|
######################
|
|
|
|
|
# Create Print Array #
|
|
|
|
|
######################
|
|
|
|
|
PRINT_ARRAY=()
|
|
|
|
|
|
|
|
|
|
################
|
|
|
|
|
# print header #
|
|
|
|
|
################
|
|
|
|
|
PRINT_ARRAY+=("")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
PRINT_ARRAY+=("Linting [$FILE_TYPE] files...")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
|
2020-06-30 15:32:42 -04:00
|
|
|
#####################################
|
|
|
|
|
# Validate we have linter installed #
|
|
|
|
|
#####################################
|
2020-06-29 10:55:59 -04:00
|
|
|
# shellcheck disable=SC2230
|
|
|
|
|
VALIDATE_INSTALL_CMD=$(command -v "$LINTER_NAME" 2>&1)
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
|
|
|
|
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
# Failed
|
|
|
|
|
echo "ERROR! Failed to find [$LINTER_NAME] in system!"
|
|
|
|
|
echo "ERROR:[$VALIDATE_INSTALL_CMD]"
|
|
|
|
|
exit 1
|
|
|
|
|
else
|
|
|
|
|
# Success
|
|
|
|
|
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
|
2020-06-30 15:57:43 -04:00
|
|
|
echo "Successfully found binary for [$LINTER_NAME] in system"
|
2020-06-29 10:55:59 -04:00
|
|
|
echo "Location:[$VALIDATE_INSTALL_CMD]"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
|
2020-06-30 15:32:42 -04:00
|
|
|
###############################################################
|
|
|
|
|
# For POWERSHELL, ensure PSScriptAnalyzer module is available #
|
|
|
|
|
###############################################################
|
|
|
|
|
if [[ "$FILE_TYPE" == "POWERSHELL" ]]; then
|
|
|
|
|
VALIDATE_PSSA_MODULE=$(pwsh -c "(Get-Module -Name PSScriptAnalyzer -ListAvailable | Select-Object -First 1).Name" 2>&1)
|
2020-06-30 15:57:43 -04:00
|
|
|
# If module found, ensure Invoke-ScriptAnalyzer command is available
|
|
|
|
|
if [[ "$VALIDATE_PSSA_MODULE" == "PSScriptAnalyzer" ]]; then
|
|
|
|
|
VALIDATE_PSSA_CMD=$(pwsh -c "(Get-Command Invoke-ScriptAnalyzer | Select-Object -First 1).Name" 2>&1)
|
|
|
|
|
fi
|
2020-06-30 15:32:42 -04:00
|
|
|
|
2020-06-30 15:57:43 -04:00
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
2020-06-30 15:32:42 -04:00
|
|
|
|
2020-06-30 15:57:43 -04:00
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
# Failed
|
|
|
|
|
echo "ERROR! Failed find module [PSScriptAnalyzer] for [$LINTER_NAME] in system!"
|
|
|
|
|
echo "ERROR:[PSSA_MODULE $VALIDATE_PSSA_MODULE] [PSSA_CMD $VALIDATE_PSSA_CMD]"
|
|
|
|
|
exit 1
|
|
|
|
|
else
|
|
|
|
|
# Success
|
|
|
|
|
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
|
|
|
|
|
echo "Successfully found module [$VALIDATE_PSSA_MODULE] in system"
|
|
|
|
|
echo "Successfully found command [$VALIDATE_PSSA_CMD] in system"
|
|
|
|
|
fi
|
2020-06-30 15:32:42 -04:00
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
|
2020-06-29 10:55:59 -04:00
|
|
|
##########################
|
|
|
|
|
# Initialize empty Array #
|
|
|
|
|
##########################
|
|
|
|
|
LIST_FILES=()
|
|
|
|
|
|
|
|
|
|
################
|
|
|
|
|
# Set the flag #
|
|
|
|
|
################
|
|
|
|
|
SKIP_FLAG=0
|
|
|
|
|
|
|
|
|
|
############################################################
|
|
|
|
|
# Check to see if we need to go through array or all files #
|
|
|
|
|
############################################################
|
|
|
|
|
if [ ${#FILE_ARRAY[@]} -eq 0 ] && [ "$VALIDATE_ALL_CODEBASE" == "false" ]; then
|
|
|
|
|
# No files found in commit and user has asked to not validate code base
|
|
|
|
|
SKIP_FLAG=1
|
|
|
|
|
# echo " - No files found in changeset to lint for language:[$FILE_TYPE]"
|
|
|
|
|
elif [ ${#FILE_ARRAY[@]} -ne 0 ]; then
|
|
|
|
|
# We have files added to array of files to check
|
|
|
|
|
LIST_FILES=("${FILE_ARRAY[@]}") # Copy the array into list
|
|
|
|
|
else
|
|
|
|
|
###############################################################################
|
|
|
|
|
# Set the file seperator to newline to allow for grabbing objects with spaces #
|
|
|
|
|
###############################################################################
|
|
|
|
|
IFS=$'\n'
|
|
|
|
|
|
|
|
|
|
#################################
|
|
|
|
|
# Get list of all files to lint #
|
|
|
|
|
#################################
|
|
|
|
|
# shellcheck disable=SC2207,SC2086
|
|
|
|
|
LIST_FILES=($(cd "$GITHUB_WORKSPACE" || exit; find . -type f -regex "$FILE_EXTENSIONS" 2>&1))
|
|
|
|
|
|
|
|
|
|
###########################
|
|
|
|
|
# Set IFS back to default #
|
|
|
|
|
###########################
|
|
|
|
|
IFS="$DEFAULT_IFS"
|
|
|
|
|
|
|
|
|
|
############################################################
|
|
|
|
|
# Set it back to empty if loaded with blanks from scanning #
|
|
|
|
|
############################################################
|
|
|
|
|
if [ ${#LIST_FILES[@]} -lt 1 ]; then
|
|
|
|
|
######################
|
|
|
|
|
# Set to empty array #
|
|
|
|
|
######################
|
|
|
|
|
LIST_FILES=()
|
|
|
|
|
#############################
|
|
|
|
|
# Skip as we found no files #
|
|
|
|
|
#############################
|
|
|
|
|
SKIP_FLAG=1
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
###############################
|
|
|
|
|
# Check if any data was found #
|
|
|
|
|
###############################
|
|
|
|
|
if [ $SKIP_FLAG -eq 0 ]; then
|
|
|
|
|
######################
|
|
|
|
|
# Print Header array #
|
|
|
|
|
######################
|
|
|
|
|
for LINE in "${PRINT_ARRAY[@]}"
|
|
|
|
|
do
|
|
|
|
|
#########################
|
|
|
|
|
# Print the header info #
|
|
|
|
|
#########################
|
|
|
|
|
echo "$LINE"
|
|
|
|
|
done
|
|
|
|
|
|
|
|
|
|
##################
|
|
|
|
|
# Lint the files #
|
|
|
|
|
##################
|
|
|
|
|
for FILE in "${LIST_FILES[@]}"
|
|
|
|
|
do
|
|
|
|
|
#####################
|
|
|
|
|
# Get the file name #
|
|
|
|
|
#####################
|
|
|
|
|
FILE_NAME=$(basename "$FILE" 2>&1)
|
|
|
|
|
|
|
|
|
|
#####################################################
|
|
|
|
|
# Make sure we dont lint node modules or test cases #
|
|
|
|
|
#####################################################
|
|
|
|
|
if [[ $FILE == *"node_modules"* ]]; then
|
|
|
|
|
# This is a node modules file
|
|
|
|
|
continue
|
|
|
|
|
elif [[ $FILE == *"$TEST_CASE_FOLDER"* ]]; then
|
|
|
|
|
# This is the test cases, we should always skip
|
|
|
|
|
continue
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
##############
|
|
|
|
|
# File print #
|
|
|
|
|
##############
|
|
|
|
|
echo "---------------------------"
|
|
|
|
|
echo "File:[$FILE]"
|
|
|
|
|
|
|
|
|
|
####################
|
|
|
|
|
# Set the base Var #
|
|
|
|
|
####################
|
|
|
|
|
LINT_CMD=''
|
|
|
|
|
|
|
|
|
|
#######################################
|
|
|
|
|
# Corner case for Powershell subshell #
|
|
|
|
|
#######################################
|
|
|
|
|
if [[ "$FILE_TYPE" == "POWERSHELL" ]]; then
|
|
|
|
|
################################
|
|
|
|
|
# Lint the file with the rules #
|
|
|
|
|
################################
|
|
|
|
|
# Need to append "'" to make the pwsh call syntax correct, also exit with exit code from inner subshell
|
2020-06-30 15:32:42 -04:00
|
|
|
LINT_CMD=$(cd "$GITHUB_WORKSPACE" || exit; pwsh -c "($LINTER_COMMAND $FILE)"; exit $? 2>&1)
|
2020-06-29 10:55:59 -04:00
|
|
|
else
|
|
|
|
|
################################
|
|
|
|
|
# Lint the file with the rules #
|
|
|
|
|
################################
|
|
|
|
|
LINT_CMD=$(cd "$GITHUB_WORKSPACE" || exit; $LINTER_COMMAND "$FILE" 2>&1)
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
|
|
|
|
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
#########
|
|
|
|
|
# Error #
|
|
|
|
|
#########
|
|
|
|
|
echo "ERROR! Found errors in [$LINTER_NAME] linter!"
|
|
|
|
|
echo "ERROR:[$LINT_CMD]"
|
|
|
|
|
# Increment the error count
|
|
|
|
|
(("ERRORS_FOUND_$FILE_TYPE++"))
|
|
|
|
|
else
|
|
|
|
|
###########
|
|
|
|
|
# Success #
|
|
|
|
|
###########
|
|
|
|
|
echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully"
|
|
|
|
|
fi
|
|
|
|
|
done
|
|
|
|
|
fi
|
|
|
|
|
}
|
|
|
|
|
################################################################################
|
|
|
|
|
#### Function TestCodebase #####################################################
|
|
|
|
|
function TestCodebase()
|
|
|
|
|
{
|
|
|
|
|
####################
|
|
|
|
|
# Pull in the vars #
|
|
|
|
|
####################
|
2020-06-29 16:22:52 -04:00
|
|
|
FILE_TYPE="$1" # Pull the variable and remove from array path (Example: JSON)
|
|
|
|
|
LINTER_NAME="$2" # Pull the variable and remove from array path (Example: jsonlint)
|
|
|
|
|
LINTER_COMMAND="$3" # Pull the variable and remove from array path (Example: jsonlint -c ConfigFile /path/to/file)
|
|
|
|
|
FILE_EXTENSIONS="$4" # Pull the variable and remove from array path (Example: *.json)
|
|
|
|
|
INDVIDUAL_TEST_FOLDER="$5" # Folder for specific tests
|
2020-06-29 10:55:59 -04:00
|
|
|
|
|
|
|
|
################
|
|
|
|
|
# print header #
|
|
|
|
|
################
|
|
|
|
|
echo ""
|
|
|
|
|
echo "----------------------------------------------"
|
|
|
|
|
echo "----------------------------------------------"
|
|
|
|
|
echo "Testing Codebase [$FILE_TYPE] files..."
|
|
|
|
|
echo "----------------------------------------------"
|
|
|
|
|
echo "----------------------------------------------"
|
|
|
|
|
echo ""
|
|
|
|
|
|
|
|
|
|
#####################################
|
|
|
|
|
# Validate we have linter installed #
|
|
|
|
|
#####################################
|
|
|
|
|
# shellcheck disable=SC2230
|
|
|
|
|
VALIDATE_INSTALL_CMD=$(command -v "$LINTER_NAME" 2>&1)
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
|
|
|
|
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
# Failed
|
|
|
|
|
echo "ERROR! Failed to find [$LINTER_NAME] in system!"
|
|
|
|
|
echo "ERROR:[$VALIDATE_INSTALL_CMD]"
|
|
|
|
|
exit 1
|
|
|
|
|
else
|
|
|
|
|
# Success
|
|
|
|
|
echo "Successfully found binary in system"
|
|
|
|
|
echo "Location:[$VALIDATE_INSTALL_CMD]"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
##########################
|
|
|
|
|
# Initialize empty Array #
|
|
|
|
|
##########################
|
|
|
|
|
LIST_FILES=()
|
|
|
|
|
|
|
|
|
|
############################################
|
|
|
|
|
# Check if its ansible, as its the outlier #
|
|
|
|
|
############################################
|
|
|
|
|
if [[ "$FILE_TYPE" == "ANSIBLE" ]]; then
|
|
|
|
|
#################################
|
|
|
|
|
# Get list of all files to lint #
|
|
|
|
|
#################################
|
|
|
|
|
# shellcheck disable=SC2207,SC2086,SC2010
|
|
|
|
|
LIST_FILES=($(cd "$GITHUB_WORKSPACE/$TEST_CASE_FOLDER" || exit; ls ansible/ | grep ".yml" 2>&1))
|
|
|
|
|
else
|
|
|
|
|
###############################################################################
|
|
|
|
|
# Set the file seperator to newline to allow for grabbing objects with spaces #
|
|
|
|
|
###############################################################################
|
|
|
|
|
IFS=$'\n'
|
|
|
|
|
|
|
|
|
|
#################################
|
|
|
|
|
# Get list of all files to lint #
|
|
|
|
|
#################################
|
|
|
|
|
# shellcheck disable=SC2207,SC2086
|
2020-06-29 16:22:52 -04:00
|
|
|
LIST_FILES=($(cd "$GITHUB_WORKSPACE/$TEST_CASE_FOLDER" || exit; find "$INDVIDUAL_TEST_FOLDER" -type f -regex "$FILE_EXTENSIONS" ! -path "*./ansible*" 2>&1))
|
2020-06-29 10:55:59 -04:00
|
|
|
|
|
|
|
|
###########################
|
|
|
|
|
# Set IFS back to default #
|
|
|
|
|
###########################
|
|
|
|
|
IFS="$DEFAULT_IFS"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
##################
|
|
|
|
|
# Lint the files #
|
|
|
|
|
##################
|
|
|
|
|
for FILE in "${LIST_FILES[@]}"
|
|
|
|
|
do
|
|
|
|
|
#####################
|
|
|
|
|
# Get the file name #
|
|
|
|
|
#####################
|
|
|
|
|
FILE_NAME=$(basename "$FILE" 2>&1)
|
|
|
|
|
|
|
|
|
|
############################
|
|
|
|
|
# Get the file pass status #
|
|
|
|
|
############################
|
|
|
|
|
# Example: markdown_good_1.md -> good
|
|
|
|
|
FILE_STATUS=$(echo "$FILE_NAME" |cut -f2 -d'_')
|
|
|
|
|
|
|
|
|
|
#########################################################
|
|
|
|
|
# If not found, assume it should be linted successfully #
|
|
|
|
|
#########################################################
|
|
|
|
|
if [ -z "$FILE_STATUS" ] || [[ "$FILE" == *"README"* ]]; then
|
|
|
|
|
##################################
|
|
|
|
|
# Set to good for proper linting #
|
|
|
|
|
##################################
|
|
|
|
|
FILE_STATUS="good"
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
##############
|
|
|
|
|
# File print #
|
|
|
|
|
##############
|
|
|
|
|
echo "---------------------------"
|
|
|
|
|
echo "File:[$FILE]"
|
|
|
|
|
|
|
|
|
|
########################
|
|
|
|
|
# Set the lint command #
|
|
|
|
|
########################
|
|
|
|
|
LINT_CMD=''
|
|
|
|
|
|
|
|
|
|
#######################################
|
|
|
|
|
# Check if docker and get folder name #
|
|
|
|
|
#######################################
|
|
|
|
|
if [[ "$FILE_TYPE" == "DOCKER" ]]; then
|
|
|
|
|
if [[ "$FILE" == *"good"* ]]; then
|
|
|
|
|
#############
|
|
|
|
|
# Good file #
|
|
|
|
|
#############
|
|
|
|
|
FILE_STATUS='good'
|
|
|
|
|
else
|
|
|
|
|
############
|
|
|
|
|
# Bad file #
|
|
|
|
|
############
|
|
|
|
|
FILE_STATUS='bad'
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
#####################
|
|
|
|
|
# Check for ansible #
|
|
|
|
|
#####################
|
|
|
|
|
if [[ "$FILE_TYPE" == "ANSIBLE" ]]; then
|
|
|
|
|
########################################
|
|
|
|
|
# Make sure we dont lint certain files #
|
|
|
|
|
########################################
|
|
|
|
|
if [[ $FILE == *"vault.yml"* ]] || [[ $FILE == *"galaxy.yml"* ]]; then
|
|
|
|
|
# This is a file we dont look at
|
|
|
|
|
continue
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
################################
|
|
|
|
|
# Lint the file with the rules #
|
|
|
|
|
################################
|
|
|
|
|
LINT_CMD=$(cd "$GITHUB_WORKSPACE/$TEST_CASE_FOLDER/ansible" || exit; $LINTER_COMMAND "$FILE" 2>&1)
|
|
|
|
|
elif [[ "$FILE_TYPE" == "POWERSHELL" ]]; then
|
|
|
|
|
################################
|
|
|
|
|
# Lint the file with the rules #
|
|
|
|
|
################################
|
|
|
|
|
# Need to append "'" to make the pwsh call syntax correct, also exit with exit code from inner subshell
|
2020-06-30 15:32:42 -04:00
|
|
|
LINT_CMD=$(cd "$GITHUB_WORKSPACE/$TEST_CASE_FOLDER" || exit; pwsh -c "$LINTER_COMMAND $FILE"; exit $? 2>&1)
|
2020-06-29 10:55:59 -04:00
|
|
|
else
|
|
|
|
|
################################
|
|
|
|
|
# Lint the file with the rules #
|
|
|
|
|
################################
|
|
|
|
|
LINT_CMD=$(cd "$GITHUB_WORKSPACE/$TEST_CASE_FOLDER" || exit; $LINTER_COMMAND "$FILE" 2>&1)
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
|
|
|
|
|
|
|
|
|
########################################
|
|
|
|
|
# Check for if it was supposed to pass #
|
|
|
|
|
########################################
|
|
|
|
|
if [[ "$FILE_STATUS" == "good" ]]; then
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
#########
|
|
|
|
|
# Error #
|
|
|
|
|
#########
|
|
|
|
|
echo "ERROR! Found errors in [$LINTER_NAME] linter!"
|
|
|
|
|
echo "ERROR:[$LINT_CMD]"
|
|
|
|
|
echo "ERROR: Linter CMD:[$LINTER_COMMAND $FILE]"
|
|
|
|
|
# Increment the error count
|
|
|
|
|
(("ERRORS_FOUND_$FILE_TYPE++"))
|
|
|
|
|
else
|
|
|
|
|
###########
|
|
|
|
|
# Success #
|
|
|
|
|
###########
|
|
|
|
|
echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully"
|
|
|
|
|
fi
|
|
|
|
|
else
|
|
|
|
|
#######################################
|
|
|
|
|
# File status = bad, this should fail #
|
|
|
|
|
#######################################
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -eq 0 ]; then
|
|
|
|
|
#########
|
|
|
|
|
# Error #
|
|
|
|
|
#########
|
|
|
|
|
echo "ERROR! Found errors in [$LINTER_NAME] linter!"
|
|
|
|
|
echo "ERROR! This file should have failed test case!"
|
|
|
|
|
echo "ERROR:[$LINT_CMD]"
|
|
|
|
|
echo "ERROR: Linter CMD:[$LINTER_COMMAND $FILE]"
|
|
|
|
|
# Increment the error count
|
|
|
|
|
(("ERRORS_FOUND_$FILE_TYPE++"))
|
|
|
|
|
else
|
|
|
|
|
###########
|
|
|
|
|
# Success #
|
|
|
|
|
###########
|
|
|
|
|
echo " - File:[$FILE_NAME] failed test case with [$LINTER_NAME] successfully"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
done
|
|
|
|
|
}
|
|
|
|
|
################################################################################
|
|
|
|
|
#### Function RunTestCases #####################################################
|
|
|
|
|
function RunTestCases()
|
|
|
|
|
{
|
|
|
|
|
# This loop will run the test cases and exclude user code
|
|
|
|
|
# This is called from the automation process to validate new code
|
|
|
|
|
# When a PR is opened, the new code is validated with the default branch
|
|
|
|
|
# version of linter.sh, and a new container is built with the latest codebase
|
|
|
|
|
# for testing. That container is spun up, and ran,
|
|
|
|
|
# with the flag: TEST_CASE_RUN=true
|
|
|
|
|
# So that the new code can be validated against the test cases
|
|
|
|
|
|
|
|
|
|
#################
|
|
|
|
|
# Header prints #
|
|
|
|
|
#################
|
|
|
|
|
echo ""
|
|
|
|
|
echo "----------------------------------------------"
|
|
|
|
|
echo "-------------- TEST CASE RUN -----------------"
|
|
|
|
|
echo "----------------------------------------------"
|
|
|
|
|
echo ""
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Test case languages #
|
|
|
|
|
#######################
|
2020-06-29 16:22:52 -04:00
|
|
|
# TestCodebase "Language" "Linter" "Linter-command" "Regex to find files" "Test Folder"
|
|
|
|
|
TestCodebase "YML" "yamllint" "yamllint -c $YAML_LINTER_RULES" ".*\.\(yml\|yaml\)\$" "yml"
|
|
|
|
|
TestCodebase "JSON" "jsonlint" "jsonlint" ".*\.\(json\)\$" "json"
|
|
|
|
|
TestCodebase "XML" "xmllint" "xmllint" ".*\.\(xml\)\$" "xml"
|
|
|
|
|
TestCodebase "MARKDOWN" "markdownlint" "markdownlint -c $MD_LINTER_RULES" ".*\.\(md\)\$" "markdown"
|
|
|
|
|
TestCodebase "BASH" "shellcheck" "shellcheck" ".*\.\(sh\)\$" "shell"
|
|
|
|
|
TestCodebase "PYTHON" "pylint" "pylint --rcfile $PYTHON_LINTER_RULES" ".*\.\(py\)\$" "python"
|
|
|
|
|
TestCodebase "PERL" "perl" "perl -Mstrict -cw" ".*\.\(pl\)\$" "perl"
|
|
|
|
|
TestCodebase "PHP" "php" "php -l" ".*\.\(php\)\$" "php"
|
|
|
|
|
TestCodebase "RUBY" "rubocop" "rubocop -c $RUBY_LINTER_RULES" ".*\.\(rb\)\$" "ruby"
|
|
|
|
|
TestCodebase "GO" "golangci-lint" "golangci-lint run -c $GO_LINTER_RULES" ".*\.\(go\)\$" "golang"
|
|
|
|
|
TestCodebase "COFFEESCRIPT" "coffeelint" "coffeelint -f $COFFEESCRIPT_LINTER_RULES" ".*\.\(coffee\)\$" "coffeescript"
|
|
|
|
|
TestCodebase "JAVASCRIPT_ES" "eslint" "eslint --no-eslintrc -c $JAVASCRIPT_LINTER_RULES" ".*\.\(js\)\$" "javascript"
|
|
|
|
|
TestCodebase "JAVASCRIPT_STANDARD" "standard" "standard $JAVASCRIPT_STANDARD_LINTER_RULES" ".*\.\(js\)\$" "javascript"
|
|
|
|
|
TestCodebase "TYPESCRIPT_ES" "eslint" "eslint --no-eslintrc -c $TYPESCRIPT_LINTER_RULES" ".*\.\(ts\)\$" "typescript"
|
|
|
|
|
TestCodebase "TYPESCRIPT_STANDARD" "standard" "standard --parser @typescript-eslint/parser --plugin @typescript-eslint/eslint-plugin $TYPESCRIPT_STANDARD_LINTER_RULES" ".*\.\(ts\)\$" "typescript"
|
|
|
|
|
TestCodebase "DOCKER" "/dockerfilelint/bin/dockerfilelint" "/dockerfilelint/bin/dockerfilelint -c $DOCKER_LINTER_RULES" ".*\(Dockerfile\)\$" "docker"
|
|
|
|
|
TestCodebase "ANSIBLE" "ansible-lint" "ansible-lint -v -c $ANSIBLE_LINTER_RULES" "ansible-lint" "ansible"
|
|
|
|
|
TestCodebase "TERRAFORM" "tflint" "tflint -c $TERRAFORM_LINTER_RULES" ".*\.\(tf\)\$" "terraform"
|
|
|
|
|
TestCodebase "CFN" "cfn-lint" "cfn-lint --config-file $CFN_LINTER_RULES" ".*\.\(json\|yml\|yaml\)\$" "cfn"
|
|
|
|
|
TestCodebase "POWERSHELL" "pwsh" "pwsh -c Invoke-ScriptAnalyzer -EnableExit -Settings $POWERSHELL_LINTER_RULES -Path" ".*\.\(ps1\|psm1\|psd1\|ps1xml\|pssc\|psrc\|cdxml\)\$" "powershell"
|
|
|
|
|
TestCodebase "CSS" "stylelint" "stylelint --config $CSS_LINTER_RULES" ".*\.\(css\)\$" "css"
|
|
|
|
|
TestCodebase "ENV" "dotenv-linter" "dotenv-linter" ".*\.\(env\)\$" "env"
|
|
|
|
|
TestCodebase "CLOJURE" "clj-kondo" "clj-kondo --config $CLOJURE_LINTER_RULES --lint" ".*\.\(clj\|cljs\|cljc\|edn\)\$" "clojure"
|
|
|
|
|
TestCodebase "KOTLIN" "ktlint" "ktlint" ".*\.\(kt\|kts\)\$" "kotlin"
|
|
|
|
|
TestCodebase "PROTOBUF" "protolint" "protolint lint --config_path $PROTOBUF_LINTER_RULES" ".*\.\(proto\)\$" "protobuf"
|
|
|
|
|
TestCodebase "OPENAPI" "spectral" "spectral lint -r $OPENAPI_LINTER_RULES" ".*\.\(ymlopenapi\|jsonopenapi\)\$" "openapi"
|
2020-06-29 10:55:59 -04:00
|
|
|
|
|
|
|
|
#################
|
|
|
|
|
# Footer prints #
|
|
|
|
|
#################
|
|
|
|
|
# Call the footer to display run information
|
|
|
|
|
# and exit with error code
|
|
|
|
|
Footer
|
|
|
|
|
}
|
|
|
|
|
################################################################################
|
|
|
|
|
#### Function LintAnsibleFiles #################################################
|
|
|
|
|
function LintAnsibleFiles()
|
|
|
|
|
{
|
|
|
|
|
######################
|
|
|
|
|
# Create Print Array #
|
|
|
|
|
######################
|
|
|
|
|
PRINT_ARRAY=()
|
|
|
|
|
|
|
|
|
|
################
|
|
|
|
|
# print header #
|
|
|
|
|
################
|
|
|
|
|
PRINT_ARRAY+=("")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
PRINT_ARRAY+=("Linting [Ansible] files...")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
PRINT_ARRAY+=("----------------------------------------------")
|
|
|
|
|
|
|
|
|
|
######################
|
|
|
|
|
# Name of the linter #
|
|
|
|
|
######################
|
|
|
|
|
LINTER_NAME="ansible-lint"
|
|
|
|
|
|
|
|
|
|
###########################################
|
|
|
|
|
# Validate we have ansible-lint installed #
|
|
|
|
|
###########################################
|
|
|
|
|
# shellcheck disable=SC2230
|
|
|
|
|
VALIDATE_INSTALL_CMD=$(command -v "$LINTER_NAME" 2>&1)
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
|
|
|
|
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
# Failed
|
|
|
|
|
echo "ERROR! Failed to find $LINTER_NAME in system!"
|
|
|
|
|
echo "ERROR:[$VALIDATE_INSTALL_CMD]"
|
|
|
|
|
exit 1
|
|
|
|
|
else
|
|
|
|
|
# Success
|
|
|
|
|
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
|
|
|
|
|
# Success
|
|
|
|
|
echo "Successfully found binary in system"
|
|
|
|
|
echo "Location:[$VALIDATE_INSTALL_CMD]"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
##########################
|
|
|
|
|
# Initialize empty Array #
|
|
|
|
|
##########################
|
|
|
|
|
LIST_FILES=()
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Create flag to skip #
|
|
|
|
|
#######################
|
|
|
|
|
SKIP_FLAG=0
|
|
|
|
|
|
|
|
|
|
######################################################
|
|
|
|
|
# Only go into ansible linter if we have base folder #
|
|
|
|
|
######################################################
|
|
|
|
|
if [ -d "$ANSIBLE_DIRECTORY" ]; then
|
|
|
|
|
|
|
|
|
|
############################################################
|
|
|
|
|
# Check to see if we need to go through array or all files #
|
|
|
|
|
############################################################
|
|
|
|
|
if [ "$VALIDATE_ALL_CODEBASE" == "false" ]; then
|
|
|
|
|
# We need to only check the ansible playbooks that have updates
|
|
|
|
|
#LIST_FILES=("${ANSIBLE_ARRAY[@]}")
|
|
|
|
|
# shellcheck disable=SC2164,SC2010,SC2207
|
|
|
|
|
LIST_FILES=($(cd "$ANSIBLE_DIRECTORY"; ls | grep ".yml" 2>&1))
|
|
|
|
|
else
|
|
|
|
|
#################################
|
|
|
|
|
# Get list of all files to lint #
|
|
|
|
|
#################################
|
|
|
|
|
# shellcheck disable=SC2164,SC2010,SC2207
|
|
|
|
|
LIST_FILES=($(cd "$ANSIBLE_DIRECTORY"; ls | grep ".yml" 2>&1))
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
###############################################################
|
|
|
|
|
# Set the list to empty if only MD and TXT files were changed #
|
|
|
|
|
###############################################################
|
|
|
|
|
# No need to run the full ansible checks on read only file changes
|
|
|
|
|
if [ "$READ_ONLY_CHANGE_FLAG" -eq 0 ]; then
|
|
|
|
|
##########################
|
|
|
|
|
# Set the array to empty #
|
|
|
|
|
##########################
|
|
|
|
|
LIST_FILES=()
|
|
|
|
|
###################################
|
|
|
|
|
# Send message that were skipping #
|
|
|
|
|
###################################
|
|
|
|
|
#echo "- Skipping Ansible lint run as file(s) that were modified were read only..."
|
|
|
|
|
############################
|
|
|
|
|
# Create flag to skip loop #
|
|
|
|
|
############################
|
|
|
|
|
SKIP_FLAG=1
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
####################################
|
|
|
|
|
# Check if we have data to look at #
|
|
|
|
|
####################################
|
|
|
|
|
if [ $SKIP_FLAG -eq 0 ]; then
|
|
|
|
|
for LINE in "${PRINT_ARRAY[@]}"
|
|
|
|
|
do
|
|
|
|
|
#########################
|
|
|
|
|
# Print the header line #
|
|
|
|
|
#########################
|
|
|
|
|
echo "$LINE"
|
|
|
|
|
done
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
##################
|
|
|
|
|
# Lint the files #
|
|
|
|
|
##################
|
|
|
|
|
for FILE in "${LIST_FILES[@]}"
|
|
|
|
|
do
|
|
|
|
|
|
|
|
|
|
########################################
|
|
|
|
|
# Make sure we dont lint certain files #
|
|
|
|
|
########################################
|
|
|
|
|
if [[ $FILE == *"vault.yml"* ]] || [[ $FILE == *"galaxy.yml"* ]]; then
|
|
|
|
|
# This is a file we dont look at
|
|
|
|
|
continue
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
####################
|
|
|
|
|
# Get the filename #
|
|
|
|
|
####################
|
|
|
|
|
FILE_NAME=$(basename "$ANSIBLE_DIRECTORY/$FILE" 2>&1)
|
|
|
|
|
|
|
|
|
|
##############
|
|
|
|
|
# File print #
|
|
|
|
|
##############
|
|
|
|
|
echo "---------------------------"
|
|
|
|
|
echo "File:[$FILE]"
|
|
|
|
|
|
|
|
|
|
################################
|
|
|
|
|
# Lint the file with the rules #
|
|
|
|
|
################################
|
|
|
|
|
LINT_CMD=$("$LINTER_NAME" -v -c "$ANSIBLE_LINTER_RULES" "$ANSIBLE_DIRECTORY/$FILE" 2>&1)
|
|
|
|
|
|
|
|
|
|
#######################
|
|
|
|
|
# Load the error code #
|
|
|
|
|
#######################
|
|
|
|
|
ERROR_CODE=$?
|
|
|
|
|
|
|
|
|
|
##############################
|
|
|
|
|
# Check the shell for errors #
|
|
|
|
|
##############################
|
|
|
|
|
if [ $ERROR_CODE -ne 0 ]; then
|
|
|
|
|
#########
|
|
|
|
|
# Error #
|
|
|
|
|
#########
|
|
|
|
|
echo "ERROR! Found errors in [$LINTER_NAME] linter!"
|
|
|
|
|
echo "ERROR:[$LINT_CMD]"
|
|
|
|
|
# Increment error count
|
|
|
|
|
((ERRORS_FOUND_ANSIBLE++))
|
|
|
|
|
else
|
|
|
|
|
###########
|
|
|
|
|
# Success #
|
|
|
|
|
###########
|
|
|
|
|
echo " - File:[$FILE_NAME] was linted with [$LINTER_NAME] successfully"
|
|
|
|
|
fi
|
|
|
|
|
done
|
|
|
|
|
else # No ansible directory found in path
|
|
|
|
|
###############################
|
|
|
|
|
# Check to see if debug is on #
|
|
|
|
|
###############################
|
|
|
|
|
if [[ "$ACTIONS_RUNNER_DEBUG" == "true" ]]; then
|
|
|
|
|
########################
|
|
|
|
|
# No Ansible dir found #
|
|
|
|
|
########################
|
|
|
|
|
echo "WARN! No Ansible base directory found at:[$ANSIBLE_DIRECTORY]"
|
|
|
|
|
echo "skipping ansible lint"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
}
|
