diff --git a/rspec-tools/.gitignore b/rspec-tools/.gitignore new file mode 100644 index 0000000000..01388e4494 --- /dev/null +++ b/rspec-tools/.gitignore @@ -0,0 +1,4 @@ +*.egg-info +*.toml +*.mypy_cache +*.pytest_cache \ No newline at end of file diff --git a/rspec-tools/Pipfile b/rspec-tools/Pipfile new file mode 100644 index 0000000000..437e9cc574 --- /dev/null +++ b/rspec-tools/Pipfile @@ -0,0 +1,15 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +rspec-tools = {editable = true, path = "."} +click = ">=7.1.2" + +[dev-packages] +pytest = ">=6.2.2" +mypy = ">=0.800" + +[requires] +python_version = "3.9" diff --git a/rspec-tools/Pipfile.lock b/rspec-tools/Pipfile.lock new file mode 100644 index 0000000000..4db470e3bc --- /dev/null +++ b/rspec-tools/Pipfile.lock @@ -0,0 +1,175 @@ +{ + "_meta": { + "hash": { + "sha256": "288c23377a61ea856f97a76e48b91df69139ed1ebefcbaddb2493647cb805ab2" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.9" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "click": { + "hashes": [ + "sha256:d2b5255c7c6349bc1bd1e59e08cd12acbbd63ce649f2588755783aa94dfb6b1a", + "sha256:dacca89f4bfadd5de3d7489b7c8a566eee0d3676333fbb50030263894c38c0dc" + ], + "index": "pypi", + "version": "==7.1.2" + }, + "rspec-tools": { + "editable": true, + "path": "." + } + }, + "develop": { + "attrs": { + "hashes": [ + "sha256:31b2eced602aa8423c2aea9c76a724617ed67cf9513173fd3a4f03e3a929c7e6", + "sha256:832aa3cde19744e49938b91fea06d69ecb9e649c93ba974535d08ad92164f700" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==20.3.0" + }, + "iniconfig": { + "hashes": [ + "sha256:011e24c64b7f47f6ebd835bb12a743f2fbe9a26d4cecaa7f53bc4f35ee9da8b3", + "sha256:bc3af051d7d14b2ee5ef9969666def0cd1a000e121eaea580d4a313df4b37f32" + ], + "version": "==1.1.1" + }, + "mypy": { + "hashes": [ + "sha256:0d2fc8beb99cd88f2d7e20d69131353053fbecea17904ee6f0348759302c52fa", + "sha256:2b216eacca0ec0ee124af9429bfd858d5619a0725ee5f88057e6e076f9eb1a7b", + "sha256:319ee5c248a7c3f94477f92a729b7ab06bf8a6d04447ef3aa8c9ba2aa47c6dcf", + "sha256:3e0c159a7853e3521e3f582adb1f3eac66d0b0639d434278e2867af3a8c62653", + "sha256:5615785d3e2f4f03ab7697983d82c4b98af5c321614f51b8f1034eb9ebe48363", + "sha256:5ff616787122774f510caeb7b980542a7cc2222be3f00837a304ea85cd56e488", + "sha256:6f8425fecd2ba6007e526209bb985ce7f49ed0d2ac1cc1a44f243380a06a84fb", + "sha256:74f5aa50d0866bc6fb8e213441c41e466c86678c800700b87b012ed11c0a13e0", + "sha256:90b6f46dc2181d74f80617deca611925d7e63007cf416397358aa42efb593e07", + "sha256:947126195bfe4709c360e89b40114c6746ae248f04d379dca6f6ab677aa07641", + "sha256:a301da58d566aca05f8f449403c710c50a9860782148332322decf73a603280b", + "sha256:aa9d4901f3ee1a986a3a79fe079ffbf7f999478c281376f48faa31daaa814e86", + "sha256:b9150db14a48a8fa114189bfe49baccdff89da8c6639c2717750c7ae62316738", + "sha256:b95068a3ce3b50332c40e31a955653be245666a4bc7819d3c8898aa9fb9ea496", + "sha256:ca7ad5aed210841f1e77f5f2f7d725b62c78fa77519312042c719ed2ab937876", + "sha256:d16c54b0dffb861dc6318a8730952265876d90c5101085a4bc56913e8521ba19", + "sha256:e0202e37756ed09daf4b0ba64ad2c245d357659e014c3f51d8cd0681ba66940a", + "sha256:e1c84c65ff6d69fb42958ece5b1255394714e0aac4df5ffe151bc4fe19c7600a", + "sha256:e32b7b282c4ed4e378bba8b8dfa08e1cfa6f6574067ef22f86bee5b1039de0c9", + "sha256:e3b8432f8df19e3c11235c4563a7250666dc9aa7cdda58d21b4177b20256ca9f", + "sha256:e497a544391f733eca922fdcb326d19e894789cd4ff61d48b4b195776476c5cf", + "sha256:f5fdf935a46aa20aa937f2478480ebf4be9186e98e49cc3843af9a5795a49a25" + ], + "index": "pypi", + "version": "==0.800" + }, + "mypy-extensions": { + "hashes": [ + "sha256:090fedd75945a69ae91ce1303b5824f428daf5a028d2f6ab8a299250a846f15d", + "sha256:2d82818f5bb3e369420cb3c4060a7970edba416647068eb4c5343488a6c604a8" + ], + "version": "==0.4.3" + }, + "packaging": { + "hashes": [ + "sha256:24e0da08660a87484d1602c30bb4902d74816b6985b93de36926f5bc95741858", + "sha256:78598185a7008a470d64526a8059de9aaa449238f280fc9eb6b13ba6c4109093" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==20.8" + }, + "pluggy": { + "hashes": [ + "sha256:15b2acde666561e1298d71b523007ed7364de07029219b604cf808bfa1c765b0", + "sha256:966c145cd83c96502c3c3868f50408687b38434af77734af1e9ca461a4081d2d" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==0.13.1" + }, + "py": { + "hashes": [ + "sha256:21b81bda15b66ef5e1a777a21c4dcd9c20ad3efd0b3f817e7a809035269e1bd3", + "sha256:3b80836aa6d1feeaa108e046da6423ab8f6ceda6468545ae8d02d9d58d18818a" + ], + "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==1.10.0" + }, + "pyparsing": { + "hashes": [ + "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1", + "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b" + ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==2.4.7" + }, + "pytest": { + "hashes": [ + "sha256:9d1edf9e7d0b84d72ea3dbcdfd22b35fb543a5e8f2a60092dd578936bf63d7f9", + "sha256:b574b57423e818210672e07ca1fa90aaf194a4f63f3ab909a2c67ebb22913839" + ], + "index": "pypi", + "version": "==6.2.2" + }, + "toml": { + "hashes": [ + "sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b", + "sha256:b3bda1d108d5dd99f4a20d24d9c348e91c4db7ab1b749200bded2f839ccbe68f" + ], + "markers": "python_version >= '2.6' and python_version not in '3.0, 3.1, 3.2, 3.3'", + "version": "==0.10.2" + }, + "typed-ast": { + "hashes": [ + "sha256:07d49388d5bf7e863f7fa2f124b1b1d89d8aa0e2f7812faff0a5658c01c59aa1", + "sha256:14bf1522cdee369e8f5581238edac09150c765ec1cb33615855889cf33dcb92d", + "sha256:240296b27397e4e37874abb1df2a608a92df85cf3e2a04d0d4d61055c8305ba6", + "sha256:36d829b31ab67d6fcb30e185ec996e1f72b892255a745d3a82138c97d21ed1cd", + "sha256:37f48d46d733d57cc70fd5f30572d11ab8ed92da6e6b28e024e4a3edfb456e37", + "sha256:4c790331247081ea7c632a76d5b2a265e6d325ecd3179d06e9cf8d46d90dd151", + "sha256:5dcfc2e264bd8a1db8b11a892bd1647154ce03eeba94b461effe68790d8b8e07", + "sha256:7147e2a76c75f0f64c4319886e7639e490fee87c9d25cb1d4faef1d8cf83a440", + "sha256:7703620125e4fb79b64aa52427ec192822e9f45d37d4b6625ab37ef403e1df70", + "sha256:8368f83e93c7156ccd40e49a783a6a6850ca25b556c0fa0240ed0f659d2fe496", + "sha256:84aa6223d71012c68d577c83f4e7db50d11d6b1399a9c779046d75e24bed74ea", + "sha256:85f95aa97a35bdb2f2f7d10ec5bbdac0aeb9dafdaf88e17492da0504de2e6400", + "sha256:8db0e856712f79c45956da0c9a40ca4246abc3485ae0d7ecc86a20f5e4c09abc", + "sha256:9044ef2df88d7f33692ae3f18d3be63dec69c4fb1b5a4a9ac950f9b4ba571606", + "sha256:963c80b583b0661918718b095e02303d8078950b26cc00b5e5ea9ababe0de1fc", + "sha256:987f15737aba2ab5f3928c617ccf1ce412e2e321c77ab16ca5a293e7bbffd581", + "sha256:9ec45db0c766f196ae629e509f059ff05fc3148f9ffd28f3cfe75d4afb485412", + "sha256:9fc0b3cb5d1720e7141d103cf4819aea239f7d136acf9ee4a69b047b7986175a", + "sha256:a2c927c49f2029291fbabd673d51a2180038f8cd5a5b2f290f78c4516be48be2", + "sha256:a38878a223bdd37c9709d07cd357bb79f4c760b29210e14ad0fb395294583787", + "sha256:b4fcdcfa302538f70929eb7b392f536a237cbe2ed9cba88e3bf5027b39f5f77f", + "sha256:c0c74e5579af4b977c8b932f40a5464764b2f86681327410aa028a22d2f54937", + "sha256:c1c876fd795b36126f773db9cbb393f19808edd2637e00fd6caba0e25f2c7b64", + "sha256:c9aadc4924d4b5799112837b226160428524a9a45f830e0d0f184b19e4090487", + "sha256:cc7b98bf58167b7f2db91a4327da24fb93368838eb84a44c472283778fc2446b", + "sha256:cf54cfa843f297991b7388c281cb3855d911137223c6b6d2dd82a47ae5125a41", + "sha256:d003156bb6a59cda9050e983441b7fa2487f7800d76bdc065566b7d728b4581a", + "sha256:d175297e9533d8d37437abc14e8a83cbc68af93cc9c1c59c2c292ec59a0697a3", + "sha256:d746a437cdbca200622385305aedd9aef68e8a645e385cc483bdc5e488f07166", + "sha256:e683e409e5c45d5c9082dc1daf13f6374300806240719f95dc783d1fc942af10" + ], + "version": "==1.4.2" + }, + "typing-extensions": { + "hashes": [ + "sha256:7cb407020f00f7bfc3cb3e7881628838e69d8f3fcab2f64742a5e76b2f841918", + "sha256:99d4073b617d30288f569d3f13d2bd7548c3a7e4c8de87db09a9d29bb3a4a60c", + "sha256:dafc7639cde7f1b6e1acc0f457842a83e722ccca8eef5270af2d74792619a89f" + ], + "version": "==3.7.4.3" + } + } +} diff --git a/rspec-tools/README.adoc b/rspec-tools/README.adoc new file mode 100644 index 0000000000..1f4a0ea1dd --- /dev/null +++ b/rspec-tools/README.adoc @@ -0,0 +1,48 @@ +:source-highlighter: highlightjs + +rspec-tools: Tools automating RSPEC workflows +============================================= + +Install +------- + +.Install Pipenv +[source,shell] +---- +# macos +$ brew install pipenv +---- + +.Install rspec-tools +[source,shell] +---- +$ cd rspec-tools +$ pipenv install -e . +---- + + +Usage +----- + +.See all commands +[source,sh] +---- +$ rspec-tools --help +---- + + +Development +----------- + +.Install dev dependencies + +[source,sh] +---- +$ pipenv install --dev -e . +---- + +.Run tests +[source,sh] +---- +$ pytest +---- \ No newline at end of file diff --git a/rspec-tools/rspec_tools/__init__.py b/rspec-tools/rspec_tools/__init__.py new file mode 100644 index 0000000000..96241e54ee --- /dev/null +++ b/rspec-tools/rspec_tools/__init__.py @@ -0,0 +1,3 @@ +from .cli import cli + +__all__=["cli"] \ No newline at end of file diff --git a/rspec-tools/rspec_tools/cli.py b/rspec-tools/rspec_tools/cli.py new file mode 100644 index 0000000000..c7c1f91f76 --- /dev/null +++ b/rspec-tools/rspec_tools/cli.py @@ -0,0 +1,18 @@ +import click +from .errors import RuleNotFoundError + +@click.group() +@click.option('--debug/--no-debug', default=False) +def cli(debug): + 'Tools automating RSPEC workflows.' + +@cli.command() +@click.option('--rule', help='Validate only the rule matching the provided ID.') +def validate(rule): + '''Validate rules.''' + # TODO + if rule == '42': + raise RuleNotFoundError(rule) + + +__all__=['cli'] diff --git a/rspec-tools/rspec_tools/errors.py b/rspec-tools/rspec_tools/errors.py new file mode 100644 index 0000000000..096803afdd --- /dev/null +++ b/rspec-tools/rspec_tools/errors.py @@ -0,0 +1,5 @@ +from click import ClickException + +class RuleNotFoundError(ClickException): + def __init__(self, id): + super().__init__(f'No rule has ID {id}') diff --git a/rspec-tools/setup.py b/rspec-tools/setup.py new file mode 100644 index 0000000000..97638bf7ee --- /dev/null +++ b/rspec-tools/setup.py @@ -0,0 +1,13 @@ +from setuptools import setup, find_packages + +setup( + name='rspec-tools', + version='1.0.0', + url='https://github.com/SonarSource/rspec', + author='SonarSource', + description='Rule specification tooling', + packages=find_packages(), + entry_points={ + 'console_scripts': ['rspec-tools = rspec_tools:cli'] + }, +) \ No newline at end of file diff --git a/rspec-tools/tests/cli/test_validate.py b/rspec-tools/tests/cli/test_validate.py new file mode 100644 index 0000000000..83808c9f7b --- /dev/null +++ b/rspec-tools/tests/cli/test_validate.py @@ -0,0 +1,8 @@ +from click.testing import CliRunner +from rspec_tools import cli + +def test_hello_world(): + runner = CliRunner() + result = runner.invoke(cli, ['--debug', 'validate', '--rule=42']) + assert result.exit_code == 1 + assert result.output == 'Error: No rule has ID 42\n' \ No newline at end of file