restructure create plugin command to enable broader client access

Signed-off-by: Mic Bowman <[email protected]>

Author: cmickeyb

client/pdo/client/controller/commands/create.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import os
 import argparse
 import logging
 import random
@@ -33,7 +34,7 @@
 __all__ = ['command_create']
 
 ## -----------------------------------------------------------------
-def __add_enclave_secrets(ledger_config, contract_id, client_keys, enclaveclients, provclients) :
+def __add_enclave_secrets__(ledger_config, contract_id, client_keys, enclaveclients, provclients) :
     """Create and provision the encrypted secrets for each of the
     enclaves that will be provisioned for this contract.
     """
@@ -76,7 +77,7 @@ def __add_enclave_secrets(ledger_config, contract_id, client_keys, enclaveclient
     return encrypted_state_encryption_keys
 
 ## -----------------------------------------------------------------
-def __create_contract(ledger_config, client_keys, preferred_eservice_client, eservice_clients, contract) :
+def __create_contract__(ledger_config, client_keys, preferred_eservice_client, eservice_clients, contract) :
     """Create the initial contract state
     """
 
@@ -106,30 +107,27 @@ def __create_contract(ledger_config, client_keys, preferred_eservice_client, ese
 
 ## -----------------------------------------------------------------
 ## -----------------------------------------------------------------
-def command_create(state, bindings, pargs) :
-    """controller command to create a contract
+def create_contract(state, save_file, contract_source, **kwargs) :
+    """Expose the contract creation logic to other client applications
+
+    @param save_file: file name for the local contract information
+    @param contract_source : path to the contract source file
+    @param contract_class : optional parameter to specific class in the contract source
+    @param eservice_group : name of the eservice group to provision the contract
+    @param pservice_group : name of the pservice group to provision the contract
+    @param interpreter : name of the interpreter that is expected from the eservices
+    @param state_replicas : number of mandatory copies of state
+    @param state_duration : minimum duration replicas must be available
+    @param extra_data : opaque data that can be store in the contract file
     """
-    default_interpreter = state.get(['Contract', 'Interpreter'])
-    default_replicas = state.get(['Replication', 'NumProvableReplicas'], 2)
-    default_duration = state.get(['Replication', 'Duration'], 120)
-
-    parser = argparse.ArgumentParser(prog='create')
-    parser.add_argument('-c', '--contract-class', help='Name of the contract class', required=False, type=str)
-    parser.add_argument('-e', '--eservice-group', help='Name of the enclave service group to use', default="default")
-    parser.add_argument('-f', '--save-file', help='File where contract data is stored', type=str)
-    parser.add_argument('-i', '--interpreter', help='Interpreter used to evaluate the contract', default=default_interpreter)
-    parser.add_argument('-p', '--pservice-group', help='Name of the provisioning service group to use', default="default")
-    parser.add_argument('-s', '--contract-source', help='File that contains contract source code', required=True, type=str)
-
-    parser.add_argument('--symbol', help='binding symbol for result', type=str)
-    parser.add_argument('--state-replicas', help='Number of authoritative replicas of the state', default=default_replicas)
-    parser.add_argument('--state-duration', help='Duration required for state replicas', default=default_duration)
-    parser.add_argument('--extra-data', help='Simple string that can save extra data with the contract file', type=str)
-
-    options = parser.parse_args(pargs)
 
-    contract_class = options.contract_class
-    contract_source = options.contract_source
+    contract_class = kwargs.get('contract_class') or os.path.basename(contract_source)
+    eservice_group = kwargs.get('eservice_group') or 'default'
+    pservice_group = kwargs.get('pservice_group') or 'default'
+    interpreter = kwargs.get('interpreter') or state.get(['Contract', 'Interpreter'])
+    state_replicas = kwargs.get('state_replicas') or state.get(['Replication', 'NumProvableReplicas'], 2)
+    state_duration = kwargs.get('state_duration') or state.get(['Replication', 'Duration'], 120)
+    extra_data = kwargs.get('extra_data')
 
     # ---------- load the invoker's keys ----------
     try :
@@ -143,38 +141,38 @@ def command_create(state, bindings, pargs) :
     try :
         source_path = state.get(['Contract', 'SourceSearchPath'])
         contract_code = ContractCode.create_from_file(
-            contract_class, contract_source, source_path, interpreter=options.interpreter)
+            contract_class, contract_source, source_path, interpreter=interpreter)
     except Exception as e :
         raise Exception('unable to load contract source; {0}'.format(str(e)))
 
     logger.debug('Loaded contract code for %s', contract_class)
 
     # ---------- set up the enclave clients ----------
-    eservice_clients = get_eservice_list(state, options.eservice_group)
+    eservice_clients = get_eservice_list(state, eservice_group)
     if len(eservice_clients) == 0 :
-        raise Exception('unable to locate enclave services in the group %s', options.eservice_group)
+        raise Exception('unable to locate enclave services in the group %s', eservice_group)
 
-    preferred_eservice_client = get_eservice(state, eservice_group=options.eservice_group)
-    if preferred_eservice_client.interpreter != options.interpreter :
-        raise Exception('enclave interpreter does not match requested contract interpreter %s', options.interpreter)
+    preferred_eservice_client = get_eservice(state, eservice_group=eservice_group)
+    if preferred_eservice_client.interpreter != interpreter :
+        raise Exception('enclave interpreter does not match requested contract interpreter %s', interpreter)
 
     # ---------- set up the provisioning service clients ----------
-    pservice_clients = get_pservice_list(state, options.pservice_group)
+    pservice_clients = get_pservice_list(state, pservice_group)
     if len(pservice_clients) == 0 :
-        raise Exception('unable to locate provisioning services in the group %s', options.pservice_group)
+        raise Exception('unable to locate provisioning services in the group %s', pservice_group)
 
     # ---------- register contract ----------
     data_directory = state.get(['Contract', 'DataDirectory'])
     ledger_config = state.get(['Ledger'])
 
     try :
         extra_params = {
-            'num_provable_replicas' : options.state_replicas,
-            'availability_duration' : options.state_duration,
+            'num_provable_replicas' : state_replicas,
+            'availability_duration' : state_duration,
         }
 
-        if options.extra_data :
-            extra_params['extra_data'] = options.extra_data
+        if extra_data :
+            extra_params['extra_data'] = extra_data
 
         provisioning_service_keys = [pc.identity for pc in pservice_clients]
         contract_id = register_contract(
@@ -188,8 +186,8 @@ def command_create(state, bindings, pargs) :
         contract.extra_data['preferred-enclave'] = preferred_eservice_client.enclave_id
 
         contract_file = "{0}_{1}.pdo".format(contract_class, contract.short_id)
-        if options.save_file :
-            contract_file = options.save_file
+        if save_file :
+            contract_file = save_file
 
         contract.save_to_file(contract_file, data_dir=data_directory)
 
@@ -198,7 +196,7 @@ def command_create(state, bindings, pargs) :
 
     # provision the encryption keys to all of the enclaves
     try :
-        encrypted_state_encryption_keys = __add_enclave_secrets(
+        encrypted_state_encryption_keys = __add_enclave_secrets__(
             ledger_config, contract.contract_id, client_keys, eservice_clients, pservice_clients)
 
         for enclave_id in encrypted_state_encryption_keys :
@@ -211,11 +209,35 @@ def command_create(state, bindings, pargs) :
 
     # create the initial contract state
     try :
-        __create_contract(ledger_config, client_keys, preferred_eservice_client, eservice_clients, contract)
+        __create_contract__(ledger_config, client_keys, preferred_eservice_client, eservice_clients, contract)
 
         contract.save_to_file(contract_file, data_dir=data_directory)
     except Exception as e :
         raise Exception('failed to create the initial contract state; {0}'.format(str(e)))
 
+    return contract_file
+
+## -----------------------------------------------------------------
+## -----------------------------------------------------------------
+def command_create(state, bindings, pargs) :
+    """controller command to create a contract
+    """
+
+    parser = argparse.ArgumentParser(prog='create')
+    parser.add_argument('-c', '--contract-class', help='Name of the contract class', type=str)
+    parser.add_argument('-e', '--eservice-group', help='Name of the enclave service group to use', type=str)
+    parser.add_argument('-f', '--save-file', help='File where contract data is stored', type=str)
+    parser.add_argument('-i', '--interpreter', help='Interpreter used to evaluate the contract', type=str)
+    parser.add_argument('-p', '--pservice-group', help='Name of the provisioning service group to use', type=str)
+    parser.add_argument('-s', '--contract-source', help='File that contains contract source code', required=True, type=str)
+
+    parser.add_argument('--symbol', help='binding symbol for result', type=str)
+    parser.add_argument('--state-replicas', help='Number of authoritative replicas of the state', type=int)
+    parser.add_argument('--state-duration', help='Duration required for state replicas', type=int)
+    parser.add_argument('--extra-data', help='Simple string that can save extra data with the contract file', type=str)
+
+    options = parser.parse_args(pargs)
+
+    contract_id = create_contract(state, **vars(options))
     if contract_id and options.symbol :
         bindings.bind(options.symbol, contract_id)

client/pdo/client/controller/contract_controller.py

@@ -130,8 +130,8 @@ def bind(self, variable, value) :
         return saved
 
     # --------------------------------------------------
-    def isbound(self, variable) :
-        return variable in self.__bindings__
+    def isbound(self, variable, default_value=None) :
+        return self.__bindings__.get(variable, default_value)
 
     # --------------------------------------------------
     def expand(self, argstring) :