simplify command line by only allowing exactly one test argument

[Jean-Baptiste Lallement]

autopkgtest for a dkms module with autodep8.

Content of local control file:
'''
Test-Command: /non-existent
Restrictions: needs-root, allow-stderr
Depends: dkms
'''

This command fails (as expected)
adt-run -d --override-control=dkms/dkms.control asic0x --- qemu adt-vivid-amd64-cloud.img

But this command passes:
adt-run asic0x -d --override-control=dkms/dkms.control --- qemu adt-vivid-amd64-cloud.img

In the second case, the test uses the control file generated by autodep8 instead of the control file provided on the command line.

ProblemType: Bug
DistroRelease: Ubuntu 15.10
Package: autopkgtest 3.14
ProcVersionSignature: Ubuntu 3.19.0-16.16-generic 3.19.3
Uname: Linux 3.19.0-16-generic x86_64
ApportVersion: 2.17.2-0ubuntu1
Architecture: amd64
CurrentDesktop: Unity
Date: Sun May 10 11:03:40 2015
InstallationDate: Installed on 2013-09-03 (613 days ago)
InstallationMedia: Ubuntu 13.10 "Saucy Salamander" - Alpha amd64 (20130902)
PackageArchitecture: all
SourcePackage: autopkgtest
UpgradeStatus: No upgrade log present (probably fresh install)

[Martin Pitt (pitti)]

adt-run is designed to run an arbitrary number of tests on the command line; see the manpage:

    TEST OPTIONS
           Unless stated otherwise, these affect all subsequent test arguments.

    (-B, --built-binaries, --control-override)

For the record, I think that makes command line parsing and understanding unnecessarily complex and introduces this kind of positional dependency. But it has been adt-run's CLI interface since pretty much day one, so I'm a bit hesitant to change it. IIRC Rodney Dawes was complaining about this as well a while ago, subscribing him for his interest.

I retitle this to rearrange the CLI to only accept exactly one test, then the test modifications like --built-binaries, --control-override, or --click-source can occur anywhere.

[Jean-Baptiste Lallement (jibel)]

I understand but it is annoying for the case you're using the same configuration file for several packages and just want to change the name of the package.

For example, if the configuration file contains:
'''
-d
--override-control=control.override
---
qemu
adt-vivid-amd64-cloud.img
'''

And the user wants to specify the package on the command line, you have to use this order: adt-run <PACKAGE> @cfg
In this case adt uses the control file of the package instead of the override.

The other option is to change the configuration file to include the name of the package for each package.

[Vincent Ladeuil (vila)]

FWIW, I also felt into related traps and I have not encounter a use case for multiple test arguments. So +1 to have a single one.

[Martin Pitt (pitti)]

This is being developed in http://anonscm.debian.org/cgit/autopkgtest/autopkgtest.git/log/?h=one-action

[Launchpad Janitor (janitor)]

This bug was fixed in the package autopkgtest - 4.0+git1

---------------
autopkgtest (4.0+git1) yakkety; urgency=medium

  * Skip tests/autopkgtest NullRunner.test_apt_source_nonexisting test instead
    of failing if there are no deb-src apt sources configured on the host.

autopkgtest (4.0) unstable; urgency=medium

  * Add new "autopkgtest" CLI. This provides a simplified CLI compared to the
    now deprecated adt-run:
    - It accepts only exactly one tested source package, and gives a proper
      error if none or more than one (often unintend) is given
    - It defaults to the current directory if that is a Debian source package
    - The order of arguments is not relevant any more
    - Built vs. unbuilt tree is now automatically detected
    - The explicit --source, --click-source etc. options are gone, the type of
      tested source/binary packages is detected automatically
    - The virtualization server is now separated with a double instead of a
      tripe dash, as the former is standard Unix syntax.
    - The virtualization server must be specified with its "short" name only,
      e. g. "ssh" instead of "adt-virt-ssh".
    The old "adt-run" CLI will still be available for some time.
    (Closes: #795274, LP: #1453509)
  * Rename adt-build* tools to autopkgtest-build* and build images prefixed
    with"autopkgtest" instead of "adt". Keep compatibility symlink for the old
    commands, and when being called through them, also produce images with the
    old adt* names.
  * Rename public ADT_* env vars to AUTOPKGTEST_*:
    - AUTOPKGTEST_APT_PROXY
    - AUTOPKGTEST_ARTIFACTS
    - AUTOPKGTEST_AUTOPILOT_MODULE
    - AUTOPKGTEST_NORMAL_USER
    - AUTOPKGTEST_REBOOT_MARK
    - AUTOPKGTEST_TMP
    As these are being used in existing tests and tools, also export/check
    those under their old ADT_* name.

 -- Martin Pitt <email address hidden> Thu, 09 Jun 2016 08:12:49 +0200