Merge pull request #99 from RedisLabsModules/gkorland-capability_name

fix #98 Add support for capability_name

RAMP/module_metadata.py

@@ -10,6 +10,7 @@
 ARCHITECTURE = platform.machine()
 OS = platform.system()
 DISPLAY_NAME = ""
+CAPABILITY_NAME = ""
 AUTHOR = ""
 EMAIL = ""
 DESCRIPTION = ""
@@ -46,6 +47,7 @@
     "optional-dependencies",
     "description",
     "display_name",
+    "capability_name",
     "email",
     "exclude_commands",
     "git_sha",
@@ -104,6 +106,7 @@ def create_default_metadata(module_path):
         "version": MODULE_VERSION,
         "semantic_version": MODULE_SEMANTIC_VERSION,
         "display_name": DISPLAY_NAME,
+        "capability_name": CAPABILITY_NAME,
         "author": AUTHOR,
         "email": EMAIL,
         "description": DESCRIPTION,

RAMP/ramp.py

@@ -13,7 +13,7 @@
 
 def comma_seperated_to_list(ctx, param, value):
     """
-    Converts a comma seperated string into a list.
+    Converts a comma separated string into a list.
     """
     if value is None:
         return []
@@ -86,6 +86,7 @@ def unpack(bundle):
 @click.argument('module')
 @click.option('--manifest', '-m', type=click.File('rb'), help='generate package from manifest')
 @click.option('--display-name', '-d', default=None, help='name for display purposes')
+@click.option('--capability-name', '-b', default=None, help='name of capability')
 @click.option('--module-name', '-n', default=None, help='module name')
 @click.option('--author', '-a', default=None, help='module author')
 @click.option('--email', '-e', default=None, help='author\'s email')
@@ -99,9 +100,9 @@ def unpack(bundle):
 @click.option('--redis-pack-min-version', '-R', 'min_redis_pack_version', default=None, help='redis pack minimum version')
 @click.option('--config-command', '-cc', default=None, help='command used to configure module args at runtime')
 @click.option('--os', '-O', default=None, help='build target OS (Darwin/Linux)')
-@click.option('--capabilities', '-C', callback=comma_seperated_to_list, help='comma seperated list of module capabilities')
-@click.option('--exclude-commands', '-E', callback=comma_seperated_to_list, help='comma seperated list of exclude commands')
-@click.option('--overide-command', multiple=True, callback=jsons_str_tuple_to_jsons_tuple, help='gets a command json representation and overide it on the module json file')
+@click.option('--capabilities', '-C', callback=comma_seperated_to_list, help='comma separated list of module capabilities')
+@click.option('--exclude-commands', '-E', callback=comma_seperated_to_list, help='comma separated list of exclude commands')
+@click.option('--overide-command', multiple=True, callback=jsons_str_tuple_to_jsons_tuple, help='gets a command json representation and override it on the module json file')
 @click.option('--add-command', multiple=True, callback=jsons_str_tuple_to_jsons_tuple, help='gets a command json representation and add it on the module json file')
 @click.option('--dependencies', callback=jsons_str_tuple_to_jsons_tuple, help='list of module dependencies: <name, uri, sha256, local_path(optional)>')
 @click.option('--optional-dependencies', callback=jsons_str_tuple_to_jsons_tuple, help='list of module optional dependencies: <name, uri, sha256, local_path(optional)>')

test.py

@@ -80,6 +80,7 @@ def test_defaults():
     assert metadata["version"] == MODULE_VERSION
     assert metadata["semantic_version"] == MODULE_SEMANTIC_VERSION
     assert metadata["display_name"] == module_metadata.DISPLAY_NAME
+    assert metadata["capability_name"] == module_metadata.CAPABILITY_NAME
     assert metadata["author"] == module_metadata.AUTHOR
     assert metadata["email"] == module_metadata.EMAIL
     assert metadata["description"] == module_metadata.DESCRIPTION
@@ -114,10 +115,11 @@ def test_bundle_from_cmd():
     min_redis_version = "4.6"
     min_redis_pack_version = "5.0"
     display_name = "test_module"
+    capability_name = "Test & Module"
     module_name = "module_test"
 
     argv = [MODULE_FILE_PATH, '-a', author, '-e', email, '-D', description,
-            '-d', display_name, '-n', module_name,
+            '-d', display_name, '-b', capability_name, '-n', module_name,
             '-h', homepage, '-l', _license, '-c', command_line_args,
             '-r', min_redis_version, '-R', min_redis_pack_version,
             '-C', ','.join([cap['name'] for cap in MODULE_CAPABILITIES]),
@@ -137,6 +139,7 @@ def test_bundle_from_cmd():
     assert metadata["module_file"] == MODULE_FILE
     assert metadata["architecture"] == "x86_64"
     assert metadata["display_name"] == display_name
+    assert metadata["capability_name"] == capability_name
     assert metadata["version"] == MODULE_VERSION
     assert metadata["semantic_version"] == MODULE_SEMANTIC_VERSION
     assert metadata["author"] == author