configurationengine/source/scripts/cone_subaction.py
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     1
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     3
# All rights reserved.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     4
# This component and the accompanying materials are made available
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
# under the terms of "Eclipse Public License v1.0"
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     6
# which accompanies this distribution, and is available
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     7
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     9
# Initial Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    10
# Nokia Corporation - initial contribution.
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    12
# Contributors:
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    13
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
# Description: 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    15
#
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    16
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    17
import os
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
import sys
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    19
import fnmatch 
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    20
import re
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
import logging
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    22
import ConfigParser
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    23
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    24
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    25
def get_cfg_files(paths, filename):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    26
    """ Find out the cone subscripts that are present in the"""
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    27
    files = []
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    28
    for path in paths:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    29
        cfgfile = os.path.join(path, filename)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    30
        if os.path.exists(cfgfile):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    31
            files.append(cfgfile)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    32
    return files
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    33
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    34
def get_config(cfgfiles):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    35
    config = ConfigParser.ConfigParser()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    36
    config.read(cfgfiles)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    37
    return config
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    38
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    39
def get_actions(cfgfiles):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    40
    """ Find out the cone subscripts that are present in the"""
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    41
    subacts = ActionContainer()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    42
    config = get_config(cfgfiles)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    43
    actions_section = 'actions'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    44
    if not config.has_section(actions_section):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    45
        raise Exception('The cone.ini does not have any %s section.' % actions_section)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    46
    for (name, section) in config.items(actions_section):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    47
        subacts += get_subactions_from_configs(cfgfiles, section)     
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    48
    return subacts
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    49
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    50
def get_subactions_from_configs(cfgfiles, section):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    51
    """ Find out the cone subscripts that are present in the"""
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    52
    subacts = ActionContainer()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    53
    config = get_config(cfgfiles)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    54
    paths = [os.path.dirname(cfgfile) for cfgfile in cfgfiles]
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    55
    if not config.has_section(section):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    56
        raise Exception('The cone.ini does not have any %s section.' % section)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    57
    for (commandname, path) in config.items(section):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    58
        subacts.append(ConeAction(commandname, path, type=section, paths=paths))
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    59
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    60
    return subacts
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    61
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    62
def get_subactions(path,pattern):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    63
    """ Find out the cone subscripts that are present in the ROOT_PATH """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    64
    subacts = ActionContainer()
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    65
    for file in os.listdir(path):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    66
        if fnmatch.fnmatch(file, pattern):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    67
            sact = SubAction(file,pattern)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    68
            subacts[sact.name] = sact
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    69
    return subacts
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    70
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    71
def get_log_level(level):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    72
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    73
    Change the given user input log level to logging categorisation
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    74
    """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    75
    if level == 0 : return logging.NOTSET
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    76
    elif level == 1 : return logging.CRITICAL
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    77
    elif level == 2 : return logging.ERROR
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    78
    elif level == 3 : return logging.WARNING
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    79
    elif level == 4 : return logging.INFO
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    80
    elif level == 5 : return logging.DEBUG
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    81
    else : return logging.NOTSET
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    82
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    83
class ActionContainer(list):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    84
    pass
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    85
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    86
#    def __init__(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    87
#        self._actions = {}
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    88
#
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    89
#    def __len__(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    90
#        return len(self._actions)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    91
#
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    92
    def __getitem__(self, key):
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    93
        for item in self:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    94
            if item.name == key:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    95
                return item
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    96
        raise KeyError('Key %s not found in %s'  % (key, self))
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    97
#
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    98
#    def __setitem__( self, key, value):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    99
#        self._actions[key] = value
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   100
#
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   101
#    def __delitem__( self, key):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   102
#        del self._actions[key]
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   103
#
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   104
#    def __iter__( self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   105
#        return self._actions.__iter__()
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   106
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   107
class ConeAction(object):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   108
    def __init__(self, name, path, **kwargs):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   109
        self.name = name
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   110
        self.path = path
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   111
        self.type = kwargs.get('type', '')
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   112
        self.paths = kwargs.get('paths', [])
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   113
        self._module = None
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   114
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   115
    @property
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   116
    def module_name(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   117
        return os.path.basename(self.path)
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   118
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   119
    @property
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   120
    def module_path(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   121
        return os.path.dirname(self.path)
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   122
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   123
    @property
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   124
    def module(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   125
        if not self._module:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   126
            paths = [os.path.join(pth, self.module_path) for pth in self.paths]
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   127
            paths.append(self.module_path)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   128
            sys.path += paths
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   129
            try:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   130
                self._module  = __import__(self.module_name)
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   131
            finally:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   132
                del sys.path[-len(paths):]
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   133
        return self._module
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   134
    
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   135
    def short_help(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   136
        if hasattr(self.module, 'short_help'):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   137
            return self.module.short_help
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   138
        elif hasattr(self.module, 'main'):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   139
            helpstr = self.module.main.__doc__ or '<None>'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   140
            return helpstr.replace('\n', '').strip(' ')[:50]
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   141
        else:
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   142
            return 'Not a valid module!!'
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   143
        
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   144
    def run(self):
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   145
        self.module.main()
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
   146
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   147
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   148
class SubAction(object):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   149
    def __init__(self, scriptname, pattern):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   150
        self._scriptname = scriptname
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   151
        self._pattern = pattern
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   152
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   153
    @property
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   154
    def name(self):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   155
        """ translate the pattern """
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   156
        pattern = fnmatch.translate(self._pattern).replace('.*', '(.*)')
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   157
        m = re.match(pattern, self._scriptname)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   158
        return m.group(1)
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   159
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   160
    def run(self):
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   161
        module = __import__(self._scriptname.replace('.py',''))
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
   162
        module.main()