Plugin interfaces: proposal for a better module name and location

Avocado currently does not define a set of APIs for plugin writers.
It's well understood that anyone writing plugins is really playing
under the hoods of core Avocado.

Because there's no such module namespace allocated for that purpose
alone (say, `avocado.plugin`) it was decided to put plugin interfaces
together with the "core plugin repository", that is the
"avocado/plugins" directory.  By no means the contents of
"avocado/plugins/", that is, the plugin implementations themselves,
need be the "avocado.plugins" module, it could just as well live in
"avocado-core-plugins" directory or repository.  This is also well
exemplified by the avocado-vt and avocado-virt plugins, which live in
completely separate repositories.

So, the first goal of these changes are, effectively, to make all
plugin implementations equal, always referring to
`avocado.core.plugins_interface`.  Then, the secondary goal is to pave
the way for a specific namespace to contain only the interfaces (which
should be non-core) which plugin writers should rely on.
Signed-off-by: NCleber Rosa <crosa@redhat.com>

avocado/plugins/config.py

@@ -15,10 +15,9 @@
 import logging
 
 from avocado.core import data_dir
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.core.settings import settings
 
-from .base import CLICmd
-
 
 class Config(CLICmd):
 

avocado/plugins/distro.py

@@ -19,12 +19,11 @@ import os
 import sys
 
 from avocado.core import exit_codes
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.utils import distro as utils_distro
 from avocado.utils import path as utils_path
 from avocado.utils import process
 
-from .base import CLICmd
-
 
 class SoftwarePackage(object):
 

avocado/plugins/exec_path.py

@@ -19,8 +19,7 @@ import os
 import sys
 
 from avocado.core import exit_codes
-
-from .base import CLICmd
+from avocado.core.plugin_interfaces import CLICmd
 
 
 class ExecPath(CLICmd):

avocado/plugins/gdb.py

@@ -14,8 +14,8 @@
 
 """Run tests with GDB goodies enabled."""
 
-from .base import CLI
 from avocado.core import exceptions
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.settings import settings
 from avocado.utils import gdb
 from avocado.utils import process

avocado/plugins/html.py

@@ -21,8 +21,7 @@ import sys
 from avocado.core import exit_codes
 from avocado.core.html import HTMLTestResult
 from avocado.core.result import register_test_result_class
-
-from .base import CLI
+from avocado.core.plugin_interfaces import CLI
 
 
 class HTML(CLI):

avocado/plugins/jobscripts.py

 import os
 import logging
 
-from avocado.utils import process
+from avocado.core.plugin_interfaces import JobPre, JobPost
 from avocado.core.settings import settings
-from avocado.plugins.base import JobPre, JobPost
+from avocado.utils import process
 
 
 CONFIG_SECTION = 'plugins.jobscripts'

avocado/plugins/journal.py

@@ -18,7 +18,7 @@ import os
 import sqlite3
 import datetime
 
-from .base import CLI
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.result import TestResult
 from avocado.core.result import register_test_result_class
 

avocado/plugins/json.py

@@ -17,10 +17,9 @@ JSON output module.
 """
 
 from avocado.core.jsonresult import JSONTestResult
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.result import register_test_result_class
 
-from .base import CLI
-
 
 class JSON(CLI):
 

avocado/plugins/list.py

@@ -15,13 +15,13 @@
 import logging
 import sys
 
+
 from avocado.core import exit_codes, output
 from avocado.core import loader
 from avocado.core import test
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.utils import astring
 
-from .base import CLICmd
-
 
 class TestLister(object):
 

avocado/plugins/multiplex.py

@@ -18,10 +18,9 @@ import sys
 from avocado.core import exit_codes, output
 from avocado.core import multiplexer
 from avocado.core import tree
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.core.settings import settings
 
-from .base import CLICmd
-
 
 class Multiplex(CLICmd):
 

avocado/plugins/plugins.py

@@ -18,10 +18,9 @@ Plugins information plugin
 import logging
 
 from avocado.core import dispatcher
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.utils import astring
 
-from .base import CLICmd
-
 
 class Plugins(CLICmd):
 

avocado/plugins/remote.py

@@ -20,12 +20,11 @@ import sys
 
 from avocado.core import exit_codes
 from avocado.core import remoter
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.remote import RemoteTestResult
 from avocado.core.remote import RemoteTestRunner
 from avocado.core.result import register_test_result_class
 
-from .base import CLI
-
 
 class Remote(CLI):
 

avocado/plugins/replay.py

@@ -17,10 +17,10 @@ import logging
 import os
 import sys
 
-from .base import CLI
+from avocado.core import exit_codes
 from avocado.core import replay
 from avocado.core import status
-from avocado.core import exit_codes
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.settings import settings
 
 

avocado/plugins/run.py

@@ -24,10 +24,9 @@ from avocado.core import exit_codes
 from avocado.core import job
 from avocado.core import loader
 from avocado.core import multiplexer
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.core.settings import settings
 
-from .base import CLICmd
-
 
 class Run(CLICmd):
 

avocado/plugins/sysinfo.py

@@ -15,7 +15,7 @@
 System information plugin
 """
 
-from .base import CLICmd
+from avocado.core.plugin_interfaces import CLICmd
 from avocado.core import sysinfo
 
 

avocado/plugins/vm.py

@@ -20,12 +20,11 @@ import sys
 
 from avocado.core import exit_codes
 from avocado.core import virt
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.remote import VMTestResult
 from avocado.core.remote import VMTestRunner
 from avocado.core.result import register_test_result_class
 
-from .base import CLI
-
 
 class VM(CLI):
 

avocado/plugins/wrapper.py

@@ -17,10 +17,9 @@ import os
 import sys
 
 from avocado.core import exit_codes
+from avocado.core.plugin_interfaces import CLI
 from avocado.utils import process
 
-from .base import CLI
-
 
 class Wrapper(CLI):
 

avocado/plugins/xunit.py

@@ -14,9 +14,9 @@
 
 """xUnit module."""
 
+from avocado.core.plugin_interfaces import CLI
 from avocado.core.result import register_test_result_class
 from avocado.core.xunit import xUnitTestResult
-from .base import CLI
 
 
 class XUnit(CLI):