diff --git a/ip_listener/tests.py b/ip_listener/tests.py index 35f6f41..06276b8 100644 --- a/ip_listener/tests.py +++ b/ip_listener/tests.py @@ -1,8 +1,11 @@ import json -from unittest import TestCase -from unittest.mock import patch + +from unittest import TestCase, skipIf +from unittest.mock import call, patch from click.testing import CliRunner +from pkg_resources import get_distribution +from requests import HTTPError from ip_listener.cli import DEFAULT_API_URL, run @@ -18,6 +21,8 @@ class RunTestCase(TestCase): patcher = patch("ip_listener.main.requests.put") self.mocked_put = patcher.start() + self.runner = CliRunner() + def test_simple(self): self.mocked_dns.return_value = b"111.420\n" self.mocked_get.return_value.json.return_value = { @@ -42,8 +47,7 @@ class RunTestCase(TestCase): } with self.assertLogs("ip_listener.main", level="INFO") as logger: - runner = CliRunner() - result = runner.invoke(run, ["foobar.com", "TOKEN"]) + result = self.runner.invoke(run, ["foobar.com", "TOKEN"]) self.assertEqual( logger.output, ["INFO:ip_listener.main:Updated domain foobar.com"] @@ -74,3 +78,328 @@ class RunTestCase(TestCase): data=expected_json, headers={"Authorization": "Bearer TOKEN"}, ) + + def test_error_response(self): + self.mocked_dns.return_value = b"111.420\n" + self.mocked_get.return_value.raise_for_status.side_effect = HTTPError + + with self.assertLogs("ip_listener.main", level="INFO") as logger: + result = self.runner.invoke(run, ["foobar.com", "TOKEN"]) + + error_log = logger.output[0] + + self.assertIn("Failed retrieving information for foobar.com", error_log) + self.assertEqual(result.exit_code, 0) + + self.mocked_get.assert_called_with( + f"{DEFAULT_API_URL}/domains/foobar.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ) + + self.mocked_put.assert_not_called() + + def test_matching_ip(self): + self.mocked_dns.return_value = b"111.420\n" + self.mocked_get.return_value.json.return_value = { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.420", + } + ], + "_links": [ + { + "rel": "self", + "link": "https://api.transip.nl/v6/domains/foobar.com/dns", + }, + { + "rel": "domain", + "link": "https://api.transip.nl/v6/domains/foobar.com", + }, + ], + } + + result = self.runner.invoke(run, ["foobar.com", "TOKEN"]) + + self.assertEqual(result.exit_code, 0) + + self.mocked_get.assert_called_with( + f"{DEFAULT_API_URL}/domains/foobar.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ) + + self.mocked_put.assert_not_called() + + def test_readonly(self): + self.mocked_dns.return_value = b"111.420\n" + self.mocked_get.return_value.json.return_value = { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.421", + } + ], + "_links": [ + { + "rel": "self", + "link": "https://api.transip.nl/v6/domains/foobar.com/dns", + }, + { + "rel": "domain", + "link": "https://api.transip.nl/v6/domains/foobar.com", + }, + ], + } + + result = self.runner.invoke(run, ["foobar.com", "TOKEN", "--read-only"]) + + self.assertEqual(result.exit_code, 0) + + self.mocked_get.assert_called_with( + f"{DEFAULT_API_URL}/domains/foobar.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ) + + self.mocked_put.assert_not_called() + + def test_different_api_url(self): + self.mocked_dns.return_value = b"111.420\n" + self.mocked_get.return_value.json.return_value = { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.421", + } + ], + "_links": [ + { + "rel": "self", + "link": "https://api.transip.nl/v6/domains/foobar.com/dns", + }, + { + "rel": "domain", + "link": "https://api.transip.nl/v6/domains/foobar.com", + }, + ], + } + + with self.assertLogs("ip_listener.main", level="INFO") as logger: + result = self.runner.invoke( + run, ["foobar.com", "TOKEN", "--api-url", "https://other-provider.com"] + ) + + self.assertEqual( + logger.output, ["INFO:ip_listener.main:Updated domain foobar.com"] + ) + + self.assertEqual(result.exit_code, 0) + + self.mocked_get.assert_called_with( + f"https://other-provider.com/domains/foobar.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ) + + expected_json = json.dumps( + { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.420", + } + ] + } + ) + + self.mocked_put.assert_called_with( + f"https://other-provider.com/domains/foobar.com/dns", + data=expected_json, + headers={"Authorization": "Bearer TOKEN"}, + ) + + def test_env_var(self): + self.mocked_dns.return_value = b"111.420\n" + self.mocked_get.return_value.json.return_value = { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.421", + } + ], + "_links": [ + { + "rel": "self", + "link": "https://api.transip.nl/v6/domains/foobar.com/dns", + }, + { + "rel": "domain", + "link": "https://api.transip.nl/v6/domains/foobar.com", + }, + ], + } + + with self.assertLogs("ip_listener.main", level="INFO") as logger: + result = self.runner.invoke( + run, ["foobar.com", "TOKEN"], env={"API_URL": "https://new-api.com"} + ) + + self.assertEqual( + logger.output, ["INFO:ip_listener.main:Updated domain foobar.com"] + ) + + self.assertEqual(result.exit_code, 0) + + self.mocked_get.assert_called_with( + "https://new-api.com/domains/foobar.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ) + + expected_json = json.dumps( + { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.420", + } + ] + } + ) + + self.mocked_put.assert_called_with( + "https://new-api.com/domains/foobar.com/dns", + data=expected_json, + headers={"Authorization": "Bearer TOKEN"}, + ) + + # see https://click.palletsprojects.com/en/master/changelog/#version-8-0 + @skipIf( + get_distribution("click").version < "8", + "Multiple arguments through env variables not supported", + ) + def test_multi_arg_env_var(self): + self.mocked_dns.return_value = b"111.420\n" + self.mocked_get.return_value.json.side_effect = [ + { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.421", + } + ], + "_links": [ + { + "rel": "self", + "link": "https://api.transip.nl/v6/domains/foobar.com/dns", + }, + { + "rel": "domain", + "link": "https://api.transip.nl/v6/domains/foobar.com", + }, + ], + }, + { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.421", + } + ], + "_links": [ + { + "rel": "self", + "link": "https://api.transip.nl/v6/domains/foofoo.com/dns", + }, + { + "rel": "domain", + "link": "https://api.transip.nl/v6/domains/foofoo.com", + }, + ], + }, + ] + + with self.assertLogs("ip_listener.main", level="INFO") as logger: + result = self.runner.invoke( + run, ["TOKEN"], env={"DOMAINS": "foobar.com foofoo.com"} + ) + + self.assertIsNone(result.exception) + self.assertEqual( + logger.output, + [ + "INFO:ip_listener.main:Updated domain foobar.com", + "INFO:ip_listener.main:Updated domain foofoo.com", + ], + ) + + self.assertEqual(result.exit_code, 0) + + expected_calls = [ + call( + f"{DEFAULT_API_URL}/domains/foobar.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ), + call().raise_for_status(), + call().json(), + call( + f"{DEFAULT_API_URL}/domains/foofoo.com/dns", + headers={"Authorization": "Bearer TOKEN"}, + ), + call().raise_for_status(), + call().json(), + ] + + self.mocked_get.assert_has_calls(expected_calls) + + expected_json = json.dumps( + { + "dnsEntries": [ + { + "name": "@", + "expire": 60, + "type": "A", + "content": "111.420", + } + ] + } + ) + + expected_calls = [ + call( + f"{DEFAULT_API_URL}/domains/foobar.com/dns", + data=expected_json, + headers={"Authorization": "Bearer TOKEN"}, + ), + call().raise_for_status(), + call( + f"{DEFAULT_API_URL}/domains/foofoo.com/dns", + data=expected_json, + headers={"Authorization": "Bearer TOKEN"}, + ), + call().raise_for_status(), + ] + + self.mocked_put.assert_has_calls(expected_calls) + + def test_no_domains(self): + result = self.runner.invoke(run, ["TOKEN"]) + + self.assertEqual(result.exit_code, 1) + self.assertEqual(str(result.exception), "No domain(s) specified") + + self.mocked_get.assert_not_called() + self.mocked_put.assert_not_called() diff --git a/poetry.lock b/poetry.lock index 6bffee5..5127967 100644 --- a/poetry.lock +++ b/poetry.lock @@ -73,7 +73,7 @@ python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" [[package]] name = "isort" -version = "5.6.4" +version = "5.7.0" description = "A Python utility / library to sort Python imports." category = "dev" optional = false @@ -155,7 +155,7 @@ python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" [[package]] name = "typed-ast" -version = "1.4.1" +version = "1.4.2" description = "a fork of Python 2 and 3 ast modules with type comment support" category = "dev" optional = false @@ -215,8 +215,8 @@ idna = [ {file = "idna-2.10.tar.gz", hash = "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6"}, ] isort = [ - {file = "isort-5.6.4-py3-none-any.whl", hash = "sha256:dcab1d98b469a12a1a624ead220584391648790275560e1a43e54c5dceae65e7"}, - {file = "isort-5.6.4.tar.gz", hash = "sha256:dcaeec1b5f0eca77faea2a35ab790b4f3680ff75590bfcb7145986905aab2f58"}, + {file = "isort-5.7.0-py3-none-any.whl", hash = "sha256:fff4f0c04e1825522ce6949973e83110a6e907750cd92d128b0d14aaaadbffdc"}, + {file = "isort-5.7.0.tar.gz", hash = "sha256:c729845434366216d320e936b8ad6f9d681aab72dc7cbc2d51bedc3582f3ad1e"}, ] mypy-extensions = [ {file = "mypy_extensions-0.4.3-py2.py3-none-any.whl", hash = "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d"}, @@ -286,27 +286,36 @@ toml = [ {file = "toml-0.10.2.tar.gz", hash = "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f"}, ] typed-ast = [ - {file = "typed_ast-1.4.1-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:73d785a950fc82dd2a25897d525d003f6378d1cb23ab305578394694202a58c3"}, - {file = "typed_ast-1.4.1-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:aaee9905aee35ba5905cfb3c62f3e83b3bec7b39413f0a7f19be4e547ea01ebb"}, - {file = "typed_ast-1.4.1-cp35-cp35m-win32.whl", hash = "sha256:0c2c07682d61a629b68433afb159376e24e5b2fd4641d35424e462169c0a7919"}, - {file = "typed_ast-1.4.1-cp35-cp35m-win_amd64.whl", hash = "sha256:4083861b0aa07990b619bd7ddc365eb7fa4b817e99cf5f8d9cf21a42780f6e01"}, - {file = "typed_ast-1.4.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:269151951236b0f9a6f04015a9004084a5ab0d5f19b57de779f908621e7d8b75"}, - {file = "typed_ast-1.4.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:24995c843eb0ad11a4527b026b4dde3da70e1f2d8806c99b7b4a7cf491612652"}, - {file = "typed_ast-1.4.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:fe460b922ec15dd205595c9b5b99e2f056fd98ae8f9f56b888e7a17dc2b757e7"}, - {file = "typed_ast-1.4.1-cp36-cp36m-win32.whl", hash = "sha256:4e3e5da80ccbebfff202a67bf900d081906c358ccc3d5e3c8aea42fdfdfd51c1"}, - {file = "typed_ast-1.4.1-cp36-cp36m-win_amd64.whl", hash = "sha256:249862707802d40f7f29f6e1aad8d84b5aa9e44552d2cc17384b209f091276aa"}, - {file = "typed_ast-1.4.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8ce678dbaf790dbdb3eba24056d5364fb45944f33553dd5869b7580cdbb83614"}, - {file = "typed_ast-1.4.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:c9e348e02e4d2b4a8b2eedb48210430658df6951fa484e59de33ff773fbd4b41"}, - {file = "typed_ast-1.4.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:bcd3b13b56ea479b3650b82cabd6b5343a625b0ced5429e4ccad28a8973f301b"}, - {file = "typed_ast-1.4.1-cp37-cp37m-win32.whl", hash = "sha256:d5d33e9e7af3b34a40dc05f498939f0ebf187f07c385fd58d591c533ad8562fe"}, - {file = "typed_ast-1.4.1-cp37-cp37m-win_amd64.whl", hash = "sha256:0666aa36131496aed8f7be0410ff974562ab7eeac11ef351def9ea6fa28f6355"}, - {file = "typed_ast-1.4.1-cp38-cp38-macosx_10_15_x86_64.whl", hash = "sha256:d205b1b46085271b4e15f670058ce182bd1199e56b317bf2ec004b6a44f911f6"}, - {file = "typed_ast-1.4.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:6daac9731f172c2a22ade6ed0c00197ee7cc1221aa84cfdf9c31defeb059a907"}, - {file = "typed_ast-1.4.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:498b0f36cc7054c1fead3d7fc59d2150f4d5c6c56ba7fb150c013fbc683a8d2d"}, - {file = "typed_ast-1.4.1-cp38-cp38-win32.whl", hash = "sha256:715ff2f2df46121071622063fc7543d9b1fd19ebfc4f5c8895af64a77a8c852c"}, - {file = "typed_ast-1.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:fc0fea399acb12edbf8a628ba8d2312f583bdbdb3335635db062fa98cf71fca4"}, - {file = "typed_ast-1.4.1-cp39-cp39-macosx_10_15_x86_64.whl", hash = "sha256:d43943ef777f9a1c42bf4e552ba23ac77a6351de620aa9acf64ad54933ad4d34"}, - {file = "typed_ast-1.4.1.tar.gz", hash = "sha256:8c8aaad94455178e3187ab22c8b01a3837f8ee50e09cf31f1ba129eb293ec30b"}, + {file = "typed_ast-1.4.2-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:7703620125e4fb79b64aa52427ec192822e9f45d37d4b6625ab37ef403e1df70"}, + {file = "typed_ast-1.4.2-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:c9aadc4924d4b5799112837b226160428524a9a45f830e0d0f184b19e4090487"}, + {file = "typed_ast-1.4.2-cp35-cp35m-manylinux2014_aarch64.whl", hash = "sha256:9ec45db0c766f196ae629e509f059ff05fc3148f9ffd28f3cfe75d4afb485412"}, + {file = "typed_ast-1.4.2-cp35-cp35m-win32.whl", hash = "sha256:85f95aa97a35bdb2f2f7d10ec5bbdac0aeb9dafdaf88e17492da0504de2e6400"}, + {file = "typed_ast-1.4.2-cp35-cp35m-win_amd64.whl", hash = "sha256:9044ef2df88d7f33692ae3f18d3be63dec69c4fb1b5a4a9ac950f9b4ba571606"}, + {file = "typed_ast-1.4.2-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:c1c876fd795b36126f773db9cbb393f19808edd2637e00fd6caba0e25f2c7b64"}, + {file = "typed_ast-1.4.2-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:5dcfc2e264bd8a1db8b11a892bd1647154ce03eeba94b461effe68790d8b8e07"}, + {file = "typed_ast-1.4.2-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:8db0e856712f79c45956da0c9a40ca4246abc3485ae0d7ecc86a20f5e4c09abc"}, + {file = "typed_ast-1.4.2-cp36-cp36m-manylinux2014_aarch64.whl", hash = "sha256:d003156bb6a59cda9050e983441b7fa2487f7800d76bdc065566b7d728b4581a"}, + {file = "typed_ast-1.4.2-cp36-cp36m-win32.whl", hash = "sha256:4c790331247081ea7c632a76d5b2a265e6d325ecd3179d06e9cf8d46d90dd151"}, + {file = "typed_ast-1.4.2-cp36-cp36m-win_amd64.whl", hash = "sha256:d175297e9533d8d37437abc14e8a83cbc68af93cc9c1c59c2c292ec59a0697a3"}, + {file = "typed_ast-1.4.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:cf54cfa843f297991b7388c281cb3855d911137223c6b6d2dd82a47ae5125a41"}, + {file = "typed_ast-1.4.2-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:b4fcdcfa302538f70929eb7b392f536a237cbe2ed9cba88e3bf5027b39f5f77f"}, + {file = "typed_ast-1.4.2-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:987f15737aba2ab5f3928c617ccf1ce412e2e321c77ab16ca5a293e7bbffd581"}, + {file = "typed_ast-1.4.2-cp37-cp37m-manylinux2014_aarch64.whl", hash = "sha256:37f48d46d733d57cc70fd5f30572d11ab8ed92da6e6b28e024e4a3edfb456e37"}, + {file = "typed_ast-1.4.2-cp37-cp37m-win32.whl", hash = "sha256:36d829b31ab67d6fcb30e185ec996e1f72b892255a745d3a82138c97d21ed1cd"}, + {file = "typed_ast-1.4.2-cp37-cp37m-win_amd64.whl", hash = "sha256:8368f83e93c7156ccd40e49a783a6a6850ca25b556c0fa0240ed0f659d2fe496"}, + {file = "typed_ast-1.4.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:963c80b583b0661918718b095e02303d8078950b26cc00b5e5ea9ababe0de1fc"}, + {file = "typed_ast-1.4.2-cp38-cp38-manylinux1_i686.whl", hash = "sha256:e683e409e5c45d5c9082dc1daf13f6374300806240719f95dc783d1fc942af10"}, + {file = "typed_ast-1.4.2-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:84aa6223d71012c68d577c83f4e7db50d11d6b1399a9c779046d75e24bed74ea"}, + {file = "typed_ast-1.4.2-cp38-cp38-manylinux2014_aarch64.whl", hash = "sha256:a38878a223bdd37c9709d07cd357bb79f4c760b29210e14ad0fb395294583787"}, + {file = "typed_ast-1.4.2-cp38-cp38-win32.whl", hash = "sha256:a2c927c49f2029291fbabd673d51a2180038f8cd5a5b2f290f78c4516be48be2"}, + {file = "typed_ast-1.4.2-cp38-cp38-win_amd64.whl", hash = "sha256:c0c74e5579af4b977c8b932f40a5464764b2f86681327410aa028a22d2f54937"}, + {file = "typed_ast-1.4.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:07d49388d5bf7e863f7fa2f124b1b1d89d8aa0e2f7812faff0a5658c01c59aa1"}, + {file = "typed_ast-1.4.2-cp39-cp39-manylinux1_i686.whl", hash = "sha256:240296b27397e4e37874abb1df2a608a92df85cf3e2a04d0d4d61055c8305ba6"}, + {file = "typed_ast-1.4.2-cp39-cp39-manylinux1_x86_64.whl", hash = "sha256:d746a437cdbca200622385305aedd9aef68e8a645e385cc483bdc5e488f07166"}, + {file = "typed_ast-1.4.2-cp39-cp39-manylinux2014_aarch64.whl", hash = "sha256:14bf1522cdee369e8f5581238edac09150c765ec1cb33615855889cf33dcb92d"}, + {file = "typed_ast-1.4.2-cp39-cp39-win32.whl", hash = "sha256:cc7b98bf58167b7f2db91a4327da24fb93368838eb84a44c472283778fc2446b"}, + {file = "typed_ast-1.4.2-cp39-cp39-win_amd64.whl", hash = "sha256:7147e2a76c75f0f64c4319886e7639e490fee87c9d25cb1d4faef1d8cf83a440"}, + {file = "typed_ast-1.4.2.tar.gz", hash = "sha256:9fc0b3cb5d1720e7141d103cf4819aea239f7d136acf9ee4a69b047b7986175a"}, ] typing-extensions = [ {file = "typing_extensions-3.7.4.3-py2-none-any.whl", hash = "sha256:dafc7639cde7f1b6e1acc0f457842a83e722ccca8eef5270af2d74792619a89f"}, diff --git a/pyproject.toml b/pyproject.toml index 9d03171..a42d767 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,7 @@ isort = "^5.6.4" autoflake = "^1.4" [tool.poetry.scripts] -ip_listen = "ip_listener.cli:run" +listen = "ip_listener.cli:run" [build-system] requires = ["poetry>=0.12"]