2020-06-23 12:02:45 -04:00
#!/usr/bin/env bash
2019-10-21 10:12:50 -04:00
2020-09-28 16:29:48 -04:00
##################################################################
# Debug Vars #
# Define these early, so we can use debug logging ASAP if needed #
##################################################################
2024-01-11 15:30:00 -05:00
declare -l ACTIONS_RUNNER_DEBUG
ACTIONS_RUNNER_DEBUG = " ${ ACTIONS_RUNNER_DEBUG :- "false" } " # Boolean to see even more info (debug)
IMAGE = " ${ IMAGE :- standard } " # Version of the Super-linter (standard,slim,etc)
2020-09-28 16:29:48 -04:00
##################################################################
# Log Vars #
# Define these early, so we can use debug logging ASAP if needed #
##################################################################
2023-12-05 03:04:13 -05:00
LOG_FILE = " ${ LOG_FILE :- "super-linter.log" } " # Default log file name (located in GITHUB_WORKSPACE folder)
LOG_LEVEL = " ${ LOG_LEVEL :- VERBOSE } " # Default log level (VERBOSE, DEBUG, TRACE)
2024-01-11 15:30:00 -05:00
declare -l CREATE_LOG_FILE
2023-01-05 08:32:46 -05:00
CREATE_LOG_FILE = " ${ CREATE_LOG_FILE :- "false" } "
2020-09-29 16:46:24 -04:00
2020-09-28 16:29:48 -04:00
if [ [ ${ ACTIONS_RUNNER_DEBUG } = = true ] ] ; then LOG_LEVEL = "DEBUG" ; fi
# Boolean to see trace logs
LOG_TRACE = $( if [ [ ${ LOG_LEVEL } = = "TRACE" ] ] ; then echo "true" ; fi )
export LOG_TRACE
# Boolean to see debug logs
LOG_DEBUG = $( if [ [ ${ LOG_LEVEL } = = "DEBUG" || ${ LOG_LEVEL } = = "TRACE" ] ] ; then echo "true" ; fi )
export LOG_DEBUG
# Boolean to see verbose logs (info function)
LOG_VERBOSE = $( if [ [ ${ LOG_LEVEL } = = "VERBOSE" || ${ LOG_LEVEL } = = "DEBUG" || ${ LOG_LEVEL } = = "TRACE" ] ] ; then echo "true" ; fi )
export LOG_VERBOSE
2020-10-28 20:08:01 -04:00
# Boolean to see notice logs
LOG_NOTICE = $( if [ [ ${ LOG_LEVEL } = = "NOTICE" || ${ LOG_LEVEL } = = "VERBOSE" || ${ LOG_LEVEL } = = "DEBUG" || ${ LOG_LEVEL } = = "TRACE" ] ] ; then echo "true" ; fi )
export LOG_NOTICE
# Boolean to see warn logs
LOG_WARN = $( if [ [ ${ LOG_LEVEL } = = "WARN" || ${ LOG_LEVEL } = = "NOTICE" || ${ LOG_LEVEL } = = "VERBOSE" || ${ LOG_LEVEL } = = "DEBUG" || ${ LOG_LEVEL } = = "TRACE" ] ] ; then echo "true" ; fi )
export LOG_WARN
# Boolean to see error logs
LOG_ERROR = $( if [ [ ${ LOG_LEVEL } = = "ERROR" || ${ LOG_LEVEL } = = "WARN" || ${ LOG_LEVEL } = = "NOTICE" || ${ LOG_LEVEL } = = "VERBOSE" || ${ LOG_LEVEL } = = "DEBUG" || ${ LOG_LEVEL } = = "TRACE" ] ] ; then echo "true" ; fi )
export LOG_ERROR
2020-09-28 16:29:48 -04:00
2020-06-29 10:55:59 -04:00
#########################
# Source Function Files #
#########################
2020-06-30 10:56:15 -04:00
# shellcheck source=/dev/null
2020-11-12 12:27:34 -05:00
source /action/lib/functions/buildFileList.sh # Source the function script(s)
2020-06-30 10:56:15 -04:00
# shellcheck source=/dev/null
2021-04-26 10:00:42 -04:00
source /action/lib/functions/detectFiles.sh # Source the function script(s)
2020-06-30 10:56:15 -04:00
# shellcheck source=/dev/null
2021-04-26 10:00:42 -04:00
source /action/lib/functions/linterRules.sh # Source the function script(s)
# shellcheck source=/dev/null
source /action/lib/functions/linterVersions.sh # Source the function script(s)
# shellcheck source=/dev/null
source /action/lib/functions/log.sh # Source the function script(s)
2020-11-12 12:27:34 -05:00
# shellcheck source=/dev/null
2021-04-26 10:00:42 -04:00
source /action/lib/functions/updateSSL.sh # Source the function script(s)
2020-11-12 12:27:34 -05:00
# shellcheck source=/dev/null
2021-04-26 10:00:42 -04:00
source /action/lib/functions/validation.sh # Source the function script(s)
2020-11-12 12:27:34 -05:00
# shellcheck source=/dev/null
2021-04-26 10:00:42 -04:00
source /action/lib/functions/worker.sh # Source the function script(s)
2022-02-09 16:24:57 -05:00
# shellcheck source=/dev/null
source /action/lib/functions/setupSSH.sh # Source the function script(s)
2024-01-05 17:07:39 -05:00
# shellcheck source=/dev/null
source /action/lib/functions/githubEvent.sh
2020-06-29 10:55:59 -04:00
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l RUN_LOCAL
2023-12-12 14:57:15 -05:00
# Initialize RUN_LOCAL early because we need it for logging
2024-01-11 15:30:00 -05:00
RUN_LOCAL = " ${ RUN_LOCAL :- "false" } "
2023-12-12 14:57:15 -05:00
# Dynamically set the default behavior for GitHub Actions log markers because
# we want to give users a chance to enable this even when running locally, but
# we still want to provide a default value in case they don't want to explictly
# configure it.
if [ [ " ${ RUN_LOCAL } " = = "true" ] ] ; then
DEFAULT_ENABLE_GITHUB_ACTIONS_GROUP_TITLE = "false"
else
DEFAULT_ENABLE_GITHUB_ACTIONS_GROUP_TITLE = "true"
fi
# Let users configure GitHub Actions log markers regardless of running locally or not
ENABLE_GITHUB_ACTIONS_GROUP_TITLE = " ${ ENABLE_GITHUB_ACTIONS_GROUP_TITLE :- " ${ DEFAULT_ENABLE_GITHUB_ACTIONS_GROUP_TITLE } " } "
2024-01-30 14:24:55 -05:00
export ENABLE_GITHUB_ACTIONS_GROUP_TITLE
2023-12-12 14:57:15 -05:00
startGitHubActionsLogGroup " ${ SUPER_LINTER_INITIALIZATION_LOG_GROUP_TITLE } "
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l DISABLE_ERRORS
DISABLE_ERRORS = " ${ DISABLE_ERRORS :- "false" } "
# We want a lowercase value
declare -l IGNORE_GENERATED_FILES
# Do not ignore generated files by default for backwards compatibility
IGNORE_GENERATED_FILES = " ${ IGNORE_GENERATED_FILES :- false } "
2024-01-30 14:24:55 -05:00
export IGNORE_GENERATED_FILES
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l IGNORE_GITIGNORED_FILES
IGNORE_GITIGNORED_FILES = " ${ IGNORE_GITIGNORED_FILES :- false } "
2024-01-30 14:24:55 -05:00
export IGNORE_GITIGNORED_FILES
2024-01-11 15:30:00 -05:00
# We want a lowercase value
declare -l MULTI_STATUS
MULTI_STATUS = " ${ MULTI_STATUS :- true } "
# We want a lowercase value
declare -l SSH_INSECURE_NO_VERIFY_GITHUB_KEY
SSH_INSECURE_NO_VERIFY_GITHUB_KEY = " ${ SSH_INSECURE_NO_VERIFY_GITHUB_KEY :- false } "
# We want a lowercase value
declare -l SSH_SETUP_GITHUB
SSH_SETUP_GITHUB = " ${ SSH_SETUP_GITHUB :- false } "
# We want a lowercase value
declare -l SUPPRESS_FILE_TYPE_WARN
SUPPRESS_FILE_TYPE_WARN = " ${ SUPPRESS_FILE_TYPE_WARN :- false } "
# We want a lowercase value
declare -l SUPPRESS_POSSUM
SUPPRESS_POSSUM = " ${ SUPPRESS_POSSUM :- false } "
# We want a lowercase value
declare -l TEST_CASE_RUN
# Option to tell code to run only test cases
TEST_CASE_RUN = " ${ TEST_CASE_RUN :- "false" } "
# We want a lowercase value
declare -l USE_FIND_ALGORITHM
USE_FIND_ALGORITHM = " ${ USE_FIND_ALGORITHM :- false } "
# We want a lowercase value
declare -l VALIDATE_ALL_CODEBASE
VALIDATE_ALL_CODEBASE = " ${ VALIDATE_ALL_CODEBASE :- "true" } "
# We want a lowercase value
declare -l YAML_ERROR_ON_WARNING
YAML_ERROR_ON_WARNING = " ${ YAML_ERROR_ON_WARNING :- false } "
declare -l WRITE_LINTER_VERSIONS_FILE
WRITE_LINTER_VERSIONS_FILE = " ${ WRITE_LINTER_VERSIONS_FILE :- "false" } "
ValidateBooleanConfigurationVariables
2023-12-12 14:57:15 -05:00
2019-10-21 10:12:50 -04:00
###########
2019-10-21 12:05:55 -04:00
# GLOBALS #
2019-10-21 10:12:50 -04:00
###########
2024-01-11 15:30:00 -05:00
DEFAULT_BRANCH = " ${ DEFAULT_BRANCH :- master } "
DEFAULT_RULES_LOCATION = '/action/lib/.automation' # Default rules files location
DEFAULT_SUPER_LINTER_WORKSPACE = "/tmp/lint" # Fall-back value for the workspace
DEFAULT_WORKSPACE = " ${ DEFAULT_WORKSPACE :- ${ DEFAULT_SUPER_LINTER_WORKSPACE } } " # Default workspace if running locally
FILTER_REGEX_INCLUDE = " ${ FILTER_REGEX_INCLUDE :- "" } "
FILTER_REGEX_EXCLUDE = " ${ FILTER_REGEX_EXCLUDE :- "" } "
2021-10-04 10:53:43 -04:00
# GitHub API root url
2024-01-11 15:30:00 -05:00
GITHUB_API_URL = " ${ GITHUB_CUSTOM_API_URL :- "https://api.github.com" } "
2021-10-04 10:53:43 -04:00
# Remove trailing slash if present
GITHUB_API_URL = " ${ GITHUB_API_URL %/ } "
2024-01-11 15:30:00 -05:00
GITHUB_SERVER_URL = " ${ GITHUB_DOMAIN :- "https://github.com" } "
2023-07-05 18:00:11 -04:00
# Extract domain name from URL
GITHUB_SERVER_URL = $( echo " $GITHUB_SERVER_URL " | cut -d '/' -f 3)
2021-10-04 10:53:43 -04:00
LINTER_RULES_PATH = " ${ LINTER_RULES_PATH :- .github/linters } " # Linter rules directory
2024-01-11 15:30:00 -05:00
# shellcheck disable=SC2034 # Variable is referenced in other scripts
RAW_FILE_ARRAY = ( ) # Array of all files that were changed
# shellcheck disable=SC2034 # Variable is referenced in other scripts
TEST_CASE_FOLDER = 'test/linters' # Folder for test cases we should always ignore
# shellcheck disable=SC2034 # Variable is referenced in other scripts
VERSION_FILE = '/action/lib/functions/linterVersions.txt' # File to store linter versions
2023-12-05 03:04:13 -05:00
2023-12-15 04:29:34 -05:00
# Set the log level
TF_LOG_LEVEL = "info"
if [ " ${ ACTIONS_RUNNER_DEBUG } " = "true" ] ; then
TF_LOG_LEVEL = "debug"
fi
export TF_LOG_LEVEL
debug " TF_LOG_LEVEL: ${ TF_LOG_LEVEL } "
TFLINT_LOG = " ${ TF_LOG_LEVEL } "
export TFLINT_LOG
debug " TFLINT_LOG: ${ TFLINT_LOG } "
2020-10-15 05:43:56 -04:00
###############
# Rules files #
###############
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-04-11 23:24:43 -04:00
ANSIBLE_FILE_NAME = " ${ ANSIBLE_CONFIG_FILE :- .ansible-lint.yml } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
ARM_FILE_NAME = ".arm-ttk.psd1"
2023-12-22 07:22:15 -05:00
CHECKOV_FILE_NAME = " ${ CHECKOV_FILE_NAME :- ".checkov.yaml" } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
CLOJURE_FILE_NAME = ".clj-kondo/config.edn"
# shellcheck disable=SC2034 # Variable is referenced indirectly
CLOUDFORMATION_FILE_NAME = ".cfnlintrc.yml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
COFFEESCRIPT_FILE_NAME = ".coffee-lint.json"
CSS_FILE_NAME = " ${ CSS_FILE_NAME :- .stylelintrc.json } "
2020-10-30 07:15:16 -04:00
DOCKERFILE_HADOLINT_FILE_NAME = " ${ DOCKERFILE_HADOLINT_FILE_NAME :- .hadolint.yaml } "
2020-10-15 05:43:56 -04:00
EDITORCONFIG_FILE_NAME = " ${ EDITORCONFIG_FILE_NAME :- .ecrc } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-07-19 10:28:49 -04:00
GITHUB_ACTIONS_FILE_NAME = " ${ GITHUB_ACTIONS_CONFIG_FILE :- actionlint .yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2023-01-04 00:05:31 -05:00
GITHUB_ACTIONS_COMMAND_ARGS = " ${ GITHUB_ACTIONS_COMMAND_ARGS :- null } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-09-27 12:02:18 -04:00
GITLEAKS_FILE_NAME = " ${ GITLEAKS_CONFIG_FILE :- .gitleaks.toml } "
2021-09-27 10:32:18 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-11-19 10:54:20 -05:00
GHERKIN_FILE_NAME = ".gherkin-lintrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
GO_FILE_NAME = ".golangci.yml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
GROOVY_FILE_NAME = ".groovylintrc.json"
# shellcheck disable=SC2034 # Variable is referenced indirectly
HTML_FILE_NAME = ".htmlhintrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-07-14 10:45:07 -04:00
JAVA_FILE_NAME = " ${ JAVA_FILE_NAME :- sun_checks .xml } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
JAVASCRIPT_ES_FILE_NAME = " ${ JAVASCRIPT_ES_CONFIG_FILE :- .eslintrc.yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-01-04 12:07:57 -05:00
JAVASCRIPT_DEFAULT_STYLE = " ${ JAVASCRIPT_DEFAULT_STYLE :- standard } "
JAVASCRIPT_STYLE_NAME = '' # Variable for the style
JAVASCRIPT_STYLE = '' # Variable for the style
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
JAVASCRIPT_STANDARD_FILE_NAME = " ${ JAVASCRIPT_ES_CONFIG_FILE :- .eslintrc.yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-01-27 14:47:34 -05:00
JSCPD_FILE_NAME = " ${ JSCPD_CONFIG_FILE :- .jscpd.json } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
JSX_FILE_NAME = " ${ JAVASCRIPT_ES_CONFIG_FILE :- .eslintrc.yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2023-01-11 11:21:02 -05:00
KUBERNETES_KUBECONFORM_OPTIONS = " ${ KUBERNETES_KUBECONFORM_OPTIONS :- null } "
2021-06-01 16:04:25 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
LATEX_FILE_NAME = ".chktexrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
LUA_FILE_NAME = ".luacheckrc"
# shellcheck disable=SC2034 # Variable is referenced indirectly
MARKDOWN_FILE_NAME = " ${ MARKDOWN_CONFIG_FILE :- .markdown-lint.yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
OPENAPI_FILE_NAME = ".openapirc.yml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
2022-03-28 09:56:50 -04:00
PERL_PERLCRITIC_OPTIONS = " ${ PERL_PERLCRITIC_OPTIONS :- null } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-06-09 12:53:11 -04:00
PHP_BUILTIN_FILE_NAME = " ${ PHP_CONFIG_FILE :- php .ini } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2023-11-15 01:10:36 -05:00
PHP_PHPCS_FILE_NAME = " ${ PHP_PHPCS_FILE_NAME :- phpcs .xml } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
PHP_PHPSTAN_FILE_NAME = "phpstan.neon"
# shellcheck disable=SC2034 # Variable is referenced indirectly
PHP_PSALM_FILE_NAME = "psalm.xml"
# shellcheck disable=SC2034 # Variable is referenced indirectly
2022-12-23 21:01:24 -05:00
POWERSHELL_FILE_NAME = ".powershell-psscriptanalyzer.psd1"
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2022-01-03 12:30:56 -05:00
PROTOBUF_FILE_NAME = " ${ PROTOBUF_CONFIG_FILE :- .protolintrc.yml } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
PYTHON_BLACK_FILE_NAME = " ${ PYTHON_BLACK_CONFIG_FILE :- .python-black } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
PYTHON_FLAKE8_FILE_NAME = " ${ PYTHON_FLAKE8_CONFIG_FILE :- .flake8 } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-28 11:22:55 -04:00
PYTHON_ISORT_FILE_NAME = " ${ PYTHON_ISORT_CONFIG_FILE :- .isort.cfg } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-03-24 15:00:23 -04:00
PYTHON_MYPY_FILE_NAME = " ${ PYTHON_MYPY_CONFIG_FILE :- .mypy.ini } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
PYTHON_PYLINT_FILE_NAME = " ${ PYTHON_PYLINT_CONFIG_FILE :- .python-lint } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
R_FILE_NAME = ".lintr"
# shellcheck disable=SC2034 # Variable is referenced indirectly
RUBY_FILE_NAME = " ${ RUBY_CONFIG_FILE :- .ruby-lint.yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-11-10 13:28:50 -05:00
SCALAFMT_FILE_NAME = " ${ SCALAFMT_CONFIG_FILE :- .scalafmt.conf } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
SNAKEMAKE_SNAKEFMT_FILE_NAME = " ${ SNAKEMAKE_SNAKEFMT_CONFIG_FILE :- .snakefmt.toml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-03-23 13:02:16 -04:00
SQL_FILE_NAME = " ${ SQL_CONFIG_FILE :- .sql-config.json } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2022-01-24 10:01:37 -05:00
SQLFLUFF_FILE_NAME = " ${ SQLFLUFF_CONFIG_FILE :- /.sqlfluff } "
2022-01-20 10:02:30 -05:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-08-30 10:47:50 -04:00
TERRAFORM_TFLINT_FILE_NAME = " ${ TERRAFORM_TFLINT_CONFIG_FILE :- .tflint.hcl } "
2020-10-15 05:43:56 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-07-14 11:20:24 -04:00
TERRAFORM_TERRASCAN_FILE_NAME = " ${ TERRAFORM_TERRASCAN_CONFIG_FILE :- terrascan .toml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2021-10-05 09:29:05 -04:00
NATURAL_LANGUAGE_FILE_NAME = " ${ NATURAL_LANGUAGE_CONFIG_FILE :- .textlintrc } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
TSX_FILE_NAME = " ${ TYPESCRIPT_ES_CONFIG_FILE :- .eslintrc.yml } "
# shellcheck disable=SC2034 # Variable is referenced indirectly
2022-03-16 11:21:57 -04:00
TYPESCRIPT_DEFAULT_STYLE = " ${ TYPESCRIPT_DEFAULT_STYLE :- ts -standard } "
2021-11-12 11:25:32 -05:00
TYPESCRIPT_STYLE_NAME = '' # Variable for the style
TYPESCRIPT_STYLE = '' # Variable for the style
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
TYPESCRIPT_ES_FILE_NAME = " ${ TYPESCRIPT_ES_CONFIG_FILE :- .eslintrc.yml } "
2021-06-08 11:40:59 -04:00
# shellcheck disable=SC2034 # Variable is referenced indirectly
2020-10-15 05:43:56 -04:00
YAML_FILE_NAME = " ${ YAML_CONFIG_FILE :- .yaml-lint.yml } "
2020-06-18 19:40:41 -04:00
2021-01-04 12:07:57 -05:00
#################################################
# Parse if we are using JS standard or prettier #
#################################################
# Remove spaces
JAVASCRIPT_DEFAULT_STYLE = $( echo " ${ JAVASCRIPT_DEFAULT_STYLE } " | tr -d ' ' )
# lowercase
JAVASCRIPT_DEFAULT_STYLE = $( echo " ${ JAVASCRIPT_DEFAULT_STYLE } " | tr '[:upper:]' '[:lower:]' )
# Check and set
if [ " ${ JAVASCRIPT_DEFAULT_STYLE } " = = "prettier" ] ; then
# Set to prettier
JAVASCRIPT_STYLE_NAME = 'JAVASCRIPT_PRETTIER'
JAVASCRIPT_STYLE = 'prettier'
else
# Default to standard
JAVASCRIPT_STYLE_NAME = 'JAVASCRIPT_STANDARD'
JAVASCRIPT_STYLE = 'standard'
fi
2021-11-12 11:25:32 -05:00
#################################################
# Parse if we are using JS standard or prettier #
#################################################
# Remove spaces
TYPESCRIPT_DEFAULT_STYLE = $( echo " ${ TYPESCRIPT_DEFAULT_STYLE } " | tr -d ' ' )
# lowercase
TYPESCRIPT_DEFAULT_STYLE = $( echo " ${ TYPESCRIPT_DEFAULT_STYLE } " | tr '[:upper:]' '[:lower:]' )
# Check and set
if [ " ${ TYPESCRIPT_DEFAULT_STYLE } " = = "prettier" ] ; then
# Set to prettier
TYPESCRIPT_STYLE_NAME = 'TYPESCRIPT_PRETTIER'
TYPESCRIPT_STYLE = 'prettier'
else
# Default to standard
TYPESCRIPT_STYLE_NAME = 'TYPESCRIPT_STANDARD'
2022-03-16 11:21:57 -04:00
TYPESCRIPT_STYLE = 'ts-standard'
2021-11-12 11:25:32 -05:00
fi
2020-10-08 18:54:28 -04:00
##################
# Language array #
##################
2023-12-22 07:22:15 -05:00
LANGUAGE_ARRAY = ( 'ANSIBLE' 'ARM' 'BASH' 'BASH_EXEC' 'CHECKOV' 'CLANG_FORMAT'
2021-07-14 15:43:10 -04:00
'CLOUDFORMATION' 'CLOJURE' 'COFFEESCRIPT' 'CPP' 'CSHARP' 'CSS' 'DART'
2021-12-08 10:53:05 -05:00
'DOCKERFILE_HADOLINT' 'EDITORCONFIG' 'ENV' 'GITHUB_ACTIONS'
2023-12-16 03:30:33 -05:00
'GITLEAKS' 'GHERKIN' 'GO' 'GO_MODULES' 'GOOGLE_JAVA_FORMAT' 'GROOVY' 'HTML' 'JAVA'
2021-09-28 18:09:21 -04:00
'JAVASCRIPT_ES' " ${ JAVASCRIPT_STYLE_NAME } " 'JSCPD' 'JSON' 'JSONC' 'JSX'
2023-12-24 13:33:08 -05:00
'KUBERNETES_KUBECONFORM' 'KOTLIN' 'LATEX' 'LUA' 'MARKDOWN'
2022-03-28 09:55:45 -04:00
'NATURAL_LANGUAGE' 'OPENAPI' 'PERL' 'PHP_BUILTIN' 'PHP_PHPCS' 'PHP_PHPSTAN'
'PHP_PSALM' 'POWERSHELL' 'PROTOBUF' 'PYTHON_BLACK' 'PYTHON_PYLINT'
2023-09-12 12:58:09 -04:00
'PYTHON_FLAKE8' 'PYTHON_ISORT' 'PYTHON_MYPY' 'R' 'RAKU' 'RENOVATE' 'RUBY' 'RUST_2015'
2022-03-28 09:55:45 -04:00
'RUST_2018' 'RUST_2021' 'RUST_CLIPPY' 'SCALAFMT' 'SHELL_SHFMT'
'SNAKEMAKE_LINT' 'SNAKEMAKE_SNAKEFMT' 'STATES' 'SQL' 'SQLFLUFF' 'TEKTON'
2022-12-23 05:26:32 -05:00
'TERRAFORM_FMT' 'TERRAFORM_TFLINT' 'TERRAFORM_TERRASCAN' 'TERRAGRUNT' 'TSX'
2022-12-23 03:58:50 -05:00
'TYPESCRIPT_ES' " ${ TYPESCRIPT_STYLE_NAME } " 'XML' 'YAML' )
2020-07-21 09:12:28 -04:00
2020-10-08 18:54:28 -04:00
##############################
# Linter command names array #
##############################
declare -A LINTER_NAMES_ARRAY
2020-10-14 04:59:34 -04:00
LINTER_NAMES_ARRAY[ 'ANSIBLE' ] = "ansible-lint"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'ARM' ] = "arm-ttk"
LINTER_NAMES_ARRAY[ 'BASH' ] = "shellcheck"
LINTER_NAMES_ARRAY[ 'BASH_EXEC' ] = "bash-exec"
2023-12-22 07:22:15 -05:00
LINTER_NAMES_ARRAY[ 'CHECKOV' ] = "checkov"
2021-07-14 15:43:10 -04:00
LINTER_NAMES_ARRAY[ 'CLANG_FORMAT' ] = "clang-format"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'CLOJURE' ] = "clj-kondo"
LINTER_NAMES_ARRAY[ 'CLOUDFORMATION' ] = "cfn-lint"
LINTER_NAMES_ARRAY[ 'COFFEESCRIPT' ] = "coffeelint"
2021-05-04 14:24:41 -04:00
LINTER_NAMES_ARRAY[ 'CPP' ] = "cpplint"
2023-10-16 14:31:03 -04:00
LINTER_NAMES_ARRAY[ 'CSHARP' ] = "dotnet"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'CSS' ] = "stylelint"
LINTER_NAMES_ARRAY[ 'DART' ] = "dart"
LINTER_NAMES_ARRAY[ 'DOCKERFILE_HADOLINT' ] = "hadolint"
LINTER_NAMES_ARRAY[ 'EDITORCONFIG' ] = "editorconfig-checker"
LINTER_NAMES_ARRAY[ 'ENV' ] = "dotenv-linter"
2021-07-19 10:28:49 -04:00
LINTER_NAMES_ARRAY[ 'GITHUB_ACTIONS' ] = "actionlint"
2021-09-27 10:32:18 -04:00
LINTER_NAMES_ARRAY[ 'GITLEAKS' ] = "gitleaks"
2020-11-19 10:54:20 -05:00
LINTER_NAMES_ARRAY[ 'GHERKIN' ] = "gherkin-lint"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'GO' ] = "golangci-lint"
2023-12-16 03:30:33 -05:00
LINTER_NAMES_ARRAY[ 'GO_MODULES' ] = " ${ LINTER_NAMES_ARRAY [ 'GO' ] } "
2021-09-28 18:09:21 -04:00
LINTER_NAMES_ARRAY[ 'GOOGLE_JAVA_FORMAT' ] = "google-java-format"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'GROOVY' ] = "npm-groovy-lint"
LINTER_NAMES_ARRAY[ 'HTML' ] = "htmlhint"
LINTER_NAMES_ARRAY[ 'JAVA' ] = "checkstyle"
LINTER_NAMES_ARRAY[ 'JAVASCRIPT_ES' ] = "eslint"
2021-01-04 12:07:57 -05:00
LINTER_NAMES_ARRAY[ " ${ JAVASCRIPT_STYLE_NAME } " ] = " ${ JAVASCRIPT_STYLE } "
2021-01-27 14:47:34 -05:00
LINTER_NAMES_ARRAY[ 'JSCPD' ] = "jscpd"
2021-07-13 10:10:37 -04:00
LINTER_NAMES_ARRAY[ 'JSON' ] = "eslint"
2021-05-11 11:54:58 -04:00
LINTER_NAMES_ARRAY[ 'JSONC' ] = "eslint"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'JSX' ] = "eslint"
LINTER_NAMES_ARRAY[ 'KOTLIN' ] = "ktlint"
2022-12-07 23:24:36 -05:00
LINTER_NAMES_ARRAY[ 'KUBERNETES_KUBECONFORM' ] = "kubeconform"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'LATEX' ] = "chktex"
LINTER_NAMES_ARRAY[ 'LUA' ] = "lua"
LINTER_NAMES_ARRAY[ 'MARKDOWN' ] = "markdownlint"
2021-10-05 09:29:05 -04:00
LINTER_NAMES_ARRAY[ 'NATURAL_LANGUAGE' ] = "textlint"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'OPENAPI' ] = "spectral"
LINTER_NAMES_ARRAY[ 'PERL' ] = "perl"
LINTER_NAMES_ARRAY[ 'PHP_BUILTIN' ] = "php"
LINTER_NAMES_ARRAY[ 'PHP_PHPCS' ] = "phpcs"
LINTER_NAMES_ARRAY[ 'PHP_PHPSTAN' ] = "phpstan"
LINTER_NAMES_ARRAY[ 'PHP_PSALM' ] = "psalm"
LINTER_NAMES_ARRAY[ 'POWERSHELL' ] = "pwsh"
LINTER_NAMES_ARRAY[ 'PROTOBUF' ] = "protolint"
LINTER_NAMES_ARRAY[ 'PYTHON_BLACK' ] = "black"
LINTER_NAMES_ARRAY[ 'PYTHON_PYLINT' ] = "pylint"
LINTER_NAMES_ARRAY[ 'PYTHON_FLAKE8' ] = "flake8"
2020-10-28 11:22:55 -04:00
LINTER_NAMES_ARRAY[ 'PYTHON_ISORT' ] = "isort"
2021-03-24 15:00:23 -04:00
LINTER_NAMES_ARRAY[ 'PYTHON_MYPY' ] = "mypy"
2020-10-14 04:59:34 -04:00
LINTER_NAMES_ARRAY[ 'R' ] = "R"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'RAKU' ] = "raku"
2023-09-12 12:58:09 -04:00
LINTER_NAMES_ARRAY[ 'RENOVATE' ] = "renovate-config-validator"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'RUBY' ] = "rubocop"
2021-02-26 09:47:21 -05:00
LINTER_NAMES_ARRAY[ 'RUST_2015' ] = "rustfmt"
LINTER_NAMES_ARRAY[ 'RUST_2018' ] = "rustfmt"
2021-12-07 12:18:34 -05:00
LINTER_NAMES_ARRAY[ 'RUST_2021' ] = "rustfmt"
2021-03-08 15:13:04 -05:00
LINTER_NAMES_ARRAY[ 'RUST_CLIPPY' ] = "clippy"
2021-11-10 13:28:50 -05:00
LINTER_NAMES_ARRAY[ 'SCALAFMT' ] = "scalafmt"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'SHELL_SHFMT' ] = "shfmt"
LINTER_NAMES_ARRAY[ 'SNAKEMAKE_LINT' ] = "snakemake"
LINTER_NAMES_ARRAY[ 'SNAKEMAKE_SNAKEFMT' ] = "snakefmt"
LINTER_NAMES_ARRAY[ 'STATES' ] = "asl-validator"
LINTER_NAMES_ARRAY[ 'SQL' ] = "sql-lint"
2021-08-05 16:32:27 -04:00
LINTER_NAMES_ARRAY[ 'SQLFLUFF' ] = "sqlfluff"
2020-10-13 11:21:23 -04:00
LINTER_NAMES_ARRAY[ 'TEKTON' ] = "tekton-lint"
2022-12-23 03:58:50 -05:00
LINTER_NAMES_ARRAY[ 'TERRAFORM_FMT' ] = "terraform"
2021-08-30 10:47:50 -04:00
LINTER_NAMES_ARRAY[ 'TERRAFORM_TFLINT' ] = "tflint"
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'TERRAFORM_TERRASCAN' ] = "terrascan"
LINTER_NAMES_ARRAY[ 'TERRAGRUNT' ] = "terragrunt"
LINTER_NAMES_ARRAY[ 'TSX' ] = "eslint"
LINTER_NAMES_ARRAY[ 'TYPESCRIPT_ES' ] = "eslint"
2021-11-12 11:25:32 -05:00
LINTER_NAMES_ARRAY[ " ${ TYPESCRIPT_STYLE_NAME } " ] = " ${ TYPESCRIPT_STYLE } "
2020-10-08 18:54:28 -04:00
LINTER_NAMES_ARRAY[ 'XML' ] = "xmllint"
LINTER_NAMES_ARRAY[ 'YAML' ] = "yamllint"
2019-10-25 15:22:57 -04:00
##########################
# Array of changed files #
##########################
2020-10-02 17:02:47 -04:00
for LANGUAGE in " ${ LANGUAGE_ARRAY [@] } " ; do
FILE_ARRAY_VARIABLE_NAME = " FILE_ARRAY_ ${ LANGUAGE } "
debug " Setting ${ FILE_ARRAY_VARIABLE_NAME } variable... "
eval " ${ FILE_ARRAY_VARIABLE_NAME } =() "
done
2019-10-25 15:22:57 -04:00
2019-10-21 10:12:50 -04:00
################################################################################
2019-10-21 12:05:55 -04:00
########################## FUNCTIONS BELOW #####################################
2019-10-21 10:12:50 -04:00
################################################################################
################################################################################
2019-10-21 12:05:55 -04:00
#### Function Header ###########################################################
2020-07-01 17:40:40 -04:00
Header( ) {
2020-05-06 11:03:06 -04:00
###############################
# Give them the possum action #
###############################
2021-01-19 12:03:14 -05:00
if [ [ " ${ SUPPRESS_POSSUM } " = = "false" ] ] ; then
/bin/bash /action/lib/functions/possum.sh
fi
2020-05-06 11:03:06 -04:00
##########
# Prints #
##########
2020-07-30 16:39:05 -04:00
info "---------------------------------------------"
info "--- GitHub Actions Multi Language Linter ----"
2020-09-04 11:14:47 -04:00
info " - Image Creation Date:[ ${ BUILD_DATE } ] "
info " - Image Revision:[ ${ BUILD_REVISION } ] "
info " - Image Version:[ ${ BUILD_VERSION } ] "
2020-07-30 16:39:05 -04:00
info "---------------------------------------------"
info "---------------------------------------------"
info "The Super-Linter source code can be found at:"
2023-08-17 11:12:11 -04:00
info " - https://github.com/super-linter/super-linter"
2020-07-30 16:39:05 -04:00
info "---------------------------------------------"
2024-01-11 15:30:00 -05:00
if [ [ ${ VALIDATE_ALL_CODEBASE } != "false" ] ] ; then
VALIDATE_ALL_CODEBASE = "true"
info "- Validating all files in code base..."
else
info "- Validating changed files in code base..."
fi
2019-10-21 12:05:55 -04:00
}
2023-12-07 14:07:22 -05:00
ConfigureGitSafeDirectories( ) {
debug "Configuring Git safe directories"
declare -a git_safe_directories = ( " ${ GITHUB_WORKSPACE } " " ${ DEFAULT_SUPER_LINTER_WORKSPACE } " " ${ DEFAULT_WORKSPACE } " )
for safe_directory in " ${ git_safe_directories [@] } " ; do
debug " Set ${ safe_directory } as a Git safe directory "
if ! git config --global --add safe.directory " ${ safe_directory } " ; then
fatal " Cannot configure ${ safe_directory } as a Git safe directory. "
fi
done
}
2019-10-21 12:05:55 -04:00
################################################################################
2019-10-21 15:12:37 -04:00
#### Function GetGitHubVars ####################################################
2020-07-01 17:40:40 -04:00
GetGitHubVars( ) {
2019-10-21 15:12:37 -04:00
##########
# Prints #
##########
2020-07-30 16:39:05 -04:00
info "--------------------------------------------"
info "Gathering GitHub information..."
2019-10-21 15:12:37 -04:00
2020-07-21 13:09:07 -04:00
if [ [ ${ RUN_LOCAL } != "false" ] ] ; then
2023-12-07 14:07:22 -05:00
info " RUN_LOCAL has been set to: ${ RUN_LOCAL } . Bypassing GitHub Actions variables... "
2020-06-19 13:31:53 -04:00
2020-07-21 13:09:07 -04:00
if [ -z " ${ GITHUB_WORKSPACE } " ] ; then
GITHUB_WORKSPACE = " ${ DEFAULT_WORKSPACE } "
2020-06-19 13:31:53 -04:00
fi
2020-06-29 10:55:59 -04:00
2024-01-11 15:30:00 -05:00
ValidateGitHubWorkspace " ${ GITHUB_WORKSPACE } "
2020-07-06 17:57:30 -04:00
2023-11-05 00:29:52 -04:00
pushd " ${ GITHUB_WORKSPACE } " >/dev/null || exit 1
2020-01-09 11:29:18 -05:00
2023-12-07 14:07:22 -05:00
if [ [ " ${ USE_FIND_ALGORITHM } " = = "false" ] ] ; then
ConfigureGitSafeDirectories
debug " Initializing GITHUB_SHA considering ${ GITHUB_WORKSPACE } "
2024-01-30 02:48:24 -05:00
if ! GITHUB_SHA = $( git -C " ${ GITHUB_WORKSPACE } " rev-parse HEAD) ; then
2023-12-07 14:07:22 -05:00
fatal " Failed to initialize GITHUB_SHA. Output: ${ GITHUB_SHA } "
fi
debug " GITHUB_SHA: ${ GITHUB_SHA } "
else
debug "Skip the initalization of GITHUB_SHA because we don't need it"
fi
2023-12-14 15:22:49 -05:00
MULTI_STATUS = "false"
debug " Setting MULTI_STATUS to ${ MULTI_STATUS } because we are not running on GitHub Actions "
2019-10-21 15:12:37 -04:00
else
2024-01-11 15:30:00 -05:00
ValidateGitHubWorkspace " ${ GITHUB_WORKSPACE } "
2019-10-21 15:12:37 -04:00
2024-01-04 16:54:47 -05:00
# Ensure that Git can access the local repository
ConfigureGitSafeDirectories
2020-07-21 13:09:07 -04:00
if [ -z " ${ GITHUB_EVENT_PATH } " ] ; then
2024-01-04 16:54:47 -05:00
fatal " Failed to get GITHUB_EVENT_PATH: ${ GITHUB_EVENT_PATH } ] "
2020-01-09 11:29:18 -05:00
else
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_EVENT_PATH: ${ GITHUB_EVENT_PATH } ] "
2024-01-04 16:54:47 -05:00
debug " ${ GITHUB_EVENT_PATH } contents: $( cat " ${ GITHUB_EVENT_PATH } " ) "
2020-01-09 11:29:18 -05:00
fi
2019-10-21 15:12:37 -04:00
2023-12-04 04:47:49 -05:00
if [ -z " ${ GITHUB_SHA } " ] ; then
2024-01-04 16:54:47 -05:00
fatal " Failed to get GITHUB_SHA: ${ GITHUB_SHA } "
2023-12-04 04:47:49 -05:00
else
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_SHA: ${ GITHUB_SHA } "
2023-12-04 04:47:49 -05:00
fi
2020-01-09 11:29:18 -05:00
##################################################
# Need to pull the GitHub Vars from the env file #
##################################################
2020-09-05 06:25:44 -04:00
GITHUB_ORG = $( jq -r '.repository.owner.login' <" ${ GITHUB_EVENT_PATH } " )
2020-01-09 11:29:18 -05:00
2021-03-04 14:51:44 -05:00
# Github sha on PR events is not the latest commit.
# https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request
if [ " $GITHUB_EVENT_NAME " = = "pull_request" ] ; then
2024-01-04 16:54:47 -05:00
debug " This is a GitHub pull request. Updating the current GITHUB_SHA ( ${ GITHUB_SHA } ) to the pull request HEAD SHA "
2023-12-04 04:47:49 -05:00
2024-01-30 02:48:24 -05:00
if ! GITHUB_SHA = $( jq -r .pull_request.head.sha <" $GITHUB_EVENT_PATH " ) ; then
2024-01-04 16:54:47 -05:00
fatal " Failed to update GITHUB_SHA for pull request event: ${ GITHUB_SHA } "
2023-12-04 04:47:49 -05:00
fi
debug " Updated GITHUB_SHA: ${ GITHUB_SHA } "
2023-12-23 13:33:53 -05:00
elif [ " ${ GITHUB_EVENT_NAME } " = = "push" ] ; then
debug "This is a GitHub push event."
2024-01-05 17:07:39 -05:00
GITHUB_PUSH_COMMIT_COUNT = $( GetGithubPushEventCommitCount " $GITHUB_EVENT_PATH " )
if [ -z " ${ GITHUB_PUSH_COMMIT_COUNT } " ] ; then
fatal "Failed to get GITHUB_PUSH_COMMIT_COUNT"
2024-01-04 16:54:47 -05:00
fi
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_PUSH_COMMIT_COUNT: ${ GITHUB_PUSH_COMMIT_COUNT } "
2024-01-04 16:54:47 -05:00
2024-01-05 17:07:39 -05:00
# Ref: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
debug "Get the hash of the commit to start the diff from from Git because the GitHub push event payload may not contain references to base_ref or previous commit."
# shellcheck disable=SC2086 # We checked that GITHUB_PUSH_COMMIT_COUNT is an integer
2024-01-30 02:48:24 -05:00
if ! GITHUB_BEFORE_SHA = $( git -C " ${ GITHUB_WORKSPACE } " rev-parse HEAD~${ GITHUB_PUSH_COMMIT_COUNT } ) ; then
2023-12-23 13:33:53 -05:00
fatal " Failed to initialize GITHUB_BEFORE_SHA for a push event. Output: ${ GITHUB_BEFORE_SHA } "
fi
2024-01-05 17:07:39 -05:00
ValidateGitBeforeShaReference
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_BEFORE_SHA: ${ GITHUB_BEFORE_SHA } "
2021-03-04 14:51:44 -05:00
fi
2020-01-09 11:29:18 -05:00
############################
# Validate we have a value #
############################
2020-07-21 13:09:07 -04:00
if [ -z " ${ GITHUB_ORG } " ] ; then
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_ORG]!"
fatal " [ ${ GITHUB_ORG } ] "
2020-01-09 11:29:18 -05:00
else
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_ORG: ${ GITHUB_ORG } "
2020-01-09 11:29:18 -05:00
fi
#######################
# Get the GitHub Repo #
#######################
2020-09-05 06:25:44 -04:00
GITHUB_REPO = $( jq -r '.repository.name' <" ${ GITHUB_EVENT_PATH } " )
2020-01-09 11:29:18 -05:00
############################
# Validate we have a value #
############################
2020-07-21 13:09:07 -04:00
if [ -z " ${ GITHUB_REPO } " ] ; then
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_REPO]!"
fatal " [ ${ GITHUB_REPO } ] "
2020-01-09 11:29:18 -05:00
else
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_REPO: ${ GITHUB_REPO } "
2020-01-09 11:29:18 -05:00
fi
2019-10-21 15:12:37 -04:00
fi
2020-07-20 15:07:56 -04:00
2023-12-14 15:22:49 -05:00
if [ " ${ MULTI_STATUS } " = = "true" ] ; then
2020-07-20 15:07:56 -04:00
2023-12-14 15:22:49 -05:00
if [ [ ${ RUN_LOCAL } = = "true" ] ] ; then
# Safety check. This shouldn't occur because we forcefully set MULTI_STATUS=false above
# when RUN_LOCAL=true
fatal "Cannot enable status reports when running locally."
fi
if [ -z " ${ GITHUB_TOKEN } " ] ; then
fatal "Failed to get [GITHUB_TOKEN]. Terminating because status reports were explicitly enabled, but GITHUB_TOKEN was not provided."
else
2024-01-15 13:37:45 -05:00
info "Successfully found GITHUB_TOKEN."
2023-12-14 15:22:49 -05:00
fi
2020-07-20 15:07:56 -04:00
2020-07-21 13:09:07 -04:00
if [ -z " ${ GITHUB_REPOSITORY } " ] ; then
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_REPOSITORY]!"
fatal " [ ${ GITHUB_REPOSITORY } ] "
2020-07-20 15:07:56 -04:00
else
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_REPOSITORY: ${ GITHUB_REPOSITORY } "
2020-07-20 15:07:56 -04:00
fi
2020-07-21 13:09:07 -04:00
if [ -z " ${ GITHUB_RUN_ID } " ] ; then
2020-07-30 16:39:05 -04:00
error "Failed to get [GITHUB_RUN_ID]!"
fatal " [ ${ GITHUB_RUN_ID } ] "
2020-01-09 11:29:18 -05:00
else
2024-01-15 13:37:45 -05:00
info " Successfully found GITHUB_RUN_ID ${ GITHUB_RUN_ID } "
2020-01-09 11:29:18 -05:00
fi
2023-12-14 15:22:49 -05:00
else
debug " Skip GITHUB_TOKEN, GITHUB_REPOSITORY, and GITHUB_RUN_ID validation because we don't need these variables for GitHub Actions status reports. MULTI_STATUS: ${ MULTI_STATUS } "
2019-10-21 15:12:37 -04:00
fi
2024-01-30 14:24:55 -05:00
# We need this for parallel
export GITHUB_WORKSPACE
2020-04-27 13:21:38 -04:00
}
################################################################################
2020-07-20 15:07:56 -04:00
#### Function CallStatusAPI ####################################################
CallStatusAPI( ) {
####################
# Pull in the vars #
####################
2023-03-19 01:54:32 -04:00
LANGUAGE = " ${ 1 } " # language that was validated
2020-07-30 16:39:05 -04:00
STATUS = " ${ 2 } " # success | error
2020-07-20 15:07:56 -04:00
SUCCESS_MSG = 'No errors were found in the linting process'
FAIL_MSG = 'Errors were detected, please view logs'
2020-07-30 16:39:05 -04:00
MESSAGE = '' # Message to send to status API
2020-07-20 15:07:56 -04:00
2021-03-02 09:29:12 -05:00
debug " Calling Multi-Status API for $LANGUAGE with status $STATUS "
2020-07-20 15:07:56 -04:00
######################################
# Check the status to create message #
######################################
2020-07-21 13:09:07 -04:00
if [ " ${ STATUS } " = = "success" ] ; then
2020-07-20 15:07:56 -04:00
# Success
2020-07-21 13:09:07 -04:00
MESSAGE = " ${ SUCCESS_MSG } "
2020-07-20 15:07:56 -04:00
else
# Failure
2020-07-21 13:09:07 -04:00
MESSAGE = " ${ FAIL_MSG } "
2020-07-20 15:07:56 -04:00
fi
2020-07-21 11:13:15 -04:00
##########################################################
# Check to see if were enabled for multi Status mesaages #
##########################################################
2020-08-19 15:18:49 -04:00
if [ " ${ MULTI_STATUS } " = = "true" ] && [ -n " ${ GITHUB_TOKEN } " ] && [ -n " ${ GITHUB_REPOSITORY } " ] ; then
2020-09-03 19:37:10 -04:00
# make sure we honor DISABLE_ERRORS
if [ " ${ DISABLE_ERRORS } " = = "true" ] ; then
STATUS = "success"
fi
2023-12-04 04:47:49 -05:00
debug " Status URL: ${ GITHUB_API_URL } /repos/ ${ GITHUB_REPOSITORY } /statuses/ ${ GITHUB_SHA } "
2021-03-02 09:29:12 -05:00
2020-07-21 11:13:15 -04:00
##############################################
# Call the status API to create status check #
##############################################
2024-01-30 02:48:24 -05:00
if ! SEND_STATUS_CMD = $(
2022-09-28 09:45:01 -04:00
curl -f -s --show-error -X POST \
2020-09-15 01:44:55 -04:00
--url " ${ GITHUB_API_URL } /repos/ ${ GITHUB_REPOSITORY } /statuses/ ${ GITHUB_SHA } " \
-H 'accept: application/vnd.github.v3+json' \
-H " authorization: Bearer ${ GITHUB_TOKEN } " \
-H 'content-type: application/json' \
-d " { \"state\": \" ${ STATUS } \",
2023-07-05 18:00:11 -04:00
\" target_url\" : \" https://${ GITHUB_SERVER_URL } /${ GITHUB_REPOSITORY } /actions/runs/${ GITHUB_RUN_ID } \" ,
2020-07-21 13:09:07 -04:00
\" description\" : \" ${ MESSAGE } \" , \" context\" : \" --> Linted: ${ LANGUAGE } \"
2020-09-09 14:22:32 -04:00
} " 2>&1
2024-01-30 02:48:24 -05:00
) ; then
2023-12-05 03:04:13 -05:00
info " Failed to call GitHub Status API: ${ SEND_STATUS_CMD } "
2020-07-01 08:49:17 -04:00
fi
fi
}
2024-01-30 14:24:55 -05:00
2020-07-22 15:49:26 -04:00
Footer( ) {
2020-07-30 16:39:05 -04:00
info "----------------------------------------------"
info "----------------------------------------------"
2020-07-22 15:49:26 -04:00
2024-01-30 14:24:55 -05:00
local ANY_LINTER_SUCCESS
ANY_LINTER_SUCCESS = "false"
local SUPER_LINTER_EXIT_CODE
SUPER_LINTER_EXIT_CODE = 0
2020-07-21 09:23:32 -04:00
2020-07-01 17:40:40 -04:00
for LANGUAGE in " ${ LANGUAGE_ARRAY [@] } " ; do
2024-01-30 14:24:55 -05:00
# This used to be the count of errors found for a given LANGUAGE, but since
# after we switched to running linters against a batch of files, it may not
# represent the actual number of files that didn't pass the validation,
# but a number that's less than that because of how GNU parallel returns
# exit codes.
# Ref: https://www.gnu.org/software/parallel/parallel.html#exit-status
ERROR_COUNTER_FILE_PATH = " /tmp/super-linter-parallel-command-exit-code- ${ LANGUAGE } "
if [ ! -f " ${ ERROR_COUNTER_FILE_PATH } " ] ; then
debug " Error counter ${ ERROR_COUNTER_FILE_PATH } doesn't exist "
else
ERROR_COUNTER = $( <" ${ ERROR_COUNTER_FILE_PATH } " )
debug " ERROR_COUNTER for ${ LANGUAGE } : ${ ERROR_COUNTER } "
if [ [ ${ ERROR_COUNTER } -ne 0 ] ] ; then
error " Errors found in ${ LANGUAGE } "
CallStatusAPI " ${ LANGUAGE } " "error"
SUPER_LINTER_EXIT_CODE = 1
debug " Setting super-linter exit code to ${ SUPER_LINTER_EXIT_CODE } because there were errors for ${ LANGUAGE } "
elif [ [ ${ ERROR_COUNTER } -eq 0 ] ] ; then
notice " Successfully linted ${ LANGUAGE } "
2020-09-05 06:25:44 -04:00
CallStatusAPI " ${ LANGUAGE } " "success"
2024-01-30 14:24:55 -05:00
ANY_LINTER_SUCCESS = "true"
debug " Set ANY_LINTER_SUCCESS to ${ ANY_LINTER_SUCCESS } because ${ LANGUAGE } reported a success "
2020-09-05 06:25:44 -04:00
fi
2020-04-27 15:13:12 -04:00
fi
done
2024-01-30 14:24:55 -05:00
if [ [ " ${ ANY_LINTER_SUCCESS } " = = "true" ] ] && [ [ ${ SUPER_LINTER_EXIT_CODE } -ne 0 ] ] ; then
SUPER_LINTER_EXIT_CODE = 2
debug " There was at least one linter that reported a success. Setting the super-linter exit code to: ${ SUPER_LINTER_EXIT_CODE } "
fi
2020-07-21 13:09:07 -04:00
if [ " ${ DISABLE_ERRORS } " = = "true" ] ; then
2024-01-30 14:24:55 -05:00
warn " The super-linter exit code is ${ SUPER_LINTER_EXIT_CODE } . Forcibly setting it to 0 because DISABLE_ERRORS is set to: ${ DISABLE_ERRORS } "
SUPER_LINTER_EXIT_CODE = 0
2020-07-22 15:49:26 -04:00
fi
2024-01-30 14:24:55 -05:00
if [ [ ${ SUPER_LINTER_EXIT_CODE } -eq 0 ] ] ; then
notice "All files and directories linted successfully"
else
error "Super-linter detected linting errors"
fi
2020-07-22 15:49:26 -04:00
2024-01-30 14:24:55 -05:00
exit ${ SUPER_LINTER_EXIT_CODE }
2019-10-21 10:12:50 -04:00
}
2020-08-24 15:12:37 -04:00
################################################################################
2021-05-25 11:14:43 -04:00
#### Function UpdateLoopsForImage ##############################################
UpdateLoopsForImage( ) {
######################################################################
# Need to clean the array lists of the linters removed for the image #
######################################################################
if [ [ " ${ IMAGE } " = = "slim" ] ] ; then
#############################################
# Need to remove linters for the slim image #
#############################################
2021-12-07 12:18:34 -05:00
REMOVE_ARRAY = ( "ARM" "CSHARP" "ENV" "POWERSHELL" "RUST_2015" "RUST_2018"
"RUST_2021" "RUST_CLIPPY" )
2021-05-25 11:14:43 -04:00
# Remove from LANGUAGE_ARRAY
2024-01-15 13:37:45 -05:00
debug "Removing Languages from LANGUAGE_ARRAY for slim image..."
2021-05-25 11:14:43 -04:00
for REMOVE_LANGUAGE in " ${ REMOVE_ARRAY [@] } " ; do
for INDEX in " ${ !LANGUAGE_ARRAY[@] } " ; do
if [ [ ${ LANGUAGE_ARRAY [INDEX] } = " ${ REMOVE_LANGUAGE } " ] ] ; then
2024-01-15 13:37:45 -05:00
debug " found item:[ ${ REMOVE_LANGUAGE } ], removing Language... "
2021-05-25 11:14:43 -04:00
unset 'LANGUAGE_ARRAY[INDEX]'
fi
done
done
# Remove from LINTER_NAMES_ARRAY
2024-01-15 13:37:45 -05:00
debug "Removing Linters from LINTER_NAMES_ARRAY for slim image..."
2021-05-25 11:14:43 -04:00
for REMOVE_LINTER in " ${ REMOVE_ARRAY [@] } " ; do
for INDEX in " ${ !LINTER_NAMES_ARRAY[@] } " ; do
if [ [ ${ INDEX } = " ${ REMOVE_LINTER } " ] ] ; then
2024-01-15 13:37:45 -05:00
debug " found item:[ ${ REMOVE_LINTER } ], removing linter... "
2021-05-25 11:14:43 -04:00
unset 'LINTER_NAMES_ARRAY[$INDEX]'
fi
done
done
fi
}
2023-01-05 08:32:46 -05:00
2023-01-04 01:17:47 -05:00
# shellcheck disable=SC2317
2020-07-27 17:11:33 -04:00
cleanup( ) {
2020-07-30 16:39:05 -04:00
local -ri EXIT_CODE = $?
2024-01-10 04:06:04 -05:00
debug "Removing temporary files and directories"
rm -rfv \
" ${ GITHUB_WORKSPACE } /logback.log "
if [ " ${ SUPER_LINTER_COPIED_R_LINTER_RULES_FILE } " = = "true" ] ; then
debug " Deleting ${ R_RULES_FILE_PATH_IN_ROOT } because super-linter created it. "
rm -rfv " ${ R_RULES_FILE_PATH_IN_ROOT } "
fi
2023-12-05 03:04:13 -05:00
# Define this variable here so we can rely on it as soon as possible
2023-01-05 08:32:46 -05:00
local LOG_FILE_PATH = " ${ GITHUB_WORKSPACE } / ${ LOG_FILE } "
2023-12-05 03:04:13 -05:00
debug " LOG_FILE_PATH: ${ LOG_FILE_PATH } "
2023-01-05 08:32:46 -05:00
if [ " ${ CREATE_LOG_FILE } " = "true" ] ; then
2023-12-05 03:04:13 -05:00
debug " Moving log file from ${ LOG_TEMP } to ${ LOG_FILE_PATH } "
mv \
--force \
--verbose \
" ${ LOG_TEMP } " " ${ LOG_FILE_PATH } "
2023-01-05 08:32:46 -05:00
else
2023-12-05 03:04:13 -05:00
debug " Skipping the moving of the log file from ${ LOG_TEMP } to ${ LOG_FILE_PATH } "
2023-01-05 08:32:46 -05:00
fi
2020-07-27 17:11:33 -04:00
2023-01-04 01:17:47 -05:00
exit " ${ EXIT_CODE } "
2020-07-30 16:39:05 -04:00
trap - 0 1 2 3 6 14 15
2019-10-21 10:12:50 -04:00
}
2020-07-27 17:11:33 -04:00
trap 'cleanup' 0 1 2 3 6 14 15
2023-01-05 08:32:46 -05:00
2019-10-21 10:12:50 -04:00
################################################################################
2019-10-21 12:05:55 -04:00
############################### MAIN ###########################################
2019-10-21 10:12:50 -04:00
################################################################################
2019-10-21 12:05:55 -04:00
##########
# Header #
##########
Header
2022-02-09 16:24:57 -05:00
############################################
# Create SSH agent and add key if provided #
############################################
SetupSshAgent
SetupGithubComSshKeys
2021-05-25 11:14:43 -04:00
################################################
# Need to update the loops for the image style #
################################################
UpdateLoopsForImage
2020-11-02 16:39:34 -05:00
##################################
# Get and print all version info #
##################################
GetLinterVersions
2019-10-21 15:12:37 -04:00
#######################
2020-06-19 01:44:26 -04:00
# Get GitHub Env Vars #
2019-10-21 15:12:37 -04:00
#######################
2020-06-19 01:44:26 -04:00
# Need to pull in all the GitHub variables
2019-10-21 15:12:37 -04:00
# needed to connect back and update checks
GetGitHubVars
2023-12-07 14:07:22 -05:00
# Ensure that Git safe directories are configured because we don't do this in
# all cases when initializing variables
ConfigureGitSafeDirectories
2020-09-21 18:53:30 -04:00
########################################################
# Initialize variables that depend on GitHub variables #
########################################################
2023-12-02 03:35:41 -05:00
TYPESCRIPT_STANDARD_TSCONFIG_FILE = " ${ GITHUB_WORKSPACE } / ${ TYPESCRIPT_STANDARD_TSCONFIG_FILE :- "tsconfig.json" } "
debug " TYPESCRIPT_STANDARD_TSCONFIG_FILE: ${ TYPESCRIPT_STANDARD_TSCONFIG_FILE } "
2024-01-10 04:06:04 -05:00
R_RULES_FILE_PATH_IN_ROOT = " ${ GITHUB_WORKSPACE } / ${ R_FILE_NAME } "
debug " R_RULES_FILE_PATH_IN_ROOT: ${ R_RULES_FILE_PATH_IN_ROOT } "
2020-10-08 18:54:28 -04:00
############################
# Validate the environment #
############################
2023-12-07 14:07:22 -05:00
GetValidationInfo
2023-12-18 13:31:06 -05:00
if [ [ " ${ USE_FIND_ALGORITHM } " = = "false" ] ] || [ [ " ${ IGNORE_GITIGNORED_FILES } " = = "true" ] ] ; then
2023-12-04 04:47:49 -05:00
debug "Validate the local Git environment"
ValidateLocalGitRepository
ValidateGitShaReference
ValidateDefaultGitBranch
else
debug "Skipped the validation of the local Git environment because we don't depend on it."
fi
2023-12-24 11:56:15 -05:00
ValidateDeprecatedVariables
2021-06-10 14:09:24 -04:00
#################################
# Get the linter rules location #
#################################
LinterRulesLocation
2019-10-21 12:05:55 -04:00
########################
# Get the linter rules #
########################
2022-03-16 11:21:57 -04:00
LANGUAGE_ARRAY_FOR_LINTER_RULES = ( " ${ LANGUAGE_ARRAY [@] } " "TYPESCRIPT_STANDARD_TSCONFIG" )
for LANGUAGE in " ${ LANGUAGE_ARRAY_FOR_LINTER_RULES [@] } " ; do
2020-10-03 17:01:07 -04:00
debug " Loading rules for ${ LANGUAGE } ... "
2020-10-15 05:43:56 -04:00
eval " GetLinterRules ${ LANGUAGE } ${ DEFAULT_RULES_LOCATION } "
2020-10-03 17:01:07 -04:00
done
2020-02-03 11:27:40 -05:00
2023-12-02 03:35:41 -05:00
# Load rules for special cases
2020-10-08 18:54:28 -04:00
GetStandardRules "javascript"
2021-04-26 10:00:42 -04:00
#################################
# Check for SSL cert and update #
#################################
CheckSSLCert
2020-10-03 06:55:34 -04:00
###########################################
# Build the list of files for each linter #
###########################################
2023-12-24 11:56:15 -05:00
BuildFileList " ${ VALIDATE_ALL_CODEBASE } " " ${ TEST_CASE_RUN } "
2019-10-21 15:12:37 -04:00
2021-09-10 10:43:20 -04:00
#####################################
# Run additional Installs as needed #
#####################################
RunAdditionalInstalls
2020-10-15 07:07:01 -04:00
####################################
# Print ENV before running linters #
####################################
debug "--- ENV (before running linters) ---"
debug "------------------------------------"
debug "ENV:"
2024-01-30 14:24:55 -05:00
debug " $( printenv) "
2020-10-15 07:07:01 -04:00
debug "------------------------------------"
2020-10-15 06:38:38 -04:00
2023-12-12 14:57:15 -05:00
endGitHubActionsLogGroup " ${ SUPER_LINTER_INITIALIZATION_LOG_GROUP_TITLE } "
2024-01-30 14:24:55 -05:00
###############
# Run linters #
###############
declare PARALLEL_RESULTS_FILE_PATH
PARALLEL_RESULTS_FILE_PATH = "/tmp/super-linter-results.json"
debug " PARALLEL_RESULTS_FILE_PATH: ${ PARALLEL_RESULTS_FILE_PATH } "
2020-06-25 02:13:19 -04:00
2024-01-30 14:24:55 -05:00
declare -a PARALLEL_COMMAND
PARALLEL_COMMAND = ( parallel --will-cite --keep-order --max-procs " $(( $( nproc) * 1 )) " --xargs --results " ${ PARALLEL_RESULTS_FILE_PATH } " )
2020-08-17 08:01:25 -04:00
2024-01-30 14:24:55 -05:00
# Run one LANGUAGE per process. Each of these processes will run more processees in parellel if supported
PARALLEL_COMMAND += ( --max-lines 1)
2020-08-15 15:29:22 -04:00
2024-01-30 14:24:55 -05:00
if [ " ${ LOG_DEBUG } " = = "true" ] ; then
debug "LOG_DEBUG is enabled. Enable verbose ouput for parallel"
PARALLEL_COMMAND += ( --verbose)
fi
2020-06-25 02:13:19 -04:00
2024-01-30 14:24:55 -05:00
PARALLEL_COMMAND += ( "LintCodebase" "{}" " \" ${ TEST_CASE_RUN } \" " )
debug " PARALLEL_COMMAND: ${ PARALLEL_COMMAND [*] } "
2020-07-04 18:14:27 -04:00
2024-01-30 14:24:55 -05:00
PARALLEL_COMMAND_OUTPUT = $( printf "%s\n" " ${ LANGUAGE_ARRAY [@] } " | " ${ PARALLEL_COMMAND [@] } " 2>& 1)
PARALLEL_COMMAND_RETURN_CODE = $?
debug " PARALLEL_COMMAND_OUTPUT when running linters (exit code: ${ PARALLEL_COMMAND_RETURN_CODE } ):\n ${ PARALLEL_COMMAND_OUTPUT } "
debug " Parallel output file ( ${ PARALLEL_RESULTS_FILE_PATH } ) contents when running linters:\n $( cat " ${ PARALLEL_RESULTS_FILE_PATH } " ) "
RESULTS_OBJECT =
if ! RESULTS_OBJECT = $( jq -n '[inputs]' " ${ PARALLEL_RESULTS_FILE_PATH } " ) ; then
fatal " Error loading results when building the file list: ${ RESULTS_OBJECT } "
fi
debug " RESULTS_OBJECT when running linters:\n ${ RESULTS_OBJECT } "
# Get raw output so we can strip quotes from the data we load
if ! STDOUT_LINTERS = " $( jq --raw-output '.[].Stdout' <<< " ${ RESULTS_OBJECT } " ) " ; then
fatal " Error when loading stdout when running linters:\n ${ STDOUT_LINTERS } "
fi
if [ -n " ${ STDOUT_LINTERS } " ] ; then
info " Command output when running linters:\n------\n ${ STDOUT_LINTERS } \n------ "
else
debug "Stdout when running linters is empty"
fi
if ! STDERR_LINTERS = " $( jq --raw-output '.[].Stderr' <<< " ${ RESULTS_OBJECT } " ) " ; then
fatal " Error when loading stderr for ${ FILE_TYPE } :\n ${ STDERR_LINTERS } "
fi
if [ -n " ${ STDERR_LINTERS } " ] ; then
info " Command output for ${ FILE_TYPE } :\n------\n ${ STDERR_LINTERS } \n------ "
else
debug "Stderr when running linters is empty"
fi
if [ [ ${ PARALLEL_COMMAND_RETURN_CODE } -ne 0 ] ] ; then
fatal " Error when running linters. Exit code: ${ PARALLEL_COMMAND_RETURN_CODE } "
fi
2020-07-23 13:52:43 -04:00
2019-10-21 12:05:55 -04:00
##########
# Footer #
##########
Footer
