[pacman-dev] [PATCH] libmakepkg: Add basic rules to lint makepkg.conf variables

[Allan McRae]

On 09/03/18 13:47, Eli Schwartz wrote:
> Currently the only things we check are:
> 
> - Things that should be arrays, are not strings, and vice versa (this
>   was mostly copy-pasted from the similar code in lint_pkgbuild).
> - Variables that are meant to contain pathname components cannot contain
>   a newline character, because newline characters in pathnames are weird
>   and also don't play well with future changes intended for the
>   --packagelist option.
> 
> Signed-off-by: Eli Schwartz <eschwartz at archlinux.org>
> ---
> 
> v3: rm useless logging message
> 
>  scripts/Makefile.am                           |  4 ++
>  scripts/libmakepkg/lint_config.sh.in          | 46 +++++++++++++++++++
>  scripts/libmakepkg/lint_config/paths.sh.in    | 46 +++++++++++++++++++
>  scripts/libmakepkg/lint_config/variable.sh.in | 64 +++++++++++++++++++++++++++
>  scripts/makepkg.sh.in                         |  4 ++
>  5 files changed, 164 insertions(+)
>  create mode 100755 scripts/libmakepkg/lint_config.sh.in
>  create mode 100644 scripts/libmakepkg/lint_config/paths.sh.in
>  create mode 100644 scripts/libmakepkg/lint_config/variable.sh.in
> 
> diff --git a/scripts/Makefile.am b/scripts/Makefile.am
> index 8cf79f21..7fe169b3 100644
> --- a/scripts/Makefile.am
> +++ b/scripts/Makefile.am
> @@ -44,6 +44,7 @@ libmakepkgdir = $(datarootdir)/makepkg
>  
>  LIBMAKEPKGDIRS = \
>  	integrity \
> +	lint_config \
>  	lint_package \
>  	lint_pkgbuild \
>  	source \
> @@ -56,6 +57,9 @@ LIBMAKEPKG_IN = \
>  	libmakepkg/integrity/generate_signature.sh \
>  	libmakepkg/integrity/verify_checksum.sh \
>  	libmakepkg/integrity/verify_signature.sh \
> +	libmakepkg/lint_config.sh \
> +	libmakepkg/lint_config/paths.sh \
> +	libmakepkg/lint_config/variable.sh \
>  	libmakepkg/lint_package.sh \
>  	libmakepkg/lint_package/build_references.sh \
>  	libmakepkg/lint_package/dotfiles.sh \
> diff --git a/scripts/libmakepkg/lint_config.sh.in b/scripts/libmakepkg/lint_config.sh.in
> new file mode 100755
> index 00000000..bad68bcb
> --- /dev/null
> +++ b/scripts/libmakepkg/lint_config.sh.in
> @@ -0,0 +1,46 @@
> +#!/usr/bin/bash
> +#
> +#   lint_config.sh - functions for checking for makepkg.conf errors
> +#
> +#   Copyright (c) 2018 Pacman Development Team <pacman-dev at archlinux.org>
> +#
> +#   This program is free software; you can redistribute it and/or modify
> +#   it under the terms of the GNU General Public License as published by
> +#   the Free Software Foundation; either version 2 of the License, or
> +#   (at your option) any later version.
> +#
> +#   This program is distributed in the hope that it will be useful,
> +#   but WITHOUT ANY WARRANTY; without even the implied warranty of
> +#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +#   GNU General Public License for more details.
> +#
> +#   You should have received a copy of the GNU General Public License
> +#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
> +#
> +
> +[[ -n "$LIBMAKEPKG_LINT_CONFIG_SH" ]] && return
> +LIBMAKEPKG_LINT_CONFIG_SH=1
> +
> +LIBRARY=${LIBRARY:-'/usr/share/makepkg'}
> +
> +source "$LIBRARY/util/message.sh"
> +source "$LIBRARY/util/util.sh"
> +
> +
> +declare -a lint_config_functions
> +
> +for lib in "$LIBRARY/lint_config/"*.sh; do
> +	source "$lib"
> +done
> +
> +readonly -a lint_config_functions
> +
> +
> +lint_config() {
> +	local ret=0
> +
> +	for func in ${lint_config_functions[@]}; do
> +		$func || ret=1
> +	done
> +	return $ret
> +}
> diff --git a/scripts/libmakepkg/lint_config/paths.sh.in b/scripts/libmakepkg/lint_config/paths.sh.in
> new file mode 100644
> index 00000000..c75765ff
> --- /dev/null
> +++ b/scripts/libmakepkg/lint_config/paths.sh.in
> @@ -0,0 +1,46 @@
> +#!/bin/bash
> +#
> +#   paths.sh - Check that pathname components do not contain odd characters
> +#
> +#   Copyright (c) 2018 Pacman Development Team <pacman-dev at archlinux.org>
> +#
> +#   This program is free software; you can redistribute it and/or modify
> +#   it under the terms of the GNU General Public License as published by
> +#   the Free Software Foundation; either version 2 of the License, or
> +#   (at your option) any later version.
> +#
> +#   This program is distributed in the hope that it will be useful,
> +#   but WITHOUT ANY WARRANTY; without even the implied warranty of
> +#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +#   GNU General Public License for more details.
> +#
> +#   You should have received a copy of the GNU General Public License
> +#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
> +#
> +
> +[[ -n "$LIBMAKEPKG_LINT_CONFIG_PATHS_SH" ]] && return
> +LIBMAKEPKG_LINT_CONFIG_PATHS_SH=1
> +
> +LIBRARY=${LIBRARY:-'@libmakepkgdir@'}
> +
> +source "$LIBRARY/util/message.sh"
> +source "$LIBRARY/util/pkgbuild.sh"
> +
> +lint_config_functions+=('lint_variable')

s/lint_variable/lint_paths/

> +
> +
> +lint_paths() {
> +	local pathvars=(BUILDDIR PKGDEST SRCDEST SRCPKGDEST LOGDEST PKGEXT SRCEXT)
> +

Because of that error, none of these checks work...   So another great
bit of testing before submission!

A