Skip to content

Commit

Permalink
chore(deadline): added tests for configure_identity_registration_sett…
Browse files Browse the repository at this point in the history 
…ings.py
  • Loading branch information
@horsmand
horsmand committed Oct 8, 2021
1 parent c2be47e commit e327d92
Show file tree
Hide file tree
Showing 3 changed files with 387 additions and 1 deletion.
375 changes: 375 additions & 0 deletions ...ws-rfdk/lib/deadline/scripts/python/test/test_configure_identity_registration_settings.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,375 @@
#!/usr/bin/env python3
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

"""
Tests for configure_identity_registration_settings.py
"""

import sys
import unittest
from unittest.mock import MagicMock, Mock

sys.modules['boto3'] = Mock()

# Python 3's modules don't make it easy to import from a directory above. This solves that.
import pathlib
_parentdir = pathlib.Path(__file__).parent.parent.resolve()
sys.path.insert(0, str(_parentdir))
import configure_identity_registration_settings as subject
sys.path.remove(str(_parentdir))

RFDK_REG_SETTING_JSON_1 = {
"ConnectionIpFilterType":0,
"ConnectionIpFilterValue":"111.111.*.*", # 111.111.0.0/16
"SourceIpFilterType":0,
"SourceIpFilterValue":"123.123.123.*", # 123.123.123.0/24
"SettingsId":"settings1",
"SettingsName":"RfdkSubnet|subnet-aaaaaaa|subnet-1111111",
"IsEnabled":True,
"DefaultStatus":2,
"DefaultRole":"Client"
}
RFDK_REG_SETTING_1 = subject.LoadBalancerIdentityRegistrationSetting(
connection_ip_filter_type=RFDK_REG_SETTING_JSON_1["ConnectionIpFilterType"],
connection_ip_filter_value=RFDK_REG_SETTING_JSON_1["ConnectionIpFilterValue"],
source_ip_filter_type=RFDK_REG_SETTING_JSON_1["SourceIpFilterType"],
source_ip_filter_value=RFDK_REG_SETTING_JSON_1["SourceIpFilterValue"],
settings_id=RFDK_REG_SETTING_JSON_1["SettingsId"],
settings_name=RFDK_REG_SETTING_JSON_1["SettingsName"],
is_enabled=RFDK_REG_SETTING_JSON_1["IsEnabled"],
default_status=RFDK_REG_SETTING_JSON_1["DefaultStatus"],
default_role=RFDK_REG_SETTING_JSON_1["DefaultRole"],
)

RFDK_REG_SETTING_JSON_2 = {
"ConnectionIpFilterType":0,
"ConnectionIpFilterValue":"255.*.*.*", # 255.0.0.0/8
"SourceIpFilterType":0,
"SourceIpFilterValue":"3.3.0-63.*", # 3.3.0.0/18
"SettingsId":"settings3",
"SettingsName":"RfdkSubnet|subnet-bbbbbbb|subnet-2222222",
"IsEnabled":True,
"DefaultStatus":2,
"DefaultRole":"Client"
}
RFDK_REG_SETTING_2 = subject.LoadBalancerIdentityRegistrationSetting(
connection_ip_filter_type=RFDK_REG_SETTING_JSON_2["ConnectionIpFilterType"],
connection_ip_filter_value=RFDK_REG_SETTING_JSON_2["ConnectionIpFilterValue"],
source_ip_filter_type=RFDK_REG_SETTING_JSON_2["SourceIpFilterType"],
source_ip_filter_value=RFDK_REG_SETTING_JSON_2["SourceIpFilterValue"],
settings_id=RFDK_REG_SETTING_JSON_2["SettingsId"],
settings_name=RFDK_REG_SETTING_JSON_2["SettingsName"],
is_enabled=RFDK_REG_SETTING_JSON_2["IsEnabled"],
default_status=RFDK_REG_SETTING_JSON_2["DefaultStatus"],
default_role=RFDK_REG_SETTING_JSON_2["DefaultRole"],
)

NON_RFDK_REG_SETTING_JSON = {
"ConnectionIpFilterType":0,
"ConnectionIpFilterValue":"2.2.2.2",
"SourceIpFilterType":0,
"SourceIpFilterValue":"1.1.1.1",
"SettingsId":"settings2",
"SettingsName":"LBSetting2",
"IsEnabled":False,
"DefaultStatus":2,
"DefaultRole":"Server"
}

class TestConfigureIdentityRegistrationSettingsConfigAndHelpers(unittest.TestCase):
def test_camel_to_snake_case(self):
test_cases = {
'CamelCase': 'camel_case',
'camelCamelCase': 'camel_camel_case',
'Camel2Camel2Case': 'camel_2_camel_2_case',
'GetHTTPResponseCode': 'get_http_response_code',
'get200HTTPResponseCode': 'get_200_http_response_code',
'getHTTP200ResponseCode': 'get_http_200_response_code',
'HTTPResponseCode': 'http_response_code',
'ResponseHTTP': 'response_http',
'ResponseHTTP2': 'response_http_2',
'10CoolDudes': '10_cool_dudes',
'aB': 'a_b'
}
for camel_case, snake_case in test_cases.items():
self.assertEqual(subject._camel_to_snake_case(camel_case), snake_case)

def test_parsing_basic_config(self):
config = subject.parse_args([
"--credentials", "arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c",
"--region", "test-region",
"--connection-subnet", "subnet-7e572",
"--source-subnet", "subnet-50c34,Client,Registered"
])

self.assertEqual(config.credentials, subject.AwsSecret(arn="arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c", region="us-west-2"))
self.assertEqual(config.region, "test-region")
self.assertEqual(config.connection_subnet, ["subnet-7e572"])
self.assertListEqual( config.source_subnet, [ subject.SourceSubnet(subnet_id="subnet-50c34", role="Client", registration_status="Registered") ] )

def test_parsing_complex_config(self):
config = subject.parse_args([
"--credentials", "arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c",
"--region", "test-region",
"--connection-subnet", "subnet-7e573",
"--connection-subnet", "subnet-7e574",
"--source-subnet", "subnet-50c31,Client,Registered",
"--source-subnet", "subnet-50c32,Server,Pending"
])

self.assertEqual(config.credentials, subject.AwsSecret(arn="arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c", region="us-west-2"))
self.assertEqual(config.region, "test-region")
self.assertListEqual(config.connection_subnet, [ "subnet-7e573", "subnet-7e574" ])
self.assertListEqual(
config.source_subnet,
[
subject.SourceSubnet(subnet_id="subnet-50c31", role="Client", registration_status="Registered"),
subject.SourceSubnet(subnet_id="subnet-50c32", role="Server", registration_status="Pending")
]
)

def test_validate_config(self):
config = subject.parse_args([
"--credentials", "arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c",
"--region", "test-region",
"--connection-subnet", "subnet-7e573",
"--connection-subnet", "subnet-7e574",
"--source-subnet", "subnet-50c31,Client,Registered",
"--source-subnet", "subnet-50c32,Server,Pending"
])

# Shouldn't throw
subject.validate_config(config)

def test_validate_config_no_connection(self):
config = subject.parse_args([
"--credentials", "arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c",
"--region", "test-region",
"--source-subnet", "subnet-50c31,Client,Registered"
])

self.assertRaisesRegex(ValueError, "no --connection-subnet specified", lambda: subject.validate_config(config))

def test_validate_config_duplicate_subnet(self):
subnet_id = "subnet-8008135"
config = subject.parse_args([
"--credentials", "arn:aws:secretsmanager:us-west-2:111122223333:secret:aes128-1a2b3c",
"--region", "test-region",
"--connection-subnet", "subnet-7e573",
"--connection-subnet", "subnet-7e574",
"--source-subnet", f"{subnet_id},Client,Registered",
"--source-subnet", f"{subnet_id},Server,Pending"
])

self.assertRaisesRegex(ValueError, f"Subnet \"{subnet_id}\" is not unique", lambda: subject.validate_config(config))

def test_cidr_to_ipv4_match(self):
cidr_to_ipv4_dict = {
"0.0.0.0/1": "0-127.*.*.*",
"0.0.0.0/2": "0-63.*.*.*",
"0.0.0.0/3": "0-31.*.*.*",
"0.0.0.0/4": "0-15.*.*.*",
"0.0.0.0/5": "0-7.*.*.*",
"0.0.0.0/6": "0-3.*.*.*",
"0.0.0.0/7": "0-1.*.*.*",
"0.0.0.0/8": "0.*.*.*",
"0.0.0.0/9": "0.0-127.*.*",
"0.0.0.0/10": "0.0-63.*.*",
"0.0.0.0/11": "0.0-31.*.*",
"0.0.0.0/12": "0.0-15.*.*",
"0.0.0.0/13": "0.0-7.*.*",
"0.0.0.0/14": "0.0-3.*.*",
"0.0.0.0/15": "0.0-1.*.*",
"0.0.0.0/16": "0.0.*.*",
"0.0.0.0/17": "0.0.0-127.*",
"0.0.0.0/18": "0.0.0-63.*",
"0.0.0.0/19": "0.0.0-31.*",
"0.0.0.0/20": "0.0.0-15.*",
"0.0.0.0/21": "0.0.0-7.*",
"0.0.0.0/22": "0.0.0-3.*",
"0.0.0.0/23": "0.0.0-1.*",
"0.0.0.0/24": "0.0.0.*"
}
for cidr, ipv4 in cidr_to_ipv4_dict.items():
self.assertEqual(subject.cidr_to_ipv4_match(cidr), ipv4)


class TestConfigureIdentityRegistrationSettingsCRUD(unittest.TestCase):
def setUp(self):
self.dl_secrets = Mock()

# All these tests are set up to already have these identity registration settings applied
self.prior_rfdk_reg_settings_json = [ RFDK_REG_SETTING_JSON_1, RFDK_REG_SETTING_JSON_2 ]
self.prior_rfdk_reg_settings = [
RFDK_REG_SETTING_1, # Uses subnet_id="subnet-aaaaaaa"
RFDK_REG_SETTING_2 # Uses subnet_id="subnet-bbbbbbb"
]

def test_get(self):
'''
Makes sure that a call to `get_rfdk_registration_settings` returns all the currently applied identity
registration settings that were created by RFDK and excludes the non-RFDK setting
'''
# GIVEN
configured_reg_settings = self.prior_rfdk_reg_settings_json.copy()
configured_reg_settings.append(NON_RFDK_REG_SETTING_JSON)
self.dl_secrets.run_json = MagicMock(return_value=configured_reg_settings)

# WHEN
rfdk_managed_settings = subject.get_rfdk_registration_settings(self.dl_secrets)

# THEN
self.assertListEqual(
rfdk_managed_settings,
self.prior_rfdk_reg_settings
)

def test_create(self):
'''
Calls `create_and_update_settings` a connection subnet ID that's used in one of the current registration
settings and a source subnet ID that is used in a different registration setting. Since the two subnets aren't
used together in a registration setting, a new one should be created.
'''
# GIVEN
connection_subnet_ids = [
"subnet-aaaaaaa" # Used by REG_SETTING_RFDK_1
]
source_subnets = [
subject.SourceSubnet(subnet_id="subnet-2222222", role="Client", registration_status="Registered"), # Used by REG_SETTING_RFDK_2,
]
subnet_to_cidr = {
"subnet-aaaaaaa": "111.111.0.0/16", # "111.111.*.*" Used by REG_SETTING_RFDK_1
"subnet-2222222": "3.3.0.0/18", # "3.3.0-63.*" # Used by REG_SETTING_RFDK_2
}

# WHEN
subject.create_and_update_settings(self.dl_secrets, self.prior_rfdk_reg_settings, connection_subnet_ids, source_subnets, subnet_to_cidr)

# THEN
expected = subject.LoadBalancerIdentityRegistrationSetting.from_json({
"ConnectionIpFilterType":"IPv4Match",
"ConnectionIpFilterValue":"111.111.*.*", # Similar to REG_SETTING_1
"SourceIpFilterType":"IPv4Match",
"SourceIpFilterValue":"3.3.0-63.*", # Similar to REG_SETTING_2
"SettingsId":"",
"SettingsName":"RfdkSubnet|subnet-aaaaaaa|subnet-2222222",
"IsEnabled":True,
"DefaultStatus":"Registered",
"DefaultRole":"Client"
})

self.dl_secrets.run_str.assert_called_once_with(
"CreateLoadBalancerIdentityRegistrationSetting",
expected.settings_name,
expected.connection_ip_filter_type,
expected.connection_ip_filter_value,
expected.source_ip_filter_type,
expected.source_ip_filter_value,
expected.default_role,
expected.default_status,
str(expected.is_enabled),
)

def test_update(self):
'''
Calls `create_and_update_settings` with a connection subnet and source subnet that are currently used
in an applied registration setting, but the role and registration status are different, so the existing
registration setting should be updated.
'''
# GIVEN
connection_subnet_ids = [
"subnet-aaaaaaa" # Used by REG_SETTING_RFDK_1
]
source_subnets = [
subject.SourceSubnet(subnet_id="subnet-1111111", role="Server", registration_status="Pending"), # ID ised by REG_SETTING_RFDK_1,
]
subnet_to_cidr = {
"subnet-aaaaaaa": "111.111.0.0/16", # "111.111.*.*" Used by REG_SETTING_RFDK_1
"subnet-1111111": "123.123.123.0/24", # "123.123.123.*" # Used by REG_SETTING_RFDK_1
}

# WHEN
subject.create_and_update_settings(self.dl_secrets, self.prior_rfdk_reg_settings, connection_subnet_ids, source_subnets, subnet_to_cidr)

# THEN
expected = subject.LoadBalancerIdentityRegistrationSetting(
connection_ip_filter_type="IPv4Match", # This is equivalent to `0` that `RFDK_REG_SETTING_JSON_1` uses
connection_ip_filter_value=RFDK_REG_SETTING_JSON_1["ConnectionIpFilterValue"],
source_ip_filter_type="IPv4Match", # This is equivalent to `0` that `RFDK_REG_SETTING_JSON_1` uses
source_ip_filter_value=RFDK_REG_SETTING_JSON_1["SourceIpFilterValue"],
settings_id=RFDK_REG_SETTING_JSON_1["SettingsId"],
settings_name=RFDK_REG_SETTING_JSON_1["SettingsName"],
is_enabled=RFDK_REG_SETTING_JSON_1["IsEnabled"],
default_status="Pending",
default_role="Server"
)

self.dl_secrets.run_str.assert_called_once_with(
"UpdateLoadBalancerIdentityRegistrationSetting",
expected.settings_id,
expected.settings_name,
expected.connection_ip_filter_type,
expected.connection_ip_filter_value,
expected.source_ip_filter_type,
expected.source_ip_filter_value,
expected.default_role,
expected.default_status,
str(expected.is_enabled),
)

def test_create_multiple(self):
# GIVEN
connection_subnet_ids = [
"subnet-ccccccc",
"subnet-ddddddd"
]
source_subnets = [
subject.SourceSubnet(subnet_id="subnet-3333333", role="Client", registration_status="Registered"),
subject.SourceSubnet(subnet_id="subnet-4444444", role="Client", registration_status="Registered"),
]
subnet_to_cidr = {
"subnet-ccccccc": "10.10.0.0/16", # 10.10.*.*
"subnet-ddddddd": "11.11.0.0/16", # 11.11.*.*
"subnet-3333333": "96.0.0.0/5", # 96-103.*.*.*
"subnet-4444444": "104.0.0.0/22", # 104.0.0-3.*
}

# WHEN
subject.create_and_update_settings(self.dl_secrets, [], connection_subnet_ids, source_subnets, subnet_to_cidr)

# THEN
# We can only assert on the values of the last call to a Mock, so instead we just make sure that the right number
# of identity registration settings are created
self.assertEqual(self.dl_secrets.run_str.call_count, 4)

def test_delete_removed_settings(self):
'''
Calls `delete_removed_settings` with connection subnets that are used by `REG_SETTING_RFDK_1` and `REG_SETTING_RFDK_2`,
but only the source subnet for `REG_SETTING_RFDK_1` is added. Since the source subnet for `REG_SETTING_RFDK_2` is
missing, we expect `REG_SETTING_RFDK_2` to be deleted.
'''
# GIVEN
self.dl_secrets.run_str = Mock(return_value="Pass")
connection_subnet_ids = [
"subnet-aaaaaaa", # Used by REG_SETTING_RFDK_1
"subnet-bbbbbbb", # Used by REG_SETTING_RFDK_2
"subnet-ccccccc"
]
source_subnets = [
subject.SourceSubnet(subnet_id="subnet-1111111", role="Client", registration_status="Registered"), # Used by REG_SETTING_RFDK_1
subject.SourceSubnet(subnet_id="subnet-1234567", role="Server", registration_status="Pending")
]

# WHEN
subject.delete_removed_settings(self.dl_secrets, self.prior_rfdk_reg_settings, connection_subnet_ids, source_subnets)

# THEN
self.dl_secrets.run_str.assert_called_once_with(
'DeleteLoadBalancerIdentityRegistrationSetting',
RFDK_REG_SETTING_JSON_2["SettingsId"]
)


if __name__ == '__main__':
unittest.main()
4 changes: 3 additions & 1 deletion packages/aws-rfdk/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@
"lintfix": "cdk-lint --fix",
"package": "cdk-package",
"pkglint": "pkglint -f",
"test": "cdk-test",
"test": "yarn testcdk && yarn testpy",
"testcdk": "cdk-test",
"testpy": "./test-python.sh",
"watch": "cdk-watch"
},
"keywords": [
Expand Down
9 changes: 9 additions & 0 deletions packages/aws-rfdk/test-python.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash

set -euo pipefail

echo "Running python tests"

python3 -m unittest discover -s "$PWD/lib/deadline/scripts/python/test" -b

exit 0

0 comments on commit e327d92

Please sign in to comment.