Linting with Ruff

Adding basic linting with Ruff.

[#10]

Signed-off-by: Geoffrey Wiseman <geoffrey.wiseman@codiform.com>

.github/workflows/ci.yml

@@ -20,15 +20,17 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
+
       - name: Setup Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install Poetry
         uses: snok/install-poetry@v1
+
       - name: Install Dependencies
-        run: |
-          poetry install
+        run: poetry install
+
       - name: Test
-        run: |
-          poetry run pytest
+        run: poetry run pytest

awswl/cli.py

@@ -6,8 +6,8 @@
 
 def parse_args(args):
     parser = argparse.ArgumentParser(
-        description='Maintains a list of whitelisted CIDR blocks granted SSH access to AWS via a '
-                    'security group.'
+        description='Maintains a list of whitelisted CIDR blocks granted SSH access to '
+                    'AWS via a security group.'
     )
     parser.add_argument(
         '--list', action='append_const', dest='actions', const='cmd_list',
@@ -18,7 +18,8 @@ def parse_args(args):
         help='Adds the current IP address to the whitelist.'
     )
     parser.add_argument(
-        '--remove-current', action='append_const', dest='actions', const='cmd_remove_current',
+        '--remove-current', action='append_const', dest='actions',
+        const='cmd_remove_current',
         help='Remove the current IP address from the whitelist.'
     )
     parser.add_argument(

awswl/main.py

@@ -36,11 +36,14 @@ def has_action(options):
 def validate_options(options):
     if not options.sgid:
         print(
-            "No security group specified as an argument with --sgid or in the environment "
-            "as AWSWL_SGID. Cannot proceed.")
+            "No security group specified as an argument with --sgid or in the "
+            "environment as AWSWL_SGID. Cannot proceed."
+        )
         return False
     elif has_action(options):
         print(
-            "You haven't asked AWSWL to do anything. Try `awswl --help` to get started?.")
+            "You haven't asked AWSWL to do anything. "
+            "Try `awswl --help` to get started?"
+        )
         return False
     return True

pyproject.toml

@@ -37,6 +37,7 @@ requests = "^2.28.2"
 pytest = "^7.2.2"
 moto = "^4.1.6"
 mock = "^5.0.1"
+ruff = "^0.0.260"
 
 [build-system]
 requires = ["poetry-core"]

tests/test_commands.py

@@ -146,7 +146,8 @@ def test_add_adds_specified_permission(mock_stdout, region, security_group):
 
 @patch('awswl.externalip.get_external_ip', return_value='192.0.2.1')
 @patch('sys.stdout', new_callable=io.StringIO)
-def test_remove_current_removes_permission(mock_stdout, exip_method, region, security_group):
+def test_remove_current_removes_permission(mock_stdout, exip_method, region,
+                                           security_group):
     security_group.authorize_ingress(IpPermissions=[{
         'IpRanges': [
             {'CidrIp': '192.0.2.1/32'},
@@ -160,15 +161,19 @@ def test_remove_current_removes_permission(mock_stdout, exip_method, region, sec
 
     after_group = boto3.resource('ec2').SecurityGroup(security_group.id)
     assert not after_group.ip_permissions
-    assert "Removed current external IP address as a CIDR block" in mock_stdout.getvalue()
+    assert "Removed current external IP address as a CIDR block" \
+           in mock_stdout.getvalue()
 
 
 @patch('awswl.externalip.get_external_ip', return_value='192.0.2.1')
 @patch('sys.stdout', new_callable=io.StringIO)
-def test_remove_current_indicates_notfound(mock_stdout, exip_method, region, security_group):
+def test_remove_current_indicates_notfound(mock_stdout, exip_method, region,
+                                           security_group):
     opt = options(security_group)
     commands.cmd_remove_current(opt)
-    assert "Current external IP address as a CIDR block does not seem to be whitelisted." in mock_stdout.getvalue()
+    assert \
+        "Current external IP address as a CIDR block does not seem to be whitelisted." \
+        in mock_stdout.getvalue()
 
 
 @patch('sys.stdout', new_callable=io.StringIO)
@@ -182,7 +187,7 @@ def test_remove_removes_specified(mock_stdout, region, security_group):
         'ToPort': 22
     }])
     opt = options(security_group)
-    commands.cmd_remove(opt,'192.0.2.1/32')
+    commands.cmd_remove(opt, '192.0.2.1/32')
 
     after_group = boto3.resource('ec2').SecurityGroup(security_group.id)
     assert not after_group.ip_permissions
@@ -192,6 +197,6 @@ def test_remove_removes_specified(mock_stdout, region, security_group):
 @patch('sys.stdout', new_callable=io.StringIO)
 def test_remove_specified_indicates_notfound(mock_stdout, region, security_group):
     opt = options(security_group)
-    commands.cmd_remove(opt,'192.0.2.1/32')
-    assert "Specified CIDR block does not seem to be whitelisted." in mock_stdout.getvalue()
-
+    commands.cmd_remove(opt, '192.0.2.1/32')
+    assert "Specified CIDR block does not seem to be whitelisted." \
+           in mock_stdout.getvalue()