spack/share/spack/qa/run-style-tests

#!/bin/bash -e
#
# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)

#
# Description:
#     Runs source code style checks on Spack.
#     See $SPACK_ROOT/.flake8 for a list of
#     approved exceptions.
#
# Usage:
#     run-flake8-tests
#
. "$(dirname "$0")/setup.sh"

args=()
if [[ -n $GITHUB_BASE_REF ]]; then
    args+=("--base" "${GITHUB_BASE_REF}")
else
    args+=("--base" "${GITHUB_REF_NAME}")
fi

# verify that the code style is correct
spack style --root-relative "${args[@]}"

# verify that the license headers are present
spack license verify
Separate integration tests; simplify test scripts (#4006) * Separate build integration tests; simplify test scripts - Move build tests out of the regular Travis unit tests, add more smoke test packages to build. - Run all test scripts with bash -e, which fails on error. - Factor coverage out into a Travis environment variable, so it's more obvious from .travis.yml which tests contribute to coverage and which don't. - Factor dependency checking and much of the front-matter in tests scripts into a setup.sh script, which is sourced by all the test scripts. Extra cruft in each tests script now reduced to 2 lines at the beginning. 2017-04-27 11:47:56 -07:00			`#!/bin/bash -e`
relicense: replace LGPL headers with Apache-2.0/MIT SPDX headers - remove the old LGPL license headers from all files in Spack - add SPDX headers to all files - core and most packages are (Apache-2.0 OR MIT) - a very small number of remaining packages are LGPL-2.1-only 2018-10-07 13:52:23 -07:00			`#`
Update copyright year to 2022 2022-01-12 11:21:41 -08:00			`# Copyright 2013-2022 Lawrence Livermore National Security, LLC and other`
relicense: replace LGPL headers with Apache-2.0/MIT SPDX headers - remove the old LGPL license headers from all files in Spack - add SPDX headers to all files - core and most packages are (Apache-2.0 OR MIT) - a very small number of remaining packages are LGPL-2.1-only 2018-10-07 13:52:23 -07:00			`# Spack Project Developers. See the top-level COPYRIGHT file for details.`
			`#`
			`# SPDX-License-Identifier: (Apache-2.0 OR MIT)`

Add run-flake8 script. - was missing the obvious. 2016-05-11 02:01:24 -07:00			`#`
Add generic changed_files script 2016-08-22 14:35:41 -05:00			`# Description:`
			`# Runs source code style checks on Spack.`
			`# See $SPACK_ROOT/.flake8 for a list of`
			`# approved exceptions.`
Add run-flake8 script. - was missing the obvious. 2016-05-11 02:01:24 -07:00			`#`
Add generic changed_files script 2016-08-22 14:35:41 -05:00			`# Usage:`
			`# run-flake8-tests`
			`#`
ci: run style unit tests only if we target develop (#27472) Some tests assume the base branch is develop, but this branch may not have been checked out. 2021-11-18 13:00:39 +01:00			`. "$(dirname "$0")/setup.sh"`
Add run-flake8 script. - was missing the obvious. 2016-05-11 02:01:24 -07:00
ci: run style unit tests only if we target develop (#27472) Some tests assume the base branch is develop, but this branch may not have been checked out. 2021-11-18 13:00:39 +01:00			`args=()`
			`if [[ -n $GITHUB_BASE_REF ]]; then`
			`args+=("--base" "${GITHUB_BASE_REF}")`
Fix execution of style tests 2021-12-23 16:34:31 +01:00			`else`
			`args+=("--base" "${GITHUB_REF_NAME}")`
bugfix: be careful about GITHUB_BASE_REF in `spack style` `spack style` previously used a Travis CI variable to figure out what the base branch of a PR was, and this was apparently also set on `develop`. We switched to `GITHUB_BASE_REF` to support GitHub Actions, but it looks like this is set to `""` in pushes to develop, so `spack style` breaks there. This PR does two things: - [x] Remove `GITHUB_BASE_REF` knowledge from `spack style` entirely - [x] Handle `GITHUB_BASE_REF` in style scripts instead, and explicitly pass the base ref if it is present, but don't otherwise. This makes `spack style` not dependent on the environment and fixes handling of the base branch in the right place. 2021-07-27 15:09:19 -07:00			`fi`

relicense: add `spack license` command - `spack license list-files`: list all files that should have license headers - `spack license list-lgpl`: list files still under LGPL-2.1 - `spack license verify`: check that license headers are correct - Added `spack license verify` to style tests 2018-10-07 21:59:04 -07:00			`# verify that the code style is correct`
ci: run style unit tests only if we target develop (#27472) Some tests assume the base branch is develop, but this branch may not have been checked out. 2021-11-18 13:00:39 +01:00			`spack style --root-relative "${args[@]}"`
relicense: add `spack license` command - `spack license list-files`: list all files that should have license headers - `spack license list-lgpl`: list files still under LGPL-2.1 - `spack license verify`: check that license headers are correct - Added `spack license verify` to style tests 2018-10-07 21:59:04 -07:00
			`# verify that the license headers are present`
			`spack license verify`