mirror of
https://github.com/ansible-collections/community.crypto.git
synced 2026-05-07 22:03:01 +00:00
ACME exception fixes (#217)
* Fix wrong usages of ACMEProtocolException. * Add changelog fragment. * Fix error handling when content could not be decoded. * Make sure that content_json is a dict or None. * Improve acme_inspect's ACMEProtocolException handling. * Improve error handling. * Add tests. * Fix challenge error. * Add challenges tests. * Provide content if available. * Add some order tests. * Linting.
This commit is contained in:
Felix Fontein
GitHub
248
tests/unit/plugins/module_utils/acme/test_challenges.py
Normal file
248
tests/unit/plugins/module_utils/acme/test_challenges.py
Normal file
@@ -0,0 +1,248 @@
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
import pytest
|
||||
|
||||
from mock import MagicMock
|
||||
|
||||
|
||||
from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import (
|
||||
combine_identifier,
|
||||
split_identifier,
|
||||
Challenge,
|
||||
Authorization,
|
||||
)
|
||||
|
||||
from ansible_collections.community.crypto.plugins.module_utils.acme.errors import (
|
||||
ACMEProtocolException,
|
||||
ModuleFailException,
|
||||
)
|
||||
|
||||
|
||||
def test_combine_identifier():
|
||||
assert combine_identifier('', '') == ':'
|
||||
assert combine_identifier('a', 'b') == 'a:b'
|
||||
|
||||
|
||||
def test_split_identifier():
|
||||
assert split_identifier(':') == ['', '']
|
||||
assert split_identifier('a:b') == ['a', 'b']
|
||||
assert split_identifier('a:b:c') == ['a', 'b:c']
|
||||
with pytest.raises(ModuleFailException) as exc:
|
||||
split_identifier('a')
|
||||
assert exc.value.msg == 'Identifier "a" is not of the form <type>:<identifier>'
|
||||
|
||||
|
||||
def test_challenge_from_to_json():
|
||||
client = MagicMock()
|
||||
|
||||
data = {
|
||||
'url': 'xxx',
|
||||
'type': 'type',
|
||||
'status': 'valid',
|
||||
}
|
||||
client.version = 2
|
||||
challenge = Challenge.from_json(client, data)
|
||||
assert challenge.data == data
|
||||
assert challenge.type == 'type'
|
||||
assert challenge.url == 'xxx'
|
||||
assert challenge.status == 'valid'
|
||||
assert challenge.token is None
|
||||
assert challenge.to_json() == data
|
||||
|
||||
data = {
|
||||
'type': 'type',
|
||||
'status': 'valid',
|
||||
'token': 'foo',
|
||||
}
|
||||
challenge = Challenge.from_json(None, data, url='xxx')
|
||||
assert challenge.data == data
|
||||
assert challenge.type == 'type'
|
||||
assert challenge.url == 'xxx'
|
||||
assert challenge.status == 'valid'
|
||||
assert challenge.token == 'foo'
|
||||
assert challenge.to_json() == data
|
||||
|
||||
data = {
|
||||
'uri': 'xxx',
|
||||
'type': 'type',
|
||||
'status': 'valid',
|
||||
}
|
||||
client.version = 1
|
||||
challenge = Challenge.from_json(client, data)
|
||||
assert challenge.data == data
|
||||
assert challenge.type == 'type'
|
||||
assert challenge.url == 'xxx'
|
||||
assert challenge.status == 'valid'
|
||||
assert challenge.token is None
|
||||
assert challenge.to_json() == data
|
||||
|
||||
|
||||
def test_authorization_from_to_json():
|
||||
client = MagicMock()
|
||||
client.version = 2
|
||||
|
||||
data = {
|
||||
'challenges': [],
|
||||
'status': 'valid',
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
}
|
||||
authz = Authorization.from_json(client, data, 'xxx')
|
||||
assert authz.url == 'xxx'
|
||||
assert authz.status == 'valid'
|
||||
assert authz.identifier == 'example.com'
|
||||
assert authz.identifier_type == 'dns'
|
||||
assert authz.challenges == []
|
||||
assert authz.to_json() == {
|
||||
'uri': 'xxx',
|
||||
'challenges': [],
|
||||
'status': 'valid',
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
}
|
||||
|
||||
data = {
|
||||
'challenges': [
|
||||
{
|
||||
'url': 'xxxyyy',
|
||||
'type': 'type',
|
||||
'status': 'valid',
|
||||
}
|
||||
],
|
||||
'status': 'valid',
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
'wildcard': True,
|
||||
}
|
||||
authz = Authorization.from_json(client, data, 'xxx')
|
||||
assert authz.url == 'xxx'
|
||||
assert authz.status == 'valid'
|
||||
assert authz.identifier == '*.example.com'
|
||||
assert authz.identifier_type == 'dns'
|
||||
assert len(authz.challenges) == 1
|
||||
assert authz.challenges[0].data == {
|
||||
'url': 'xxxyyy',
|
||||
'type': 'type',
|
||||
'status': 'valid',
|
||||
}
|
||||
assert authz.to_json() == {
|
||||
'uri': 'xxx',
|
||||
'challenges': [
|
||||
{
|
||||
'url': 'xxxyyy',
|
||||
'type': 'type',
|
||||
'status': 'valid',
|
||||
}
|
||||
],
|
||||
'status': 'valid',
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
'wildcard': True,
|
||||
}
|
||||
|
||||
client.version = 1
|
||||
|
||||
data = {
|
||||
'challenges': [],
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
}
|
||||
authz = Authorization.from_json(client, data, 'xxx')
|
||||
assert authz.url == 'xxx'
|
||||
assert authz.status == 'pending'
|
||||
assert authz.identifier == 'example.com'
|
||||
assert authz.identifier_type == 'dns'
|
||||
assert authz.challenges == []
|
||||
assert authz.to_json() == {
|
||||
'uri': 'xxx',
|
||||
'challenges': [],
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
def test_authorization_create_error():
|
||||
client = MagicMock()
|
||||
client.version = 2
|
||||
client.directory.directory = {}
|
||||
with pytest.raises(ACMEProtocolException) as exc:
|
||||
Authorization.create(client, 'dns', 'example.com')
|
||||
|
||||
assert exc.value.msg == 'ACME endpoint does not support pre-authorization.'
|
||||
|
||||
|
||||
def test_wait_for_validation_error():
|
||||
client = MagicMock()
|
||||
client.version = 2
|
||||
data = {
|
||||
'challenges': [
|
||||
{
|
||||
'url': 'xxxyyy1',
|
||||
'type': 'dns-01',
|
||||
'status': 'invalid',
|
||||
'error': {
|
||||
'type': 'dns-failed',
|
||||
'subproblems': [
|
||||
{
|
||||
'type': 'subproblem',
|
||||
'detail': 'example.com DNS-01 validation failed',
|
||||
},
|
||||
]
|
||||
},
|
||||
},
|
||||
{
|
||||
'url': 'xxxyyy2',
|
||||
'type': 'http-01',
|
||||
'status': 'invalid',
|
||||
'error': {
|
||||
'type': 'http-failed',
|
||||
'subproblems': [
|
||||
{
|
||||
'type': 'subproblem',
|
||||
'detail': 'example.com HTTP-01 validation failed',
|
||||
},
|
||||
]
|
||||
},
|
||||
},
|
||||
{
|
||||
'url': 'xxxyyy3',
|
||||
'type': 'something-else',
|
||||
'status': 'valid',
|
||||
},
|
||||
],
|
||||
'status': 'invalid',
|
||||
'identifier': {
|
||||
'type': 'dns',
|
||||
'value': 'example.com',
|
||||
},
|
||||
}
|
||||
client.get_request = MagicMock(return_value=(data, {}))
|
||||
authz = Authorization.from_json(client, data, 'xxx')
|
||||
with pytest.raises(ACMEProtocolException) as exc:
|
||||
authz.wait_for_validation(client, 'dns')
|
||||
|
||||
assert exc.value.msg == (
|
||||
'Failed to validate challenge for dns:example.com: Status is "invalid". Challenge dns-01: Error dns-failed Subproblems:\n'
|
||||
'(dns-01.0) Error subproblem: "example.com DNS-01 validation failed"; Challenge http-01: Error http-failed Subproblems:\n'
|
||||
'(http-01.0) Error subproblem: "example.com HTTP-01 validation failed".'
|
||||
)
|
||||
data = data.copy()
|
||||
data['uri'] = 'xxx'
|
||||
assert exc.value.module_fail_args == {
|
||||
'identifier': 'dns:example.com',
|
||||
'authorization': data,
|
||||
}
|
||||
Reference in New Issue
Block a user