model.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
 
 
from robotide.lib.robot import model
from robotide.lib.robot.conf import RobotSettings
from robotide.lib.robot.output import LOGGER, Output, pyloggingconf
from robotide.lib.robot.utils import setter
 
from .steprunner import StepRunner
from .randomizer import Randomizer
 
 
 
class Keyword(model.Keyword):
    __slots__ = []
    message_class = None  #: Internal usage only.
 
    
    def run(self, context):
        return StepRunner(context).run_step(self)
 
 
 
class ForLoop(Keyword):
    __slots__ = ['flavor']
    keyword_class = Keyword  #: Internal usage only.
 
    def __init__(self, variables, values, flavor):
        Keyword.__init__(self, assign=variables, args=values,
                         type=Keyword.FOR_LOOP_TYPE)
        self.flavorflavor = flavor
 
    @property
    variables = property
    
    def variables(self):
        return self.assignassign
 
    @property
    values = property
    
    def values(self):
        return self.argsargs
 
 
 
class TestCase(model.TestCase):
    __slots__ = ['template']
    keyword_class = Keyword  #: Internal usage only.
 
    def __init__(self, name='', doc='', tags=None, timeout=None, template=None):
        model.TestCase.__init__(self, name, doc, tags, timeout)
        #: Name of the keyword that has been used as template
        #: when building the test. ``None`` if no is template used.
        self.templatetemplate = template
 
    @setter
    
    def timeout(self, timeout):
        return Timeout(*timeout) if timeout else None
 
 
 
class TestSuite(model.TestSuite):
    __slots__ = ['resource']
    test_class = TestCase    #: Internal usage only.
    keyword_class = Keyword  #: Internal usage only.
 
    def __init__(self,  name='', doc='', metadata=None, source=None, rpa=False):
        model.TestSuite.__init__(self, name, doc, metadata, source, rpa)
        #: :class:`ResourceFile` instance containing imports, variables and
        #: keywords the suite owns. When data is parsed from the file system,
        #: this data comes from the same test case file that creates the suite.
        self.resourceresource = ResourceFile(source=source)
 
    
    def configure(self, randomize_suites=False, randomize_tests=False,
                  randomize_seed=None, **options):
        model.TestSuite.configure(self, **options)
        self.randomizerandomize(randomize_suites, randomize_tests, randomize_seed)
 
    
    def randomize(self, suites=True, tests=True, seed=None):
        self.visitvisit(Randomizer(suites, tests, seed))
 
    
    def run(self, settings=None, **options):
        from .namespace import IMPORTER
        from .signalhandler import STOP_SIGNAL_MONITOR
        from .runner import Runner
 
        with LOGGER:
            if not settings:
                settings = RobotSettings(options)
                LOGGER.register_console_logger(**settings.console_output_config)
            with pyloggingconf.robot_handler_enabled(settings.log_level):
                with STOP_SIGNAL_MONITOR:
                    IMPORTER.reset()
                    output = Output(settings)
                    runner = Runner(output, settings)
                    self.visitvisit(runner)
                output.close(runner.result)
        return runner.result
 
 
class Variable():
 
    def __init__(self, name, value, source=None):
        self.namename = name
        self.valuevalue = value
        self.sourcesource = source
 
    def report_invalid_syntax(self, message, level='ERROR'):
        LOGGER.write("Error in file '%s': Setting variable '%s' failed: %s"
                     % (self.sourcesource or '<unknown>', self.namename, message), level)
 
 
class Timeout():
 
    def __init__(self, value, message=None):
        self.valuevalue = value
        self.messagemessage = message
 
    def __str__(self):
        return self.valuevalue
 
 
class ResourceFile():
 
    def __init__(self, doc='', source=None):
        self.docdoc = doc
        self.sourcesource = source
        self.importsimportsimports = []
        self.keywordskeywordskeywords = []
        self.variablesvariablesvariables = []
 
    @setter
    def imports(self, imports):
        return model.Imports(self.sourcesource, imports)
 
    @setter
    def keywords(self, keywords):
        return model.ItemList(UserKeyword, items=keywords)
 
    @setter
    def variables(self, variables):
        return model.ItemList(Variable, {'source': self.sourcesource}, items=variables)
 
 
class UserKeyword():
 
    def __init__(self, name, args=(), doc='', tags=(), return_=None, timeout=None):
        self.namename = name
        self.argsargs = args
        self.docdoc = doc
        self.tagstagstags = tags
        self.return_return_ = return_ or ()
        self.timeouttimeouttimeout = timeout
        self.keywordskeywordskeywords = []
 
    @setter
    def keywords(self, keywords):
        return model.Keywords(Keyword, self, keywords)
 
    @setter
    
    def timeout(self, timeout):
        return Timeout(*timeout) if timeout else None
 
    @setter
    def tags(self, tags):
        return model.Tags(tags)