module.py

Go to the documentation of this file.

#
# Collective Mind
#
# See cM LICENSE.txt for licensing details.
# See cM Copyright.txt for copyright details.
#
# Developer(s): (C) Grigori Fursin, started on 2011.09
#

# Should always be here
ini={}
cm_kernel=None

# Local settings
import json
import os

# ============================================================================
def init(i):
    return {'cm_return':0}

# ============================================================================
def all(i):
    """
    Test all

    Input:  {
            }

    Output: {
              cm_return  - return code >0 if error
            }
    """

    errors=[]

    cm_kernel.print_for_con('Testing all cM functionality (alpha)')


    # *************************************************************
    func='cM UID generation'
    cm_kernel.print_for_con('')
    cm_kernel.print_for_con('Checking "'+func+'" ...')

    r=cm_kernel.gen_uid({})
    if r['cm_return']>0: 
       errors.append({'func':func,'cm_error':r['cm_error']})
       cm_kernel.print_for_con('  Error ('+r['cm_error']+')')

    uid=r['cm_uid']
    if len(uid)!=16:
       err='UID len is not 16'
       errors.append({'func':func,'cm_error':err})
       cm_kernel.print_for_con('  Error ('+err+')')

    if not cm_kernel.is_uid(uid):
       err='Generated UID is not cM UID'
       errors.append({'func':func,'cm_error':err})
       cm_kernel.print_for_con('  Error ('+err+')')

    cm_kernel.print_for_con('  Ok')

    # *************************************************************
    func='tmp data creation'
    cm_kernel.print_for_con('')
    cm_kernel.print_for_con('Checking "'+func+'" ...')

    r=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-tmp'],
                        'cm_action':'add',
                        'cm_array':{}})
    if r['cm_return']>0: 
       errors.append({'func':func,'cm_error':r['cm_error']})
       cm_kernel.print_for_con('  Error ('+r['cm_error']+')')

    uid=r['cm_uid']

    cm_kernel.print_for_con('  Ok (UID='+uid+')')

    # *************************************************************
    func='tmp data deletion'
    cm_kernel.print_for_con('')
    cm_kernel.print_for_con('Checking "'+func+'" ...')

    r=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-tmp'],
                        'cm_action':'delete',
                        'cm_data_uoa':uid})
    if r['cm_return']>0: 
       errors.append({'func':func,'cm_error':r['cm_error']})
       cm_kernel.print_for_con('  Error ('+r['cm_error']+')')

    cm_kernel.print_for_con('  Ok')

    cm_kernel.print_for_con('')
    cm_kernel.print_for_con('We should add much more tests - any help is appreciated!')


    return {'cm_return':0, 'cm_errors':errors}

# ============================================================================
def any(i):
    """
    Test some funcionality before moving to a proper test

    Input:  {
            }

    Output: {
              cm_return  - return code >0 if error
            }
    """








    return {'cm_return':0}

# ============================================================================
def functionality(i):
    """
    Test some funcionality before moving to a proper test

    Input:  {
              name
            }

    Output: {
              cm_return  - return code >0 if error
            }
    """

    if 'name' not in i: return {'cm_return':1, 'cm_error':'"name" is not set for "test functionality"'}

    name=i['name']

    if name=='array_merging_in_cmd':
       cm_kernel.print_for_con('')
       cm_kernel.print_for_con("Input "+json.dumps(i, indent=2))

    elif name=='convert_index_to_data':
       r=cm_kernel.load_json_file({'cm_filename':i['cm_filename']})
       if r['cm_return']>0: return r

       r=cm_kernel.restore_flattened_array({'cm_array':r['cm_array']})
       if r['cm_return']>0: return r

       r=cm_kernel.save_array_to_file_as_json({'cm_filename':i['cm_filename_out'], 'cm_array':r['cm_array']})
       if r['cm_return']>0: return r
       
    return {'cm_return':0}

# ============================================================================
def find_data_without_access_control(i):
    """
    Test some funcionality before moving to a proper test

    Input:  {
              (prune_repo_uoa)   - prune search by a given repository
              (prune_module_uoa) - prune search by a given module
              (prune_data_uoa)   - prune search by a given data
            }

    Output: {
              cm_return  - return code >0 if error
            }
    """

    problems=[]

    count=0

    # Search through repositories *********************************
    if i.get('prune_repo_uoa','')!='':
       # Load repo
       r1=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-repo'],
                            'cm_action':'load',
                            'cm_data_uoa':i['prune_repo_uoa']})
       if r1['cm_return']>0: return r1
       rlist=[{'cm_uoa':r1['cm_uoa'], 'cm_uid':r1['cm_uid']}]
    else:
       r1=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-repo'],
                            'cm_action':'list'})
       if r1['cm_return']>0: return r1
       rlist=r1['cm_mixed']

    for repo1 in rlist:
        repo_uoa=repo1['cm_uoa']
        repo_uid=repo1['cm_uid']

        # Load repo to exclude remote
        r2=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-repo'],
                             'cm_action':'load',
                             'cm_data_uoa':repo_uoa})
        if r2['cm_return']>0: return r2
        repo_cfg=r2['cm_data_obj']['cfg']
        if repo_cfg.get('path_type','')!='remote_url':
           # Get list of modules in a given repository *********************************
           if i.get('prune_module_uoa','')!='':
              # Load module
              r2=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-module'],
                                   'cm_action':'load',
                                   'cm_data_uoa':i['prune_module_uoa']})
              if r2['cm_return']>0: return r2
              mlist=[{'cm_uoa':r2['cm_uoa'], 'cm_uid':r2['cm_uid']}]
           else:
              r2=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-core'],
                                   'cm_action':'list',
                                   'cm_repo_uoa':repo_uoa,
                                   'cm_only_available_modules':'yes'})
              if r2['cm_return']>0: return r2
              mlist=r2['cm_mixed']

           for module1 in mlist:
               # Check print
               module_uoa=module1['cm_uoa']
               module_uid=module1['cm_uid']

               # Get list of data in a given repository *********************************
               if i.get('prune_data_uoa','')!='':
                  # Load data
                  r3=cm_kernel.access({'cm_run_module_uoa':ini['cfg']['cm_modules']['cm-core'],
                                       'cm_module_uoa':module_uoa,
                                       'cm_action':'load',
                                       'cm_data_uoa':i['prune_data_uoa'],
                                       'cm_repo_uoa':repo_uoa})
                  if r3['cm_return']==0:
                     dlist=[{'cm_uoa':r3['cm_uoa'], 'cm_uid':r3['cm_uid']}]
                  else:
                     dlist=[]
               else:
                  r3=cm_kernel.access({'cm_run_module_uoa':module_uoa,
                                       'cm_action':'list',
                                       'cm_repo_uoa':repo_uoa})
                  if r3['cm_return']>0: return r3
                  dlist=r3['cm_mixed']

               for data1 in dlist:
                   # Check print
                   data_uoa=data1['cm_uoa']
                   data_uid=data1['cm_uid']

                   count+=1
                   cm_kernel.print_for_con('('+str(count)+') Checking CID='+repo_uoa+':'+module_uoa+':'+data_uoa+' ...')

                   # Load data
                   r=cm_kernel.access({'cm_run_module_uoa':module_uoa,
                                       'cm_action':'load',
                                       'cm_data_uoa':data_uoa,
                                       'cm_repo_uoa':repo_uoa})
                   if r['cm_return']>0: return r
                   d=r['cm_data_obj']['cfg']

                   p=r['cm_path']

                   p0=os.path.join(p, cm_kernel.ini['dcfg']['dcm'])
                   p1=os.path.join(p0, cm_kernel.ini['dcfg']['fconfig'])

                   changed=False

                   if len(d.get('cm_access_control',{}))==0:
                      d['cm_access_control']={'comments_groups':'registered', 'read_groups':'registered', 'write_groups':'owner'}
                   else:
                      dx=d['cm_access_control']
                      if 'allow_comments_and_ranking' in dx:
                         dy=dx.get('allow_comments_and_ranking','')
                         del(dx['allow_comments_and_ranking'])

                         if dy=='yes':
                            dx['comments_groups']='registered'
                         else:
                            dx['comments_groups']='admin'
                      else:
                         dx['comments_groups']='admin'

                      d['cm_access_control']=dx

                   # We write directly to have a clean update
                   r4=cm_kernel.save_array_to_file_as_json({'cm_filename':p1, 'cm_array':d})
                   if r4['cm_return']>0: return r4

    return {'cm_return':0}