Skip to content

Fix %%graph_notebook_config error when excluding optional Gremlin section #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 25, 2024
Merged

Fix %%graph_notebook_config error when excluding optional Gremlin section #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e4c2bb
Fix %%graph_notebook_config exception when excluding optional Gremlin…
michaelnchin Jun 25, 2024
e0d69b7
Linter fix
michaelnchin Jun 25, 2024
0e4ed92
update changelog
michaelnchin Jun 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Starting with v1.31.6, this file will contain a record of major features and upd
## Upcoming
- Fixed broken `--help` option for `%%gremlin` ([Link to PR](https://github.com/aws/graph-notebook/pull/630))
- Fixed openCypher query bug regression in the [`01-About-the-Neptune-Notebook`](https://github.com/aws/graph-notebook/blob/main/src/graph_notebook/notebooks/01-Getting-Started/01-About-the-Neptune-Notebook.ipynb) sample ([Link to PR](https://github.com/aws/graph-notebook/pull/631))
- Fixed `%%graph_notebook_config` error when excluding optional Gremlin section ([Link to PR](https://github.com/aws/graph-notebook/pull/633))

## Release 4.4.2 (June 18, 2024)
- Set Gremlin `connection_protocol` defaults based on Neptune service when generating configuration via arguments ([Link to PR](https://github.com/aws/graph-notebook/pull/626))
Expand Down
7 changes: 4 additions & 3 deletions src/graph_notebook/configuration/get_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,10 @@ def get_config_from_dict(data: dict, neptune_hosts: list = NEPTUNE_CONFIG_HOST_I
for p in neptune_params:
if p in data:
excluded_params.append(p)
for gp in neptune_gremlin_params:
if gp in data['gremlin']:
excluded_params.append(gp)
if 'gremlin' in data:
for gp in neptune_gremlin_params:
if gp in data['gremlin']:
excluded_params.append(gp)
if excluded_params:
print(f"The provided configuration contains the following parameters that are incompatible with the "
f"specified host: {str(excluded_params)}. These parameters have not been saved.\n")
Expand Down
225 changes: 223 additions & 2 deletions test/unit/configuration/test_configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
import os
import unittest

from graph_notebook.configuration.get_config import get_config
from graph_notebook.configuration.get_config import get_config, get_config_from_dict
from graph_notebook.configuration.generate_config import Configuration, DEFAULT_AUTH_MODE, AuthModeEnum, \
generate_config, generate_default_config, GremlinSection
from graph_notebook.neptune.client import NEPTUNE_DB_SERVICE_NAME, NEPTUNE_ANALYTICS_SERVICE_NAME, \
DEFAULT_GREMLIN_PROTOCOL, DEFAULT_HTTP_PROTOCOL
DEFAULT_GREMLIN_PROTOCOL, DEFAULT_HTTP_PROTOCOL, NEPTUNE_CONFIG_HOST_IDENTIFIERS


class TestGenerateConfiguration(unittest.TestCase):
Expand Down Expand Up @@ -121,6 +121,227 @@ def test_configuration_override_defaults_generic(self):
config = Configuration(self.generic_host, self.port, ssl=ssl)
self.assertEqual(ssl, config.ssl)

def test_get_configuration_empty_input(self):
input_config = {}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_no_host(self):
input_config = {
"port": 8182,
"ssl": True
}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_generic_no_port(self):
input_config = {
"host": "localhost",
"ssl": True
}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_generic_no_ssl(self):
input_config = {
"host": "localhost",
"port": 8182
}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_generic_required_input(self):
input_config = {
"host": "localhost",
"port": 8182,
"ssl": True
}
expected_config = {
'host': 'localhost',
'port': 8182,
'proxy_host': '',
'proxy_port': 8182,
'ssl': True,
'ssl_verify': True,
'sparql': {
'path': ''
},
'gremlin': {
'traversal_source': 'g',
'username': '',
'password': '',
'message_serializer': 'graphsonv3'
},
'neo4j': {
'username': 'neo4j',
'password': 'password',
'auth': True,
'database': None
}
}
config = get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)
self.assertEqual(config.to_dict(), expected_config)

def test_get_configuration_generic_all_input(self):
input_and_expected_config = {
'host': 'a_host',
'port': 9999,
'proxy_host': 'a_proxy_host',
'proxy_port': 9999,
'ssl': False,
'ssl_verify': False,
'sparql': {
'path': 'a_path'
},
'gremlin': {
'traversal_source': 'a',
'username': 'user',
'password': 'pass',
'message_serializer': 'graphbinaryv1'
},
'neo4j': {
'username': 'neo_user',
'password': 'neo_pass',
'auth': False,
'database': 'neo_db'
}
}
config = get_config_from_dict(input_and_expected_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)
self.assertEqual(config.to_dict(), input_and_expected_config)

def test_get_configuration_neptune_no_auth_mode(self):
input_config = {
"host": "db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com",
"port": 8182,
"ssl": True,
"load_from_s3_arn": "",
"aws_region": "us-west-2"
}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_neptune_no_load_arn(self):
input_config = {
"host": "db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com",
"port": 8182,
"ssl": True,
"aws_region": "us-west-2"
}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_neptune_no_region(self):
input_config = {
"host": "db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com",
"port": 8182,
"ssl": True,
"load_from_s3_arn": ""
}
with self.assertRaises(KeyError):
get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)

def test_get_configuration_neptune_required_input(self):
input_config = {
"host": "db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com",
"port": 8182,
"auth_mode": "IAM",
"load_from_s3_arn": "",
"ssl": True,
"aws_region": "us-west-2"
}
expected_config = {
'host': 'db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com',
'neptune_service': 'neptune-db',
'port': 8182,
'proxy_host': '',
'proxy_port': 8182,
'auth_mode': 'IAM',
'load_from_s3_arn': '',
'ssl': True,
'ssl_verify': True,
'aws_region': 'us-west-2',
'sparql': {
'path': ''
},
'gremlin': {
'traversal_source': 'g',
'username': '',
'password': '',
'message_serializer': 'graphsonv3',
'connection_protocol': 'websockets'
},
'neo4j': {
'username': 'neo4j',
'password': 'password',
'auth': True,
'database': None
}
}

config = get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)
self.assertEqual(config.to_dict(), expected_config)

def test_get_configuration_neptune_all_input(self):
input_config = {
'host': 'db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com',
'neptune_service': 'neptune-graph',
'port': 9999,
'proxy_host': 'a_proxy+port',
'proxy_port': 9999,
'auth_mode': 'DEFAULT',
'load_from_s3_arn': 'a_role',
'ssl': False,
'ssl_verify': False,
'aws_region': 'us-west-2',
'sparql': {
'path': 'a_path'
},
'gremlin': {
'traversal_source': 'a',
'username': 'a_user',
'password': 'a_pass',
'message_serializer': 'graphbinaryv1',
'connection_protocol': 'http'
},
'neo4j': {
'username': 'a_user',
'password': 'a_pass',
'auth': False,
'database': 'a_db'
}
}
expected_config = {
'host': 'db.cluster-xxxxxxxxx.us-west-2.neptune.amazonaws.com',
'neptune_service': 'neptune-graph',
'port': 9999,
'proxy_host': 'a_proxy+port',
'proxy_port': 9999,
'auth_mode': 'DEFAULT',
'load_from_s3_arn': 'a_role',
'ssl': False,
'ssl_verify': False,
'aws_region': 'us-west-2',
'sparql': {
'path': 'a_path'
},
'gremlin': {
'traversal_source': 'g',
'username': '',
'password': '',
'message_serializer': 'graphbinaryv1',
'connection_protocol': 'http'
},
'neo4j': {
'username': 'neo4j',
'password': 'password',
'auth': True,
'database': None
}
}

config = get_config_from_dict(input_config, neptune_hosts=NEPTUNE_CONFIG_HOST_IDENTIFIERS)
self.assertEqual(config.to_dict(), expected_config)

def test_generate_configuration_with_defaults_neptune_reg(self):
config = Configuration(self.neptune_host_reg, self.port)
c = generate_config(config.host, config.port, auth_mode=config.auth_mode, ssl=config.ssl,
Expand Down
Loading