# Copyright 2016-2018, Pulumi Corporation. # # 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. """ Mocks for testing. """ import functools import logging from abc import ABC, abstractmethod from typing import TYPE_CHECKING, Dict, List, NamedTuple, Optional, Tuple from google.protobuf import empty_pb2 from ..runtime.proto import engine_pb2, provider_pb2, resource_pb2 from ..runtime.stack import Stack, run_pulumi_func from . import rpc, rpc_manager from .settings import ( Settings, configure, get_project, get_root_resource, get_stack, SETTINGS, ) from .sync_await import _ensure_event_loop, _sync_await if TYPE_CHECKING: from ..resource import Resource def test(fn): """ Decorates a test function to make sure that a returned Future or Output is awaited as part of the test. """ @functools.wraps(fn) def wrapper(*args, **kwargs): from .. import Output # pylint: disable=import-outside-toplevel SETTINGS.rpc_manager.clear() SETTINGS.outputs.clear() _sync_await( run_pulumi_func( lambda: _sync_await(Output.from_input(fn(*args, **kwargs)).future()) ) ) return wrapper class MockResourceArgs: """ MockResourceArgs is used to construct a newResource Mock """ typ: str name: str inputs: dict provider: Optional[str] = None resource_id: Optional[str] = None custom: Optional[bool] = None def __init__( self, typ: str, name: str, inputs: dict, provider: Optional[str] = None, resource_id: Optional[str] = None, custom: Optional[bool] = None, ) -> None: """ :param str typ: The token that indicates which resource type is being constructed. This token is of the form "package:module:type". :param str name: The logical name of the resource instance. :param dict inputs: The inputs for the resource. :param str provider: The identifier of the provider instance being used to manage this resource. :param str resource_id: The physical identifier of an existing resource to read or import. :param bool custom: Specifies whether or not the resource is Custom (i.e. managed by a resource provider). """ self.typ = typ self.name = name self.inputs = inputs self.provider = provider self.resource_id = resource_id self.custom = custom class MockCallArgs: """ MockCallArgs is used to construct a call Mock """ token: str args: dict provider: str def __init__(self, token: str, args: dict, provider: str) -> None: """ :param str token: The token that indicates which function is being called. This token is of the form "package:module:function". :param dict args: The arguments provided to the function call. :param str provider: The identifier of the provider instance being used to make the call """ self.token = token self.args = args self.provider = provider class Mocks(ABC): """ Mocks is an abstract class that allows subclasses to replace operations normally implemented by the Pulumi engine with their own implementations. This can be used during testing to ensure that calls to provider functions and resource constructors return predictable values. """ @abstractmethod def call(self, args: MockCallArgs) -> Tuple[dict, Optional[List[Tuple[str, str]]]]: """ call mocks provider-implemented function calls (e.g. aws.get_availability_zones). :param MockCallArgs args. """ return {}, None @abstractmethod def new_resource(self, args: MockResourceArgs) -> Tuple[Optional[str], dict]: """ new_resource mocks resource construction calls. This function should return the physical identifier and the output properties for the resource being constructed. :param MockResourceArgs args. """ return "", {} class MockMonitor: class ResourceRegistration(NamedTuple): urn: str id: str state: dict mocks: Mocks resources: Dict[str, ResourceRegistration] def __init__(self, mocks: Mocks): self.mocks = mocks self.resources = {} def make_urn(self, parent: str, type_: str, name: str) -> str: if parent != "": qualifiedType = parent.split("::")[2] parentType = qualifiedType.split("$").pop() type_ = parentType + "$" + type_ return "urn:pulumi:" + "::".join([get_stack(), get_project(), type_, name]) def Invoke(self, request): # Ensure we have an event loop on this thread because it's needed when deserializing resource references. _ensure_event_loop() args = rpc.deserialize_properties(request.args) if request.tok == "pulumi:pulumi:getResource": registered_resource = self.resources.get(args["urn"]) if registered_resource is None: raise Exception(f"unknown resource {args['urn']}") ret_proto = _sync_await( rpc.serialize_properties(registered_resource._asdict(), {}) ) fields = {"failures": None, "return": ret_proto} return provider_pb2.InvokeResponse(**fields) call_args = MockCallArgs( token=request.tok, args=args, provider=request.provider ) tup = self.mocks.call(call_args) if isinstance(tup, dict): (ret, failures) = (tup, None) else: (ret, failures) = tup[0], [ provider_pb2.CheckFailure(property=failure[0], reason=failure[1]) for failure in tup[1] ] ret_proto = _sync_await(rpc.serialize_properties(ret, {})) fields = {"failures": failures, "return": ret_proto} return provider_pb2.InvokeResponse(**fields) def ReadResource(self, request): # Ensure we have an event loop on this thread because it's needed when deserializing resource references. _ensure_event_loop() state = rpc.deserialize_properties(request.properties) resource_args = MockResourceArgs( typ=request.type, name=request.name, inputs=state, provider=request.provider, resource_id=request.id, ) id_, state = self.mocks.new_resource(resource_args) props_proto = _sync_await(rpc.serialize_properties(state, {})) urn = self.make_urn(request.parent, request.type, request.name) self.resources[urn] = MockMonitor.ResourceRegistration(urn, id_, state) return resource_pb2.ReadResourceResponse(urn=urn, properties=props_proto) def RegisterResource(self, request): urn = self.make_urn(request.parent, request.type, request.name) if request.type == "pulumi:pulumi:Stack": return resource_pb2.RegisterResourceResponse(urn=urn) # Ensure we have an event loop on this thread because it's needed when deserializing resource references. _ensure_event_loop() inputs = rpc.deserialize_properties(request.object) resource_args = MockResourceArgs( typ=request.type, name=request.name, inputs=inputs, provider=request.provider, resource_id=request.importId, custom=request.custom or False, ) id_, state = self.mocks.new_resource(resource_args) obj_proto = _sync_await(rpc.serialize_properties(state, {})) self.resources[urn] = MockMonitor.ResourceRegistration(urn, id_, state) return resource_pb2.RegisterResourceResponse(urn=urn, id=id_, object=obj_proto) def RegisterResourceOutputs(self, request): # pylint: disable=unused-argument return empty_pb2.Empty() def SupportsFeature(self, request): # Support for "outputValues" is deliberately disabled for the mock monitor so # instances of `Output` don't show up in `MockResourceArgs` inputs. has_support = request.id != "outputValues" return type("SupportsFeatureResponse", (object,), {"hasSupport": has_support}) class MockEngine: logger: logging.Logger def __init__(self, logger: Optional[logging.Logger]): self.logger = logger if logger is not None else logging.getLogger() def Log(self, request): if request.severity == engine_pb2.DEBUG: self.logger.debug(request.message) elif request.severity == engine_pb2.INFO: self.logger.info(request.message) elif request.severity == engine_pb2.WARNING: self.logger.warning(request.message) elif request.severity == engine_pb2.ERROR: self.logger.error(request.message) # We use this MockSettings class in the case where test setup needs to stub in settings objects # Because ContextVars are context-sensitive, asyncio threads lose track of external settings meddling class MockSettings(Settings): def __init__(self, *_, **kwargs): # pylint: disable=super-init-not-called self.rpc_manager = rpc_manager.RPCManager() for key, value in kwargs.items(): setattr(self, key, value) def __repr__(self): return f"" def set_mocks( mocks: Mocks, project: Optional[str] = None, stack: Optional[str] = None, preview: Optional[bool] = None, logger: Optional[logging.Logger] = None, monitor: Optional[MockMonitor] = None, organization: Optional[str] = None, ): """ set_mocks configures the Pulumi runtime to use the given mocks for testing. """ settings = MockSettings( monitor=MockMonitor(mocks) if not monitor else monitor, engine=MockEngine(logger), project=project if project is not None else "project", stack=stack if stack is not None else "stack", dry_run=preview, organization=organization, ) configure(settings) # Ensure a new root stack resource has been initialized. if get_root_resource() is None: Stack(lambda: None)