Minor loader improvements.

recipe_engine/loader.py

 # Copyright 2016 The LUCI Authors. All rights reserved.
 # Use of this source code is governed under the Apache License, Version 2.0
 # that can be found in the LICENSE file.
 
 import collections
 import imp
 import inspect
 import os
 import sys
 
 from . import env
 
 from .config import ConfigContext, ConfigGroupSchema
 from .config_types import Path, ModuleBasePath, PackageRepoBasePath
 from .config_types import RecipeScriptBasePath
 from .config_types import RECIPE_MODULE_PREFIX
-from .recipe_api import RecipeApiPlain, RecipeScriptApi
+from .recipe_api import RecipeApi, RecipeApiPlain, RecipeScriptApi
 from .recipe_api import _UnresolvedRequirement
 from .recipe_api import BoundProperty
 from .recipe_api import UndefinedPropertyException, PROPERTY_SENTINEL
 from .recipe_test_api import RecipeTestApi, DisabledTestData
 
 
 class LoaderError(Exception):
   """Raised when something goes wrong loading recipes or modules."""
 
 
@@ skipping 71 matching lines @@
 
     recipe_globals = {}
     recipe_globals['__file__'] = script_path
 
     with env.temp_sys_path():
       execfile(script_path, recipe_globals)
 
     recipe_globals['LOADED_DEPS'] = universe_view.deps_from_spec(
         recipe_globals.get('DEPS', []))
 
+    if 'RunSteps' not in recipe_globals:
+      raise Exception('Missing or misspelled RunSteps function.')

[dnj, 2017/05/06 02:37:14]

Let's make this "MalformedRecipeError" or something - looks better to users, and
this will be presented to users.

[iannucci, 2017/05/06 02:54:55]

Done, added test too :)

+
+    if 'GenTests' not in recipe_globals:
+      raise Exception('Missing or misspelled GenTests function.')
+
     return cls(name, recipe_globals, universe_view.package.name, script_path)
 
 
 class RecipeUniverse(object):
   def __init__(self, package_deps, config_file):
     self._loaded = {}
     self._package_deps = package_deps
     self._config_file = config_file
 
   @property
@@ skipping 328 matching lines @@
         assert not submod.CONFIG_CTX, (
           'More than one configuration context: %s, %s' %
           (submod.config, submod.CONFIG_CTX))
         submod.CONFIG_CTX = v
     assert submod.CONFIG_CTX, 'Config file, but no config context?'
 
   # Identify the RecipeApiPlain subclass as this module's API.
   submod.API = getattr(submod, 'API', None)
   assert hasattr(submod, 'api'), '%s is missing api.py' % (name,)
   for v in submod.api.__dict__.itervalues():
+    # If the recipe has literally imported the RecipeApi, we don't wan't
+    # to consider that to be the real RecipeApi :)
+    if v is RecipeApiPlain or v is RecipeApi:
+      continue
     if inspect.isclass(v) and issubclass(v, RecipeApiPlain):
       assert not submod.API, (
         '%s has more than one RecipeApi subclass: %s, %s' % (
             name, v, submod.API))
       submod.API = v
   assert submod.API, 'Submodule has no api? %s' % (submod)
 
   # Identify the (optional) RecipeTestApi subclass as this module's test API.
   submod.TEST_API = getattr(submod, 'TEST_API', None)
   if hasattr(submod, 'test_api'):
     for v in submod.test_api.__dict__.itervalues():
+      # If the recipe has literally imported the RecipeTestApi, we don't wan't
+      # to consider that to be the real RecipeTestApi :)
+      if v is RecipeTestApi:
+        continue
       if inspect.isclass(v) and issubclass(v, RecipeTestApi):
         assert not submod.TEST_API, (
           'More than one TestApi subclass: %s' % submod.api)
         submod.TEST_API = v
     assert submod.API, (
       'Submodule has test_api.py but no TestApi subclass? %s'
       % (submod)
     )
 
   # Let each property object know about the property name.
@@ skipping 200 matching lines @@
   for k,v in toplevel_deps.iteritems():
     setattr(api, k, mapper.instantiate(v))
   return api
 
 
 def _resolve_requirement(req, engine):
   if req._typ == 'client':
     return engine._get_client(req._name)
   else:
     raise ValueError('Unknown requirement type [%s]' % (req._typ,))