Differential D514

bodhi_utils: use Bodhi2Client explicitely
ClosedPublic
Actions

Authored by kparal on Aug 19 2015, 11:00 AM.

Details

Reviewers
lbrabec
tflink
jskladan
Maniphest Tasks
T558: Test libtaskotron against bodhi 2.0
Commits
rLTRNe4a7ed45f89c: bodhi_utils: use Bodhi2Client explicitely
Summary

This partially reverts 206ba5f1c. It uses a simpler approach - create
Bodhi2Client directly. The API has changed, so we wouldn't be able to
support Bodhi1 anyway. And this is a simple change which doesn't
complicate our BodhiUtils code as much as the aforementioned commit.

Please note that I've created a ticket asking for simplification in the python-fedora library itself:
https://github.com/fedora-infra/bodhi/issues/183
But even if BodhiClient itself gets rid of the version detection logic, it still seems reasonable to rely on an explicitely version class in the future, so it might not change much for us.

This clashes a bit with D511 (currently in review, some of those changes won't be needed anymore).

Test Plan

test suite works, upgradepath as well, but it hard to test because none of the builds are found in the staging instance

Diff Detail

Repository
rLTRN libtaskotron
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
kparal retitled this revision from to bodhi_utils: use Bodhi2Client explicitely.Aug 19 2015, 11:00 AM
kparal updated this object.
kparal edited the test plan for this revision. (Show Details)
kparal added reviewers: tflink, jskladan, lbrabec.
tflink added a subscriber: lmacken.Aug 19 2015, 1:57 PM

I talked to @lmacken about this yesterday and the Bodhi2Client class is going away after the migration (becoming BodhiClient, removing the Bodhi1Client class), so I'm not sure it's a good idea to explicitly use it if we have no idea when it would go away. I probably would have written the patch this way otherwise.

If the Bodhi2Client class is not going away, I agree this is a simpler approach. If it is going away, an alternative approach would be to remove the @property stuff once the Bodhi2Client class has disappeared from python-fedora.

tflink accepted this revision.Aug 19 2015, 2:29 PM
This revision is now accepted and ready to land.Aug 19 2015, 2:29 PM
kparal added a comment.Aug 19 2015, 2:30 PM

After further discussion, it turns out that Bodhi2Client is not going away. Agreed we would push this.

Closed by commit rLTRNe4a7ed45f89c: bodhi_utils: use Bodhi2Client explicitely (authored by kparal). · Explain WhyAug 19 2015, 2:33 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
Mlibtaskotron/bodhi_utils.py (24 lines)
Mtesting/test_bodhi_utils.py (13 lines)

Diff 1345

View Options

libtaskotron/bodhi_utils.py

Show All 12 Lines
13from . import python_utils 13​from . import python_utils
14from . import exceptions as exc 14​from . import exceptions as exc
15from . import config 15​from . import config
16 16​
17 17​
18class BodhiUtils(object): 18​class BodhiUtils(object):
19 '''Helper Bodhi methods. 19​ '''Helper Bodhi methods.
20 20​
21 :ivar fedora.client.BodhiClient client: Bodhi client instance 21​ :ivar fedora.client.Bodhi2Client client: Bodhi2 client instance
22 ''' 22​ '''
23 23​
24 #: How many requests to make in a single call. The maximum page limit is 24​ #: How many requests to make in a single call. The maximum page limit is
25 #: 100, so it can't be above that. With high numbers, we increase the 25​ #: 100, so it can't be above that. With high numbers, we increase the
26 #: chance to receive a timeout. 26​ #: chance to receive a timeout.
27 _MULTICALL_REQUEST_SIZE = 50 27​ _MULTICALL_REQUEST_SIZE = 50
28 28​
29 def __init__(self, client=None): 29​ def __init__(self, client=None):
30 '''Create a new BodhiUtils instance. 30​ '''Create a new BodhiUtils instance.
31 31​
32 :param client: custom :class:`BodhiClient` instance. If ``None``, a 32​ :param client: custom :class:`Bodhi2Client` instance. If ``None``, a
33 default BodhiClient instance is used. 33​ default Bodhi2Client instance is used.
34 ''' 34​ '''
35 35​
36 self.config = config.get_config() 36​ self.config = config.get_config()
37 37​
38 if client is not None: 38​ if not client:
39 self._client = client ​
40 ​
41 @property ​
42 def client(self): ​
43 if self._client is None: ​
44 log.debug('Creating Bodhi client to %s' % self.config.bodhi_server) 39​ log.debug('Creating Bodhi client to %s' % self.config.bodhi_server)
45 self._client = fedora.client.bodhi.BodhiClient(base_url=self.config.bodhi_server, 40​ self.client = fedora.client.bodhi.Bodhi2Client(base_url=self.config.bodhi_server,
46 username=self.config.fas_username, 41​ username=self.config.fas_username,
47 password=self.config.fas_password) 42​ password=self.config.fas_password)
48 # automatically retry failed requests (HTTP 5xx and similar) 43​ # automatically retry failed requests (HTTP 5xx and similar)
49 self._client.retries = 10 44​ self.client.retries = 10
50 return self._client 45​ else:
46​ self.client = client
51 47​
52 def query_update(self, package): 48​ def query_update(self, package):
53 '''Get the last Bodhi update matching criteria. 49​ '''Get the last Bodhi update matching criteria.
54 50​
55 :param str package: package NVR or package name or update title or 51​ :param str package: package NVR or package name or update title or
56 update ID 52​ update ID
57 53​
58 .. note:: 54​ .. note::
▲ Show 20 Lines • Show All 113 Lines • Show Last 20 Lines
View Options

testing/test_bodhi_utils.py

1# -*- coding: utf-8 -*- 1​# -*- coding: utf-8 -*-
2# Copyright 2009-2014, Red Hat, Inc. 2​# Copyright 2009-2014, Red Hat, Inc.
3# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+> 3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4# See the LICENSE file for more details on Licensing 4​# See the LICENSE file for more details on Licensing
5 5​
6'''Unit tests for libtaskotron/bodhi_utils.py''' 6​'''Unit tests for libtaskotron/bodhi_utils.py'''
7 7​
8import pytest 8​import pytest
9from dingus import Dingus 9​from dingus import Dingus
10from munch import Munch 10​from munch import Munch
11 11​
12from fedora.client import bodhi 12​import fedora.client.bodhi
13 13​
14from libtaskotron import bodhi_utils 14​from libtaskotron import bodhi_utils
15from libtaskotron import exceptions as exc 15​from libtaskotron import exceptions as exc
16 16​
17 17​
18class TestBodhiUtils(): 18​class TestBodhiUtils():
19 def test_nonetwork_on_creation(self, monkeypatch): 19​ def test_nonetwork_on_creation(self, monkeypatch):
20 '''It's important that our stuff not attempt to access the network 20​ '''It's important that our stuff not attempt to access the network
21 during init so that %check doesn't fail during package build. At one 21​ during init so that %check doesn't fail during package build. At one
22 point, BodhiClient did ping bodhi production during init, so let's make 22​ point, BodhiClient did ping bodhi production during init, so let's make
23 sure that doesn't happen''' 23​ sure that doesn't happen'''
24 24​
25 stub_utils = Dingus() 25​ assert hasattr(fedora.client.bodhi, 'requests')
26​ stub_requests = Dingus()
27​ monkeypatch.setattr(fedora.client.bodhi, 'requests', stub_requests)
26 28​
27 monkeypatch.setattr(bodhi, 'BodhiClient', stub_utils) 29​ bu = bodhi_utils.BodhiUtils()
30​ assert bu.client is not None
31​ assert len(stub_requests.calls()) == 0
28 32​
29 bodhi_utils.BodhiUtils() ​
30 ​
31 assert len(stub_utils.calls()) == 0 ​
32 33​
33# FIXME: once query_update() does not throw NotImplementedError 34​# FIXME: once query_update() does not throw NotImplementedError
34# class TestQueryUpdate(): 35​# class TestQueryUpdate():
35# '''Test query_update()''' 36​# '''Test query_update()'''
36# 37​#
37# def setup_method(self, method): 38​# def setup_method(self, method):
38# '''Run this before every test invocation''' 39​# '''Run this before every test invocation'''
39# self.ref_bodhi_id = 'FEDORA-1234-56789' 40​# self.ref_bodhi_id = 'FEDORA-1234-56789'
▲ Show 20 Lines • Show All 198 Lines • Show Last 20 Lines