Read configuration from debian/tests/autopkgtest-pkg-${type}.conf

For Python packages, specifying the module name to be imported via
debian/tests/pkg-python/import-name is now deprecated and will generate
a warning.

Gbp-DCh: full

Author: terceiro

Makefile

@@ -1,19 +1,20 @@
 PREFIX ?= /usr/local
-install_support = $(filter-out install-common,$(patsubst support/%, install-%, $(wildcard support/*)))
+install_support = $(filter-out install-common install-autodep8lib.sh,$(patsubst support/%, install-%, $(wildcard support/*)))
 
 all: autodep8.1
 
 autodep8.1: autodep8.pod
 	pod2man --verbose --name autodep8 -c '' -r '' --utf8 $< $@ || ($(RM) $@; false)
 
 autodep8.pod: README.md examples.md
-	(sed -e '/examples.md/ r examples.md' README.md | sed -e '/examples.md/d; s/^##/=head2/; s/^#/=head1/; s/\*\*\([^\*]*\)\*\*/B<\1>/g; s/\*\([^\*]*\)\*/I<\1>/g; ' > $@) || ($(RM) $@; false)
+	(sed -e '/examples.md/ r examples.md' README.md | sed -e '/examples.md/d; /```/,/```/ s/^/    /; /```/d; s/^##/=head2/; s/^#/=head1/; s/\*\*\([^\*]*\)\*\*/B<\1>/g; s/\*\([^\*]*\)\*/I<\1>/g' > $@) || ($(RM) $@; false)
 
 update-examples:
 	sh examples.sh > examples.md
 
 install: $(install_support)
 	install -m 644 support/common $(DESTDIR)/$(PREFIX)/share/autodep8/support
+	install -m 644 support/autodep8lib.sh $(DESTDIR)/$(PREFIX)/share/autodep8/support
 	install -d $(DESTDIR)/$(PREFIX)/bin
 	install -m 755 autodep8 $(DESTDIR)/$(PREFIX)/bin
 	install -d $(DESTDIR)/$(PREFIX)/share/man/man1

README.md

@@ -37,14 +37,39 @@ each supported package type is tried against a set of heuristics, based on
 packages names, build dependencies. specific files under debian/, or a
 combination of those.
 
-# NOTES ABOUT SOME PACKAGE TYPES
+# PACKAGE-SPECIFIC CONFIGURATION
 
-## PYTHON PACKAGES
+Packages can provide configuration for **autodep8** in
+*debian/tests/autopkgtest-pkg-${PACKAGETYPE}.conf*. The file format is the the
+following:
 
-If the module name to be imported cannot be inferred from the name of the
-Debian package, put it in `debian/tests/pkg-python/import-name`. For
-example, `python3-xlib` is used via `import Xlib`, so
-`echo Xlib > debian/tests/pkg-python/import-name` would be appropriate.
+```
+# comment lines start with # and are ignored.
+# note that #'s only mark comments when in the beginning of the line
+# empty lines are also ignored
+
+# values are set in this format:
+var1=value1
+
+# spaces around the = sign are allowed
+var2 = value 2
+
+# backslashes allow one to set values that span multiple lines.
+# Note that the newline is removed in the final value, though
+# The following is equivalent to "multiline=value1, value2"
+variable = value1, \
+value2
+```
+
+The following configuration variables are supported:
+
+## python (debian/tests/autopkgtest-pkg-python.conf)
+
+**import_name**: name of the module to import, if it cannot be inferred from
+the name of the Debian package. For example, `python3-xlib` is used via `import
+Xlib`, so `import_name = Xlib` would be appropriate.  This used to be
+configured by writing to `debian/tests/pkg-python/import-name`, but that is now
+deprecated.
 
 # COMBINING AUTO-GENERATED TESTS WITH MANUALLY SPECIFIED ONES
 

autodep8

@@ -63,11 +63,14 @@ case "${program_path}" in
     ;;
 esac
 
+. "${support_dir}"/autodep8lib.sh
+
 for packagedir in $(find $support_dir -mindepth 1 -type d | LC_ALL=C.UTF-8 sort); do
   packagetype=$(basename $packagedir)
   if detect_by_control_field $packagetype ||
     detect_by_source_contents "$packagedir"
   then
+    read_config $packagetype
     $support_dir/$packagetype/generate
     exit 0
   fi

support/autodep8lib.sh

@@ -0,0 +1,22 @@
+read_config() {
+  packagetype="${1}"
+  config="debian/tests/autopkgtest-pkg-${packagetype}.conf"
+  [ ! -f "${config}" ] && return
+
+  tmpfile="$(mktemp)"
+  sed -e '
+    /^\s*#/d;                   # remove comment lines
+    /^\s*$/d;                   # remove empty lines
+    { :a /\\$/N; s/\\\n//; ta } # fold lines ending with backslash into next
+  ' "${config}" > "${tmpfile}"
+  while read line; do
+    conf="$(echo "$line" | sed -e 's/\s*=\s*/=/')" # remove spaces around first =
+    if echo "${conf}" | grep -q '^[a-zA-Z_][a-zA-Z_0-9]*='; then
+      export "pkg_${packagetype}_${conf}"
+      echo "$conf"
+    else
+      echo "W: ${config}: invalid configuration line: ${line} (ignored)" >&2
+    fi
+  done < "${tmpfile}"
+  rm -f "${tmpfile}"
+}

support/python/generate

@@ -60,7 +60,10 @@ fi
 
 module=$(echo "$module" | sed 's/-/_/g')
 
-if [ -e debian/tests/pkg-python/import-name ]; then
+if [ -n "${pkg_python_import_name:-}" ]; then
+    module="${pkg_python_import_name}"
+elif [ -e debian/tests/pkg-python/import-name ]; then
+    echo "W: using debian/tests/pkg-python/import-name is deprecated; please set \`import_name\` in debian/tests/autopkgtest-pkg-python.conf instead." >&2
     module=$(perl -ne 'next if /^\s*(#|$)/; print; last;' debian/tests/pkg-python/import-name)
 fi
 

test/autodep8lib_test.sh

@@ -0,0 +1,80 @@
+. $(dirname $0)/helper.sh
+. "${AUTODEP8_SUPPORT_DIR}/autodep8lib.sh"
+
+run_read_config() {
+  has debian/tests/autopkgtest-pkg-ruby.conf "$@"
+  check_run read_config ruby
+}
+
+assertInvalidConfig() {
+  assertEquals "W: debian/tests/autopkgtest-pkg-ruby.conf: invalid configuration line: ${1} (ignored)" "$(cat stderr)"
+}
+
+test_no_config() {
+  check_run read_config ruby
+  assertEquals "" "$(cat stdout)"
+  assertEquals "" "$(cat stderr)"
+}
+
+test_read_config_valid() {
+  run_read_config 'foo=bar'
+  assertEquals "foo=bar" "$(cat stdout)"
+}
+
+test_read_config_invalid_single_word() {
+  run_read_config 'foo'
+  assertEquals "" "$(cat stdout)"
+  assertInvalidConfig foo
+}
+
+test_read_config_invalid_no_assignment() {
+  run_read_config 'foo bar'
+  assertEquals "" "$(cat stdout)"
+  assertInvalidConfig 'foo bar'
+}
+
+test_read_config_invalid_variable() {
+  run_read_config 'foo bar=baz'
+  assertEquals "" "$(cat stdout)"
+  assertInvalidConfig 'foo bar=baz'
+}
+
+test_read_config_invalid_variable_an_whitespace() {
+  run_read_config 'foo bar = baz'
+  assertEquals "" "$(cat stdout)"
+  assertInvalidConfig 'foo bar = baz'
+}
+
+test_read_config_invalid_command_injection() {
+  run_read_config '/bin/sh -c "poweroff"'
+  assertEquals "" "$(cat stdout)"
+  assertInvalidConfig '/bin/sh -c "poweroff"'
+}
+
+test_read_config_remove_comments() {
+  run_read_config '# comment\nfoo=bar\n# more comments'
+  assertEquals "foo=bar" "$(cat stdout)"
+  assertEquals "" "$(cat stderr)"
+}
+
+test_read_config_multiline() {
+  run_read_config 'foo=bar \\\nbaz'
+  assertEquals "foo=bar baz" "$(cat stdout)"
+}
+
+test_read_config_remove_whitespace_around_equals() {
+  run_read_config 'foo = bar'
+  assertEquals 'foo=bar' "$(cat stdout)"
+}
+
+test_read_config_remove_whitespace_multiple_equals() {
+  run_read_config 'foo = bar = baz'
+  assertEquals 'foo=bar = baz' "$(cat stdout)"
+}
+
+test_read_config_exports_variables() {
+  run_read_config 'foo=bar'
+  assertEquals "bar" "${pkg_ruby_foo}"
+}
+
+. shunit2

test/doc_test.sh

@@ -1,5 +1,5 @@
 test_updated_examples() {
-  for pkgtype in $(ls --ignore=common -1 support/); do
+  for pkgtype in $(ls --ignore=common --ignore=autodep8lib.sh -1 support/); do
     assertTrue "missing example for $pkgtype in examples.md; update examples.in and run \`make update-examples\`" "grep '^## $pkgtype' examples.md"
   done
 }

test/helper.sh

@@ -1,6 +1,9 @@
 if [ -z "$AUTOPKGTEST_TMP" ]; then
   # only use local binaries if not testing the instaled package
   export PATH="$(readlink -f $(dirname $0))/..:$PATH"
+  export AUTODEP8_SUPPORT_DIR=$(dirname $0)/../support
+else
+  export AUTODEP8_SUPPORT_DIR="/usr/share/autodep8/support"
 fi
 
 run() {

test/python_test.sh

@@ -24,6 +24,17 @@ test_python_unusual_name_py3() {
   assertFalse 'not using wrong name' 'grep --quiet "import foo;" stdout'
   assertFalse 'dont have py2 test' 'grep --quiet "pyversions" stdout'
   assertTrue 'have py3 test' 'grep --quiet "py3versions" stdout'
+  assertTrue 'grep "W:.*deprecated" stderr'
+}
+
+test_python_unusual_name_py3_via_config() {
+  has 'debian/control' 'Source: python-foo\n\nPackage:python3-foo'
+  has 'debian/tests/autopkgtest-pkg-python.conf' 'import_name = Foo'
+  check_run autodep8
+  assertTrue 'get upstream name' 'grep --quiet "import Foo;" stdout'
+  assertFalse 'not using wrong name' 'grep --quiet "import foo;" stdout'
+  assertFalse 'dont have py2 test' 'grep --quiet "pyversions" stdout'
+  assertTrue 'have py3 test' 'grep --quiet "py3versions" stdout'
 }
 
 test_python_underscore_py3() {