Merge ~sylvain-pineau/checkbox-ng:launchpad_transport_removal into checkbox-ng:master

[Sylvain Pineau]

We still have the ability to submit results to lp. This endpoint is never used in practice. Let's stop bundling this entry point in checkbox-ng.

Note we should also fix the packaging to remove checkbox-support.

[Pierre Equoy (pieq)]

+1

Less code is better code!

(Do you have a separate MR for the packaging part?)

review: Approve

[Sylvain Pineau (sylvain-pineau)]

The MR for packaging: https://code.launchpad.net/~checkbox-dev/checkbox-ng/+git/packaging/+merge/308990

review: Approve

diff --git a/checkbox_ng/commands/newcli.py b/checkbox_ng/commands/newcli.py
index eeb781c..8d359c0 100644
--- a/checkbox_ng/commands/newcli.py
+++ b/checkbox_ng/commands/newcli.py
@@ -415,51 +415,6 @@ class CliInvocation2(RunInvocation):
                     # Automatically try to submit results if the secure_id is
                     # valid
                     self.submit_certification_results()
-            elif self.launcher.submit_to == 'launchpad':
-                if self.config.email_address is Unset:
-                    again = True
-                    if not self.is_interactive:
-                        again = False
-                    while again:
-                        if self.ask_for_confirmation(
-                                _("\nSubmit results to launchpad.net/+hwdb?")):
-                            self.config.email_address = input(
-                                _("Email address: "))
-                            again = False
-                            self.submit_launchpad_results()
-                        else:
-                            again = False
-                else:
-                    # Automatically try to submit results if the email_address
-                    # is valid
-                    self.submit_launchpad_results()
-
-    def submit_launchpad_results(self):
-        transport_cls = get_all_transports().get('launchpad')
-        options_string = "field.emailaddress={}".format(
-            self.config.email_address)
-        transport = transport_cls(self.config.lp_url, options_string)
-        # TRANSLATORS: Do not translate the {} format markers.
-        print(_("Submitting results to {0} for email_address {1}").format(
-            self.config.lp_url, self.config.email_address))
-        with open(self.submission_file, encoding='utf-8') as stream:
-            try:
-                # NOTE: don't pass the file-like object to this transport
-                json = transport.send(
-                    stream.read(),
-                    self.config,
-                    session_state=self.manager.state)
-                if json.get('url'):
-                    # TRANSLATORS: Do not translate the {} format marker.
-                    print(_("Submission uploaded to: {0}".format(json['url'])))
-                elif json.get('status'):
-                    print(json['status'])
-                else:
-                    # TRANSLATORS: Do not translate the {} format marker.
-                    print(
-                        _("Bad response from {0} transport".format(transport)))
-            except TransportError as exc:
-                print(str(exc))
 
     def submit_certification_results(self):
         from checkbox_ng.certification import InvalidSecureIDError
diff --git a/checkbox_ng/config.py b/checkbox_ng/config.py
index 92ded84..7107dc0 100644
--- a/checkbox_ng/config.py
+++ b/checkbox_ng/config.py
@@ -50,23 +50,12 @@ class CheckBoxConfig(PlainBoxConfig):
         help_text=_("Whether to also send the submission data to HEXR"),
         kind=bool)
 
-    # TODO: Add a validator to check if email looks fine
-    email_address = config.Variable(
-        section="sru",
-        help_text=_("Email address to log into the Launchpad HWDB"))
-
     # TODO: Add a validator to check if URL looks fine
     c3_url = config.Variable(
         section="sru",
         help_text=_("URL of the certification website"),
         default="https://certification.canonical.com/submissions/submit/")
 
-    # TODO: Add a validator to check if URL looks fine
-    lp_url = config.Variable(
-        section="sru",
-        help_text=_("URL of the launchpad hardware database"),
-        default="https://launchpad.net/+hwdb/+submit")
-
     fallback_file = config.Variable(
         section="sru",
         help_text=_("Location of the fallback file"))
diff --git a/checkbox_ng/launchpad.py b/checkbox_ng/launchpad.py
deleted file mode 100644
index e6e6725..0000000
--- a/checkbox_ng/launchpad.py
+++ /dev/null
@@ -1,204 +0,0 @@
-# This file is part of Checkbox.
-#
-# Copyright 2014 Canonical Ltd.
-# Written by:
-#   Brendan Donegan <[e-mail]>
-#
-# Checkbox is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License version 3,
-# as published by the Free Software Foundation.
-
-#
-# Checkbox 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 Checkbox.  If not, see <http://www.gnu.org/licenses/>.
-
-"""
-:mod:`checkbox_ng.launchpad` -- plainbox transport to Launchpad database
-=============================================================================
-
-This module contains a PlainBox transport that knows how to send the
-submission XML data to the Launchpad hardware database.
-"""
-from datetime import datetime
-from gettext import gettext as _
-from io import BytesIO
-from logging import getLogger
-from socket import gethostname
-import bz2
-import hashlib
-
-import requests
-
-from checkbox_support.lib.dmi import Dmi
-from plainbox.impl.secure.config import Unset
-from plainbox.impl.transport import TransportBase, TransportError
-
-logger = getLogger("checkbox.ng.launchpad")
-
-
-class InvalidSubmissionDataError(TransportError):
-    def __init__(self, value):
-        self.value = value
-
-    def __str__(self):
-        return repr(self.value)
-
-
-class LaunchpadTransport(TransportBase):
-    """
-    Transport for sending data to Launchpad database.
-     - POSTs data to a http(s) endpoint
-     - Adds a header with a hardware identifier
-     - Data is expected to be in checkbox xml-compatible format.
-       This means it will work best with a stream produced by the
-       xml exporter.
-   """
-
-    def _get_resource_attr(self, session_state, resource, attr):
-        resource_result = session_state.resource_map.get(resource)
-        if not resource_result:
-            raise InvalidSubmissionDataError(
-                _("Cannot get {0} resource job").format(resource))
-        attr_value = getattr(resource_result[0], attr)
-        if attr_value is None:
-            raise InvalidSubmissionDataError(
-                _("{0} has no attribute {1}").format(resource, attr))
-        return attr_value
-
-    def _get_launchpad_form_fields(self, session_state):
-        form_fields = {}
-        form_fields['field.private'] = 'False'
-        form_fields['field.contactable'] = 'False'
-        form_fields['field.live_cd'] = 'False'
-        form_fields['field.format'] = 'VERSION_1'
-        form_fields['field.actions.upload'] = 'Upload'
-        form_fields['field.date_created'] = datetime.utcnow().strftime(
-            "%Y-%m-%dT%H:%M:%S")
-        arch = self._get_resource_attr(
-            session_state, '2013.com.canonical.certification::dpkg',
-            'architecture')
-        form_fields['field.architecture'] = arch
-        distro = self._get_resource_attr(
-            session_state, '2013.com.canonical.certification::lsb',
-            'distributor_id')
-        form_fields['field.distribution'] = distro
-        series = self._get_resource_attr(
-            session_state, '2013.com.canonical.certification::lsb', 'codename')
-        form_fields['field.distroseries'] = series
-        dmi_resources = session_state.resource_map.get(
-            '2013.com.canonical.certification::dmi')
-        if dmi_resources is None:
-            raise InvalidSubmissionDataError(
-                _("DMI resources not found"))
-        system_id = ""
-        for resource in dmi_resources:
-            if resource.category == 'CHASSIS':
-                chassis_type = Dmi.chassis_name_to_type[resource.product]
-                vendor = getattr(resource, 'vendor', "")
-                model = getattr(resource, 'model', "")
-                fingerprint = hashlib.md5()
-                for field in ["Computer", "unknown", chassis_type,
-                              vendor, model]:
-                    fingerprint.update(field.encode('utf-8'))
-                system_id = fingerprint.hexdigest()
-        if not system_id:
-            raise InvalidSubmissionDataError(_("System ID not found"))
-        form_fields['field.system'] = system_id
-        fingerprint = hashlib.md5()
-        fingerprint.update(system_id.encode('utf-8'))
-        fingerprint.update(str(datetime.utcnow()).encode('utf-8'))
-        form_fields['field.submission_key'] = fingerprint.hexdigest()
-        return form_fields
-
-    def send(self, data, config=None, session_state=None):
-        """ Sends data to the specified server.
-
-        :param data:
-            Data containing the xml dump to be sent to the server. This can be
-            either bytes or a file-like object (BytesIO works fine too).  If
-            this is a file-like object, it will be read and streamed "on the
-            fly".
-        :param config:
-            An optional PlainBoxConfig object. If http_proxy and https_proxy
-            values are set in this config object, they will be used to send
-            data via the specified protocols. Note that the transport also
-            honors the http_proxy and https_proxy environment variables.
-            Proxy string format is http://[user:password@]<proxy-ip>:port
-        :param session_state:
-            ?
-        :returns:
-            A dictionary with responses from the server if submission was
-            successful and empty dictionary otherwise.
-        :raises ValueError:
-            If no session state was provided.
-        :raises TransportError:
-            - If sending timed out.
-            - If connection failed outright.
-            - If the server returned
-              a non-success result code
-            - If a required resource job is missing from the submission
-              or a resource job is missing a required attribute. The following
-              resource/attribute pairs are needed:
-                - dpkg: architecture
-                - lsb: distributor_id
-                - lsb: codename
-                - dmi: product
-        """
-        proxies = None
-        if config and config.environment is not Unset:
-            proxies = {
-                proto[:-len("_proxy")]: config.environment[proto]
-                for proto in ['http_proxy', 'https_proxy']
-                if proto in config.environment
-            }
-
-        if session_state is None:
-            raise ValueError("LaunchpadTransport requires a session "
-                             "state to be provided.")
-
-        logger.debug("Sending to %s, email is %s",
-                     self.url, self.options['field.emailaddress'])
-        lp_headers = {"x-launchpad-hwdb-submission": ""}
-
-        form_fields = self._get_launchpad_form_fields(session_state)
-        form_fields['field.emailaddress'] = self.options['field.emailaddress']
-
-        compressed_payload = bz2.compress(data.encode('utf-8'))
-        file = BytesIO(compressed_payload)
-        file.name = "{}.xml.bz2".format(gethostname())
-        file.size = len(compressed_payload)
-        submission_data = {'field.submission_data': file}
-        try:
-            response = requests.post(self.url, data=form_fields,
-                                     files=submission_data,
-                                     headers=lp_headers,
-                                     proxies=proxies)
-        except requests.exceptions.Timeout as exc:
-            raise TransportError(
-                _("Request to {0} timed out: {1}").format(self.url, exc))
-        except requests.exceptions.InvalidSchema as exc:
-            raise TransportError(
-                _("Invalid destination URL: {0}").format(exc))
-        except requests.exceptions.ConnectionError as exc:
-            raise TransportError(
-                _("Unable to connect to {0}: {1}").format(self.url, exc))
-        if response is not None:
-            try:
-                # This will raise HTTPError for status != 20x
-                response.raise_for_status()
-            except requests.exceptions.RequestException as exc:
-                raise TransportError(str(exc))
-            logger.debug(_("Success! Server said %s"), response.text)
-            status = _('The submission was uploaded to Launchpad successfully')
-            if (response.headers['x-launchpad-hwdb-submission'] != (
-                    'OK data stored')):
-                status = response.headers['x-launchpad-hwdb-submission']
-            return {'status': status}
-
-        # ISessionStateTransport.send must return dictionary
-        return {}
diff --git a/requirements/container-tests-checkbox-ng-unit b/requirements/container-tests-checkbox-ng-unit
index f08f8a8..5d99ea2 100755
--- a/requirements/container-tests-checkbox-ng-unit
+++ b/requirements/container-tests-checkbox-ng-unit
@@ -2,7 +2,6 @@
 
 function finish {
   rm -rf ./plainbox
-  rm -rf ./checkbox-support
 }
 trap finish EXIT
 
@@ -12,8 +11,4 @@ git clone git://git.launchpad.net/plainbox
 echo "I: running 'develop' on plainbox"
 ( cd ./plainbox/ && python3 setup.py develop --quiet | sed -e 's/^/I (develop output) /' )
 
-git clone git://git.launchpad.net/checkbox-support
-echo "I: running 'develop' on checkbox-support"
-( cd ./checkbox-support/ && python3 setup.py develop --quiet | sed -e 's/^/I (develop output) /' )
-
 python3 setup.py test
diff --git a/requirements/remove-deb-core.txt b/requirements/remove-deb-core.txt
index 0d3e59d..fc8e225 100644
--- a/requirements/remove-deb-core.txt
+++ b/requirements/remove-deb-core.txt
@@ -1,4 +1,3 @@
 checkbox-cli
 checkbox-ng
-checkbox-ng-service
 python3-chekbox-ng
diff --git a/setup.py b/setup.py
index afd6396..9278d8e 100755
--- a/setup.py
+++ b/setup.py
@@ -47,7 +47,6 @@ if on_rtd:
     install_requires = ['plainbox >= 0.5.3',]
 else:
     install_requires = [
-        'checkbox-support >= 0.2',
         'guacamole >= 0.9',
         'plainbox >= 0.5.3',
         'requests >= 1.0',
@@ -75,8 +74,6 @@ setup(
         'plainbox.transport': [
             'certification='
             'checkbox_ng.certification:CertificationTransport',
-            'launchpad='
-            'checkbox_ng.launchpad:LaunchpadTransport',
         ],
     },
     include_package_data=True)