o2olib.O2OTool Class Reference

Public Member Functions
def	create (self)
def	disable (self)
def	dumpConf (self)
def	enable (self)
def	execute (self)
def	listConf (self)
def	listJobs (self)
def	run (self)
def	setConfig (self)
def	setFrequent (self)
def	setInterval (self)
def	setup (self, args)

Public Attributes
	args
	mgr

Detailed Description

Definition at line 433 of file o2olib.py.

Member Function Documentation

create()

def o2olib.O2OTool.create

(

self

)

Definition at line 509 of file o2olib.py.

    def create(self):
        configJson = None
        if self.args.configFile is not None:
            if self.args.configString is not None:
                logging.error('Ambigouous input provided: please specify a configFile OR a configString')
                return False
            else:
                configJson = readConfiguration( self.args.configFile )
        else:
            if self.args.configString is None:
                logging.error('No configuration has been provided: please specify "configFile" or "configString" param.')
                return False
            else:
                configJson = checkConfiguration( self.args.configString )
        self.mgr.add( self.args.name, configJson, self.args.interval, self.args.frequent, True )
 

References PVValHelper.add(), o2olib.O2OTool.args, o2olib.checkConfiguration(), o2olib.O2OTool.mgr, and o2olib.readConfiguration().

Referenced by o2olib.O2OTool.execute().

disable()

def o2olib.O2OTool.disable

(

self

)

Definition at line 547 of file o2olib.py.

    def disable(self):
        self.mgr.set( self.args.name, False )
 

References o2olib.O2OTool.args, and o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

dumpConf()

def o2olib.O2OTool.dumpConf

(

self

)

Definition at line 559 of file o2olib.py.

    def dumpConf(self):
        self.mgr.dumpConfig( self.args.name, self.args.versionIndex, self.args.configFile )
 

References o2olib.O2OTool.args, Herwig7_Dummy_Matchbox_90X_ppToee.dumpConfig, and o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

enable()

def o2olib.O2OTool.enable

(

self

)

Definition at line 544 of file o2olib.py.

    def enable(self):
        self.mgr.set( self.args.name, True )
    

References o2olib.O2OTool.args, and o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

execute()

def o2olib.O2OTool.execute

(

self

)

Definition at line 435 of file o2olib.py.

    def execute(self):
        parser = argparse.ArgumentParser(description='CMS o2o command-line tool. For general help (manual page), use the help subcommand.')
        parser.add_argument('--db', type=str, help='The target database: pro ( for prod ) or dev ( for prep ). default=pro')
        parser.add_argument("--auth","-a", type=str,  help="The path of the authentication file")
        parser.add_argument('--verbose', '-v', action='count', help='The verbosity level')
        parser_subparsers = parser.add_subparsers(title='Available subcommands')
        parser_create = parser_subparsers.add_parser('create', description='Create a new O2O job')
        parser_create.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_create.add_argument('--configFile', '-c', type=str, help='the JSON configuration file path')
        parser_create.add_argument('--configString', '-s', type=str, help='the JSON configuration string')
        parser_create.add_argument('--interval', '-i', type=int, help='the chron job interval',default=0)
        parser_create.add_argument('--frequent', '-f',action='store_true',help='set the "frequent" flag for this job ("false" by default)')
        parser_create.set_defaults(func=self.create,role=auth.admin_role)
        parser_setConfig = parser_subparsers.add_parser('setConfig', description='Set a new configuration for the specified job. The configuration is expected as a list of entries "param": "value" (dictionary). The "param" labels will be used to inject the values in the command to execute. The dictionary is stored in JSON format.')
        parser_setConfig.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_setConfig.add_argument('--configFile', '-c', type=str, help='the JSON configuration file path')
        parser_setConfig.add_argument('--configString', '-s', type=str, help='the JSON configuration string')
        parser_setConfig.set_defaults(func=self.setConfig,role=auth.admin_role)
        parser_setFrequent = parser_subparsers.add_parser('setFrequent',description='Set the "frequent" flag for the specified job')
        parser_setFrequent.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_setFrequent.add_argument('--flag', '-f', choices=['0','1'], help='the flag value to set',required=True)
        parser_setFrequent.set_defaults(func=self.setFrequent,role=auth.admin_role)
        parser_setInterval = parser_subparsers.add_parser('setInterval',description='Set a new execution interval for the specified job')
        parser_setInterval.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_setInterval.add_argument('--interval', '-i', type=int, help='the chron job interval',required=True)
        parser_setInterval.set_defaults(func=self.setInterval,role=auth.admin_role)
        parser_enable = parser_subparsers.add_parser('enable',description='enable the O2O job')
        parser_enable.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_enable.set_defaults(func=self.enable,role=auth.admin_role)
        parser_disable = parser_subparsers.add_parser('disable',description='disable the O2O job')
        parser_disable.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_disable.set_defaults(func=self.disable,role=auth.admin_role)
        parser_listJobs = parser_subparsers.add_parser('listJobs', description='list the registered jobs')
        parser_listJobs.set_defaults(func=self.listJobs,role=auth.reader_role)
        parser_listConf = parser_subparsers.add_parser('listConfig', description='shows the configurations for the specified job')
        parser_listConf.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_listConf.add_argument('--dump', type=int, help='Dump the specified config.',default=0)
        parser_listConf.set_defaults(func=self.listConf,role=auth.reader_role)
        parser_dumpConf = parser_subparsers.add_parser('dumpConfig', description='dumps a specific job configuration version')
        parser_dumpConf.add_argument('versionIndex', type=str,help='the version to dump')
        parser_dumpConf.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_dumpConf.add_argument('--configFile', '-c', type=str, help='the JSON configuration file name - default:[jobname]_[version].json')
        parser_dumpConf.set_defaults(func=self.dumpConf,role=auth.reader_role)
        parser_run = parser_subparsers.add_parser('run', description='Wrapper for O2O jobs execution. Supports input parameter injection from the configuration file associated to the job. The formatting syntax supported are the python ones: "command -paramName {paramLabel}" or "command -paramName %(paramLabel)s". where [paramName] is the name of the parameter required for the command, and [paramLabel] is the key of the parameter entry in the config dictionary (recommended to be equal for clarity!"')
        parser_run.add_argument('executable', type=str,help='command to execute')
        parser_run.add_argument('--name', '-n', type=str, help='The o2o job name',required=True)
        parser_run.set_defaults(func=self.run,role=auth.writer_role)
 
        args = parser.parse_args()
        
        if args.verbose is not None and args.verbose >=1:
            self.setup(args)
            return args.func()
        else:
            try:
                self.setup(args) 
                sys.exit( args.func())
            except Exception as e:
                logging.error(e)
                sys.exit(1)
 

References cond::CoralServiceWrapperBase.create(), cond::persistency::ITagTable.create(), cond::CoralServiceWrapper< T >.create(), cond::persistency::GLOBAL_TAG::Table.create(), cond::persistency::TAG::Table.create(), cond::CoralServiceFactory.create(), converter::helper::ConcreteCreator.create(), converter::helper::PolymorphicCreator.create(), cond::persistency::RUN_INFO::Table.create(), cond::persistency::IPayloadTable.create(), cond::persistency::GLOBAL_TAG_MAP::Table.create(), cond::persistency::RunInfoSchema.create(), cond::persistency::IIOVTable.create(), cond::persistency::GTSchema.create(), cond::persistency::PAYLOAD::Table.create(), cond::persistency::ITagAccessPermissionTable.create(), tkal_create_file_lists.FileListCreator.create(), cond::persistency::ITagLogTable.create(), cond::persistency::IIOVSchema.create(), cond::persistency::IOV::Table.create(), cond::persistency::IGTTable.create(), cond::persistency::IGTMapTable.create(), cond::persistency::IGTSchema.create(), cond::persistency::TAG_AUTHORIZATION::Table.create(), cond::persistency::IRunInfoTable.create(), cond::persistency::IRunInfoSchema.create(), cond::persistency::TAG_LOG::Table.create(), cond::persistency::IOVSchema.create(), o2olib.O2OTool.create(), o2olib.O2OTool.disable(), o2olib.O2OTool.dumpConf(), TritonService::FallbackOpts.enable, core.PileUpAnalyzer.PileUpAnalyzer.enable, o2olib.O2OTool.enable(), o2olib.O2OTool.listConf(), o2olib.O2OJobMgr.listJobs(), o2olib.O2OTool.listJobs(), splitter.FileObj.run, uploader.FileObj.run, uploadPayloads.FileObj.run, RPCRunIOV::RunIOV_Item.run, beamspot::BeamSpotContainer.run, TB06Reco.run, TB06RecoH2.run, RPCDQMObject.run, MultiEventFilter::Event.run, DTCalibrationWorker.DTCalibrationWorker.run(), L1Analysis::L1AnalysisEventDataFormat.run, cond::Utilities.run(), PFEGammaToCandidateRemapper.run(), TrackInfoProducerAlgorithm.run(), SurveyAlignmentAlgorithm.run(), EfficiencyPlotter.run, lumi::Lumi2DB::LumiSource.run, generateEDF.LumiInfo.run, WZInterestingEventSelector::event.run, MuonRecoTest.run, crabWrapper.CrabWrapper.run(), options.ConnectionHLTMenu.run, DTResolutionAnalysisTest.run, Point.run, HIPAlignmentAlgorithm.run(), DTWorkflow.DTWorkflow.run(), MatacqProducer::MatacqEventId.run, BeamSpotRcdReader::theBSfromDB.run, BeamSpotOnlineHLTRcdReader::theBSOfromDB.run, BeamSpotOnlineLegacyRcdReader::theBSOfromDB.run, DTDataIntegrityTest.run, DTBlockedROChannelsTest.run, CSCOverlapsAlignmentAlgorithm.run(), ConstantStepOdeSolver.run(), DTChamberEfficiencyTest.run, DTResolutionTest.run, ME::Header.run, DTEfficiencyTest.run, ApeSettingAlgorithm.run(), MuonAlignmentFromReference.run(), DQMNet::CoreObject.run, MillePedeAlignmentAlgorithm.run(), personalPlayback.Playback.run, DTLocalTriggerBaseTest.run, MatrixUtil.InputInfo.run, QIE8Simulator.run(), EcalDeadCellDeltaRFilter.run, HitEff.run, cond::RunInfo_t.run, AlignmentAlgorithmBase.run(), SiPixelErrorEstimation.run, personalPlayback.FrameworkJob.run, SiPixelTrackingRecHitsValid.run, dqm_interfaces.DirWalkerFile.run, o2olib.O2OTool.run(), JsonOutputProducer::JsonEvent.run, SummaryOutputProducer.run, SummaryOutputProducer::Event.run, o2olib.O2OJobMgr.setConfig(), o2olib.O2OTool.setConfig(), o2olib.O2OTool.setFrequent(), o2olib.O2OJobMgr.setInterval(), o2olib.O2OTool.setInterval(), EcalGeomPhiSymHelper.setup(), HBHERecalibration.setup(), event.Event.setup, HcalTPGScale.setup(), HcalPedestalAnalysis.setup(), CastorPedestalAnalysis.setup(), CaloTPGTranscoderULUT.setup(), mps_alisetup.SetupAlignment.setup(), NamedCandCombinerBase.setup(), CandCombinerBase< OutputCollection, CandPtr >.setup(), querying.connection.setup(), CandCombiner< Selector, PairSelector, Cloner, OutputCollection, Setup >.setup(), looper.Looper.setup, NamedCandCombiner< Selector, PairSelector, Cloner, Setup >.setup(), options.HLTProcessOptions.setup, o2olib.O2OTool.setup(), and HcalObjRepresent::ADataRepr.setup().

listConf()

def o2olib.O2OTool.listConf

(

self

)

Definition at line 556 of file o2olib.py.

    def listConf(self):
        self.mgr.listConfig( self.args.name )
 

References o2olib.O2OTool.args, and o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

listJobs()

def o2olib.O2OTool.listJobs

(

self

)

Definition at line 553 of file o2olib.py.

    def listJobs(self):
        self.mgr.listJobs()
 

References o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

run()

def o2olib.O2OTool.run

(

self

)

Definition at line 562 of file o2olib.py.

    def run(self):
        rmgr = self.mgr.runManager()
        return rmgr.executeJob( self.args )

References o2olib.O2OTool.args, and o2olib.O2OTool.mgr.

Referenced by Types.EventID.cppID(), Types.LuminosityBlockID.cppID(), and o2olib.O2OTool.execute().

setConfig()

def o2olib.O2OTool.setConfig

(

self

)

Definition at line 525 of file o2olib.py.

    def setConfig(self):
        configJson = None
        if self.args.configFile is not None:
            if self.args.configString is not None:
                logging.error('Ambigouous input provided: please specify a configFile OR a configString')
                return False
            else:
                configJson = readConfiguration( self.args.configFile )
        else:
            if self.args.configString is None:
                logging.error('No configuration has been provided: please specify "configFile" or "configString" param.')
                return False
            else:
                configJson = checkConfiguration( self.args.configString )
        self.mgr.setConfig( self.args.name, configJson )
 

References o2olib.O2OTool.args, o2olib.checkConfiguration(), o2olib.O2OTool.mgr, and o2olib.readConfiguration().

Referenced by o2olib.O2OTool.execute().

setFrequent()

def o2olib.O2OTool.setFrequent

(

self

)

Definition at line 550 of file o2olib.py.

    def setFrequent(self):
        self.mgr.set( self.args.name, None, int(self.args.flag) )
 

References o2olib.O2OTool.args, createfilelist.int, and o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

setInterval()

def o2olib.O2OTool.setInterval

(

self

)

Definition at line 541 of file o2olib.py.

    def setInterval(self):
        self.mgr.setInterval( self.args.name, self.args.interval )
 

References o2olib.O2OTool.args, and o2olib.O2OTool.mgr.

Referenced by o2olib.O2OTool.execute().

setup()

def o2olib.O2OTool.setup	(		self,
			args
	)

Definition at line 496 of file o2olib.py.

    def setup(self, args):
        self.args = args
        db_service = prod_db_service
        if args.db is not None:
            if args.db == 'dev' or args.db == 'oradev' :
                db_service = dev_db_service
            elif args.db != 'orapro' and args.db != 'onlineorapro' and args.db != 'pro':
                raise Exception("Database '%s' is not known." %args.db )
        
        logLevel = logging.DEBUG if args.verbose is not None and args.verbose >= 1 else logging.INFO
        self.mgr = O2OJobMgr( logLevel )
        return self.mgr.connect( db_service, args )
        

Referenced by o2olib.O2OTool.execute().

Member Data Documentation

args

o2olib.O2OTool.args

Definition at line 497 of file o2olib.py.

Referenced by tier0.ResponseError.__init__(), tier0.ResponseError.__str__(), conddb_version_mgr.conddb_tool.connect(), o2olib.O2OTool.create(), o2olib.O2OTool.disable(), o2olib.O2OTool.dumpConf(), o2olib.O2OTool.enable(), conddb_version_mgr.conddb_tool.insert_boost_run(), o2olib.O2OTool.listConf(), esMonitoring.ElasticReport.make_report(), o2olib.O2OTool.run(), o2olib.O2OTool.setConfig(), o2olib.O2OTool.setFrequent(), o2olib.O2OTool.setInterval(), conddb_version_mgr.conddb_tool.show_tag_boost_version(), and conddb_version_mgr.conddb_tool.update_tags().

mgr

o2olib.O2OTool.mgr

Definition at line 506 of file o2olib.py.

Referenced by o2olib.O2OTool.create(), o2olib.O2OTool.disable(), o2olib.O2OTool.dumpConf(), o2olib.O2OTool.enable(), o2olib.O2OTool.listConf(), o2olib.O2OTool.listJobs(), o2olib.O2OTool.run(), o2olib.O2OTool.setConfig(), o2olib.O2OTool.setFrequent(), and o2olib.O2OTool.setInterval().