summaryrefslogtreecommitdiff
path: root/tests/unittests/config/test_cc_rh_subscription.py
blob: fcc7db34767b94afaf8c86c24df18ba9ad562521 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# This file is part of cloud-init. See LICENSE file for license information.

"""Tests for registering RHEL subscription via rh_subscription."""

import copy
import logging

from cloudinit import subp
from cloudinit.config import cc_rh_subscription
from tests.unittests.helpers import CiTestCase, mock

SUBMGR = cc_rh_subscription.SubscriptionManager
SUB_MAN_CLI = "cloudinit.config.cc_rh_subscription._sub_man_cli"


@mock.patch(SUB_MAN_CLI)
class GoodTests(CiTestCase):
    with_logs = True

    def setUp(self):
        super(GoodTests, self).setUp()
        self.name = "cc_rh_subscription"
        self.cloud_init = None
        self.log = logging.getLogger("good_tests")
        self.args = []
        self.handle = cc_rh_subscription.handle

        self.config = {
            "rh_subscription": {
                "username": "scooby@do.com",
                "password": "scooby-snacks",
            }
        }
        self.config_full = {
            "rh_subscription": {
                "username": "scooby@do.com",
                "password": "scooby-snacks",
                "auto-attach": True,
                "service-level": "self-support",
                "add-pool": ["pool1", "pool2", "pool3"],
                "enable-repo": ["repo1", "repo2", "repo3"],
                "disable-repo": ["repo4", "repo5"],
            }
        }

    def test_already_registered(self, m_sman_cli):
        """
        Emulates a system that is already registered. Ensure it gets
        a non-ProcessExecution error from is_registered()
        """
        self.handle(
            self.name, self.config, self.cloud_init, self.log, self.args
        )
        self.assertEqual(m_sman_cli.call_count, 1)
        self.assertIn("System is already registered", self.logs.getvalue())

    def test_simple_registration(self, m_sman_cli):
        """
        Simple registration with username and password
        """
        reg = (
            "The system has been registered with ID:"
            " 12345678-abde-abcde-1234-1234567890abc"
        )
        m_sman_cli.side_effect = [subp.ProcessExecutionError, (reg, "bar")]
        self.handle(
            self.name, self.config, self.cloud_init, self.log, self.args
        )
        self.assertIn(mock.call(["identity"]), m_sman_cli.call_args_list)
        self.assertIn(
            mock.call(
                [
                    "register",
                    "--username=scooby@do.com",
                    "--password=scooby-snacks",
                ],
                logstring_val=True,
            ),
            m_sman_cli.call_args_list,
        )
        self.assertIn(
            "rh_subscription plugin completed successfully",
            self.logs.getvalue(),
        )
        self.assertEqual(m_sman_cli.call_count, 2)

    @mock.patch.object(cc_rh_subscription.SubscriptionManager, "_getRepos")
    def test_update_repos_disable_with_none(self, m_get_repos, m_sman_cli):
        cfg = copy.deepcopy(self.config)
        m_get_repos.return_value = ([], ["repo1"])
        cfg["rh_subscription"].update(
            {"enable-repo": ["repo1"], "disable-repo": None}
        )
        mysm = cc_rh_subscription.SubscriptionManager(cfg)
        self.assertEqual(True, mysm.update_repos())
        m_get_repos.assert_called_with()
        self.assertEqual(
            m_sman_cli.call_args_list, [mock.call(["repos", "--enable=repo1"])]
        )

    def test_full_registration(self, m_sman_cli):
        """
        Registration with auto-attach, service-level, adding pools,
        and enabling and disabling yum repos
        """
        call_lists = []
        call_lists.append(["attach", "--pool=pool1", "--pool=pool3"])
        call_lists.append(
            ["repos", "--disable=repo5", "--enable=repo2", "--enable=repo3"]
        )
        call_lists.append(["attach", "--auto", "--servicelevel=self-support"])
        reg = (
            "The system has been registered with ID:"
            " 12345678-abde-abcde-1234-1234567890abc"
        )
        m_sman_cli.side_effect = [
            subp.ProcessExecutionError,
            (reg, "bar"),
            ("Service level set to: self-support", ""),
            ("pool1\npool3\n", ""),
            ("pool2\n", ""),
            ("", ""),
            ("Repo ID: repo1\nRepo ID: repo5\n", ""),
            ("Repo ID: repo2\nRepo ID: repo3\nRepo ID: repo4", ""),
            ("", ""),
        ]
        self.handle(
            self.name, self.config_full, self.cloud_init, self.log, self.args
        )
        self.assertEqual(m_sman_cli.call_count, 9)
        for call in call_lists:
            self.assertIn(mock.call(call), m_sman_cli.call_args_list)
        self.assertIn(
            "rh_subscription plugin completed successfully",
            self.logs.getvalue(),
        )


@mock.patch(SUB_MAN_CLI)
class TestBadInput(CiTestCase):
    with_logs = True
    name = "cc_rh_subscription"
    cloud_init = None
    log = logging.getLogger("bad_tests")
    args = []
    SM = cc_rh_subscription.SubscriptionManager
    reg = (
        "The system has been registered with ID:"
        " 12345678-abde-abcde-1234-1234567890abc"
    )

    config_no_password = {"rh_subscription": {"username": "scooby@do.com"}}

    config_no_key = {
        "rh_subscription": {
            "activation-key": "1234abcde",
        }
    }

    config_service = {
        "rh_subscription": {
            "username": "scooby@do.com",
            "password": "scooby-snacks",
            "service-level": "self-support",
        }
    }

    config_badpool = {
        "rh_subscription": {
            "username": "scooby@do.com",
            "password": "scooby-snacks",
            "add-pool": "not_a_list",
        }
    }
    config_badrepo = {
        "rh_subscription": {
            "username": "scooby@do.com",
            "password": "scooby-snacks",
            "enable-repo": "not_a_list",
        }
    }
    config_badkey = {
        "rh_subscription": {
            "activation-key": "abcdef1234",
            "fookey": "bar",
            "org": "123",
        }
    }

    def setUp(self):
        super(TestBadInput, self).setUp()
        self.handle = cc_rh_subscription.handle

    def assert_logged_warnings(self, warnings):
        logs = self.logs.getvalue()
        missing = [w for w in warnings if "WARNING: " + w not in logs]
        self.assertEqual([], missing, "Missing expected warnings.")

    def test_no_password(self, m_sman_cli):
        """Attempt to register without the password key/value."""
        m_sman_cli.side_effect = [
            subp.ProcessExecutionError,
            (self.reg, "bar"),
        ]
        self.handle(
            self.name,
            self.config_no_password,
            self.cloud_init,
            self.log,
            self.args,
        )
        self.assertEqual(m_sman_cli.call_count, 0)

    def test_no_org(self, m_sman_cli):
        """Attempt to register without the org key/value."""
        m_sman_cli.side_effect = [subp.ProcessExecutionError]
        self.handle(
            self.name, self.config_no_key, self.cloud_init, self.log, self.args
        )
        m_sman_cli.assert_called_with(["identity"])
        self.assertEqual(m_sman_cli.call_count, 1)
        self.assert_logged_warnings(
            (
                "Unable to register system due to incomplete information.",
                "Use either activationkey and org *or* userid and password",
                "Registration failed or did not run completely",
                "rh_subscription plugin did not complete successfully",
            )
        )

    def test_service_level_without_auto(self, m_sman_cli):
        """Attempt to register using service-level without auto-attach key."""
        m_sman_cli.side_effect = [
            subp.ProcessExecutionError,
            (self.reg, "bar"),
        ]
        self.handle(
            self.name,
            self.config_service,
            self.cloud_init,
            self.log,
            self.args,
        )
        self.assertEqual(m_sman_cli.call_count, 1)
        self.assert_logged_warnings(
            (
                "The service-level key must be used in conjunction with ",
                "rh_subscription plugin did not complete successfully",
            )
        )

    def test_pool_not_a_list(self, m_sman_cli):
        """
        Register with pools that are not in the format of a list
        """
        m_sman_cli.side_effect = [
            subp.ProcessExecutionError,
            (self.reg, "bar"),
        ]
        self.handle(
            self.name,
            self.config_badpool,
            self.cloud_init,
            self.log,
            self.args,
        )
        self.assertEqual(m_sman_cli.call_count, 2)
        self.assert_logged_warnings(
            (
                "Pools must in the format of a list",
                "rh_subscription plugin did not complete successfully",
            )
        )

    def test_repo_not_a_list(self, m_sman_cli):
        """
        Register with repos that are not in the format of a list
        """
        m_sman_cli.side_effect = [
            subp.ProcessExecutionError,
            (self.reg, "bar"),
        ]
        self.handle(
            self.name,
            self.config_badrepo,
            self.cloud_init,
            self.log,
            self.args,
        )
        self.assertEqual(m_sman_cli.call_count, 2)
        self.assert_logged_warnings(
            (
                "Repo IDs must in the format of a list.",
                "Unable to add or remove repos",
                "rh_subscription plugin did not complete successfully",
            )
        )

    def test_bad_key_value(self, m_sman_cli):
        """
        Attempt to register with a key that we don't know
        """
        m_sman_cli.side_effect = [
            subp.ProcessExecutionError,
            (self.reg, "bar"),
        ]
        self.handle(
            self.name, self.config_badkey, self.cloud_init, self.log, self.args
        )
        self.assertEqual(m_sman_cli.call_count, 1)
        self.assert_logged_warnings(
            (
                "fookey is not a valid key for rh_subscription. Valid keys"
                " are:",
                "rh_subscription plugin did not complete successfully",
            )
        )


# vi: ts=4 expandtab