mirror of
https://github.com/certbot/certbot.git
synced 2026-06-06 07:12:54 -04:00
d5de24d9fc
This PR is the second part of #6497 to ease the integration, following the new plan propose by @bmw here: #6497 (comment) This PR creates the module certbot.compat.os, that delegates everything to os, and that will be the safeguard against problematic methods of the standard module. On top of that, a quality check wrapper is called in the lint tox environment. This wrapper calls pylint and ensures that standard os module is no used directly in the certbot codebase. Finally local oldest requirements are updated to ensure that tests will take the new logic when running. * Add executable permissions * Add the delegate certbot.compat.os module, add check coding style to enforce usage of certbot.compat.os instead of standard os * Load certbot.compat.os instead of os * Move existing compat test * Update local oldest requirements * Import sys * Update account_test.py * Update os.py * Update os.py * Update local oldest requirements * Implement the new linter_plugin * Fix local oldest for nginx * Remove check coding style * Update linter_plugin.py * Add several comments * Update the setup.py * Add documentation * Update acme dependencies * Update certbot/compat/os.py * Update docs/contributing.rst * Update linter_plugin.py * Handle os.path. Simplify checker. * Add a comment to a reference implementation * Update changelog * Fix module registering * Update docs/contributing.rst * Update config and changelog
174 lines
6.6 KiB
Python
174 lines
6.6 KiB
Python
"""Tests for certbot_dns_cloudflare.dns_cloudflare."""
|
|
|
|
import unittest
|
|
|
|
import CloudFlare
|
|
import mock
|
|
|
|
from certbot import errors
|
|
from certbot.compat import os
|
|
from certbot.plugins import dns_test_common
|
|
from certbot.plugins.dns_test_common import DOMAIN
|
|
from certbot.tests import util as test_util
|
|
|
|
API_ERROR = CloudFlare.exceptions.CloudFlareAPIError(1000, '', '')
|
|
API_KEY = 'an-api-key'
|
|
EMAIL = 'example@example.com'
|
|
|
|
|
|
class AuthenticatorTest(test_util.TempDirTestCase, dns_test_common.BaseAuthenticatorTest):
|
|
|
|
def setUp(self):
|
|
from certbot_dns_cloudflare.dns_cloudflare import Authenticator
|
|
|
|
super(AuthenticatorTest, self).setUp()
|
|
|
|
path = os.path.join(self.tempdir, 'file.ini')
|
|
dns_test_common.write({"cloudflare_email": EMAIL, "cloudflare_api_key": API_KEY}, path)
|
|
|
|
self.config = mock.MagicMock(cloudflare_credentials=path,
|
|
cloudflare_propagation_seconds=0) # don't wait during tests
|
|
|
|
self.auth = Authenticator(self.config, "cloudflare")
|
|
|
|
self.mock_client = mock.MagicMock()
|
|
# _get_cloudflare_client | pylint: disable=protected-access
|
|
self.auth._get_cloudflare_client = mock.MagicMock(return_value=self.mock_client)
|
|
|
|
def test_perform(self):
|
|
self.auth.perform([self.achall])
|
|
|
|
expected = [mock.call.add_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY, mock.ANY)]
|
|
self.assertEqual(expected, self.mock_client.mock_calls)
|
|
|
|
def test_cleanup(self):
|
|
# _attempt_cleanup | pylint: disable=protected-access
|
|
self.auth._attempt_cleanup = True
|
|
self.auth.cleanup([self.achall])
|
|
|
|
expected = [mock.call.del_txt_record(DOMAIN, '_acme-challenge.'+DOMAIN, mock.ANY)]
|
|
self.assertEqual(expected, self.mock_client.mock_calls)
|
|
|
|
|
|
class CloudflareClientTest(unittest.TestCase):
|
|
record_name = "foo"
|
|
record_content = "bar"
|
|
record_ttl = 42
|
|
zone_id = 1
|
|
record_id = 2
|
|
|
|
def setUp(self):
|
|
from certbot_dns_cloudflare.dns_cloudflare import _CloudflareClient
|
|
|
|
self.cloudflare_client = _CloudflareClient(EMAIL, API_KEY)
|
|
|
|
self.cf = mock.MagicMock()
|
|
self.cloudflare_client.cf = self.cf
|
|
|
|
def test_add_txt_record(self):
|
|
self.cf.zones.get.return_value = [{'id': self.zone_id}]
|
|
|
|
self.cloudflare_client.add_txt_record(DOMAIN, self.record_name, self.record_content,
|
|
self.record_ttl)
|
|
|
|
self.cf.zones.dns_records.post.assert_called_with(self.zone_id, data=mock.ANY)
|
|
|
|
post_data = self.cf.zones.dns_records.post.call_args[1]['data']
|
|
|
|
self.assertEqual('TXT', post_data['type'])
|
|
self.assertEqual(self.record_name, post_data['name'])
|
|
self.assertEqual(self.record_content, post_data['content'])
|
|
self.assertEqual(self.record_ttl, post_data['ttl'])
|
|
|
|
def test_add_txt_record_error(self):
|
|
self.cf.zones.get.return_value = [{'id': self.zone_id}]
|
|
|
|
self.cf.zones.dns_records.post.side_effect = API_ERROR
|
|
|
|
self.assertRaises(
|
|
errors.PluginError,
|
|
self.cloudflare_client.add_txt_record,
|
|
DOMAIN, self.record_name, self.record_content, self.record_ttl)
|
|
|
|
def test_add_txt_record_error_during_zone_lookup(self):
|
|
self.cf.zones.get.side_effect = API_ERROR
|
|
|
|
self.assertRaises(
|
|
errors.PluginError,
|
|
self.cloudflare_client.add_txt_record,
|
|
DOMAIN, self.record_name, self.record_content, self.record_ttl)
|
|
|
|
def test_add_txt_record_zone_not_found(self):
|
|
self.cf.zones.get.return_value = []
|
|
|
|
self.assertRaises(
|
|
errors.PluginError,
|
|
self.cloudflare_client.add_txt_record,
|
|
DOMAIN, self.record_name, self.record_content, self.record_ttl)
|
|
|
|
def test_del_txt_record(self):
|
|
self.cf.zones.get.return_value = [{'id': self.zone_id}]
|
|
self.cf.zones.dns_records.get.return_value = [{'id': self.record_id}]
|
|
|
|
self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content)
|
|
|
|
expected = [mock.call.zones.get(params=mock.ANY),
|
|
mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY),
|
|
mock.call.zones.dns_records.delete(self.zone_id, self.record_id)]
|
|
|
|
self.assertEqual(expected, self.cf.mock_calls)
|
|
|
|
get_data = self.cf.zones.dns_records.get.call_args[1]['params']
|
|
|
|
self.assertEqual('TXT', get_data['type'])
|
|
self.assertEqual(self.record_name, get_data['name'])
|
|
self.assertEqual(self.record_content, get_data['content'])
|
|
|
|
def test_del_txt_record_error_during_zone_lookup(self):
|
|
self.cf.zones.get.side_effect = API_ERROR
|
|
|
|
self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content)
|
|
|
|
def test_del_txt_record_error_during_delete(self):
|
|
self.cf.zones.get.return_value = [{'id': self.zone_id}]
|
|
self.cf.zones.dns_records.get.return_value = [{'id': self.record_id}]
|
|
self.cf.zones.dns_records.delete.side_effect = API_ERROR
|
|
|
|
self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content)
|
|
expected = [mock.call.zones.get(params=mock.ANY),
|
|
mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY),
|
|
mock.call.zones.dns_records.delete(self.zone_id, self.record_id)]
|
|
|
|
self.assertEqual(expected, self.cf.mock_calls)
|
|
|
|
def test_del_txt_record_error_during_get(self):
|
|
self.cf.zones.get.return_value = [{'id': self.zone_id}]
|
|
self.cf.zones.dns_records.get.side_effect = API_ERROR
|
|
|
|
self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content)
|
|
expected = [mock.call.zones.get(params=mock.ANY),
|
|
mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY)]
|
|
|
|
self.assertEqual(expected, self.cf.mock_calls)
|
|
|
|
def test_del_txt_record_no_record(self):
|
|
self.cf.zones.get.return_value = [{'id': self.zone_id}]
|
|
self.cf.zones.dns_records.get.return_value = []
|
|
|
|
self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content)
|
|
expected = [mock.call.zones.get(params=mock.ANY),
|
|
mock.call.zones.dns_records.get(self.zone_id, params=mock.ANY)]
|
|
|
|
self.assertEqual(expected, self.cf.mock_calls)
|
|
|
|
def test_del_txt_record_no_zone(self):
|
|
self.cf.zones.get.return_value = [{'id': None}]
|
|
|
|
self.cloudflare_client.del_txt_record(DOMAIN, self.record_name, self.record_content)
|
|
expected = [mock.call.zones.get(params=mock.ANY)]
|
|
|
|
self.assertEqual(expected, self.cf.mock_calls)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
unittest.main() # pragma: no cover
|