ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity
community.general/tests/unit/plugins/modules/test_redhat_subscription.py

1295 lines
44 KiB
Python
Raw Normal View History

redhat_subscription: call 'remove' instead of 'unsubscribe' (#4809) The 'unsubscribe' command of 'subscription-manager' was deprecated already in subscription-manager 1.11.3, shipped with RHEL 5.11. As it was removed in subscription-manager 1.29.x, unsubscribing from pools was thus broken. The simple fix is to call the proper command, 'remove'.
2022-06-14 07:26:38 +02:00
# -*- coding: utf-8 -*-
Add remaining copyright statements, add licenses sanity test (#5098) * Add sanity test (currently fails). * doc_fragments can also be non-GPLv3+. * Replace 'Author:' by 'Copyright:' in some specific cases. * Avoid matching string for license checkers. * Reformulate not to throw license detection off. * Add PSF copyright notice for plugins/module_utils/_mount.py. * Add generic copyright notices. * Update changelog fragment.
2022-08-08 23:23:08 +02:00
# Copyright (c) Jiri Hnidek (jhnidek@redhat.com)
Initial commit
2020-03-09 10:11:07 +01:00
#
Move licenses to LICENSES/, run add-license.py, add LICENSES/MIT.txt (#5065) * Move licenses to LICENSES/, run add-license.py, add LICENSES/MIT.txt. * Replace 'Copyright:' with 'Copyright' sed -i 's|Copyright:\(.*\)|Copyright\1|' $(rg -l 'Copyright:') Co-authored-by: Maxwell G <gotmax@e.email>
2022-08-05 12:28:29 +02:00
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
Initial commit
2020-03-09 10:11:07 +01:00
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import json
from ansible.module_utils import basic
Unflatmap community.general (#5461) * Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
2022-11-02 21:42:29 +01:00
from ansible_collections.community.general.plugins.modules import redhat_subscription
Initial commit
2020-03-09 10:11:07 +01:00
import pytest
TESTED_MODULE = redhat_subscription.__name__
@pytest.fixture
def patch_redhat_subscription(mocker):
"""
Fix macports package present/active detection (#1308) * Fix typo in redhat_subscription testcase * Fix macports state=present matching against the wrong package name Previous implementation returned true if the desired package name occurred anywhere in the list of all installed packages. For example as a substring of another package name, or even as a substring of a variant name for a different package. Instead: - request macports only list installed packages matching the desired package name, instead of all installed packages. - Note `port` exits with 0 regardless of whether any packages match the requested name. - pass `-q` flag: "Do not print the header line. This is useful when parsing the output of port installed in scripts for further processing." - eliminate `use_unsafe_shell=True` by searching stdout contents natively in python instead of using `grep`. This has the added benefit of eliminating any potential misinterpretation of characters in the package name as regex special characters. If there are zero matching installed packages, `out` is empty. If there are one or more matches (due to multiple installed versions), the output format is: https://github.com/macports/macports-base/blob/ec8a2bc682c7afbde198aee23a1920557721b508/src/port/port.tcl#L3320-L3323 Notably, two leading spaces, the package name, a space, and then other information. According to blame via github, those lines haven't changed in 11 years. * Update macports state=active to eliminate use_unsafe_shell Similar to previous commit (for macports state=present): - pass `-q` flag: "Do not print the header line. This is useful when parsing the output of port installed in scripts for further processing." - search stdout contents natively in python instead of using `grep`. - added parentheses to search string to eliminate false positives if the package name or variants contain the word `active`. Still could fail if they contain `(active)`, but that's less likely If there are zero matching installed packages, `out` is empty. If there are one or more matches (due to multiple installed versions), the output format is: https://github.com/macports/macports-base/blob/ec8a2bc682c7afbde198aee23a1920557721b508/src/port/port.tcl#L3320-L3323 For "state=active", we're looking for a line that contains `(active)` in the output. * Basic test case of query_port for present and active * Attempt to fix lint errors in test * Different mock module creation, changed test cases indentation/spacing - picked the wrong mock code to cargo-cult. Thanks to felixfontein for this suggestion - 4 space indentation on continuation line. I thought I had that originally, but it looks like my editor sabotaged me with mixed tabs/spaces - Remove leading newline on multi-line test cases. I don't think it would make a difference, but I'd read up on how the python syntax works and want to more accurately represent macports output. fingers crossed this addresses the known build errors * Add changelog fragment * Update tests/unit/plugins/modules/packaging/os/test_macports.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/1307-macports-fix-status-check.yml Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-11-26 06:59:32 +01:00
Function used for mocking some parts of redhat_subscription module
Initial commit
2020-03-09 10:11:07 +01:00
"""
Unflatmap community.general (#5461) * Move files. * Update imports and references. * Move wrongly placed files. * Reverse redirects, deprecate long → short name redirects. * Simplify contribution guidelines for new modules. * Rewrite BOTMETA. * Add changelog fragment. * Fix ignore.txt files.
2022-11-02 21:42:29 +01:00
mocker.patch('ansible_collections.community.general.plugins.modules.redhat_subscription.RegistrationBase.REDHAT_REPO')
mocker.patch('ansible_collections.community.general.plugins.modules.redhat_subscription.isfile', return_value=False)
mocker.patch('ansible_collections.community.general.plugins.modules.redhat_subscription.unlink', return_value=True)
mocker.patch('ansible_collections.community.general.plugins.modules.redhat_subscription.AnsibleModule.get_bin_path',
Initial commit
2020-03-09 10:11:07 +01:00
return_value='/testbin/subscription-manager')
[PR #6122/e939cd07 backport][stable-6] redhat_subscription: use D-Bus for registration if possible (#6188) redhat_subscription: use D-Bus for registration if possible (#6122) subscription-manager currently does not have a way to get credentials (username, password, activation keys, organization ID) in a secure way: the existing command line parameters can be easily spotted when running a process listing while 'subscription-manager register' runs. There is a D-Bus service, which is used by e.g. cockpit and Anaconda to interface with RHSM (at least for registration and common queries). Try to perform the registration using D-Bus, in a way very similar to the work done in convert2rhel [1] (with my help): - try to do a simple signal test to check whether the system bus works; inspired by the login in the dconf module - pass most of the options as registration options; for the few that are not part of the registration, execute 'subscription-manager' manually - add quirks for differently working (or not) registration options for the D-Bus Register*() methods depending on the version of RHEL - 'subscription-manager register' is used only in case the signal test is not working; silent fallback in case of D-Bus errors during the registration is not done on purpose to avoid silent fallback to a less secure registration [1] https://github.com/oamg/convert2rhel/pull/540/ (cherry picked from commit e939cd07ef335e939e901c3ccc76523eab8d5e4a) Co-authored-by: Pino Toscano <ptoscano@redhat.com>
2023-03-14 23:06:41 +01:00
mocker.patch('ansible_collections.community.general.plugins.modules.redhat_subscription.Rhsm._can_connect_to_dbus',
return_value=False)
Initial commit
2020-03-09 10:11:07 +01:00
@pytest.mark.parametrize('patch_ansible_module', [{}], indirect=['patch_ansible_module'])
@pytest.mark.usefixtures('patch_ansible_module')
def test_without_required_parameters(capfd, patch_redhat_subscription):
"""
Failure must occurs when all parameters are missing
"""
with pytest.raises(SystemExit):
redhat_subscription.main()
out, err = capfd.readouterr()
results = json.loads(out)
assert results['failed']
assert 'state is present but any of the following are missing' in results['msg']
TEST_CASES = [
# Test the case, when the system is already registered
[
{
'state': 'present',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
'org_id': 'admin'
},
{
'id': 'test_already_registered_system',
'run_command.calls': [
(
# Calling of following command will be asserted
['/testbin/subscription-manager', 'identity'],
# Was return code checked?
{'check_rc': False},
# Mock of returned code, stdout and stderr
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', '')
)
],
'changed': False,
'msg': 'System already registered.'
}
],
# Test simple registration using username and password
[
{
'state': 'present',
'server_hostname': 'satellite.company.com',
'username': 'admin',
'password': 'admin',
},
{
'id': 'test_registeration_username_password',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, '', '')
),
(
['/testbin/subscription-manager', 'config', '--server.hostname=satellite.company.com'],
{'check_rc': True},
(0, '', '')
),
(
['/testbin/subscription-manager', 'register',
'--username', 'admin',
'--password', 'admin'],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'satellite.company.com'."
}
],
[PR #5725/4dc897d5 backport][stable-6] redhat_subscription: Add support for Red Hat API token (#5768) redhat_subscription: Add support for Red Hat API token (#5725) Add support for Red Hat API token fix mixed up fix version (cherry picked from commit 4dc897d559cd631554691a2a4d3d82e34325686c) Co-authored-by: Eric C Chong <ecchong@gmail.com>
2023-01-05 21:51:21 +01:00
# Test simple registration using token
[
{
'state': 'present',
'server_hostname': 'satellite.company.com',
'token': 'fake_token',
},
{
'id': 'test_registeration_token',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, '', '')
),
(
['/testbin/subscription-manager', 'config', '--server.hostname=satellite.company.com'],
{'check_rc': True},
(0, '', '')
),
(
['/testbin/subscription-manager', 'register',
'--token', 'fake_token'],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'satellite.company.com'."
}
],
Initial commit
2020-03-09 10:11:07 +01:00
# Test unregistration, when system is unregistered
[
{
'state': 'absent',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
},
{
'id': 'test_unregisteration',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', '')
),
(
redhat_subscription: call 'remove' instead of 'unsubscribe' (#4809) The 'unsubscribe' command of 'subscription-manager' was deprecated already in subscription-manager 1.11.3, shipped with RHEL 5.11. As it was removed in subscription-manager 1.29.x, unsubscribing from pools was thus broken. The simple fix is to call the proper command, 'remove'.
2022-06-14 07:26:38 +02:00
['/testbin/subscription-manager', 'remove', '--all'],
Initial commit
2020-03-09 10:11:07 +01:00
{'check_rc': True},
(0, '', '')
),
(
['/testbin/subscription-manager', 'unregister'],
{'check_rc': True},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully unregistered from subscription.rhsm.redhat.com."
}
],
# Test unregistration of already unregistered system
[
{
'state': 'absent',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
},
{
'id': 'test_unregisteration_of_unregistered_system',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
)
],
'changed': False,
'msg': "System already unregistered."
}
],
# Test registration using activation key
[
{
'state': 'present',
'server_hostname': 'satellite.company.com',
'activationkey': 'some-activation-key',
'org_id': 'admin'
},
{
'id': 'test_registeration_activation_key',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
['/testbin/subscription-manager', 'config', '--server.hostname=satellite.company.com'],
{'check_rc': True},
(0, '', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--activationkey', 'some-activation-key'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'satellite.company.com'."
}
],
# Test of registration using username and password with auto-attach option
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'auto_attach': 'true'
},
{
'id': 'test_registeration_username_password_auto_attach',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--auto-attach',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test of force registration despite the system is already registered
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'force_register': 'true'
},
{
'id': 'test_force_registeration_username_password',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'This system already registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--force',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
redhat_subscription: Add server_prefix and server_port as supported arguments (#2779) * Add server_prefix and server_port as supported arguments for the redhat_subscription module. * Adjust the argument sequence in the test case to be consistent with the original code in line 364 in redhat_subscription.py and add the changelog fragment. * Grammatical changes such as adding full stops and using 'an HTTP' instead of 'a HTTP'. * Commit the suggested changelog update. Co-authored-by: Amin Vakil <info@aminvakil.com> * Fix typo. Co-authored-by: Amin Vakil <info@aminvakil.com> Co-authored-by: Amin Vakil <info@aminvakil.com>
2021-06-16 09:01:54 +02:00
# Test of registration with arguments that are not part of register options but needs to be configured
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'force_register': 'true',
'server_prefix': '/rhsm',
'server_port': '443'
},
{
'id': 'test_arguments_not_in_register_options',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'This system already registered.', '')
),
(
['/testbin/subscription-manager', 'config',
'--server.port=443',
'--server.prefix=/rhsm'
],
{'check_rc': True},
(0, '', '')
),
(
['/testbin/subscription-manager', 'register',
'--force',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
Initial commit
2020-03-09 10:11:07 +01:00
# Test of registration using username, password and proxy options
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'force_register': 'true',
'server_proxy_hostname': 'proxy.company.com',
[PR #5662/471f523f backport][stable-6] redhat_subscription: add `server_proxy_scheme` parameter (#5671) redhat_subscription: add `server_proxy_scheme` parameter (#5662) Add the `server_proxy_scheme` parameter to configure the scheme used for the proxy server. This completes the configuration parameters for the proxy server. (cherry picked from commit 471f523f53220bfbb3e6585b767c7483790c025d) Co-authored-by: Pino Toscano <ptoscano@redhat.com>
2022-12-08 22:54:18 +01:00
'server_proxy_scheme': 'https',
Initial commit
2020-03-09 10:11:07 +01:00
'server_proxy_port': '12345',
'server_proxy_user': 'proxy_user',
'server_proxy_password': 'secret_proxy_password'
},
{
'id': 'test_registeration_username_password_proxy_options',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'This system already registered.', '')
),
(
[
'/testbin/subscription-manager',
'config',
'--server.proxy_hostname=proxy.company.com',
'--server.proxy_password=secret_proxy_password',
'--server.proxy_port=12345',
[PR #5662/471f523f backport][stable-6] redhat_subscription: add `server_proxy_scheme` parameter (#5671) redhat_subscription: add `server_proxy_scheme` parameter (#5662) Add the `server_proxy_scheme` parameter to configure the scheme used for the proxy server. This completes the configuration parameters for the proxy server. (cherry picked from commit 471f523f53220bfbb3e6585b767c7483790c025d) Co-authored-by: Pino Toscano <ptoscano@redhat.com>
2022-12-08 22:54:18 +01:00
'--server.proxy_scheme=https',
Initial commit
2020-03-09 10:11:07 +01:00
'--server.proxy_user=proxy_user'
],
{'check_rc': True},
(0, '', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--force',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test of registration using username and password and attach to pool
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'pool': 'ff8080816b8e967f016b8e99632804a6'
},
{
'id': 'test_registeration_username_password_pool',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
),
(
[
'subscription-manager list --available',
{'check_rc': True, 'environ_update': {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'}},
(0,
'''
+-------------------------------------------+
Available Subscriptions
+-------------------------------------------+
Subscription Name: SP Server Premium (S: Premium, U: Production, R: SP Server)
Provides: SP Server Bits
SKU: sp-server-prem-prod
Contract: 0
Pool ID: ff8080816b8e967f016b8e99632804a6
Provides Management: Yes
Available: 5
Suggested: 1
Service Type: L1-L3
Roles: SP Server
Service Level: Premium
Usage: Production
Add-ons:
Subscription Type: Standard
Starts: 06/25/19
Ends: 06/24/20
Entitlement Type: Physical
''', ''),
]
),
(
'subscription-manager attach --pool ff8080816b8e967f016b8e99632804a6',
{'check_rc': True},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test of registration using username and password and attach to pool ID and quantities
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'pool_ids': [{'ff8080816b8e967f016b8e99632804a6': 2}, {'ff8080816b8e967f016b8e99747107e9': 4}]
},
{
'id': 'test_registeration_username_password_pool_ids_quantities',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
),
(
[
'subscription-manager list --available',
{'check_rc': True, 'environ_update': {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'}},
(0,
'''
+-------------------------------------------+
Available Subscriptions
+-------------------------------------------+
Subscription Name: SP Smart Management (A: ADDON1)
Provides: SP Addon 1 bits
SKU: sp-with-addon-1
Contract: 1
Pool ID: ff8080816b8e967f016b8e99747107e9
Provides Management: Yes
Available: 10
Suggested: 1
Service Type:
Roles:
Service Level:
Usage:
Add-ons: ADDON1
Subscription Type: Standard
Starts: 25.6.2019
Ends: 24.6.2020
Entitlement Type: Physical
Subscription Name: SP Server Premium (S: Premium, U: Production, R: SP Server)
Provides: SP Server Bits
SKU: sp-server-prem-prod
Contract: 0
Pool ID: ff8080816b8e967f016b8e99632804a6
Provides Management: Yes
Available: 5
Suggested: 1
Service Type: L1-L3
Roles: SP Server
Service Level: Premium
Usage: Production
Add-ons:
Subscription Type: Standard
Starts: 06/25/19
Ends: 06/24/20
Entitlement Type: Physical
''', '')
]
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99632804a6',
'--quantity', '2'
],
{'check_rc': True},
(0, '', '')
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99747107e9',
'--quantity', '4'
],
{'check_rc': True},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test of registration using username and password and attach to pool ID without quantities
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'pool_ids': ['ff8080816b8e967f016b8e99632804a6', 'ff8080816b8e967f016b8e99747107e9']
},
{
'id': 'test_registeration_username_password_pool_ids',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
),
(
[
'subscription-manager list --available',
{'check_rc': True, 'environ_update': {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'}},
(0,
'''
+-------------------------------------------+
Available Subscriptions
+-------------------------------------------+
Subscription Name: SP Smart Management (A: ADDON1)
Provides: SP Addon 1 bits
SKU: sp-with-addon-1
Contract: 1
Pool ID: ff8080816b8e967f016b8e99747107e9
Provides Management: Yes
Available: 10
Suggested: 1
Service Type:
Roles:
Service Level:
Usage:
Add-ons: ADDON1
Subscription Type: Standard
Starts: 25.6.2019
Ends: 24.6.2020
Entitlement Type: Physical
Subscription Name: SP Server Premium (S: Premium, U: Production, R: SP Server)
Provides: SP Server Bits
SKU: sp-server-prem-prod
Contract: 0
Pool ID: ff8080816b8e967f016b8e99632804a6
Provides Management: Yes
Available: 5
Suggested: 1
Service Type: L1-L3
Roles: SP Server
Service Level: Premium
Usage: Production
Add-ons:
Subscription Type: Standard
Starts: 06/25/19
Ends: 06/24/20
Entitlement Type: Physical
''', '')
]
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99632804a6'
],
{'check_rc': True},
(0, '', '')
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99747107e9'
],
{'check_rc': True},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test of registration using username and password and attach to pool ID (one pool)
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'pool_ids': ['ff8080816b8e967f016b8e99632804a6']
},
{
'id': 'test_registeration_username_password_one_pool_id',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
),
(
[
'subscription-manager list --available',
{'check_rc': True, 'environ_update': {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'}},
(0,
'''
+-------------------------------------------+
Available Subscriptions
+-------------------------------------------+
Subscription Name: SP Smart Management (A: ADDON1)
Provides: SP Addon 1 bits
SKU: sp-with-addon-1
Contract: 1
Pool ID: ff8080816b8e967f016b8e99747107e9
Provides Management: Yes
Available: 10
Suggested: 1
Service Type:
Roles:
Service Level:
Usage:
Add-ons: ADDON1
Subscription Type: Standard
Starts: 25.6.2019
Ends: 24.6.2020
Entitlement Type: Physical
Subscription Name: SP Server Premium (S: Premium, U: Production, R: SP Server)
Provides: SP Server Bits
SKU: sp-server-prem-prod
Contract: 0
Pool ID: ff8080816b8e967f016b8e99632804a6
Provides Management: Yes
Available: 5
Suggested: 1
Service Type: L1-L3
Roles: SP Server
Service Level: Premium
Usage: Production
Add-ons:
Subscription Type: Standard
Starts: 06/25/19
Ends: 06/24/20
Entitlement Type: Physical
''', '')
]
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99632804a6',
],
{'check_rc': True},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test attaching different set of pool IDs
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'pool_ids': [{'ff8080816b8e967f016b8e99632804a6': 2}, {'ff8080816b8e967f016b8e99747107e9': 4}]
},
{
'id': 'test_attaching_different_pool_ids',
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', ''),
),
(
'subscription-manager list --consumed',
{'check_rc': True, 'environ_update': {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'}},
(0, '''
+-------------------------------------------+
Consumed Subscriptions
+-------------------------------------------+
Subscription Name: Multi-Attribute Stackable (4 cores, no content)
Provides: Multi-Attribute Limited Product (no content)
SKU: cores4-multiattr
Contract: 1
Account: 12331131231
Serial: 7807912223970164816
Pool ID: ff8080816b8e967f016b8e995f5103b5
Provides Management: No
Active: True
Quantity Used: 1
Service Type: Level 3
Roles:
Service Level: Premium
Usage:
Add-ons:
Status Details: Subscription is current
Subscription Type: Stackable
Starts: 06/25/19
Ends: 06/24/20
Entitlement Type: Physical
''', '')
),
(
[
'/testbin/subscription-manager',
redhat_subscription: call 'remove' instead of 'unsubscribe' (#4809) The 'unsubscribe' command of 'subscription-manager' was deprecated already in subscription-manager 1.11.3, shipped with RHEL 5.11. As it was removed in subscription-manager 1.29.x, unsubscribing from pools was thus broken. The simple fix is to call the proper command, 'remove'.
2022-06-14 07:26:38 +02:00
'remove',
Initial commit
2020-03-09 10:11:07 +01:00
'--serial=7807912223970164816',
],
{'check_rc': True},
(0, '', '')
),
(
[
'subscription-manager list --available',
{'check_rc': True, 'environ_update': {'LANG': 'C', 'LC_ALL': 'C', 'LC_MESSAGES': 'C'}},
(0,
'''
+-------------------------------------------+
Available Subscriptions
+-------------------------------------------+
Subscription Name: SP Smart Management (A: ADDON1)
Provides: SP Addon 1 bits
SKU: sp-with-addon-1
Contract: 1
Pool ID: ff8080816b8e967f016b8e99747107e9
Provides Management: Yes
Available: 10
Suggested: 1
Service Type:
Roles:
Service Level:
Usage:
Add-ons: ADDON1
Subscription Type: Standard
Starts: 25.6.2019
Ends: 24.6.2020
Entitlement Type: Physical
Subscription Name: SP Server Premium (S: Premium, U: Production, R: SP Server)
Provides: SP Server Bits
SKU: sp-server-prem-prod
Contract: 0
Pool ID: ff8080816b8e967f016b8e99632804a6
Provides Management: Yes
Available: 5
Suggested: 1
Service Type: L1-L3
Roles: SP Server
Service Level: Premium
Usage: Production
Add-ons:
Subscription Type: Standard
Starts: 06/25/19
Ends: 06/24/20
Entitlement Type: Physical
Subscription Name: Multi-Attribute Stackable (4 cores, no content)
Provides: Multi-Attribute Limited Product (no content)
SKU: cores4-multiattr
Contract: 1
Pool ID: ff8080816b8e967f016b8e995f5103b5
Provides Management: No
Available: 10
Suggested: 1
Service Type: Level 3
Roles:
Service Level: Premium
Usage:
Add-ons:
Subscription Type: Stackable
Starts: 11.7.2019
Ends: 10.7.2020
Entitlement Type: Physical
''', '')
]
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99632804a6',
'--quantity', '2'
],
{'check_rc': True},
(0, '', '')
),
(
[
'/testbin/subscription-manager',
'attach',
'--pool', 'ff8080816b8e967f016b8e99747107e9',
'--quantity', '4'
],
{'check_rc': True},
(0, '', '')
)
],
'changed': True,
}
]
]
TEST_CASES_IDS = [item[1]['id'] for item in TEST_CASES]
@pytest.mark.parametrize('patch_ansible_module, testcase', TEST_CASES, ids=TEST_CASES_IDS, indirect=['patch_ansible_module'])
@pytest.mark.usefixtures('patch_ansible_module')
Fix macports package present/active detection (#1308) * Fix typo in redhat_subscription testcase * Fix macports state=present matching against the wrong package name Previous implementation returned true if the desired package name occurred anywhere in the list of all installed packages. For example as a substring of another package name, or even as a substring of a variant name for a different package. Instead: - request macports only list installed packages matching the desired package name, instead of all installed packages. - Note `port` exits with 0 regardless of whether any packages match the requested name. - pass `-q` flag: "Do not print the header line. This is useful when parsing the output of port installed in scripts for further processing." - eliminate `use_unsafe_shell=True` by searching stdout contents natively in python instead of using `grep`. This has the added benefit of eliminating any potential misinterpretation of characters in the package name as regex special characters. If there are zero matching installed packages, `out` is empty. If there are one or more matches (due to multiple installed versions), the output format is: https://github.com/macports/macports-base/blob/ec8a2bc682c7afbde198aee23a1920557721b508/src/port/port.tcl#L3320-L3323 Notably, two leading spaces, the package name, a space, and then other information. According to blame via github, those lines haven't changed in 11 years. * Update macports state=active to eliminate use_unsafe_shell Similar to previous commit (for macports state=present): - pass `-q` flag: "Do not print the header line. This is useful when parsing the output of port installed in scripts for further processing." - search stdout contents natively in python instead of using `grep`. - added parentheses to search string to eliminate false positives if the package name or variants contain the word `active`. Still could fail if they contain `(active)`, but that's less likely If there are zero matching installed packages, `out` is empty. If there are one or more matches (due to multiple installed versions), the output format is: https://github.com/macports/macports-base/blob/ec8a2bc682c7afbde198aee23a1920557721b508/src/port/port.tcl#L3320-L3323 For "state=active", we're looking for a line that contains `(active)` in the output. * Basic test case of query_port for present and active * Attempt to fix lint errors in test * Different mock module creation, changed test cases indentation/spacing - picked the wrong mock code to cargo-cult. Thanks to felixfontein for this suggestion - 4 space indentation on continuation line. I thought I had that originally, but it looks like my editor sabotaged me with mixed tabs/spaces - Remove leading newline on multi-line test cases. I don't think it would make a difference, but I'd read up on how the python syntax works and want to more accurately represent macports output. fingers crossed this addresses the known build errors * Add changelog fragment * Update tests/unit/plugins/modules/packaging/os/test_macports.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/1307-macports-fix-status-check.yml Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-11-26 06:59:32 +01:00
def test_redhat_subscription(mocker, capfd, patch_redhat_subscription, testcase):
Initial commit
2020-03-09 10:11:07 +01:00
"""
Run unit tests for test cases listen in TEST_CASES
"""
# Mock function used for running commands first
call_results = [item[2] for item in testcase['run_command.calls']]
mock_run_command = mocker.patch.object(
basic.AnsibleModule,
'run_command',
side_effect=call_results)
# Try to run test case
with pytest.raises(SystemExit):
redhat_subscription.main()
out, err = capfd.readouterr()
results = json.loads(out)
assert 'changed' in results
assert results['changed'] == testcase['changed']
if 'msg' in results:
assert results['msg'] == testcase['msg']
assert basic.AnsibleModule.run_command.call_count == len(testcase['run_command.calls'])
if basic.AnsibleModule.run_command.call_count:
call_args_list = [(item[0][0], item[1]) for item in basic.AnsibleModule.run_command.call_args_list]
expected_call_args_list = [(item[0], item[1]) for item in testcase['run_command.calls']]
assert call_args_list == expected_call_args_list
SYSPURPOSE_TEST_CASES = [
# Test setting syspurpose attributes (system is already registered)
# and synchronization with candlepin server
[
{
'state': 'present',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'syspurpose': {
'role': 'AwesomeOS',
'usage': 'Production',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
'sync': True
}
},
{
'id': 'test_setting_syspurpose_attributes',
'existing_syspurpose': {},
'expected_syspurpose': {
'role': 'AwesomeOS',
'usage': 'Production',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
},
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', '')
),
(
['/testbin/subscription-manager', 'status'],
{'check_rc': False},
(0, '''
+-------------------------------------------+
System Status Details
+-------------------------------------------+
Overall Status: Current
System Purpose Status: Matched
''', '')
)
],
'changed': True,
'msg': 'Syspurpose attributes changed.'
}
],
# Test setting unspupported attributes
[
{
'state': 'present',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'syspurpose': {
'foo': 'Bar',
'role': 'AwesomeOS',
'usage': 'Production',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
'sync': True
}
},
{
'id': 'test_setting_syspurpose_wrong_attributes',
'existing_syspurpose': {},
'expected_syspurpose': {},
'run_command.calls': [],
'failed': True
}
],
# Test setting addons not a list
[
{
'state': 'present',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'syspurpose': {
'role': 'AwesomeOS',
'usage': 'Production',
'service_level_agreement': 'Premium',
'addons': 'ADDON1',
'sync': True
}
},
{
'id': 'test_setting_syspurpose_addons_not_list',
'existing_syspurpose': {},
'expected_syspurpose': {
'role': 'AwesomeOS',
'usage': 'Production',
'service_level_agreement': 'Premium',
'addons': ['ADDON1']
},
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', '')
),
(
['/testbin/subscription-manager', 'status'],
{'check_rc': False},
(0, '''
+-------------------------------------------+
System Status Details
+-------------------------------------------+
Overall Status: Current
System Purpose Status: Matched
''', '')
)
],
'changed': True,
'msg': 'Syspurpose attributes changed.'
}
],
# Test setting syspurpose attributes (system is already registered)
# without synchronization with candlepin server. Some syspurpose attributes were set
# in the past
[
{
'state': 'present',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'syspurpose': {
'role': 'AwesomeOS',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
'sync': False
}
},
{
'id': 'test_changing_syspurpose_attributes',
'existing_syspurpose': {
'role': 'CoolOS',
'usage': 'Production',
'service_level_agreement': 'Super',
'addons': [],
'foo': 'bar'
},
'expected_syspurpose': {
'role': 'AwesomeOS',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
'foo': 'bar'
},
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', '')
),
],
'changed': True,
'msg': 'Syspurpose attributes changed.'
}
],
# Test trying to set syspurpose attributes (system is already registered)
# without synchronization with candlepin server. Some syspurpose attributes were set
# in the past. Syspurpose attributes are same as before
[
{
'state': 'present',
'server_hostname': 'subscription.rhsm.redhat.com',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'syspurpose': {
'role': 'AwesomeOS',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
'sync': False
}
},
{
'id': 'test_not_changing_syspurpose_attributes',
'existing_syspurpose': {
'role': 'AwesomeOS',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
},
'expected_syspurpose': {
'role': 'AwesomeOS',
'service_level_agreement': 'Premium',
'addons': ['ADDON1', 'ADDON2'],
},
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(0, 'system identity: b26df632-25ed-4452-8f89-0308bfd167cb', '')
),
],
'changed': False,
'msg': 'System already registered.'
}
],
# Test of registration using username and password with auto-attach option, when
# syspurpose attributes are set
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'auto_attach': 'true',
'syspurpose': {
'role': 'AwesomeOS',
'usage': 'Testing',
'service_level_agreement': 'Super',
'addons': ['ADDON1'],
'sync': False
},
},
{
'id': 'test_registeration_username_password_auto_attach_syspurpose',
'existing_syspurpose': None,
'expected_syspurpose': {
'role': 'AwesomeOS',
'usage': 'Testing',
'service_level_agreement': 'Super',
'addons': ['ADDON1'],
},
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--auto-attach',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
# Test of registration using username and password with auto-attach option, when
# syspurpose attributes are set. Syspurpose attributes are also synchronized
# in this case
[
{
'state': 'present',
'username': 'admin',
'password': 'admin',
'org_id': 'admin',
'auto_attach': 'true',
'syspurpose': {
'role': 'AwesomeOS',
'usage': 'Testing',
'service_level_agreement': 'Super',
'addons': ['ADDON1'],
'sync': True
},
},
{
'id': 'test_registeration_username_password_auto_attach_syspurpose_sync',
'existing_syspurpose': None,
'expected_syspurpose': {
'role': 'AwesomeOS',
'usage': 'Testing',
'service_level_agreement': 'Super',
'addons': ['ADDON1'],
},
'run_command.calls': [
(
['/testbin/subscription-manager', 'identity'],
{'check_rc': False},
(1, 'This system is not yet registered.', '')
),
(
[
'/testbin/subscription-manager',
'register',
'--org', 'admin',
'--auto-attach',
'--username', 'admin',
'--password', 'admin'
],
{'check_rc': True, 'expand_user_and_vars': False},
(0, '', '')
),
(
['/testbin/subscription-manager', 'status'],
{'check_rc': False},
(0, '''
+-------------------------------------------+
System Status Details
+-------------------------------------------+
Overall Status: Current
System Purpose Status: Matched
''', '')
)
],
'changed': True,
'msg': "System successfully registered to 'None'."
}
],
]
SYSPURPOSE_TEST_CASES_IDS = [item[1]['id'] for item in SYSPURPOSE_TEST_CASES]
@pytest.mark.parametrize('patch_ansible_module, testcase', SYSPURPOSE_TEST_CASES, ids=SYSPURPOSE_TEST_CASES_IDS, indirect=['patch_ansible_module'])
@pytest.mark.usefixtures('patch_ansible_module')
Fix macports package present/active detection (#1308) * Fix typo in redhat_subscription testcase * Fix macports state=present matching against the wrong package name Previous implementation returned true if the desired package name occurred anywhere in the list of all installed packages. For example as a substring of another package name, or even as a substring of a variant name for a different package. Instead: - request macports only list installed packages matching the desired package name, instead of all installed packages. - Note `port` exits with 0 regardless of whether any packages match the requested name. - pass `-q` flag: "Do not print the header line. This is useful when parsing the output of port installed in scripts for further processing." - eliminate `use_unsafe_shell=True` by searching stdout contents natively in python instead of using `grep`. This has the added benefit of eliminating any potential misinterpretation of characters in the package name as regex special characters. If there are zero matching installed packages, `out` is empty. If there are one or more matches (due to multiple installed versions), the output format is: https://github.com/macports/macports-base/blob/ec8a2bc682c7afbde198aee23a1920557721b508/src/port/port.tcl#L3320-L3323 Notably, two leading spaces, the package name, a space, and then other information. According to blame via github, those lines haven't changed in 11 years. * Update macports state=active to eliminate use_unsafe_shell Similar to previous commit (for macports state=present): - pass `-q` flag: "Do not print the header line. This is useful when parsing the output of port installed in scripts for further processing." - search stdout contents natively in python instead of using `grep`. - added parentheses to search string to eliminate false positives if the package name or variants contain the word `active`. Still could fail if they contain `(active)`, but that's less likely If there are zero matching installed packages, `out` is empty. If there are one or more matches (due to multiple installed versions), the output format is: https://github.com/macports/macports-base/blob/ec8a2bc682c7afbde198aee23a1920557721b508/src/port/port.tcl#L3320-L3323 For "state=active", we're looking for a line that contains `(active)` in the output. * Basic test case of query_port for present and active * Attempt to fix lint errors in test * Different mock module creation, changed test cases indentation/spacing - picked the wrong mock code to cargo-cult. Thanks to felixfontein for this suggestion - 4 space indentation on continuation line. I thought I had that originally, but it looks like my editor sabotaged me with mixed tabs/spaces - Remove leading newline on multi-line test cases. I don't think it would make a difference, but I'd read up on how the python syntax works and want to more accurately represent macports output. fingers crossed this addresses the known build errors * Add changelog fragment * Update tests/unit/plugins/modules/packaging/os/test_macports.py Co-authored-by: Felix Fontein <felix@fontein.de> * Update changelogs/fragments/1307-macports-fix-status-check.yml Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Felix Fontein <felix@fontein.de>
2020-11-26 06:59:32 +01:00
def test_redhat_subscription_syspurpose(mocker, capfd, patch_redhat_subscription, patch_ansible_module, testcase, tmpdir):
Initial commit
2020-03-09 10:11:07 +01:00
"""
Run unit tests for test cases listen in SYSPURPOSE_TEST_CASES (syspurpose specific cases)
"""
# Mock function used for running commands first
call_results = [item[2] for item in testcase['run_command.calls']]
mock_run_command = mocker.patch.object(
basic.AnsibleModule,
'run_command',
side_effect=call_results)
mock_syspurpose_file = tmpdir.mkdir("syspurpose").join("syspurpose.json")
# When there there are some existing syspurpose attributes specified, then
# write them to the file first
if testcase['existing_syspurpose'] is not None:
mock_syspurpose_file.write(json.dumps(testcase['existing_syspurpose']))
else:
mock_syspurpose_file.write("{}")
redhat_subscription.SysPurpose.SYSPURPOSE_FILE_PATH = str(mock_syspurpose_file)
# Try to run test case
with pytest.raises(SystemExit):
redhat_subscription.main()
out, err = capfd.readouterr()
results = json.loads(out)
if 'failed' in testcase:
assert results['failed'] == testcase['failed']
else:
assert 'changed' in results
assert results['changed'] == testcase['changed']
if 'msg' in results:
assert results['msg'] == testcase['msg']
mock_file_content = mock_syspurpose_file.read_text("utf-8")
current_syspurpose = json.loads(mock_file_content)
assert current_syspurpose == testcase['expected_syspurpose']
assert basic.AnsibleModule.run_command.call_count == len(testcase['run_command.calls'])
if basic.AnsibleModule.run_command.call_count:
call_args_list = [(item[0][0], item[1]) for item in basic.AnsibleModule.run_command.call_args_list]
expected_call_args_list = [(item[0], item[1]) for item in testcase['run_command.calls']]
assert call_args_list == expected_call_args_list
Copy permalink