diff --git a/apps/cic-cache/cic_cache/runnable/daemons/tracker.py b/apps/cic-cache/cic_cache/runnable/daemons/tracker.py index 0746df7f..ec03f6b7 100644 --- a/apps/cic-cache/cic_cache/runnable/daemons/tracker.py +++ b/apps/cic-cache/cic_cache/runnable/daemons/tracker.py @@ -16,6 +16,7 @@ import cic_base.config import cic_base.log import cic_base.argparse import cic_base.rpc +from cic_base.eth.syncer import chain_interface from cic_eth_registry import CICRegistry from cic_eth_registry.error import UnknownContractError from chainlib.chain import ChainSpec @@ -28,10 +29,8 @@ from hexathon import ( strip_0x, ) from chainsyncer.backend.sql import SQLBackend -from chainsyncer.driver import ( - HeadSyncer, - HistorySyncer, - ) +from chainsyncer.driver.head import HeadSyncer +from chainsyncer.driver.history import HistorySyncer from chainsyncer.db.models.base import SessionBase # local imports @@ -113,10 +112,10 @@ def main(): logg.info('resuming sync session {}'.format(syncer_backend)) for syncer_backend in syncer_backends: - syncers.append(HistorySyncer(syncer_backend)) + syncers.append(HistorySyncer(syncer_backend, chain_interface)) syncer_backend = SQLBackend.live(chain_spec, block_offset+1) - syncers.append(HeadSyncer(syncer_backend)) + syncers.append(HeadSyncer(syncer_backend, chain_interface)) trusted_addresses_src = config.get('CIC_TRUST_ADDRESS') if trusted_addresses_src == None: diff --git a/apps/cic-cache/requirements.txt b/apps/cic-cache/requirements.txt index ad1232c3..2bc3a75a 100644 --- a/apps/cic-cache/requirements.txt +++ b/apps/cic-cache/requirements.txt @@ -1,12 +1,13 @@ -cic-base~=0.1.2b10 +cic-base==0.1.3a3+build.4aa03607 alembic==1.4.2 confini~=0.3.6rc3 uwsgi==2.0.19.1 moolb~=0.1.0 -cic-eth-registry~=0.5.5a4 +cic-eth-registry~=0.5.6a1 SQLAlchemy==1.3.20 semver==2.13.0 psycopg2==2.8.6 celery==4.4.7 redis==3.5.3 -chainsyncer[sql]~=0.0.2a4 +chainsyncer[sql]~=0.0.3a3 +erc20-faucet~=0.2.2a1 diff --git a/apps/cic-cache/scripts/migrate.py b/apps/cic-cache/scripts/migrate.py index 6db1ed64..b6925144 100644 --- a/apps/cic-cache/scripts/migrate.py +++ b/apps/cic-cache/scripts/migrate.py @@ -2,6 +2,7 @@ import os import argparse import logging +import re import alembic from alembic.config import Config as AlembicConfig @@ -23,6 +24,8 @@ argparser = argparse.ArgumentParser() argparser.add_argument('-c', type=str, default=config_dir, help='config file') argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration') argparser.add_argument('--migrations-dir', dest='migrations_dir', default=migrationsdir, type=str, help='path to alembic migrations directory') +argparser.add_argument('--reset', action='store_true', help='downgrade before upgrading') +argparser.add_argument('-f', action='store_true', help='force action') argparser.add_argument('-v', action='store_true', help='be verbose') argparser.add_argument('-vv', action='store_true', help='be more verbose') args = argparser.parse_args() @@ -53,4 +56,10 @@ ac = AlembicConfig(os.path.join(migrations_dir, 'alembic.ini')) ac.set_main_option('sqlalchemy.url', dsn) ac.set_main_option('script_location', migrations_dir) +if args.reset: + if not args.f: + if not re.match(r'[yY][eE]?[sS]?', input('EEK! this will DELETE the existing db. are you sure??')): + logg.error('user chickened out on requested reset, bailing') + sys.exit(1) + alembic.command.downgrade(ac, 'base') alembic.command.upgrade(ac, 'head') diff --git a/apps/cic-cache/test_requirements.txt b/apps/cic-cache/test_requirements.txt index e0addadd..f0c5fd81 100644 --- a/apps/cic-cache/test_requirements.txt +++ b/apps/cic-cache/test_requirements.txt @@ -6,6 +6,5 @@ sqlparse==0.4.1 pytest-celery==0.0.0a1 eth_tester==0.5.0b3 py-evm==0.3.0a20 -web3==5.12.2 -cic-eth-registry~=0.5.5a3 -cic-base[full]==0.1.2b8 +cic_base[full]==0.1.3a3+build.4aa03607 +sarafu-faucet~=0.0.4a1 diff --git a/apps/cic-eth/MANIFEST.in b/apps/cic-eth/MANIFEST.in new file mode 100644 index 00000000..739a53c6 --- /dev/null +++ b/apps/cic-eth/MANIFEST.in @@ -0,0 +1,2 @@ +include *requirements.txt + diff --git a/apps/cic-eth/cic_eth/api/api_admin.py b/apps/cic-eth/cic_eth/api/api_admin.py index c5c1e142..34fc4d68 100644 --- a/apps/cic-eth/cic_eth/api/api_admin.py +++ b/apps/cic-eth/cic_eth/api/api_admin.py @@ -562,13 +562,13 @@ class AdminApi: tx['source_token_symbol'] = source_token.symbol o = erc20_c.balance_of(tx['source_token'], tx['sender'], sender_address=self.call_address) r = self.rpc.do(o) - tx['sender_token_balance'] = erc20_c.parse_balance_of(r) + tx['sender_token_balance'] = erc20_c.parse_balance(r) if destination_token != None: tx['destination_token_symbol'] = destination_token.symbol o = erc20_c.balance_of(tx['destination_token'], tx['recipient'], sender_address=self.call_address) r = self.rpc.do(o) - tx['recipient_token_balance'] = erc20_c.parse_balance_of(r) + tx['recipient_token_balance'] = erc20_c.parse_balance(r) #tx['recipient_token_balance'] = destination_token.function('balanceOf')(tx['recipient']).call() # TODO: this can mean either not subitted or culled, need to check other txs with same nonce to determine which diff --git a/apps/cic-eth/cic_eth/runnable/daemons/server.py b/apps/cic-eth/cic_eth/runnable/daemons/server.py deleted file mode 100644 index 875c581e..00000000 --- a/apps/cic-eth/cic_eth/runnable/daemons/server.py +++ /dev/null @@ -1,136 +0,0 @@ -# standard imports -import os -import re -import logging -import argparse -import json - -# third-party imports -import web3 -import confini -import celery -from json.decoder import JSONDecodeError -from cic_registry.chain import ChainSpec - -# local imports -from cic_eth.db import dsn_from_config -from cic_eth.db.models.base import SessionBase -from cic_eth.eth.util import unpack_signed_raw_tx - -logging.basicConfig(level=logging.WARNING) -logg = logging.getLogger() - -rootdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__))) -dbdir = os.path.join(rootdir, 'cic_eth', 'db') -migrationsdir = os.path.join(dbdir, 'migrations') - -config_dir = os.path.join('/usr/local/etc/cic-eth') - -argparser = argparse.ArgumentParser() -argparser.add_argument('-c', type=str, default=config_dir, help='config file') -argparser.add_argument('-i', '--chain-spec', dest='i', type=str, help='chain spec') -argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration') -argparser.add_argument('-q', type=str, default='cic-eth', help='queue name for worker tasks') -argparser.add_argument('-v', action='store_true', help='be verbose') -argparser.add_argument('-vv', action='store_true', help='be more verbose') -args = argparser.parse_args() - -if args.vv: - logging.getLogger().setLevel(logging.DEBUG) -elif args.v: - logging.getLogger().setLevel(logging.INFO) - -config = confini.Config(args.c, args.env_prefix) -config.process() -args_override = { - 'CIC_CHAIN_SPEC': getattr(args, 'i'), - } -config.censor('PASSWORD', 'DATABASE') -config.censor('PASSWORD', 'SSL') -logg.debug('config:\n{}'.format(config)) - -dsn = dsn_from_config(config) -SessionBase.connect(dsn) - -celery_app = celery.Celery(backend=config.get('CELERY_RESULT_URL'), broker=config.get('CELERY_BROKER_URL')) -queue = args.q - -re_something = r'^/something/?' - -chain_spec = ChainSpec.from_chain_str(config.get('CIC_CHAIN_SPEC')) - - -def process_something(session, env): - r = re.match(re_something, env.get('PATH_INFO')) - if not r: - return None - - #if env.get('CONTENT_TYPE') != 'application/json': - # raise AttributeError('content type') - - #if env.get('REQUEST_METHOD') != 'POST': - # raise AttributeError('method') - - #post_data = json.load(env.get('wsgi.input')) - - #return ('text/plain', 'foo'.encode('utf-8'),) - - -# uwsgi application -def application(env, start_response): - - for k in env.keys(): - logg.debug('env {} {}'.format(k, env[k])) - - headers = [] - content = b'' - err = None - - session = SessionBase.create_session() - for handler in [ - process_something, - ]: - try: - r = handler(session, env) - except AttributeError as e: - logg.error('handler fail attribute {}'.format(e)) - err = '400 Impertinent request' - break - except JSONDecodeError as e: - logg.error('handler fail json {}'.format(e)) - err = '400 Invalid data format' - break - except KeyError as e: - logg.error('handler fail key {}'.format(e)) - err = '400 Invalid JSON' - break - except ValueError as e: - logg.error('handler fail value {}'.format(e)) - err = '400 Invalid data' - break - except RuntimeError as e: - logg.error('task fail value {}'.format(e)) - err = '500 Task failed, sorry I cannot tell you more' - break - if r != None: - (mime_type, content) = r - break - session.close() - - if err != None: - headers.append(('Content-Type', 'text/plain, charset=UTF-8',)) - start_response(err, headers) - session.close() - return [content] - - headers.append(('Content-Length', str(len(content))),) - headers.append(('Access-Control-Allow-Origin', '*',)); - - if len(content) == 0: - headers.append(('Content-Type', 'text/plain, charset=UTF-8',)) - start_response('404 Looked everywhere, sorry', headers) - else: - headers.append(('Content-Type', mime_type,)) - start_response('200 OK', headers) - - return [content] diff --git a/apps/cic-eth/cic_eth/runnable/daemons/tracker.py b/apps/cic-eth/cic_eth/runnable/daemons/tracker.py index 10ef5154..0a977825 100644 --- a/apps/cic-eth/cic_eth/runnable/daemons/tracker.py +++ b/apps/cic-eth/cic_eth/runnable/daemons/tracker.py @@ -15,6 +15,7 @@ import cic_base.config import cic_base.log import cic_base.argparse import cic_base.rpc +from cic_base.eth.syncer import chain_interface from cic_eth_registry.error import UnknownContractError from chainlib.chain import ChainSpec from chainlib.eth.constant import ZERO_ADDRESS @@ -26,10 +27,8 @@ from hexathon import ( strip_0x, ) from chainsyncer.backend.sql import SQLBackend -from chainsyncer.driver import ( - HeadSyncer, - HistorySyncer, - ) +from chainsyncer.driver.head import HeadSyncer +from chainsyncer.driver.history import HistorySyncer from chainsyncer.db.models.base import SessionBase # local imports @@ -80,6 +79,7 @@ chain_spec = ChainSpec.from_chain_str(config.get('CIC_CHAIN_SPEC')) cic_base.rpc.setup(chain_spec, config.get('ETH_PROVIDER')) + def main(): # connect to celery celery.Celery(broker=config.get('CELERY_BROKER_URL'), backend=config.get('CELERY_RESULT_URL')) @@ -121,11 +121,11 @@ def main(): for syncer_backend in syncer_backends: try: - syncers.append(HistorySyncer(syncer_backend)) + syncers.append(HistorySyncer(syncer_backend, chain_interface)) logg.info('Initializing HISTORY syncer on backend {}'.format(syncer_backend)) except AttributeError: logg.info('Initializing HEAD syncer on backend {}'.format(syncer_backend)) - syncers.append(HeadSyncer(syncer_backend)) + syncers.append(HeadSyncer(syncer_backend, chain_interface)) connect_registry(rpc, chain_spec, config.get('CIC_REGISTRY_ADDRESS')) diff --git a/apps/cic-eth/cic_eth/version.py b/apps/cic-eth/cic_eth/version.py index 0edda257..9a7a232e 100644 --- a/apps/cic-eth/cic_eth/version.py +++ b/apps/cic-eth/cic_eth/version.py @@ -9,8 +9,8 @@ import semver version = ( 0, 11, - 0, - 'beta.16', + 1, + 'alpha.2', ) version_object = semver.VersionInfo( diff --git a/apps/cic-eth/requirements.txt b/apps/cic-eth/requirements.txt index 631f384e..207045ed 100644 --- a/apps/cic-eth/requirements.txt +++ b/apps/cic-eth/requirements.txt @@ -1,25 +1,25 @@ -cic-base~=0.1.2b15 +cic-base==0.1.3a3+build.4aa03607 celery==4.4.7 -crypto-dev-signer~=0.4.14b3 +crypto-dev-signer~=0.4.14b6 confini~=0.3.6rc3 -cic-eth-registry~=0.5.5a7 +cic-eth-registry~=0.5.6a1 redis==3.5.3 alembic==1.4.2 websockets==8.1 requests~=2.24.0 -eth_accounts_index~=0.0.11a12 -erc20-transfer-authorization~=0.3.1a7 +eth_accounts_index~=0.0.12a1 +erc20-transfer-authorization~=0.3.2a1 uWSGI==2.0.19.1 semver==2.13.0 websocket-client==0.57.0 moolb~=0.1.1b2 -eth-address-index~=0.1.1a11 -chainlib~=0.0.3rc2 +eth-address-index~=0.1.2a1 +chainlib-eth~=0.0.5a1 hexathon~=0.0.1a7 -chainsyncer[sql]==0.0.2a5 -chainqueue~=0.0.2b3 -sarafu-faucet~=0.0.3a3 -erc20-faucet~=0.2.1a5 +chainsyncer[sql]~=0.0.3a3 +chainqueue~=0.0.2b5 +sarafu-faucet~=0.0.4a1 +erc20-faucet~=0.2.2a1 coincurve==15.0.0 potaahto~=0.0.1a2 pycryptodome==3.10.1 diff --git a/apps/cic-eth/scripts/migrate.py b/apps/cic-eth/scripts/migrate.py index 4a2c0139..d3602989 100644 --- a/apps/cic-eth/scripts/migrate.py +++ b/apps/cic-eth/scripts/migrate.py @@ -2,6 +2,8 @@ import os import argparse import logging +import re +import sys import alembic from alembic.config import Config as AlembicConfig @@ -23,6 +25,8 @@ argparser = argparse.ArgumentParser() argparser.add_argument('-c', type=str, default=config_dir, help='config file') argparser.add_argument('--env-prefix', default=os.environ.get('CONFINI_ENV_PREFIX'), dest='env_prefix', type=str, help='environment prefix for variables to overwrite configuration') argparser.add_argument('--migrations-dir', dest='migrations_dir', default=migrationsdir, type=str, help='path to alembic migrations directory') +argparser.add_argument('--reset', action='store_true', help='downgrade before upgrading') +argparser.add_argument('-f', action='store_true', help='force action') argparser.add_argument('-v', action='store_true', help='be verbose') argparser.add_argument('-vv', action='store_true', help='be more verbose') args = argparser.parse_args() @@ -53,4 +57,10 @@ ac = AlembicConfig(os.path.join(migrations_dir, 'alembic.ini')) ac.set_main_option('sqlalchemy.url', dsn) ac.set_main_option('script_location', migrations_dir) +if args.reset: + if not args.f: + if not re.match(r'[yY][eE]?[sS]?', input('EEK! this will DELETE the existing db. are you sure??')): + logg.error('user chickened out on requested reset, bailing') + sys.exit(1) + alembic.command.downgrade(ac, 'base') alembic.command.upgrade(ac, 'head') diff --git a/apps/cic-notify/cic_notify/api.py b/apps/cic-notify/cic_notify/api.py index f879a6ee..fb27f7bd 100644 --- a/apps/cic-notify/cic_notify/api.py +++ b/apps/cic-notify/cic_notify/api.py @@ -26,7 +26,7 @@ def get_sms_queue_tasks(app, task_prefix='cic_notify.tasks.sms.'): for q in qs[host]: if re.match(re_q, q['name']): host_queues.append((host, q['name'],)) - + task_prefix_len = len(task_prefix) queue_tasks = [] for (host, queue) in host_queues: @@ -35,17 +35,18 @@ def get_sms_queue_tasks(app, task_prefix='cic_notify.tasks.sms.'): for task in tasks: if len(task) >= task_prefix_len and task[:task_prefix_len] == task_prefix: queue_tasks.append((queue, task,)) - + return queue_tasks class Api: # TODO: Implement callback strategy - def __init__(self, queue='cic-notify'): + def __init__(self, queue=None): """ :param queue: The queue on which to execute notification tasks :type queue: str """ + self.queue = queue self.sms_tasks = get_sms_queue_tasks(app) logg.debug('sms tasks {}'.format(self.sms_tasks)) @@ -61,13 +62,19 @@ class Api: """ signatures = [] for q in self.sms_tasks: + + if not self.queue: + queue = q[0] + else: + queue = self.queue + signature = celery.signature( q[1], [ message, recipient, ], - queue=q[0], + queue=queue, ) signatures.append(signature) diff --git a/apps/cic-notify/cic_notify/version.py b/apps/cic-notify/cic_notify/version.py index e795aad8..4ba6055f 100644 --- a/apps/cic-notify/cic_notify/version.py +++ b/apps/cic-notify/cic_notify/version.py @@ -9,7 +9,7 @@ import semver logg = logging.getLogger() -version = (0, 4, 0, 'alpha.5') +version = (0, 4, 0, 'alpha.6') version_object = semver.VersionInfo( major=version[0], diff --git a/apps/cic-notify/requirements.txt b/apps/cic-notify/requirements.txt index 0b7de273..67db2dfb 100644 --- a/apps/cic-notify/requirements.txt +++ b/apps/cic-notify/requirements.txt @@ -1 +1 @@ -cic_base[full_graph]~=0.1.2a61 +cic_base[full_graph]==0.1.3a3+build.4aa03607 diff --git a/apps/cic-notify/test_requirements.txt b/apps/cic-notify/test_requirements.txt index fda03d35..41c5f099 100644 --- a/apps/cic-notify/test_requirements.txt +++ b/apps/cic-notify/test_requirements.txt @@ -2,4 +2,3 @@ pytest~=6.0.1 pytest-celery~=0.0.0a1 pytest-mock~=3.3.1 pysqlite3~=0.4.3 - diff --git a/apps/cic-ussd/cic_ussd/db/enum.py b/apps/cic-ussd/cic_ussd/db/enum.py new file mode 100644 index 00000000..cb9761d3 --- /dev/null +++ b/apps/cic-ussd/cic_ussd/db/enum.py @@ -0,0 +1,9 @@ +# standard import +from enum import IntEnum + + +class AccountStatus(IntEnum): + PENDING = 1 + ACTIVE = 2 + LOCKED = 3 + RESET = 4 diff --git a/apps/cic-ussd/cic_ussd/db/models/account.py b/apps/cic-ussd/cic_ussd/db/models/account.py index 18f5e370..1e073625 100644 --- a/apps/cic-ussd/cic_ussd/db/models/account.py +++ b/apps/cic-ussd/cic_ussd/db/models/account.py @@ -1,19 +1,13 @@ # standard imports -from enum import IntEnum - -# third party imports -from sqlalchemy import Column, Integer, String # local imports +from cic_ussd.db.enum import AccountStatus from cic_ussd.db.models.base import SessionBase from cic_ussd.encoder import check_password_hash, create_password_hash - -class AccountStatus(IntEnum): - PENDING = 1 - ACTIVE = 2 - LOCKED = 3 - RESET = 4 +# third party imports +from sqlalchemy import Column, Integer, String +from sqlalchemy.orm.session import Session class Account(SessionBase): @@ -30,6 +24,21 @@ class Account(SessionBase): account_status = Column(Integer) preferred_language = Column(String) + @staticmethod + def get_by_phone_number(phone_number: str, session: Session): + """Retrieves an account from a phone number. + :param phone_number: The E164 format of a phone number. + :type phone_number:str + :param session: + :type session: + :return: An account object. + :rtype: Account + """ + session = SessionBase.bind_session(session=session) + account = session.query(Account).filter_by(phone_number=phone_number).first() + SessionBase.release_session(session=session) + return account + def __init__(self, blockchain_address, phone_number): self.blockchain_address = blockchain_address self.phone_number = phone_number diff --git a/apps/cic-ussd/cic_ussd/operations.py b/apps/cic-ussd/cic_ussd/operations.py index 5f2ca7a2..bd0e7476 100644 --- a/apps/cic-ussd/cic_ussd/operations.py +++ b/apps/cic-ussd/cic_ussd/operations.py @@ -6,11 +6,13 @@ import logging import celery import i18n from cic_eth.api.api_task import Api +from sqlalchemy.orm.session import Session from tinydb.table import Document from typing import Optional # local imports from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase from cic_ussd.db.models.ussd_session import UssdSession from cic_ussd.db.models.task_tracker import TaskTracker from cic_ussd.menu.ussd_menu import UssdMenu @@ -22,15 +24,18 @@ from cic_ussd.validator import check_known_user, validate_response_type logg = logging.getLogger() -def add_tasks_to_tracker(task_uuid): - """ - This function takes tasks spawned over api interfaces and records their creation time for tracking. +def add_tasks_to_tracker(session, task_uuid: str): + """This function takes tasks spawned over api interfaces and records their creation time for tracking. + :param session: + :type session: :param task_uuid: The uuid for an initiated task. :type task_uuid: str """ + session = SessionBase.bind_session(session=session) task_record = TaskTracker(task_uuid=task_uuid) - TaskTracker.session.add(task_record) - TaskTracker.session.commit() + session.add(task_record) + session.flush() + SessionBase.release_session(session=session) def define_response_with_content(headers: list, response: str) -> tuple: @@ -95,6 +100,7 @@ def create_or_update_session( service_code: str, user_input: str, current_menu: str, + session, session_data: Optional[dict] = None) -> InMemoryUssdSession: """ Handles the creation or updating of session as necessary. @@ -108,12 +114,15 @@ def create_or_update_session( :type user_input: str :param current_menu: Menu name that is currently being displayed on the ussd session :type current_menu: str + :param session: + :type session: :param session_data: Any additional data that was persisted during the user's interaction with the system. :type session_data: dict. :return: ussd session object :rtype: InMemoryUssdSession """ - existing_ussd_session = UssdSession.session.query(UssdSession).filter_by( + session = SessionBase.bind_session(session=session) + existing_ussd_session = session.query(UssdSession).filter_by( external_session_id=external_session_id).first() if existing_ussd_session: @@ -132,20 +141,25 @@ def create_or_update_session( current_menu=current_menu, session_data=session_data ) + SessionBase.release_session(session=session) return ussd_session -def get_account_status(phone_number) -> str: +def get_account_status(phone_number, session: Session) -> str: """Get the status of a user's account. :param phone_number: The phone number to be checked. :type phone_number: str + :param session: + :type session: :return: The user account status. :rtype: str """ - user = Account.session.query(Account).filter_by(phone_number=phone_number).first() - status = user.get_account_status() - Account.session.add(user) - Account.session.commit() + session = SessionBase.bind_session(session=session) + account = Account.get_by_phone_number(phone_number=phone_number, session=session) + status = account.get_account_status() + session.add(account) + session.flush() + SessionBase.release_session(session=session) return status @@ -165,6 +179,7 @@ def initiate_account_creation_request(chain_str: str, external_session_id: str, phone_number: str, service_code: str, + session, user_input: str) -> str: """This function issues a task to create a blockchain account on cic-eth. It then creates a record of the ussd session corresponding to the creation of the account and returns a response denoting that the user's account is @@ -177,6 +192,8 @@ def initiate_account_creation_request(chain_str: str, :type phone_number: str :param service_code: The service code dialed. :type service_code: str + :param session: + :type session: :param user_input: The input entered by the user. :type user_input: str :return: A response denoting that the account is being created. @@ -190,7 +207,7 @@ def initiate_account_creation_request(chain_str: str, creation_task_id = cic_eth_api.create_account().id # record task initiation time - add_tasks_to_tracker(task_uuid=creation_task_id) + add_tasks_to_tracker(task_uuid=creation_task_id, session=session) # cache account creation data cache_account_creation_task_id(phone_number=phone_number, task_id=creation_task_id) @@ -204,6 +221,7 @@ def initiate_account_creation_request(chain_str: str, phone=phone_number, service_code=service_code, current_menu=current_menu.get('name'), + session=session, user_input=user_input) # define response to relay to user @@ -268,12 +286,14 @@ def cache_account_creation_task_id(phone_number: str, task_id: str): redis_cache.persist(name=task_id) -def process_current_menu(ussd_session: Optional[dict], user: Account, user_input: str) -> Document: +def process_current_menu(account: Account, session: Session, ussd_session: Optional[dict], user_input: str) -> Document: """This function checks user input and returns a corresponding ussd menu :param ussd_session: An in db ussd session object. :type ussd_session: UssdSession - :param user: A user object. - :type user: Account + :param account: A account object. + :type account: Account + :param session: + :type session: :param user_input: The user's input. :type user_input: str :return: An in memory ussd menu object. @@ -285,7 +305,13 @@ def process_current_menu(ussd_session: Optional[dict], user: Account, user_input else: # get current state latest_input = get_latest_input(user_input=user_input) - current_menu = process_request(ussd_session=ussd_session, user_input=latest_input, user=user) + session = SessionBase.bind_session(session=session) + current_menu = process_request( + account=account, + session=session, + ussd_session=ussd_session, + user_input=latest_input) + SessionBase.release_session(session=session) return current_menu @@ -294,6 +320,7 @@ def process_menu_interaction_requests(chain_str: str, phone_number: str, queue: str, service_code: str, + session, user_input: str) -> str: """This function handles requests intended for interaction with ussd menu, it checks whether a user matching the provided phone number exists and in the absence of which it creates an account for the user. @@ -308,25 +335,29 @@ def process_menu_interaction_requests(chain_str: str, :type queue: str :param service_code: The service dialed by the user making the request. :type service_code: str + :param session: + :type session: :param user_input: The inputs entered by the user. :type user_input: str :return: A response based on the request received. :rtype: str """ # check whether the user exists - if not check_known_user(phone=phone_number): + if not check_known_user(phone_number=phone_number, session=session): response = initiate_account_creation_request(chain_str=chain_str, external_session_id=external_session_id, phone_number=phone_number, service_code=service_code, + session=session, user_input=user_input) else: - # get user - user = Account.session.query(Account).filter_by(phone_number=phone_number).first() + # get account + session = SessionBase.bind_session(session=session) + account = Account.get_by_phone_number(phone_number=phone_number, session=session) # retrieve and cache user's metadata - blockchain_address = user.blockchain_address + blockchain_address = account.blockchain_address s_query_person_metadata = celery.signature( 'cic_ussd.tasks.metadata.query_person_metadata', [blockchain_address] @@ -334,24 +365,25 @@ def process_menu_interaction_requests(chain_str: str, s_query_person_metadata.apply_async(queue='cic-ussd') # find any existing ussd session - existing_ussd_session = UssdSession.session.query(UssdSession).filter_by( - external_session_id=external_session_id).first() + existing_ussd_session = session.query(UssdSession).filter_by(external_session_id=external_session_id).first() # validate user inputs if existing_ussd_session: current_menu = process_current_menu( + account=account, + session=session, ussd_session=existing_ussd_session.to_json(), - user=user, user_input=user_input ) else: current_menu = process_current_menu( + account=account, + session=session, ussd_session=None, - user=user, user_input=user_input ) - last_ussd_session = retrieve_most_recent_ussd_session(phone_number=user.phone_number) + last_ussd_session = retrieve_most_recent_ussd_session(phone_number=account.phone_number, session=session) if last_ussd_session: # create or update the ussd session as appropriate @@ -361,6 +393,7 @@ def process_menu_interaction_requests(chain_str: str, service_code=service_code, user_input=user_input, current_menu=current_menu.get('name'), + session=session, session_data=last_ussd_session.session_data ) else: @@ -369,15 +402,17 @@ def process_menu_interaction_requests(chain_str: str, phone=phone_number, service_code=service_code, user_input=user_input, - current_menu=current_menu.get('name') + current_menu=current_menu.get('name'), + session=session ) # define appropriate response response = custom_display_text( + account=account, display_key=current_menu.get('display_key'), menu_name=current_menu.get('name'), + session=session, ussd_session=ussd_session.to_json(), - user=user ) # check that the response from the processor is valid @@ -386,21 +421,26 @@ def process_menu_interaction_requests(chain_str: str, # persist session to db persist_session_to_db_task(external_session_id=external_session_id, queue=queue) + SessionBase.release_session(session=session) return response -def reset_pin(phone_number: str) -> str: +def reset_pin(phone_number: str, session: Session) -> str: """Reset account status from Locked to Pending. :param phone_number: The phone number belonging to the account to be unlocked. :type phone_number: str + :param session: + :type session: :return: The status of the pin reset. :rtype: str """ - user = Account.session.query(Account).filter_by(phone_number=phone_number).first() - user.reset_account_pin() - Account.session.add(user) - Account.session.commit() + session = SessionBase.bind_session(session=session) + account = Account.get_by_phone_number(phone_number=phone_number, session=session) + account.reset_account_pin() + session.add(account) + session.flush() + SessionBase.release_session(session=session) response = f'Pin reset for user {phone_number} is successful!' return response @@ -438,11 +478,13 @@ def update_ussd_session( return session -def save_to_in_memory_ussd_session_data(queue: str, session_data: dict, ussd_session: dict): +def save_to_in_memory_ussd_session_data(queue: str, session: Session, session_data: dict, ussd_session: dict): """This function is used to save information to the session data attribute of a ussd session object in the redis cache. :param queue: The queue on which the celery task should run. :type queue: str + :param session: + :type session: :param session_data: A dictionary containing data for a specific ussd session in redis that needs to be saved temporarily. :type session_data: dict @@ -473,7 +515,7 @@ def save_to_in_memory_ussd_session_data(queue: str, session_data: dict, ussd_ses service_code=in_redis_ussd_session.get('service_code'), user_input=in_redis_ussd_session.get('user_input'), current_menu=in_redis_ussd_session.get('state'), + session=session, session_data=session_data ) persist_session_to_db_task(external_session_id=external_session_id, queue=queue) - diff --git a/apps/cic-ussd/cic_ussd/phone_number.py b/apps/cic-ussd/cic_ussd/phone_number.py index 7556709f..1fc94f6f 100644 --- a/apps/cic-ussd/cic_ussd/phone_number.py +++ b/apps/cic-ussd/cic_ussd/phone_number.py @@ -33,19 +33,5 @@ def process_phone_number(phone_number: str, region: str): return parsed_phone_number - -def get_user_by_phone_number(phone_number: str) -> Optional[Account]: - """This function queries the database for a user based on the provided phone number. - :param phone_number: A valid phone number. - :type phone_number: str - :return: A user object matching a given phone number - :rtype: Account|None - """ - # consider adding region to user's metadata - phone_number = process_phone_number(phone_number=phone_number, region=E164Format.region) - user = Account.session.query(Account).filter_by(phone_number=phone_number).first() - return user - - class Support: phone_number = None diff --git a/apps/cic-ussd/cic_ussd/processor.py b/apps/cic-ussd/cic_ussd/processor.py index adf81f12..9f9bccd3 100644 --- a/apps/cic-ussd/cic_ussd/processor.py +++ b/apps/cic-ussd/cic_ussd/processor.py @@ -2,25 +2,26 @@ import datetime import logging import json -import re from typing import Optional # third party imports -import celery from sqlalchemy import desc from cic_eth.api import Api +from sqlalchemy.orm.session import Session from tinydb.table import Document # local imports from cic_ussd.account import define_account_tx_metadata, retrieve_account_statement from cic_ussd.balance import BalanceManager, compute_operational_balance, get_cached_operational_balance from cic_ussd.chain import Chain -from cic_ussd.db.models.account import AccountStatus, Account +from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase from cic_ussd.db.models.ussd_session import UssdSession -from cic_ussd.error import MetadataNotFoundError, SeppukuError +from cic_ussd.db.enum import AccountStatus +from cic_ussd.error import SeppukuError from cic_ussd.menu.ussd_menu import UssdMenu from cic_ussd.metadata import blockchain_address_to_metadata_pointer -from cic_ussd.phone_number import get_user_by_phone_number, Support +from cic_ussd.phone_number import Support from cic_ussd.redis import cache_data, create_cached_data_key, get_cached_data from cic_ussd.state_machine import UssdStateMachine from cic_ussd.conversions import to_wei, from_wei @@ -62,47 +63,48 @@ def retrieve_token_symbol(chain_str: str = Chain.spec.__str__()): raise SeppukuError(f'Could not retrieve default token for: {chain_str}') -def process_pin_authorization(display_key: str, user: Account, **kwargs) -> str: - """ - This method provides translation for all ussd menu entries that follow the pin authorization pattern. +def process_pin_authorization(account: Account, display_key: str, **kwargs) -> str: + """This method provides translation for all ussd menu entries that follow the pin authorization pattern. + :param account: The account in a running USSD session. + :type account: Account :param display_key: The path in the translation files defining an appropriate ussd response :type display_key: str - :param user: The user in a running USSD session. - :type user: Account :param kwargs: Any additional information required by the text values in the internationalization files. :type kwargs :return: A string value corresponding the ussd menu's text value. :rtype: str """ remaining_attempts = 3 - if user.failed_pin_attempts > 0: + if account.failed_pin_attempts > 0: return translation_for( key=f'{display_key}.retry', - preferred_language=user.preferred_language, - remaining_attempts=(remaining_attempts - user.failed_pin_attempts) + preferred_language=account.preferred_language, + remaining_attempts=(remaining_attempts - account.failed_pin_attempts) ) else: return translation_for( key=f'{display_key}.first', - preferred_language=user.preferred_language, + preferred_language=account.preferred_language, **kwargs ) -def process_exit_insufficient_balance(display_key: str, user: Account, ussd_session: dict): +def process_exit_insufficient_balance(account: Account, display_key: str, session: Session, ussd_session: dict): """This function processes the exit menu letting users their account balance is insufficient to perform a specific transaction. + :param account: The account requesting access to the ussd menu. + :type account: Account :param display_key: The path in the translation files defining an appropriate ussd response :type display_key: str - :param user: The user requesting access to the ussd menu. - :type user: Account + :param session: + :type session: :param ussd_session: A JSON serialized in-memory ussd session object :type ussd_session: dict :return: Corresponding translation text response :rtype: str """ # get account balance - operational_balance = get_cached_operational_balance(blockchain_address=user.blockchain_address) + operational_balance = get_cached_operational_balance(blockchain_address=account.blockchain_address) # compile response data user_input = ussd_session.get('user_input').split('*')[-1] @@ -112,13 +114,13 @@ def process_exit_insufficient_balance(display_key: str, user: Account, ussd_sess token_symbol = retrieve_token_symbol() recipient_phone_number = ussd_session.get('session_data').get('recipient_phone_number') - recipient = get_user_by_phone_number(phone_number=recipient_phone_number) + recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=session) tx_recipient_information = define_account_tx_metadata(user=recipient) return translation_for( key=display_key, - preferred_language=user.preferred_language, + preferred_language=account.preferred_language, amount=from_wei(transaction_amount), token_symbol=token_symbol, recipient_information=tx_recipient_information, @@ -126,12 +128,14 @@ def process_exit_insufficient_balance(display_key: str, user: Account, ussd_sess ) -def process_exit_successful_transaction(display_key: str, user: Account, ussd_session: dict): +def process_exit_successful_transaction(account: Account, display_key: str, session: Session, ussd_session: dict): """This function processes the exit menu after a successful initiation for a transfer of tokens. + :param account: The account requesting access to the ussd menu. + :type account: Account :param display_key: The path in the translation files defining an appropriate ussd response :type display_key: str - :param user: The user requesting access to the ussd menu. - :type user: Account + :param session: + :type session: :param ussd_session: A JSON serialized in-memory ussd session object :type ussd_session: dict :return: Corresponding translation text response @@ -140,13 +144,13 @@ def process_exit_successful_transaction(display_key: str, user: Account, ussd_se transaction_amount = to_wei(int(ussd_session.get('session_data').get('transaction_amount'))) token_symbol = retrieve_token_symbol() recipient_phone_number = ussd_session.get('session_data').get('recipient_phone_number') - recipient = get_user_by_phone_number(phone_number=recipient_phone_number) + recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=session) tx_recipient_information = define_account_tx_metadata(user=recipient) - tx_sender_information = define_account_tx_metadata(user=user) + tx_sender_information = define_account_tx_metadata(user=account) return translation_for( key=display_key, - preferred_language=user.preferred_language, + preferred_language=account.preferred_language, transaction_amount=from_wei(transaction_amount), token_symbol=token_symbol, recipient_information=tx_recipient_information, @@ -154,13 +158,15 @@ def process_exit_successful_transaction(display_key: str, user: Account, ussd_se ) -def process_transaction_pin_authorization(user: Account, display_key: str, ussd_session: dict): +def process_transaction_pin_authorization(account: Account, display_key: str, session: Session, ussd_session: dict): """This function processes pin authorization where making a transaction is concerned. It constructs a pre-transaction response menu that shows the details of the transaction. - :param user: The user requesting access to the ussd menu. - :type user: Account + :param account: The account requesting access to the ussd menu. + :type account: Account :param display_key: The path in the translation files defining an appropriate ussd response :type display_key: str + :param session: + :type session: :param ussd_session: The USSD session determining what user data needs to be extracted and added to the menu's text values. :type ussd_session: UssdSession @@ -169,16 +175,16 @@ def process_transaction_pin_authorization(user: Account, display_key: str, ussd_ """ # compile response data recipient_phone_number = ussd_session.get('session_data').get('recipient_phone_number') - recipient = get_user_by_phone_number(phone_number=recipient_phone_number) + recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=session) tx_recipient_information = define_account_tx_metadata(user=recipient) - tx_sender_information = define_account_tx_metadata(user=user) + tx_sender_information = define_account_tx_metadata(user=account) token_symbol = retrieve_token_symbol() user_input = ussd_session.get('session_data').get('transaction_amount') transaction_amount = to_wei(value=int(user_input)) logg.debug('Requires integration to determine user tokens.') return process_pin_authorization( - user=user, + account=account, display_key=display_key, recipient_information=tx_recipient_information, transaction_amount=from_wei(transaction_amount), @@ -187,14 +193,12 @@ def process_transaction_pin_authorization(user: Account, display_key: str, ussd_ ) -def process_account_balances(user: Account, display_key: str, ussd_session: dict): +def process_account_balances(user: Account, display_key: str): """ :param user: :type user: :param display_key: :type display_key: - :param ussd_session: - :type ussd_session: :return: :rtype: """ @@ -290,19 +294,18 @@ def process_display_user_metadata(user: Account, display_key: str): preferred_language=user.preferred_language, full_name=absent, gender=absent, + age=absent, location=absent, products=absent ) -def process_account_statement(user: Account, display_key: str, ussd_session: dict): +def process_account_statement(user: Account, display_key: str): """ :param user: :type user: :param display_key: :type display_key: - :param ussd_session: - :type ussd_session: :return: :rtype: """ @@ -404,23 +407,26 @@ def process_start_menu(display_key: str, user: Account): ) -def retrieve_most_recent_ussd_session(phone_number: str) -> UssdSession: +def retrieve_most_recent_ussd_session(phone_number: str, session: Session) -> UssdSession: # get last ussd session based on user phone number - last_ussd_session = UssdSession.session\ - .query(UssdSession)\ + session = SessionBase.bind_session(session=session) + last_ussd_session = session.query(UssdSession)\ .filter_by(msisdn=phone_number)\ .order_by(desc(UssdSession.created))\ .first() + SessionBase.release_session(session=session) return last_ussd_session -def process_request(user_input: str, user: Account, ussd_session: Optional[dict] = None) -> Document: +def process_request(account: Account, session, user_input: str, ussd_session: Optional[dict] = None) -> Document: """This function assesses a request based on the user from the request comes, the session_id and the user's input. It determines whether the request translates to a return to an existing session by checking whether the provided session id exists in the database or whether the creation of a new ussd session object is warranted. It then returns the appropriate ussd menu text values. - :param user: The user requesting access to the ussd menu. - :type user: Account + :param account: The account requesting access to the ussd menu. + :type account: Account + :param session: + :type session: :param user_input: The value a user enters in the ussd menu. :type user_input: str :param ussd_session: A JSON serialized in-memory ussd session object @@ -433,11 +439,15 @@ def process_request(user_input: str, user: Account, ussd_session: Optional[dict] if user_input == "0": return UssdMenu.parent_menu(menu_name=ussd_session.get('state')) else: - successive_state = next_state(ussd_session=ussd_session, user=user, user_input=user_input) + successive_state = next_state( + account=account, + session=session, + ussd_session=ussd_session, + user_input=user_input) return UssdMenu.find_by_name(name=successive_state) else: - if user.has_valid_pin(): - last_ussd_session = retrieve_most_recent_ussd_session(phone_number=user.phone_number) + if account.has_valid_pin(): + last_ussd_session = retrieve_most_recent_ussd_session(phone_number=account.phone_number, session=session) if last_ussd_session: # get last state @@ -456,28 +466,30 @@ def process_request(user_input: str, user: Account, ussd_session: Optional[dict] else: return UssdMenu.find_by_name(name=last_state) else: - if user.failed_pin_attempts >= 3 and user.get_account_status() == AccountStatus.LOCKED.name: + if account.failed_pin_attempts >= 3 and account.get_account_status() == AccountStatus.LOCKED.name: return UssdMenu.find_by_name(name='exit_pin_blocked') - elif user.preferred_language is None: + elif account.preferred_language is None: return UssdMenu.find_by_name(name='initial_language_selection') else: return UssdMenu.find_by_name(name='initial_pin_entry') -def next_state(ussd_session: dict, user: Account, user_input: str) -> str: +def next_state(account: Account, session, ussd_session: dict, user_input: str) -> str: """This function navigates the state machine based on the ussd session object and user inputs it receives. It checks the user input and provides the successive state in the state machine. It then updates the session's state attribute with the new state. + :param account: The account requesting access to the ussd menu. + :type account: Account + :param session: + :type session: :param ussd_session: A JSON serialized in-memory ussd session object :type ussd_session: dict - :param user: The user requesting access to the ussd menu. - :type user: Account :param user_input: The value a user enters in the ussd menu. :type user_input: str :return: A string value corresponding the successive give a specific state in the state machine. """ state_machine = UssdStateMachine(ussd_session=ussd_session) - state_machine.scan_data((user_input, ussd_session, user)) + state_machine.scan_data((user_input, ussd_session, account, session)) new_state = state_machine.state return new_state @@ -492,42 +504,63 @@ def process_exit_invalid_menu_option(display_key: str, preferred_language: str): def custom_display_text( + account: Account, display_key: str, menu_name: str, - ussd_session: dict, - user: Account) -> str: + session: Session, + ussd_session: dict) -> str: """This function extracts the appropriate session data based on the current menu name. It then inserts them as keywords in the i18n function. + :param account: The account in a running USSD session. + :type account: Account :param display_key: The path in the translation files defining an appropriate ussd response :type display_key: str :param menu_name: The name by which a specific menu can be identified. :type menu_name: str - :param user: The user in a running USSD session. - :type user: Account + :param session: + :type session: :param ussd_session: A JSON serialized in-memory ussd session object :type ussd_session: dict :return: A string value corresponding the ussd menu's text value. :rtype: str """ if menu_name == 'transaction_pin_authorization': - return process_transaction_pin_authorization(display_key=display_key, user=user, ussd_session=ussd_session) + return process_transaction_pin_authorization( + account=account, + display_key=display_key, + session=session, + ussd_session=ussd_session) elif menu_name == 'exit_insufficient_balance': - return process_exit_insufficient_balance(display_key=display_key, user=user, ussd_session=ussd_session) + return process_exit_insufficient_balance( + account=account, + display_key=display_key, + session=session, + ussd_session=ussd_session) elif menu_name == 'exit_successful_transaction': - return process_exit_successful_transaction(display_key=display_key, user=user, ussd_session=ussd_session) + return process_exit_successful_transaction( + account=account, + display_key=display_key, + session=session, + ussd_session=ussd_session) elif menu_name == 'start': - return process_start_menu(display_key=display_key, user=user) + return process_start_menu(display_key=display_key, user=account) elif 'pin_authorization' in menu_name: - return process_pin_authorization(display_key=display_key, user=user) + return process_pin_authorization( + account=account, + display_key=display_key, + session=session) elif 'enter_current_pin' in menu_name: - return process_pin_authorization(display_key=display_key, user=user) + return process_pin_authorization( + account=account, + display_key=display_key, + session=session) elif menu_name == 'account_balances': - return process_account_balances(display_key=display_key, user=user, ussd_session=ussd_session) + return process_account_balances(display_key=display_key, user=account) elif 'transaction_set' in menu_name: - return process_account_statement(display_key=display_key, user=user, ussd_session=ussd_session) + return process_account_statement(display_key=display_key, user=account) elif menu_name == 'display_user_metadata': - return process_display_user_metadata(display_key=display_key, user=user) + return process_display_user_metadata(display_key=display_key, user=account) elif menu_name == 'exit_invalid_menu_option': - return process_exit_invalid_menu_option(display_key=display_key, preferred_language=user.preferred_language) + return process_exit_invalid_menu_option(display_key=display_key, preferred_language=account.preferred_language) else: - return translation_for(key=display_key, preferred_language=user.preferred_language) + return translation_for(key=display_key, preferred_language=account.preferred_language) diff --git a/apps/cic-ussd/cic_ussd/requests.py b/apps/cic-ussd/cic_ussd/requests.py index 8d436f45..897d8539 100644 --- a/apps/cic-ussd/cic_ussd/requests.py +++ b/apps/cic-ussd/cic_ussd/requests.py @@ -8,9 +8,12 @@ from urllib.parse import urlparse, parse_qs # third-party imports from sqlalchemy import desc +from sqlalchemy.orm.session import Session # local imports -from cic_ussd.db.models.account import AccountStatus, Account +from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase +from cic_ussd.db.enum import AccountStatus from cic_ussd.operations import get_account_status, reset_pin from cic_ussd.validator import check_known_user @@ -72,24 +75,26 @@ def get_account_creation_callback_request_data(env: dict) -> tuple: return status, task_id, result -def process_pin_reset_requests(env: dict, phone_number: str): +def process_pin_reset_requests(env: dict, phone_number: str, session: Session): """This function processes requests that are responsible for the pin reset functionality. It processes GET and PUT requests responsible for returning an account's status and :param env: A dictionary of values representing data sent on the api. :type env: dict :param phone_number: The phone of the user whose pin is being reset. :type phone_number: str + :param session: + :type session: :return: A response denoting the result of the request to reset the user's pin. :rtype: str """ - if not check_known_user(phone=phone_number): + if not check_known_user(phone_number=phone_number, session=session): return f'No user matching {phone_number} was found.', '404 Not Found' if get_request_method(env) == 'PUT': - return reset_pin(phone_number=phone_number), '200 OK' + return reset_pin(phone_number=phone_number, session=session), '200 OK' if get_request_method(env) == 'GET': - status = get_account_status(phone_number=phone_number) + status = get_account_status(phone_number=phone_number, session=session) response = { 'status': f'{status}' } @@ -97,16 +102,18 @@ def process_pin_reset_requests(env: dict, phone_number: str): return response, '200 OK' -def process_locked_accounts_requests(env: dict) -> tuple: +def process_locked_accounts_requests(env: dict, session: Session) -> tuple: """This function authenticates staff requests and returns a serialized JSON formatted list of blockchain addresses of accounts for which the PIN has been locked due to too many failed attempts. :param env: A dictionary of values representing data sent on the api. :type env: dict + :param session: + :type session: :return: A tuple containing a serialized list of blockchain addresses for locked accounts and corresponding message for the response. :rtype: tuple """ - logg.debug('Authentication requires integration with cic-auth') + session = SessionBase.bind_session(session=session) response = '' if get_request_method(env) == 'GET': @@ -123,12 +130,14 @@ def process_locked_accounts_requests(env: dict) -> tuple: else: limit = r[1] - locked_accounts = Account.session.query(Account.blockchain_address).filter( + locked_accounts = session.query(Account.blockchain_address).filter( Account.account_status == AccountStatus.LOCKED.value, Account.failed_pin_attempts >= 3).order_by(desc(Account.updated)).offset(offset).limit(limit).all() # convert lists to scalar blockchain addresses locked_accounts = [blockchain_address for (blockchain_address, ) in locked_accounts] + + SessionBase.release_session(session=session) response = json.dumps(locked_accounts) return response, '200 OK' return response, '405 Play by the rules' diff --git a/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_server.py b/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_server.py index 53f633f6..c8df1ccd 100644 --- a/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_server.py +++ b/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_server.py @@ -36,11 +36,8 @@ logg.debug('config loaded from {}:\n{}'.format(args.c, config)) # set up db data_source_name = dsn_from_config(config) SessionBase.connect(data_source_name, pool_size=int(config.get('DATABASE_POOL_SIZE')), debug=config.true('DATABASE_DEBUG')) -# create session for the life time of http request -SessionBase.session = SessionBase.create_session() -# handle requests from CICADA def application(env, start_response): """Loads python code for application to be accessible over web server :param env: Object containing server and request information @@ -55,19 +52,24 @@ def application(env, start_response): errors_headers = [('Content-Type', 'text/plain'), ('Content-Length', '0')] headers = [('Content-Type', 'text/plain')] + # create session for the life time of http request + session = SessionBase.create_session() + if get_request_endpoint(env) == '/pin': phone_number = get_query_parameters(env=env, query_name='phoneNumber') phone_number = quote_plus(phone_number) - response, message = process_pin_reset_requests(env=env, phone_number=phone_number) + response, message = process_pin_reset_requests(env=env, phone_number=phone_number, session=session) response_bytes, headers = define_response_with_content(headers=errors_headers, response=response) - SessionBase.session.close() + session.commit() + session.close() start_response(message, headers) return [response_bytes] # handle requests for locked accounts - response, message = process_locked_accounts_requests(env=env) + response, message = process_locked_accounts_requests(env=env, session=session) response_bytes, headers = define_response_with_content(headers=headers, response=response) start_response(message, headers) - SessionBase.session.close() + session.commit() + session.close() return [response_bytes] diff --git a/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_ussd_server.py b/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_ussd_server.py index 738127e8..984fb680 100644 --- a/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_ussd_server.py +++ b/apps/cic-ussd/cic_ussd/runnable/daemons/cic_user_ussd_server.py @@ -55,8 +55,6 @@ data_source_name = dsn_from_config(config) SessionBase.connect(data_source_name, pool_size=int(config.get('DATABASE_POOL_SIZE')), debug=config.true('DATABASE_DEBUG')) -# create session for the life time of http request -SessionBase.session = SessionBase.create_session() # set up translations i18n.load_path.append(config.get('APP_LOCALE_PATH')) @@ -143,6 +141,9 @@ def application(env, start_response): errors_headers = [('Content-Type', 'text/plain'), ('Content-Length', '0')] headers = [('Content-Type', 'text/plain')] + # create session for the life time of http request + session = SessionBase.create_session() + if get_request_method(env=env) == 'POST' and get_request_endpoint(env=env) == '/': if env.get('CONTENT_TYPE') != 'application/x-www-form-urlencoded': @@ -206,17 +207,20 @@ def application(env, start_response): phone_number=phone_number, queue=args.q, service_code=service_code, + session=session, user_input=user_input) response_bytes, headers = define_response_with_content(headers=headers, response=response) start_response('200 OK,', headers) - SessionBase.session.close() + session.commit() + session.close() return [response_bytes] else: logg.error('invalid query {}'.format(env)) for r in env: logg.debug('{}: {}'.format(r, env)) + session.close() start_response('405 Play by the rules', errors_headers) return [] diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/balance.py b/apps/cic-ussd/cic_ussd/state_machine/logic/balance.py index 899ff346..64f1dd61 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/balance.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/balance.py @@ -3,6 +3,7 @@ import logging from typing import Tuple # third-party imports +from sqlalchemy.orm.session import Session # local imports from cic_ussd.db.models.account import Account @@ -10,11 +11,11 @@ from cic_ussd.db.models.account import Account logg = logging.getLogger(__file__) -def process_mini_statement_request(state_machine_data: Tuple[str, dict, Account]): +def process_mini_statement_request(state_machine_data: Tuple[str, dict, Account, Session]): """This function compiles a brief statement of a user's last three inbound and outbound transactions and send the same as a message on their selected avenue for notification. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: str """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data logg.debug('This section requires integration with cic-eth. (The last 6 transactions would be sent as an sms.)') diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py b/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py index a1889ce5..bac773b9 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/menu.py @@ -16,7 +16,7 @@ def menu_one_selected(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user input's match with '1' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '1' @@ -27,7 +27,7 @@ def menu_two_selected(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user input's match with '2' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '2' @@ -38,7 +38,7 @@ def menu_three_selected(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user input's match with '3' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '3' @@ -50,7 +50,7 @@ def menu_four_selected(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user input's match with '4' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '4' @@ -62,7 +62,7 @@ def menu_five_selected(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user input's match with '5' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '5' @@ -74,7 +74,7 @@ def menu_six_selected(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user input's match with '6' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '6' @@ -86,7 +86,7 @@ def menu_zero_zero_selected(state_machine_data: Tuple[str, dict, Account]) -> bo :return: A user input's match with '00' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '00' @@ -98,5 +98,5 @@ def menu_ninety_nine_selected(state_machine_data: Tuple[str, dict, Account]) -> :return: A user input's match with '99' :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user_input == '99' diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py b/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py index 5f51e602..9419d248 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/pin.py @@ -9,11 +9,13 @@ import re from typing import Tuple # third party imports -import bcrypt +from sqlalchemy.orm.session import Session # local imports -from cic_ussd.db.models.account import AccountStatus, Account -from cic_ussd.encoder import PasswordEncoder, create_password_hash, check_password_hash +from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase +from cic_ussd.db.enum import AccountStatus +from cic_ussd.encoder import create_password_hash, check_password_hash from cic_ussd.operations import persist_session_to_db_task, create_or_update_session from cic_ussd.redis import InMemoryStore @@ -21,7 +23,7 @@ from cic_ussd.redis import InMemoryStore logg = logging.getLogger(__file__) -def is_valid_pin(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_valid_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks a pin's validity by ensuring it has a length of for characters and the characters are numeric. :param state_machine_data: A tuple containing user input, a ussd session and user object. @@ -29,7 +31,7 @@ def is_valid_pin(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A pin's validity :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data pin_is_valid = False matcher = r'^\d{4}$' if re.match(matcher, user_input): @@ -37,34 +39,34 @@ def is_valid_pin(state_machine_data: Tuple[str, dict, Account]) -> bool: return pin_is_valid -def is_authorized_pin(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_authorized_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks whether the user input confirming a specific pin matches the initial pin entered. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user.verify_password(password=user_input) -def is_locked_account(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_locked_account(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks whether a user's account is locked due to too many failed attempts. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user.get_account_status() == AccountStatus.LOCKED.name -def save_initial_pin_to_session_data(state_machine_data: Tuple[str, dict, Account]): +def save_initial_pin_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]): """This function hashes a pin and stores it in session data. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data # define redis cache entry point cache = InMemoryStore.cache @@ -93,54 +95,56 @@ def save_initial_pin_to_session_data(state_machine_data: Tuple[str, dict, Accoun service_code=in_redis_ussd_session.get('service_code'), user_input=user_input, current_menu=in_redis_ussd_session.get('state'), + session=session, session_data=session_data ) persist_session_to_db_task(external_session_id=external_session_id, queue='cic-ussd') -def pins_match(state_machine_data: Tuple[str, dict, Account]) -> bool: +def pins_match(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks whether the user input confirming a specific pin matches the initial pin entered. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data initial_pin = ussd_session.get('session_data').get('initial_pin') - logg.debug(f'USSD SESSION: {ussd_session}') return check_password_hash(user_input, initial_pin) -def complete_pin_change(state_machine_data: Tuple[str, dict, Account]): +def complete_pin_change(state_machine_data: Tuple[str, dict, Account, Session]): """This function persists the user's pin to the database :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data + session = SessionBase.bind_session(session=session) password_hash = ussd_session.get('session_data').get('initial_pin') user.password_hash = password_hash - Account.session.add(user) - Account.session.commit() + session.add(user) + session.flush() + SessionBase.release_session(session=session) -def is_blocked_pin(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_blocked_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks whether the user input confirming a specific pin matches the initial pin entered. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data return user.get_account_status() == AccountStatus.LOCKED.name -def is_valid_new_pin(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_valid_new_pin(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks whether the user's new pin is a valid pin and that it isn't the same as the old one. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple :return: A match between two pin values. :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data is_old_pin = user.verify_password(password=user_input) return is_valid_pin(state_machine_data=state_machine_data) and not is_old_pin diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py b/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py index 517c09e9..6f33a555 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/sms.py @@ -9,15 +9,15 @@ logg = logging.getLogger() def send_terms_to_user_if_required(state_machine_data: Tuple[str, dict, Account]): - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data logg.debug('Requires integration to cic-notify.') def process_mini_statement_request(state_machine_data: Tuple[str, dict, Account]): - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data logg.debug('Requires integration to cic-notify.') def upsell_unregistered_recipient(state_machine_data: Tuple[str, dict, Account]): - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data logg.debug('Requires integration to cic-notify.') \ No newline at end of file diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py b/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py index b8894103..c2ac5e45 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/transaction.py @@ -5,13 +5,16 @@ from typing import Tuple # third party imports import celery +from sqlalchemy.orm.session import Session # local imports -from cic_ussd.balance import BalanceManager, compute_operational_balance +from cic_ussd.balance import compute_operational_balance from cic_ussd.chain import Chain -from cic_ussd.db.models.account import AccountStatus, Account +from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase +from cic_ussd.db.enum import AccountStatus from cic_ussd.operations import save_to_in_memory_ussd_session_data -from cic_ussd.phone_number import get_user_by_phone_number, process_phone_number, E164Format +from cic_ussd.phone_number import process_phone_number, E164Format from cic_ussd.processor import retrieve_token_symbol from cic_ussd.redis import create_cached_data_key, get_cached_data from cic_ussd.transactions import OutgoingTransactionProcessor @@ -20,7 +23,7 @@ from cic_ussd.transactions import OutgoingTransactionProcessor logg = logging.getLogger(__file__) -def is_valid_recipient(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_valid_recipient(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks that a user exists, is not the initiator of the transaction, has an active account status and is authorized to perform standard transactions. :param state_machine_data: A tuple containing user input, a ussd session and user object. @@ -28,15 +31,17 @@ def is_valid_recipient(state_machine_data: Tuple[str, dict, Account]) -> bool: :return: A user's validity :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data phone_number = process_phone_number(user_input, E164Format.region) - recipient = get_user_by_phone_number(phone_number=user_input) + session = SessionBase.bind_session(session=session) + recipient = Account.get_by_phone_number(phone_number=phone_number, session=session) + SessionBase.release_session(session=session) is_not_initiator = phone_number != user.phone_number has_active_account_status = user.get_account_status() == AccountStatus.ACTIVE.name return is_not_initiator and has_active_account_status and recipient is not None -def is_valid_transaction_amount(state_machine_data: Tuple[str, dict, Account]) -> bool: +def is_valid_transaction_amount(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks that the transaction amount provided is valid as per the criteria for the transaction being attempted. :param state_machine_data: A tuple containing user input, a ussd session and user object. @@ -44,14 +49,14 @@ def is_valid_transaction_amount(state_machine_data: Tuple[str, dict, Account]) - :return: A transaction amount's validity :rtype: bool """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data try: return int(user_input) > 0 except ValueError: return False -def has_sufficient_balance(state_machine_data: Tuple[str, dict, Account]) -> bool: +def has_sufficient_balance(state_machine_data: Tuple[str, dict, Account, Session]) -> bool: """This function checks that the transaction amount provided is valid as per the criteria for the transaction being attempted. :param state_machine_data: A tuple containing user input, a ussd session and user object. @@ -59,10 +64,7 @@ def has_sufficient_balance(state_machine_data: Tuple[str, dict, Account]) -> boo :return: An account balance's validity :rtype: bool """ - user_input, ussd_session, user = state_machine_data - balance_manager = BalanceManager(address=user.blockchain_address, - chain_str=Chain.spec.__str__(), - token_symbol='SRF') + user_input, ussd_session, user, session = state_machine_data # get cached balance key = create_cached_data_key( identifier=bytes.fromhex(user.blockchain_address[2:]), @@ -74,30 +76,37 @@ def has_sufficient_balance(state_machine_data: Tuple[str, dict, Account]) -> boo return int(user_input) <= operational_balance -def save_recipient_phone_to_session_data(state_machine_data: Tuple[str, dict, Account]): +def save_recipient_phone_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]): """This function saves the phone number corresponding the intended recipients blockchain account. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: str """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data session_data = ussd_session.get('session_data') or {} - session_data['recipient_phone_number'] = user_input + recipient_phone_number = process_phone_number(phone_number=user_input, region=E164Format.region) + session_data['recipient_phone_number'] = recipient_phone_number - save_to_in_memory_ussd_session_data(queue='cic-ussd', session_data=session_data, ussd_session=ussd_session) + save_to_in_memory_ussd_session_data( + queue='cic-ussd', + session=session, + session_data=session_data, + ussd_session=ussd_session) -def retrieve_recipient_metadata(state_machine_data: Tuple[str, dict, Account]): +def retrieve_recipient_metadata(state_machine_data: Tuple[str, dict, Account, Session]): """ :param state_machine_data: :type state_machine_data: :return: :rtype: """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data - recipient = get_user_by_phone_number(phone_number=user_input) + recipient_phone_number = process_phone_number(phone_number=user_input, region=E164Format.region) + recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=session) blockchain_address = recipient.blockchain_address + # retrieve and cache account's metadata s_query_person_metadata = celery.signature( 'cic_ussd.tasks.metadata.query_person_metadata', @@ -106,32 +115,36 @@ def retrieve_recipient_metadata(state_machine_data: Tuple[str, dict, Account]): s_query_person_metadata.apply_async(queue='cic-ussd') -def save_transaction_amount_to_session_data(state_machine_data: Tuple[str, dict, Account]): +def save_transaction_amount_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]): """This function saves the phone number corresponding the intended recipients blockchain account. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: str """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data session_data = ussd_session.get('session_data') or {} session_data['transaction_amount'] = user_input - save_to_in_memory_ussd_session_data(queue='cic-ussd', session_data=session_data, ussd_session=ussd_session) + save_to_in_memory_ussd_session_data( + queue='cic-ussd', + session=session, + session_data=session_data, + ussd_session=ussd_session) -def process_transaction_request(state_machine_data: Tuple[str, dict, Account]): +def process_transaction_request(state_machine_data: Tuple[str, dict, Account, Session]): """This function saves the phone number corresponding the intended recipients blockchain account. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: str """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data # retrieve token symbol chain_str = Chain.spec.__str__() # get user from phone number recipient_phone_number = ussd_session.get('session_data').get('recipient_phone_number') - recipient = get_user_by_phone_number(phone_number=recipient_phone_number) + recipient = Account.get_by_phone_number(phone_number=recipient_phone_number, session=session) to_address = recipient.blockchain_address from_address = user.blockchain_address amount = int(ussd_session.get('session_data').get('transaction_amount')) diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/user.py b/apps/cic-ussd/cic_ussd/state_machine/logic/user.py index d9218845..7c01f971 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/user.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/user.py @@ -5,12 +5,14 @@ from typing import Tuple # third-party imports import celery -from cic_types.models.person import Person, generate_metadata_pointer +from cic_types.models.person import generate_metadata_pointer from cic_types.models.person import generate_vcard_from_contact_data, manage_identity_data +from sqlalchemy.orm.session import Session # local imports from cic_ussd.chain import Chain from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase from cic_ussd.error import MetadataNotFoundError from cic_ussd.metadata import blockchain_address_to_metadata_pointer from cic_ussd.operations import save_to_in_memory_ussd_session_data @@ -19,15 +21,17 @@ from cic_ussd.redis import get_cached_data logg = logging.getLogger(__file__) -def change_preferred_language_to_en(state_machine_data: Tuple[str, dict, Account]): +def change_preferred_language_to_en(state_machine_data: Tuple[str, dict, Account, Session]): """This function changes the user's preferred language to english. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data + session = SessionBase.bind_session(session=session) user.preferred_language = 'en' - Account.session.add(user) - Account.session.commit() + session.add(user) + session.flush() + SessionBase.release_session(session=session) preferences_data = { 'preferred_language': 'en' @@ -40,15 +44,17 @@ def change_preferred_language_to_en(state_machine_data: Tuple[str, dict, Account s.apply_async(queue='cic-ussd') -def change_preferred_language_to_sw(state_machine_data: Tuple[str, dict, Account]): +def change_preferred_language_to_sw(state_machine_data: Tuple[str, dict, Account, Session]): """This function changes the user's preferred language to swahili. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data - user.preferred_language = 'sw' - Account.session.add(user) - Account.session.commit() + user_input, ussd_session, account, session = state_machine_data + session = SessionBase.bind_session(session=session) + account.preferred_language = 'sw' + session.add(account) + session.flush() + SessionBase.release_session(session=session) preferences_data = { 'preferred_language': 'sw' @@ -56,20 +62,22 @@ def change_preferred_language_to_sw(state_machine_data: Tuple[str, dict, Account s = celery.signature( 'cic_ussd.tasks.metadata.add_preferences_metadata', - [user.blockchain_address, preferences_data] + [account.blockchain_address, preferences_data] ) s.apply_async(queue='cic-ussd') -def update_account_status_to_active(state_machine_data: Tuple[str, dict, Account]): +def update_account_status_to_active(state_machine_data: Tuple[str, dict, Account, Session]): """This function sets user's account to active. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data - user.activate_account() - Account.session.add(user) - Account.session.commit() + user_input, ussd_session, account, session = state_machine_data + session = SessionBase.bind_session(session=session) + account.activate_account() + session.add(account) + session.flush() + SessionBase.release_session(session=session) def process_gender_user_input(user: Account, user_input: str): @@ -81,6 +89,7 @@ def process_gender_user_input(user: Account, user_input: str): :return: :rtype: """ + gender = "" if user.preferred_language == 'en': if user_input == '1': gender = 'Male' @@ -98,13 +107,13 @@ def process_gender_user_input(user: Account, user_input: str): return gender -def save_metadata_attribute_to_session_data(state_machine_data: Tuple[str, dict, Account]): +def save_metadata_attribute_to_session_data(state_machine_data: Tuple[str, dict, Account, Session]): """This function saves first name data to the ussd session in the redis cache. :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data - + user_input, ussd_session, user, session = state_machine_data + session = SessionBase.bind_session(session=session) # get current menu current_state = ussd_session.get('state') @@ -137,7 +146,11 @@ def save_metadata_attribute_to_session_data(state_machine_data: Tuple[str, dict, session_data = { key: user_input } - save_to_in_memory_ussd_session_data(queue='cic-ussd', session_data=session_data, ussd_session=ussd_session) + save_to_in_memory_ussd_session_data( + queue='cic-ussd', + session=session, + session_data=session_data, + ussd_session=ussd_session) def format_user_metadata(metadata: dict, user: Account): @@ -197,12 +210,12 @@ def format_user_metadata(metadata: dict, user: Account): } -def save_complete_user_metadata(state_machine_data: Tuple[str, dict, Account]): +def save_complete_user_metadata(state_machine_data: Tuple[str, dict, Account, Session]): """This function persists elements of the user metadata stored in session data :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: tuple """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data # get session data metadata = ussd_session.get('session_data') @@ -218,8 +231,8 @@ def save_complete_user_metadata(state_machine_data: Tuple[str, dict, Account]): s_create_person_metadata.apply_async(queue='cic-ussd') -def edit_user_metadata_attribute(state_machine_data: Tuple[str, dict, Account]): - user_input, ussd_session, user = state_machine_data +def edit_user_metadata_attribute(state_machine_data: Tuple[str, dict, Account, Session]): + user_input, ussd_session, user, session = state_machine_data blockchain_address = user.blockchain_address key = generate_metadata_pointer( identifier=blockchain_address_to_metadata_pointer(blockchain_address=user.blockchain_address), @@ -269,8 +282,8 @@ def edit_user_metadata_attribute(state_machine_data: Tuple[str, dict, Account]): s_edit_person_metadata.apply_async(queue='cic-ussd') -def get_user_metadata(state_machine_data: Tuple[str, dict, Account]): - user_input, ussd_session, user = state_machine_data +def get_user_metadata(state_machine_data: Tuple[str, dict, Account, Session]): + user_input, ussd_session, user, session = state_machine_data blockchain_address = user.blockchain_address s_get_user_metadata = celery.signature( 'cic_ussd.tasks.metadata.query_person_metadata', diff --git a/apps/cic-ussd/cic_ussd/state_machine/logic/validator.py b/apps/cic-ussd/cic_ussd/state_machine/logic/validator.py index 2af1e8d3..80747042 100644 --- a/apps/cic-ussd/cic_ussd/state_machine/logic/validator.py +++ b/apps/cic-ussd/cic_ussd/state_machine/logic/validator.py @@ -19,7 +19,7 @@ def has_cached_user_metadata(state_machine_data: Tuple[str, dict, Account]): :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: str """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data # check for user metadata in cache key = generate_metadata_pointer( identifier=blockchain_address_to_metadata_pointer(blockchain_address=user.blockchain_address), @@ -34,7 +34,7 @@ def is_valid_name(state_machine_data: Tuple[str, dict, Account]): :param state_machine_data: A tuple containing user input, a ussd session and user object. :type state_machine_data: str """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data name_matcher = "^[a-zA-Z]+$" valid_name = re.match(name_matcher, user_input) if valid_name: @@ -50,7 +50,7 @@ def is_valid_gender_selection(state_machine_data: Tuple[str, dict, Account]): :return: :rtype: """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data selection_matcher = "^[1-2]$" if re.match(selection_matcher, user_input): return True @@ -65,6 +65,6 @@ def is_valid_date(state_machine_data: Tuple[str, dict, Account]): :return: :rtype: """ - user_input, ussd_session, user = state_machine_data + user_input, ussd_session, user, session = state_machine_data # For MVP this value is defaulting to year return len(user_input) == 4 and int(user_input) >= 1900 diff --git a/apps/cic-ussd/cic_ussd/validator.py b/apps/cic-ussd/cic_ussd/validator.py index 660f2783..a1706f9a 100644 --- a/apps/cic-ussd/cic_ussd/validator.py +++ b/apps/cic-ussd/cic_ussd/validator.py @@ -9,6 +9,7 @@ from confini import Config # local imports from cic_ussd.db.models.account import Account +from cic_ussd.db.models.base import SessionBase logg = logging.getLogger(__file__) @@ -45,29 +46,21 @@ def check_request_content_length(config: Config, env: dict): config.get('APP_MAX_BODY_LENGTH')) -def check_known_user(phone: str): - """ - This method attempts to ascertain whether the user already exists and is known to the system. +def check_known_user(phone_number: str, session): + """This method attempts to ascertain whether the user already exists and is known to the system. It sends a get request to the platform application and attempts to retrieve the user's data which it persists in memory. - :param phone: A valid phone number - :type phone: str + :param phone_number: A valid phone number + :type phone_number: str + :param session: + :type session: :return: Is known phone number :rtype: boolean """ - user = Account.session.query(Account).filter_by(phone_number=phone).first() - return user is not None - - -def check_phone_number(number: str): - """ - Checks whether phone number is present - :param number: A valid phone number - :type number: str - :return: Phone number presence - :rtype: boolean - """ - return number is not None + session = SessionBase.bind_session(session=session) + account = session.query(Account).filter_by(phone_number=phone_number).first() + SessionBase.release_session(session=session) + return account is not None def check_request_method(env: dict): diff --git a/apps/cic-ussd/requirements.txt b/apps/cic-ussd/requirements.txt index 4411509e..f527c4ef 100644 --- a/apps/cic-ussd/requirements.txt +++ b/apps/cic-ussd/requirements.txt @@ -1,4 +1,4 @@ -cic_base[full_graph]~=0.1.2b21 -cic-eth~=0.11.0b16 -cic-notify~=0.4.0a5 +cic_base[full_graph]==0.1.3a3+build.4aa03607 +cic-eth~=0.11.1a2 +cic-notify~=0.4.0a6 cic-types~=0.1.0a11 diff --git a/apps/cic-ussd/test_requirements.txt b/apps/cic-ussd/test_requirements.txt index 76aa808a..59af6564 100644 --- a/apps/cic-ussd/test_requirements.txt +++ b/apps/cic-ussd/test_requirements.txt @@ -8,4 +8,4 @@ pytest-mock==3.3.1 pytest-ordering==0.6 pytest-redis==2.0.0 requests-mock==1.8.0 -tavern==1.14.2 \ No newline at end of file +tavern==1.14.2 diff --git a/apps/cic-ussd/tests/fixtures/integration.py b/apps/cic-ussd/tests/fixtures/integration.py index b4488dcc..c8c349d9 100644 --- a/apps/cic-ussd/tests/fixtures/integration.py +++ b/apps/cic-ussd/tests/fixtures/integration.py @@ -124,46 +124,6 @@ def second_profile_management_session_id() -> str: return session_id() -@pytest.fixture(scope='session') -def first_account_change_given_name() -> str: - return fake.first_name() - - -@pytest.fixture(scope='session') -def second_account_change_given_name() -> str: - return fake.first_name() - - -@pytest.fixture(scope='session') -def first_account_change_family_name() -> str: - return fake.last_name() - - -@pytest.fixture(scope='session') -def second_account_change_family_name() -> str: - return fake.last_name() - - -@pytest.fixture(scope='session') -def first_account_change_location() -> str: - return fake.city() - - -@pytest.fixture(scope='session') -def second_account_change_location() -> str: - return fake.city() - - -@pytest.fixture(scope='session') -def first_account_change_product() -> str: - return fake.color_name() - - -@pytest.fixture(scope='session') -def second_account_change_product() -> str: - return fake.color_name() - - @pytest.fixture(scope='session') def first_profile_management_session_id_1() -> str: return session_id() diff --git a/apps/cic-ussd/tests/integration/README.md b/apps/cic-ussd/tests/integration/README.md new file mode 100644 index 00000000..dd567c53 --- /dev/null +++ b/apps/cic-ussd/tests/integration/README.md @@ -0,0 +1,25 @@ +# INTEGRATION TESTING + +This folder contains integration tests. + +## OVERVIEW + +There are four files defining the integration tests. + +* **test_account_creation**: Tests account sign up process. +* **test_transactions**: Tests transactions between two accounts. +* **test_profile_management**: Tests that account metadata can be edited. +* **test_account_management**: Tests that account management functionalities are intact. + +## REQUIREMENTS + +In order to run the transaction tests, please ensure that the faucet amount is set to a non-zero value, ideally `50000000` +which is the value set in the config file `.config/test/integration.ini`. + +This implies setting the `DEV_FAUCET_AMOUNT` to a non-zero value before bringing up the contract-migration image: + +```shell +export DEV_FAUCET_AMOUNT=50000000 +RUN_MASK=1 docker-compose up contract-migration +RUN_MASK=2 docker-compose up contract-migration +``` diff --git a/apps/cic-ussd/tests/integration/test_account_creation.tavern.yaml b/apps/cic-ussd/tests/integration/test_account_creation.tavern.yaml index 4fa83dd5..d602583c 100644 --- a/apps/cic-ussd/tests/integration/test_account_creation.tavern.yaml +++ b/apps/cic-ussd/tests/integration/test_account_creation.tavern.yaml @@ -214,12 +214,13 @@ stages: status_code: - 200 headers: - Content-Length: '28' + Content-Length: '51' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Enter first name\n0. Back" + expected_response: "CON Balance {gift_value} {token_symbol}\n1. Send\n2. My Account\n3. Help" + delay_before: 10 - name: Pin number confirmation [{second_account_pin_number} - second account] request: @@ -232,227 +233,6 @@ stages: headers: content-type: "application/x-www-form-urlencoded" method: POST - response: - status_code: - - 200 - headers: - Content-Length: '37' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka jina lako la kwanza\n0. Nyuma" - - - name: Enter first name [first_account_given_name - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_metadata_entry_session_id}" - phoneNumber: "{first_account_phone_number}" - text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '29' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Enter family name\n0. Back" - - - name: Enter first name [second_account_given_name - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_metadata_entry_session_id}" - phoneNumber: "{second_account_phone_number}" - text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '37' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka jina lako la mwisho\n0. Nyuma" - - - name: Enter last name [first_account_family_name - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_metadata_entry_session_id}" - phoneNumber: "{first_account_phone_number}" - text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '51' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Enter gender\n1. Male\n2. Female\n3. Other\n0. Back" - - - name: Enter last name [second_account_family_name - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_metadata_entry_session_id}" - phoneNumber: "{second_account_phone_number}" - text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '64' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka jinsia yako\n1. Mwanaume\n2. Mwanamke\n3. Nyngine\n0. Nyuma" - - - name: Select gender [Male - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_metadata_entry_session_id}" - phoneNumber: "{first_account_phone_number}" - text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '31' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Enter your location\n0. Back" - - - name: Select gender [Female - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_metadata_entry_session_id}" - phoneNumber: "{second_account_phone_number}" - text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}*2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '27' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka eneo lako\n0. Nyuma" - - - name: Enter location [first_account_location - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_metadata_entry_session_id}" - phoneNumber: "{first_account_phone_number}" - text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}*1*{first_account_location}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '55' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Please enter a product or service you offer\n0. Back" - - - name: Enter location [second_account_location - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_metadata_entry_session_id}" - phoneNumber: "{second_account_phone_number}" - text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}*2*{second_account_location}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '42' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka bidhaa ama huduma unauza\n0. Nyuma" - - - name: Enter product [first_account_product - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_metadata_entry_session_id}" - phoneNumber: "{first_account_phone_number}" - text: "1*{first_account_pin_number}*{first_account_pin_number}*{first_account_given_name}*{first_account_family_name}*1*{first_account_location}*{first_account_product}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '51' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Balance {gift_value} {token_symbol}\n1. Send\n2. My Account\n3. Help" - delay_before: 10 - - - name: Enter product [second_account_product - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_metadata_entry_session_id}" - phoneNumber: "{second_account_phone_number}" - text: "2*{second_account_pin_number}*{second_account_pin_number}*{second_account_given_name}*{second_account_family_name}*2*{second_account_location}*{second_account_product}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST response: status_code: - 200 diff --git a/apps/cic-ussd/tests/integration/test_account_management.tavern.yaml b/apps/cic-ussd/tests/integration/test_account_management.tavern.yaml index 03a5a4df..1d9ea975 100644 --- a/apps/cic-ussd/tests/integration/test_account_management.tavern.yaml +++ b/apps/cic-ussd/tests/integration/test_account_management.tavern.yaml @@ -31,7 +31,6 @@ stages: status_code: - 200 headers: - Content-Length: '51' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response diff --git a/apps/cic-ussd/tests/integration/test_profile_management.tavern.yaml b/apps/cic-ussd/tests/integration/test_profile_management.tavern.yaml index 274f0265..7e19a772 100644 --- a/apps/cic-ussd/tests/integration/test_profile_management.tavern.yaml +++ b/apps/cic-ussd/tests/integration/test_profile_management.tavern.yaml @@ -17,22 +17,6 @@ marks: - second_account_product - first_profile_management_session_id - second_profile_management_session_id - - first_account_change_family_name - - second_account_change_family_name - - first_account_change_given_name - - second_account_change_given_name - - first_account_change_location - - second_account_change_location - - first_account_change_product - - second_account_change_product - - first_profile_management_session_id_1 - - second_profile_management_session_id_1 - - first_profile_management_session_id_2 - - second_profile_management_session_id_2 - - first_profile_management_session_id_3 - - second_profile_management_session_id_3 - - first_profile_management_session_id_4 - - second_profile_management_session_id_4 - third stages: @@ -139,12 +123,12 @@ stages: status_code: - 200 headers: - Content-Length: '103' + Content-Length: '115' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" + expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit age\n4. Edit location\n5. Edit products\n6. View my profile\n0. Back" - name: Profile management menu [second account] request: @@ -161,12 +145,12 @@ stages: status_code: - 200 headers: - Content-Length: '104' + Content-Length: '117' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" + expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka umri\n4. Weka eneo\n5. Weka bidhaa\n6. Angalia wasifu wako\n0. Nyuma" - name: Enter pin to view profile [first account] request: @@ -175,7 +159,7 @@ stages: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5" + text: "2*1*6" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -197,7 +181,7 @@ stages: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5" + text: "2*1*6" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -219,7 +203,7 @@ stages: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{first_account_pin_number}" + text: "2*1*6*{first_account_pin_number}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -231,7 +215,7 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Your details are:\n Name: {first_account_given_name} {first_account_family_name}\n Gender: Male\n Location: {first_account_location}\n You sell: {first_account_product}\n0. Back" + expected_response: "CON Your details are:\n Name: Not provided\n Gender: Not provided\n Age: Not provided\n Location: Not provided\n You sell: Not provided\n0. Back" - name: Display profile [second account] request: @@ -240,7 +224,7 @@ stages: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}" + text: "2*1*6*{second_account_pin_number}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -252,7 +236,7 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Wasifu wako una maelezo yafuatayo:\n Jina: {second_account_given_name} {second_account_family_name}\n Jinsia: Mwanamke\n Eneo: {second_account_location}\n Unauza: {second_account_product}\n0. Nyuma" + expected_response: "CON Wasifu wako una maelezo yafuatayo:\n Jina: Haijawekwa\n Jinsia: Haijawekwa\n Umri: Haijawekwa\n Eneo: Haijawekwa\n Unauza: Haijawekwa\n0. Nyuma" - name: Second profile management menu [first account] request: @@ -261,7 +245,7 @@ stages: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{first_account_pin_number}*0" + text: "2*1*6*{first_account_pin_number}*0" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -269,12 +253,12 @@ stages: status_code: - 200 headers: - Content-Length: '103' + Content-Length: '115' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" + expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit age\n4. Edit location\n5. Edit products\n6. View my profile\n0. Back" - name: Second profile management menu [second account] request: @@ -283,7 +267,7 @@ stages: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0" + text: "2*1*6*{second_account_pin_number}*0" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -291,12 +275,12 @@ stages: status_code: - 200 headers: - Content-Length: '104' + Content-Length: '117' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" + expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka umri\n4. Weka eneo\n5. Weka bidhaa\n6. Angalia wasifu wako\n0. Nyuma" - name: Edit name [first account] request: @@ -305,7 +289,7 @@ stages: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1" + text: "2*1*6*{first_account_pin_number}*0*1" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -327,7 +311,7 @@ stages: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1" + text: "2*1*6*{second_account_pin_number}*0*1" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -349,7 +333,7 @@ stages: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1*{first_account_change_given_name}" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -371,7 +355,7 @@ stages: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1*{second_account_change_given_name}" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -393,7 +377,7 @@ stages: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1*{first_account_change_given_name}*{first_account_change_family_name}" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -401,12 +385,12 @@ stages: status_code: - 200 headers: - Content-Length: '33' + Content-Length: '51' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Please enter your PIN\n0. Back" + expected_response: "CON Enter gender\n1. Male\n2. Female\n3. Other\n0. Back" - name: Enter family name [second account] request: @@ -415,7 +399,7 @@ stages: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1*{second_account_change_given_name}*{second_account_change_family_name}" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -423,21 +407,21 @@ stages: status_code: - 200 headers: - Content-Length: '36' + Content-Length: '64' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Tafadhali weka PIN yako\n0. Nyuma" + expected_response: "CON Weka jinsia yako\n1. Mwanaume\n2. Mwanamke\n3. Nyngine\n0. Nyuma" - - name: Enter name change pin [first account] + - name: Select gender [Male - first account] request: url: "{server_url}" data: serviceCode: "*483*46#" sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1*{first_account_change_given_name}*{first_account_change_family_name}*{first_account_pin_number}" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -445,21 +429,21 @@ stages: status_code: - 200 headers: - Content-Length: '36' + Content-Length: '31' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "END Thank you for using the service." + expected_response: "CON Enter year of birth\n0. Back" - - name: Enter name change pin [second account] + - name: Select gender [Female - second account] request: url: "{server_url}" data: serviceCode: "*483*46#" sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*1*{second_account_change_given_name}*{second_account_change_family_name}*{second_account_pin_number}" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -467,21 +451,109 @@ stages: status_code: - 200 headers: - Content-Length: '30' + Content-Length: '35' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "END Asante kwa kutumia huduma." + expected_response: "CON Weka mwaka wa kuzaliwa\n0. Nyuma" - - name: Second profile management start menu [first account] + - name: Enter age [1993 - first account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_1}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993" + headers: + content-type: "application/x-www-form-urlencoded" + method: POST + response: + status_code: + - 200 + headers: + Content-Length: '31' + Content-Type: "text/plain" + verify_response_with: + function: ext.validator:validate_response + extra_kwargs: + expected_response: "CON Enter your location\n0. Back" + + - name: Enter age [1974 - second account] + request: + url: "{server_url}" + data: + serviceCode: "*483*46#" + sessionId: "{second_profile_management_session_id}" + phoneNumber: "{second_account_phone_number}" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974" + headers: + content-type: "application/x-www-form-urlencoded" + method: POST + response: + status_code: + - 200 + headers: + Content-Length: '27' + Content-Type: "text/plain" + verify_response_with: + function: ext.validator:validate_response + extra_kwargs: + expected_response: "CON Weka eneo lako\n0. Nyuma" + + - name: Enter location [first_account_location - first account] + request: + url: "{server_url}" + data: + serviceCode: "*483*46#" + sessionId: "{first_profile_management_session_id}" + phoneNumber: "{first_account_phone_number}" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}" + headers: + content-type: "application/x-www-form-urlencoded" + method: POST + response: + status_code: + - 200 + headers: + Content-Length: '55' + Content-Type: "text/plain" + verify_response_with: + function: ext.validator:validate_response + extra_kwargs: + expected_response: "CON Please enter a product or service you offer\n0. Back" + + - name: Enter location [second_account_location - second account] + request: + url: "{server_url}" + data: + serviceCode: "*483*46#" + sessionId: "{second_profile_management_session_id}" + phoneNumber: "{second_account_phone_number}" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}" + headers: + content-type: "application/x-www-form-urlencoded" + method: POST + response: + status_code: + - 200 + headers: + Content-Length: '42' + Content-Type: "text/plain" + verify_response_with: + function: ext.validator:validate_response + extra_kwargs: + expected_response: "CON Weka bidhaa ama huduma unauza\n0. Nyuma" + + - name: Enter product [first_account_product - first account] + request: + url: "{server_url}" + data: + serviceCode: "*483*46#" + sessionId: "{first_profile_management_session_id}" + phoneNumber: "{first_account_phone_number}" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -496,14 +568,14 @@ stages: extra_kwargs: expected_response: "CON Balance 58.00 {token_symbol}\n1. Send\n2. My Account\n3. Help" - - name: Second profile management start menu [second account] + - name: Enter product [second_account_product - second account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_1}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -523,9 +595,9 @@ stages: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_1}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}*2" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -540,14 +612,14 @@ stages: extra_kwargs: expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back" - - name: Second account management [second account] + - name: Second account management menu [second account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_1}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}*2" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -567,9 +639,9 @@ stages: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_1}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}*2*1" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -577,21 +649,21 @@ stages: status_code: - 200 headers: - Content-Length: '103' + Content-Length: '115' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" + expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit age\n4. Edit location\n5. Edit products\n6. View my profile\n0. Back" - name: Second profile management menu [second account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_1}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}*2*1" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -599,813 +671,21 @@ stages: status_code: - 200 headers: - Content-Length: '104' + Content-Length: '117' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" - - - name: Gender change [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_1}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '51' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Enter gender\n1. Male\n2. Female\n3. Other\n0. Back" - - - name: Gender change [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_1}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '64' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka jinsia yako\n1. Mwanaume\n2. Mwanamke\n3. Nyngine\n0. Nyuma" - - - name: Select gender [female - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_1}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*2*2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '33' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Please enter your PIN\n0. Back" - - - name: Select gender [male - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_1}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '36' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Tafadhali weka PIN yako\n0. Nyuma" - - - name: Enter gender change pin [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_1}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*2*2*{first_account_pin_number}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '36' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "END Thank you for using the service." - - - name: Enter gender change pin [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_1}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*2*1*{second_account_pin_number}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '30' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "END Asante kwa kutumia huduma." - - - name: Third profile management start menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_2}" - phoneNumber: "{first_account_phone_number}" - text: "" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '51' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Balance 58.00 {token_symbol}\n1. Send\n2. My Account\n3. Help" - - - name: Third profile management start menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_2}" - phoneNumber: "{second_account_phone_number}" - text: "" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '56' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Salio 42.00 {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi" - - - name: Third account management menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_2}" - phoneNumber: "{first_account_phone_number}" - text: "2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '105' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back" - - - name: Third account management [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_2}" - phoneNumber: "{second_account_phone_number}" - text: "2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '148' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Akaunti yangu\n1. Wasifu wangu\n2. Chagua lugha utakayotumia\n3. Angalia salio\n4. Angalia taarifa ya matumizi\n5. Badilisha nambari ya siri\n0. Nyuma" - - - name: Third profile management menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_2}" - phoneNumber: "{first_account_phone_number}" - text: "2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '103' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" - - - name: Third profile management menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_2}" - phoneNumber: "{second_account_phone_number}" - text: "2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '104' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" - - - name: Location change [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_2}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*3" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '31' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Enter your location\n0. Back" - - - name: Location change [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_2}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*3" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '27' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka eneo lako\n0. Nyuma" - - - name: Enter location change [first_account_change_location - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_2}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*3*{first_account_change_location}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '33' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Please enter your PIN\n0. Back" - - - name: Enter location change [second_account_change_location - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_2}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*3*{second_account_change_location}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '36' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Tafadhali weka PIN yako\n0. Nyuma" - - - name: Enter location change pin [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_2}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*3*{first_account_change_location}*{first_account_pin_number}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '36' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "END Thank you for using the service." - - - name: Enter location change pin [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_2}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*3*{second_account_change_location}*{second_account_pin_number}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '30' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "END Asante kwa kutumia huduma." - - - name: Fourth profile management start menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_3}" - phoneNumber: "{first_account_phone_number}" - text: "" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '51' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Balance 58.00 {token_symbol}\n1. Send\n2. My Account\n3. Help" - - - name: Fourth profile management start menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_3}" - phoneNumber: "{second_account_phone_number}" - text: "" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '56' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Salio 42.00 {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi" - - - name: Fourth account management menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_3}" - phoneNumber: "{first_account_phone_number}" - text: "2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '105' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back" - - - name: Fourth account management menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_3}" - phoneNumber: "{second_account_phone_number}" - text: "2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '148' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Akaunti yangu\n1. Wasifu wangu\n2. Chagua lugha utakayotumia\n3. Angalia salio\n4. Angalia taarifa ya matumizi\n5. Badilisha nambari ya siri\n0. Nyuma" - - - name: Fourth profile management menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_3}" - phoneNumber: "{first_account_phone_number}" - text: "2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '103' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" - - - name: Fourth profile management menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_3}" - phoneNumber: "{second_account_phone_number}" - text: "2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '104' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" - - - name: Product change [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_3}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*4" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '55' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Please enter a product or service you offer\n0. Back" - - - name: Product change [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_3}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*4" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '42' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Weka bidhaa ama huduma unauza\n0. Nyuma" - - - name: Enter product change [first_account_change_product - first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_3}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*4*{first_account_change_product}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '33' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Please enter your PIN\n0. Back" - - - name: Enter product change [second_account_change_product - second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_3}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*4*{second_account_change_product}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '36' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Tafadhali weka PIN yako\n0. Nyuma" - - - name: Enter product change pin [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_3}" - phoneNumber: "{first_account_phone_number}" - text: "2*1*4*{first_account_change_product}*{first_account_pin_number}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '36' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "END Thank you for using the service." - - - name: Enter product change pin [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_3}" - phoneNumber: "{second_account_phone_number}" - text: "2*1*4*{second_account_change_product}*{second_account_pin_number}" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '30' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "END Asante kwa kutumia huduma." - - - name: Fifth profile managment start menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" - phoneNumber: "{first_account_phone_number}" - text: "" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '51' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Balance 58.00 {token_symbol}\n1. Send\n2. My Account\n3. Help" - - - name: Fifth profile managment start menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" - phoneNumber: "{second_account_phone_number}" - text: "" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '56' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Salio 42.00 {token_symbol}\n1. Tuma\n2. Akaunti yangu\n3. Usaidizi" - - - name: Fifth account management menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" - phoneNumber: "{first_account_phone_number}" - text: "2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '105' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON My account\n1. My profile\n2. Change language\n3. Check balance\n4. Check statement\n5. Change PIN\n0. Back" - - - name: Fifth account management menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" - phoneNumber: "{second_account_phone_number}" - text: "2" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '148' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Akaunti yangu\n1. Wasifu wangu\n2. Chagua lugha utakayotumia\n3. Angalia salio\n4. Angalia taarifa ya matumizi\n5. Badilisha nambari ya siri\n0. Nyuma" - - - name: Fifth profile management menu [first account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" - phoneNumber: "{first_account_phone_number}" - text: "2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '103' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" - - - name: Fifth profile management menu [second account] - request: - url: "{server_url}" - data: - serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" - phoneNumber: "{second_account_phone_number}" - text: "2*1" - headers: - content-type: "application/x-www-form-urlencoded" - method: POST - response: - status_code: - - 200 - headers: - Content-Length: '104' - Content-Type: "text/plain" - verify_response_with: - function: ext.validator:validate_response - extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" + expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka umri\n4. Weka eneo\n5. Weka bidhaa\n6. Angalia wasifu wako\n0. Nyuma" - name: Second enter pin to view profile [first account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}*2*1*6" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1425,9 +705,9 @@ stages: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}*2*1*6" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1447,9 +727,9 @@ stages: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{first_account_pin_number}" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}*2*1*6*{first_account_pin_number}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1461,16 +741,16 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Your details are:\n Name: {first_account_change_given_name} {first_account_change_family_name}\n Gender: Female\n Location: {first_account_change_location}\n You sell: {first_account_change_product}\n0. Back" + expected_response: "CON Your details are:\n Name: {first_account_given_name} {first_account_family_name}\n Gender: Male\n Age: 28\n Location: {first_account_location}\n You sell: {first_account_product}\n0. Back" - name: Second display profile [second account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}*2*1*6*{second_account_pin_number}" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1482,16 +762,16 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Wasifu wako una maelezo yafuatayo:\n Jina: {second_account_change_given_name} {second_account_change_family_name}\n Jinsia: Mwanaume\n Eneo: {second_account_change_location}\n Unauza: {second_account_change_product}\n0. Nyuma" + expected_response: "CON Wasifu wako una maelezo yafuatayo:\n Jina: {second_account_given_name} {second_account_family_name}\n Jinsia: Mwanamke\n Umri: 47\n Eneo: {second_account_location}\n Unauza: {second_account_product}\n0. Nyuma" - name: Return to profile management menu [first account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{first_account_pin_number}*0" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}*2*1*6*{first_account_pin_number}*0" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1499,21 +779,21 @@ stages: status_code: - 200 headers: - Content-Length: '103' + Content-Length: '115' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit location\n4. Edit products\n5. View my profile\n0. Back" + expected_response: "CON My profile\n1. Edit name\n2. Edit gender\n3. Edit age\n4. Edit location\n5. Edit products\n6. View my profile\n0. Back" - name: Return to profile management menu [second account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}*2*1*6*{second_account_pin_number}*0" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1521,21 +801,21 @@ stages: status_code: - 200 headers: - Content-Length: '104' + Content-Length: '117' Content-Type: "text/plain" verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka eneo\n4. Weka bidhaa\n5. Angalia wasifu wako\n0. Nyuma" + expected_response: "CON Wasifu wangu\n1. Weka jina\n2. Weka jinsia\n3. Weka umri\n4. Weka eneo\n5. Weka bidhaa\n6. Angalia wasifu wako\n0. Nyuma" - name: Resume start menu [first account] request: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{first_profile_management_session_id_4}" + sessionId: "{first_profile_management_session_id}" phoneNumber: "{first_account_phone_number}" - text: "2*1*5*{first_account_pin_number}*0*0" + text: "2*1*6*{first_account_pin_number}*0*1*{first_account_given_name}*{first_account_family_name}*1*1993*{first_account_location}*{first_account_product}*2*1*6*{first_account_pin_number}*0*0" headers: content-type: "application/x-www-form-urlencoded" method: POST @@ -1555,9 +835,9 @@ stages: url: "{server_url}" data: serviceCode: "*483*46#" - sessionId: "{second_profile_management_session_id_4}" + sessionId: "{second_profile_management_session_id}" phoneNumber: "{second_account_phone_number}" - text: "2*1*5*{second_account_pin_number}*0*0" + text: "2*1*6*{second_account_pin_number}*0*1*{second_account_given_name}*{second_account_family_name}*2*1974*{second_account_location}*{second_account_product}*2*1*6*{second_account_pin_number}*0*0" headers: content-type: "application/x-www-form-urlencoded" method: POST diff --git a/apps/cic-ussd/tests/integration/test_transactions.tavern.yaml b/apps/cic-ussd/tests/integration/test_transactions.tavern.yaml index 9a50f012..f71e7f70 100644 --- a/apps/cic-ussd/tests/integration/test_transactions.tavern.yaml +++ b/apps/cic-ussd/tests/integration/test_transactions.tavern.yaml @@ -170,7 +170,7 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON {second_account_given_name} {second_account_family_name} {second_account_phone_number} will receive 17.00 {token_symbol} from {first_account_given_name} {first_account_family_name} {first_account_phone_number}.\nPlease enter your PIN to confirm.\n0. Back" + expected_response: "CON {second_account_phone_number} will receive 17.00 {token_symbol} from {first_account_phone_number}.\nPlease enter your PIN to confirm.\n0. Back" - name: Enter transcation amount [second account] request: @@ -191,7 +191,7 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON {first_account_given_name} {first_account_family_name} {first_account_phone_number} atapokea 25.00 {token_symbol} kutoka kwa {second_account_given_name} {second_account_family_name} {second_account_phone_number}.\nTafadhali weka nambari yako ya siri kudhibitisha.\n0. Nyuma" + expected_response: "CON {first_account_phone_number} atapokea 25.00 {token_symbol} kutoka kwa {second_account_phone_number}.\nTafadhali weka nambari yako ya siri kudhibitisha.\n0. Nyuma" - name: Pin to authorize transaction [first account] request: @@ -212,7 +212,7 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Your request has been sent. {second_account_given_name} {second_account_family_name} {second_account_phone_number} will receive 17.00 {token_symbol} from {first_account_given_name} {first_account_family_name} {first_account_phone_number}.\n00. Back\n99. Exit" + expected_response: "CON Your request has been sent. {second_account_phone_number} will receive 17.00 {token_symbol} from {first_account_phone_number}.\n00. Back\n99. Exit" - name: Pin to authorize transaction [second account] request: @@ -233,7 +233,7 @@ stages: verify_response_with: function: ext.validator:validate_response extra_kwargs: - expected_response: "CON Ombi lako limetumwa. {first_account_given_name} {first_account_family_name} {first_account_phone_number} atapokea 25.00 {token_symbol} kutoka kwa {second_account_given_name} {second_account_family_name} {second_account_phone_number}.\n00. Nyuma\n99. Ondoka" + expected_response: "CON Ombi lako limetumwa. {first_account_phone_number} atapokea 25.00 {token_symbol} kutoka kwa {second_account_phone_number}.\n00. Nyuma\n99. Ondoka" - name: Verify balance changes [first account] delay_before: 10 diff --git a/apps/cic-ussd/transitions/age_setting_transitions.json b/apps/cic-ussd/transitions/age_setting_transitions.json index 0fe67d03..957c6ae8 100644 --- a/apps/cic-ussd/transitions/age_setting_transitions.json +++ b/apps/cic-ussd/transitions/age_setting_transitions.json @@ -12,7 +12,7 @@ { "trigger": "scan_data", "source": "enter_date_of_birth", - "dest": "enter_gender", + "dest": "enter_location", "conditions": "cic_ussd.state_machine.logic.validator.is_valid_date", "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data", "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata" diff --git a/apps/cic-ussd/transitions/gender_setting_transitions.json b/apps/cic-ussd/transitions/gender_setting_transitions.json index 7881cdd7..e0d2b346 100644 --- a/apps/cic-ussd/transitions/gender_setting_transitions.json +++ b/apps/cic-ussd/transitions/gender_setting_transitions.json @@ -2,7 +2,7 @@ { "trigger": "scan_data", "source": "enter_gender", - "dest": "enter_location", + "dest": "enter_date_of_birth", "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data", "conditions": "cic_ussd.state_machine.logic.validator.is_valid_gender_selection", "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata" diff --git a/apps/cic-ussd/transitions/name_setting_transitions.json b/apps/cic-ussd/transitions/name_setting_transitions.json index 7d3493e3..38b5e58c 100644 --- a/apps/cic-ussd/transitions/name_setting_transitions.json +++ b/apps/cic-ussd/transitions/name_setting_transitions.json @@ -15,7 +15,7 @@ { "trigger": "scan_data", "source": "enter_family_name", - "dest": "enter_date_of_birth", + "dest": "enter_gender", "after": "cic_ussd.state_machine.logic.user.save_metadata_attribute_to_session_data", "unless": "cic_ussd.state_machine.logic.validator.has_cached_user_metadata" }, diff --git a/apps/cic-ussd/var/lib/locale/ussd.en.yml b/apps/cic-ussd/var/lib/locale/ussd.en.yml index fae5eead..bfb6545a 100644 --- a/apps/cic-ussd/var/lib/locale/ussd.en.yml +++ b/apps/cic-ussd/var/lib/locale/ussd.en.yml @@ -55,7 +55,7 @@ en: CON My profile 1. Edit name 2. Edit gender - 3. Edit Age + 3. Edit age 4. Edit location 5. Edit products 6. View my profile diff --git a/apps/cic-ussd/var/lib/locale/ussd.sw.yml b/apps/cic-ussd/var/lib/locale/ussd.sw.yml index 8a8394e5..81690287 100644 --- a/apps/cic-ussd/var/lib/locale/ussd.sw.yml +++ b/apps/cic-ussd/var/lib/locale/ussd.sw.yml @@ -55,7 +55,7 @@ sw: CON Wasifu wangu 1. Weka jina 2. Weka jinsia - 3 Weka umri + 3. Weka umri 4. Weka eneo 5. Weka bidhaa 6. Angalia wasifu wako diff --git a/apps/data-seeding/README.md b/apps/data-seeding/README.md index 11043675..1b9e645b 100644 --- a/apps/data-seeding/README.md +++ b/apps/data-seeding/README.md @@ -171,7 +171,11 @@ Then, in sequence, run in first terminal: In second terminal: -`python cic_ussd/import_users.py -v -c config out` +`python cic_ussd/import_users.py -v --ussd-host --ussd-port -c config out` + +In the event that you are running the command in a local environment you may want to consider passing the `--ussd-no-ssl` flag i.e: + +`python cic_ussd/import_users.py -v --ussd-host --ussd-port --ussd-no-ssl -c config out` @@ -199,6 +203,13 @@ If _number of users_ is omitted the script will run until manually interrupted. If you imported using `cic_ussd`, the phone pointer is _already added_ and this script will do nothing. +### Importing preferences metadata + +`node cic_meta/import_meta_preferences.js ` + +If you used the `cic_ussd/import_user.py` script to import your users, preferences metadata is generated and will be imported. + + ##### Importing pins and ussd data (optional) Once the user imports are complete the next step should be importing the user's pins and auxiliary ussd data. This can be done in 3 steps: diff --git a/apps/data-seeding/cic_eth/import_balance.py b/apps/data-seeding/cic_eth/import_balance.py index 904299a1..99e8eef4 100644 --- a/apps/data-seeding/cic_eth/import_balance.py +++ b/apps/data-seeding/cic_eth/import_balance.py @@ -18,19 +18,17 @@ from hexathon import ( add_0x, ) from chainsyncer.backend.memory import MemBackend -from chainsyncer.driver import HeadSyncer +from chainsyncer.driver.head import HeadSyncer from chainlib.eth.connection import EthHTTPConnection from chainlib.eth.block import ( block_latest, - block_by_number, - Block, ) from chainlib.hash import keccak256_string_to_hex from chainlib.eth.address import to_checksum_address from chainlib.eth.gas import OverrideGasOracle from chainlib.eth.nonce import RPCNonceOracle from chainlib.eth.tx import TxFactory -from chainlib.jsonrpc import jsonrpc_template +from chainlib.jsonrpc import JSONRPCRequest from chainlib.eth.error import EthException from chainlib.chain import ChainSpec from chainlib.eth.constant import ZERO_ADDRESS @@ -38,6 +36,7 @@ from crypto_dev_signer.eth.signer import ReferenceSigner as EIP155Signer from crypto_dev_signer.keystore.dict import DictKeystore from cic_types.models.person import Person from eth_erc20 import ERC20 +from cic_base.eth.syncer import chain_interface logging.basicConfig(level=logging.WARNING) @@ -70,13 +69,14 @@ elif args.vv == True: config_dir = os.path.join(args.c) os.makedirs(config_dir, 0o777, True) config = confini.Config(config_dir, args.env_prefix) -config.process() # override args +config.process() +logg.debug('config loaded from {}:\n{}'.format(config_dir, config)) args_override = { 'CIC_CHAIN_SPEC': getattr(args, 'i'), 'ETH_PROVIDER': getattr(args, 'p'), 'CIC_REGISTRY_ADDRESS': getattr(args, 'r'), - 'KEYSTORE_FILE_PATH': getattr(args, 'key-file') + 'KEYSTORE_FILE_PATH': getattr(args, 'y'), } config.dict_override(args_override, 'cli flag') config.censor('PASSWORD', 'DATABASE') @@ -185,27 +185,6 @@ class Handler: # logg.error('key record not found in imports: {}'.format(e).ljust(200)) -#class BlockGetter: -# -# def __init__(self, conn, gas_oracle, nonce_oracle, chain_spec): -# self.conn = conn -# self.tx_factory = ERC20(signer=signer, gas_oracle=gas_oracle, nonce_oracle=nonce_oracle, chain_id=chain_id) -# -# -# def get(self, n): -# o = block_by_number(n) -# r = self.conn.do(o) -# b = None -# try: -# b = Block(r) -# except TypeError as e: -# if r == None: -# logg.debug('block not found {}'.format(n)) -# else: -# logg.error('block retrieve error {}'.format(e)) -# return b - - def progress_callback(block_number, tx_index): sys.stdout.write(str(block_number).ljust(200) + "\n") @@ -226,11 +205,13 @@ def main(): data = add_0x(registry_addressof_method) data += eth_abi.encode_single('bytes32', b'TokenRegistry').hex() txf.set_code(tx, data) - - o = jsonrpc_template() + + j = JSONRPCRequest() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) token_index_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) logg.info('found token index address {}'.format(token_index_address)) @@ -244,10 +225,11 @@ def main(): z = h.digest() data += eth_abi.encode_single('bytes32', z).hex() txf.set_code(tx, data) - o = jsonrpc_template() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) try: sarafu_token_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) @@ -305,7 +287,7 @@ def main(): f.close() syncer_backend.set(block_offset, 0) - syncer = HeadSyncer(syncer_backend, block_callback=progress_callback) + syncer = HeadSyncer(syncer_backend, chain_interface, block_callback=progress_callback) handler = Handler(conn, chain_spec, user_dir, balances, sarafu_token_address, signer, gas_oracle, nonce_oracle) syncer.add_filter(handler) syncer.loop(1, conn) diff --git a/apps/data-seeding/config/cic.ini b/apps/data-seeding/config/cic.ini index f58bf250..5064df15 100644 --- a/apps/data-seeding/config/cic.ini +++ b/apps/data-seeding/config/cic.ini @@ -7,4 +7,5 @@ approval_escrow_address = chain_spec = evm:bloxberg:8996 tx_retry_delay = trust_address = 0xEb3907eCad74a0013c259D5874AE7f22DcBcC95C -user_ussd_svc_service_port= \ No newline at end of file +user_ussd_svc_service_port = + diff --git a/apps/data-seeding/config/eth.ini b/apps/data-seeding/config/eth.ini index 54eed6ab..321384f8 100644 --- a/apps/data-seeding/config/eth.ini +++ b/apps/data-seeding/config/eth.ini @@ -1,8 +1,2 @@ [eth] -#ws_provider = ws://localhost:8546 -#ttp_provider = http://localhost:8545 provider = http://localhost:63545 -gas_provider_address = -#chain_id = -abi_dir = /usr/local/share/cic/solidity/abi -account_accounts_index_writer = diff --git a/apps/data-seeding/create_import_users.py b/apps/data-seeding/create_import_users.py index 0e0b51ad..dc252fce 100644 --- a/apps/data-seeding/create_import_users.py +++ b/apps/data-seeding/create_import_users.py @@ -204,9 +204,9 @@ def gen(): ])) if random.randint(0, 1): # fake.local_latitude() - p.location['latitude'] = (random.random() + 180) - 90 + p.location['latitude'] = (random.random() * 180) - 90 # fake.local_latitude() - p.location['longitude'] = (random.random() + 360) - 180 + p.location['longitude'] = (random.random() * 360) - 179 return (old_blockchain_checksum_address, phone, p) diff --git a/apps/data-seeding/docker/Dockerfile b/apps/data-seeding/docker/Dockerfile index 797cc66f..3b37085a 100644 --- a/apps/data-seeding/docker/Dockerfile +++ b/apps/data-seeding/docker/Dockerfile @@ -1,19 +1,21 @@ # syntax = docker/dockerfile:1.2 -FROM python:3.8.6-slim-buster as compile-image - -WORKDIR /root - -RUN apt-get update -RUN apt-get install -y --no-install-recommends git gcc g++ libpq-dev gawk jq telnet wget openssl iputils-ping gnupg socat bash procps make python2 cargo +#FROM python:3.8.6-slim-buster as compile-image +FROM registry.gitlab.com/grassrootseconomics/cic-base-images:python-3.8.6-dev-5ab8bf45 RUN mkdir -vp /usr/local/etc/cic +COPY data-seeding/package.json \ + data-seeding/package-lock.json \ + . + +RUN npm install + COPY data-seeding/requirements.txt . +ARG EXTRA_INDEX_URL="https://pip.grassrootseconomics.net:8433" +ARG GITLAB_PYTHON_REGISTRY="https://gitlab.com/api/v4/projects/27624814/packages/pypi/simple" +RUN pip install --extra-index-url $GITLAB_PYTHON_REGISTRY --extra-index-url $EXTRA_INDEX_URL -r requirements.txt + COPY data-seeding/ . -ARG EXTRA_INDEX_URL="https://pip.grassrootseconomics.net:8433" -RUN pip install --extra-index-url $EXTRA_INDEX_URL -r requirements.txt - - ENTRYPOINT [ ] diff --git a/apps/data-seeding/eth/import_balance.py b/apps/data-seeding/eth/import_balance.py index d391d021..2d436a66 100644 --- a/apps/data-seeding/eth/import_balance.py +++ b/apps/data-seeding/eth/import_balance.py @@ -18,25 +18,24 @@ from hexathon import ( add_0x, ) from chainsyncer.backend.memory import MemBackend -from chainsyncer.driver import HeadSyncer +from chainsyncer.driver.head import HeadSyncer from chainlib.eth.connection import EthHTTPConnection from chainlib.eth.block import ( block_latest, - block_by_number, - Block, ) from chainlib.hash import keccak256_string_to_hex from chainlib.eth.address import to_checksum_address from chainlib.eth.gas import OverrideGasOracle from chainlib.eth.nonce import RPCNonceOracle from chainlib.eth.tx import TxFactory -from chainlib.jsonrpc import jsonrpc_template +from chainlib.jsonrpc import JSONRPCRequest from chainlib.eth.error import EthException from chainlib.chain import ChainSpec from crypto_dev_signer.eth.signer import ReferenceSigner as EIP155Signer from crypto_dev_signer.keystore.dict import DictKeystore from cic_types.models.person import Person from eth_erc20 import ERC20 +from cic_base.eth.syncer import chain_interface logging.basicConfig(level=logging.WARNING) @@ -75,7 +74,7 @@ args_override = { 'CIC_CHAIN_SPEC': getattr(args, 'i'), 'ETH_PROVIDER': getattr(args, 'p'), 'CIC_REGISTRY_ADDRESS': getattr(args, 'r'), - 'KEYSTORE_FILE_PATH': getattr(args, 'key-file') + 'KEYSTORE_FILE_PATH': getattr(args, 'y') } config.dict_override(args_override, 'cli flag') config.censor('PASSWORD', 'DATABASE') @@ -184,27 +183,6 @@ class Handler: # logg.error('key record not found in imports: {}'.format(e).ljust(200)) -#class BlockGetter: -# -# def __init__(self, conn, gas_oracle, nonce_oracle, chain_spec): -# self.conn = conn -# self.tx_factory = ERC20(signer=signer, gas_oracle=gas_oracle, nonce_oracle=nonce_oracle, chain_id=chain_id) -# -# -# def get(self, n): -# o = block_by_number(n) -# r = self.conn.do(o) -# b = None -# try: -# b = Block(r) -# except TypeError as e: -# if r == None: -# logg.debug('block not found {}'.format(n)) -# else: -# logg.error('block retrieve error {}'.format(e)) -# return b - - def progress_callback(block_number, tx_index): sys.stdout.write(str(block_number).ljust(200) + "\n") @@ -225,11 +203,13 @@ def main(): data = add_0x(registry_addressof_method) data += eth_abi.encode_single('bytes32', b'TokenRegistry').hex() txf.set_code(tx, data) - - o = jsonrpc_template() + + j = JSONRPCRequest() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) token_index_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) logg.info('found token index address {}'.format(token_index_address)) @@ -243,10 +223,11 @@ def main(): z = h.digest() data += eth_abi.encode_single('bytes32', z).hex() txf.set_code(tx, data) - o = jsonrpc_template() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) try: sarafu_token_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) @@ -300,7 +281,7 @@ def main(): f.close() syncer_backend.set(block_offset, 0) - syncer = HeadSyncer(syncer_backend, block_callback=progress_callback) + syncer = HeadSyncer(syncer_backend, chain_interface, block_callback=progress_callback) handler = Handler(conn, chain_spec, user_dir, balances, sarafu_token_address, signer, gas_oracle, nonce_oracle) syncer.add_filter(handler) syncer.loop(1, conn) diff --git a/apps/data-seeding/eth/import_users.py b/apps/data-seeding/eth/import_users.py index 8ef9fd84..be04b2f2 100644 --- a/apps/data-seeding/eth/import_users.py +++ b/apps/data-seeding/eth/import_users.py @@ -59,7 +59,7 @@ config.process() args_override = { 'CIC_REGISTRY_ADDRESS': getattr(args, 'r'), 'CIC_CHAIN_SPEC': getattr(args, 'i'), - 'KEYSTORE_FILE_PATH': getattr(args, 'key-file') + 'KEYSTORE_FILE_PATH': getattr(args, 'y') } config.dict_override(args_override, 'cli') config.add(args.user_dir, '_USERDIR', True) diff --git a/apps/data-seeding/requirements.txt b/apps/data-seeding/requirements.txt index 4f2cb559..c178b15f 100644 --- a/apps/data-seeding/requirements.txt +++ b/apps/data-seeding/requirements.txt @@ -1,5 +1,5 @@ -cic-base[full_graph]==0.1.2b15 -sarafu-faucet==0.0.3a3 -cic-eth==0.11.0b16 -cic-types==0.1.0a11 -crypto-dev-signer==0.4.14b3 +cic_base[full_graph]==0.1.3a3+build.4aa03607 +sarafu-faucet==0.0.4a1 +cic-eth==0.11.1a1 +cic-types==0.1.0a13 +crypto-dev-signer==0.4.14b6 diff --git a/apps/data-seeding/verify.py b/apps/data-seeding/verify.py index af90c04d..bca6ce95 100644 --- a/apps/data-seeding/verify.py +++ b/apps/data-seeding/verify.py @@ -25,7 +25,7 @@ from chainlib.eth.gas import ( ) from chainlib.eth.tx import TxFactory from chainlib.hash import keccak256_string_to_hex -from chainlib.jsonrpc import jsonrpc_template +from chainlib.jsonrpc import JSONRPCRequest from cic_types.models.person import ( Person, generate_metadata_pointer, @@ -264,9 +264,11 @@ class Verifier: data += eth_abi.encode_single('address', address).hex() tx = self.tx_factory.set_code(tx, data) tx = self.tx_factory.normalize(tx) - o = jsonrpc_template() + j = JSONRPCRequest() + o = j.template() o['method'] = 'eth_call' o['params'].append(tx) + o = j.finalize(o) r = self.conn.do(o) logg.debug('index check for {}: {}'.format(address, r)) n = eth_abi.decode_single('uint256', bytes.fromhex(strip_0x(r))) @@ -429,10 +431,12 @@ def main(): data += eth_abi.encode_single('bytes32', b'TokenRegistry').hex() txf.set_code(tx, data) - o = jsonrpc_template() + j = JSONRPCRequest() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) token_index_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) logg.info('found token index address {}'.format(token_index_address)) @@ -441,10 +445,11 @@ def main(): data += eth_abi.encode_single('bytes32', b'AccountRegistry').hex() txf.set_code(tx, data) - o = jsonrpc_template() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) account_index_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) logg.info('found account index address {}'.format(account_index_address)) @@ -453,10 +458,11 @@ def main(): data += eth_abi.encode_single('bytes32', b'Faucet').hex() txf.set_code(tx, data) - o = jsonrpc_template() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) faucet_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) logg.info('found faucet {}'.format(faucet_address)) @@ -471,10 +477,11 @@ def main(): z = h.digest() data += eth_abi.encode_single('bytes32', z).hex() txf.set_code(tx, data) - o = jsonrpc_template() + o = j.template() o['method'] = 'eth_call' o['params'].append(txf.normalize(tx)) o['params'].append('latest') + o = j.finalize(o) r = conn.do(o) sarafu_token_address = to_checksum_address(eth_abi.decode_single('address', bytes.fromhex(strip_0x(r)))) logg.info('found token address {}'.format(sarafu_token_address)) diff --git a/apps/util/requirements/base_requirement.txt b/apps/util/requirements/base_requirement.txt new file mode 100644 index 00000000..ea67cea4 --- /dev/null +++ b/apps/util/requirements/base_requirement.txt @@ -0,0 +1 @@ +cic-base==0.1.3a3+build.4aa03607 diff --git a/apps/util/requirements/requirements.txt b/apps/util/requirements/requirements.txt new file mode 100644 index 00000000..c5b56441 --- /dev/null +++ b/apps/util/requirements/requirements.txt @@ -0,0 +1 @@ +requirements-magic~=0.0.2 diff --git a/apps/util/requirements/update_base.sh b/apps/util/requirements/update_base.sh new file mode 100644 index 00000000..938867be --- /dev/null +++ b/apps/util/requirements/update_base.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +which pyreq-merge &> /dev/null +if [ $? -gt 0 ]; then + >&2 echo pyreq-merge missing, please install requirements + exit 1 +fi + +t=$(mktemp) +>&2 echo using tmp $t + +repos=(../../cic-cache ../../cic-eth ../../cic-ussd ../../data-seeding ../../cic-notify) + +for r in ${repos[@]}; do + f="$r/requirements.txt" + >&2 echo updating $f + f="$r/test_requirements.txt" + >&2 echo updating $f + pyreq-update $f base_requirement.txt > $t + cp $t $f +done diff --git a/docker-compose.yml b/docker-compose.yml index 28379982..749d9c62 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -387,44 +387,6 @@ services: # command: "/root/start_retry.sh -q cic-eth -vv" -# cic-eth-server: -# build: -# context: apps/ -# dockerfile: cic-eth/docker/Dockerfile -# environment: -# CIC_CHAIN_SPEC: $CIC_CHAIN_SPEC -# CELERY_BROKER_URL: $CELERY_BROKER_URL -# CELERY_RESULT_URL: $CELERY_RESULT_URL -# SERVER_PORT: 8000 -# depends_on: -# - eth -# - postgres -# - redis -# ports: -# - ${HTTP_PORT_CIC_ETH:-63314}:8000 -# deploy: -# restart_policy: -# condition: on-failure -# volumes: -# - contract-config:/tmp/cic/config/:ro -# command: -# - /bin/bash -# - -c -# - | -# if [[ -f /tmp/cic/config/.env ]]; then source /tmp/cic/config/.env; fi -# "/usr/local/bin/uwsgi" \ -# --wsgi-file /usr/src/cic-eth/cic_eth/runnable/server_agent.py \ -# --http :80 \ -# --pyargv -vv -## entrypoint: -## - "/usr/local/bin/uwsgi" -## - "--wsgi-file" -## - "/usr/src/cic-eth/cic_eth/runnable/server_agent.py" -## - "--http" -## - ":80" -# # command: "--pyargv -vv" - - cic-notify-tasker: build: