def setUp(self, ImageObserverMock, FileObserverMock):
self.on_change = Mock()
self.image_observer_mock = Mock()
ImageObserverMock.return_value = self.image_observer_mock
self.file_observer_mock = Mock()
FileObserverMock.return_value = self.file_observer_mock
self.lambda_function_observer = LambdaFunctionObserver(self.on_change)
class LambdaFunctionObserver_stop(TestCase):
@patch("samcli.lib.utils.file_observer.FileObserver")
@patch("samcli.lib.utils.file_observer.ImageObserver")
def setUp(self, ImageObserverMock, FileObserverMock):
self.on_change = Mock()
self.image_observer_mock = Mock()
ImageObserverMock.return_value = self.image_observer_mock
self.file_observer_mock = Mock()
FileObserverMock.return_value = self.file_observer_mock
self.lambda_function_observer = LambdaFunctionObserver(self.on_change)
def test_successfully_start_observing(self):
self.lambda_function_observer.stop()
self.file_observer_mock.stop.assert_called_once_with()
self.image_observer_mock.stop.assert_called_once_with()
def test_image_observer_initiated_successfully(self, ImageObserverMock,
FileObserverMock):
on_change = Mock()
image_observer_mock = Mock()
ImageObserverMock.return_value = image_observer_mock
file_observer_mock = Mock()
FileObserverMock.return_value = file_observer_mock
lambda_function_observer = LambdaFunctionObserver(on_change)
self.assertEqual(
lambda_function_observer._observers,
{
ZIP: file_observer_mock,
IMAGE: image_observer_mock,
},
)
self.assertEqual(
lambda_function_observer._observed_functions,
{
ZIP: {},
IMAGE: {},
},
)
self.assertEqual(lambda_function_observer._input_on_change, on_change)
def __init__(self, container_manager, image_builder):
"""
Initialize the Local Lambda runtime
Parameters
----------
container_manager samcli.local.docker.manager.ContainerManager
Instance of the ContainerManager class that can run a local Docker container
image_builder samcli.local.docker.lambda_image.LambdaImage
Instance of the LambdaImage class that can create am image
warm_containers bool
Determines if the warm containers is enabled or not.
"""
self._containers = {}
self._observer = LambdaFunctionObserver(self._on_code_change)
super().__init__(container_manager, image_builder)
def setUp(self, ImageObserverMock, FileObserverMock):
self.on_change = Mock()
self.image_observer_mock = Mock()
ImageObserverMock.return_value = self.image_observer_mock
self.file_observer_mock = Mock()
FileObserverMock.return_value = self.file_observer_mock
self.lambda_function_observer = LambdaFunctionObserver(self.on_change)
self.zip_lambda_function1 = Mock()
self.zip_lambda_function1.packagetype = ZIP
self.zip_lambda_function1.code_abs_path = "path1"
self.zip_lambda_function1.layers = []
self.lambda_function_observer.watch(self.zip_lambda_function1)
self.zip_lambda_function2 = Mock()
self.zip_lambda_function2.packagetype = ZIP
self.zip_lambda_function2.code_abs_path = "path2"
layer1_mock = Mock()
layer1_mock.codeuri = "layer1_path1"
layer2_mock = Mock()
layer2_mock.codeuri = "layer1_path2"
self.zip_lambda_function2.layers = [layer1_mock, layer2_mock]
self.lambda_function_observer.watch(self.zip_lambda_function2)
self.zip_lambda_function3 = Mock()
self.zip_lambda_function3.packagetype = ZIP
self.zip_lambda_function3.code_abs_path = "path3"
self.zip_lambda_function3.layers = [layer1_mock]
self.lambda_function_observer.watch(self.zip_lambda_function3)
self.image_lambda_function1 = Mock()
self.image_lambda_function1.packagetype = IMAGE
self.image_lambda_function1.imageuri = "image1"
self.lambda_function_observer.watch(self.image_lambda_function1)
self.image_lambda_function2 = Mock()
self.image_lambda_function2.packagetype = IMAGE
self.image_lambda_function2.imageuri = "image2"
self.lambda_function_observer.watch(self.image_lambda_function2)
self.image_lambda_function3 = Mock()
self.image_lambda_function3.packagetype = IMAGE
self.image_lambda_function3.imageuri = "image2"
self.lambda_function_observer.watch(self.image_lambda_function3)
class LambdaFunctionObserver_on_change(TestCase):
@patch("samcli.lib.utils.file_observer.FileObserver")
@patch("samcli.lib.utils.file_observer.ImageObserver")
def setUp(self, ImageObserverMock, FileObserverMock):
self.on_change = Mock()
self.image_observer_mock = Mock()
ImageObserverMock.return_value = self.image_observer_mock
self.file_observer_mock = Mock()
FileObserverMock.return_value = self.file_observer_mock
self.lambda_function_observer = LambdaFunctionObserver(self.on_change)
self.zip_lambda_function1 = Mock()
self.zip_lambda_function1.packagetype = ZIP
self.zip_lambda_function1.code_abs_path = "path1"
self.zip_lambda_function1.layers = []
self.lambda_function_observer.watch(self.zip_lambda_function1)
self.zip_lambda_function2 = Mock()
self.zip_lambda_function2.packagetype = ZIP
self.zip_lambda_function2.code_abs_path = "path2"
layer1_mock = Mock()
layer1_mock.codeuri = "layer1_path1"
layer2_mock = Mock()
layer2_mock.codeuri = "layer1_path2"
self.zip_lambda_function2.layers = [layer1_mock, layer2_mock]
self.lambda_function_observer.watch(self.zip_lambda_function2)
self.zip_lambda_function3 = Mock()
self.zip_lambda_function3.packagetype = ZIP
self.zip_lambda_function3.code_abs_path = "path3"
self.zip_lambda_function3.layers = [layer1_mock]
self.lambda_function_observer.watch(self.zip_lambda_function3)
self.image_lambda_function1 = Mock()
self.image_lambda_function1.packagetype = IMAGE
self.image_lambda_function1.imageuri = "image1"
self.lambda_function_observer.watch(self.image_lambda_function1)
self.image_lambda_function2 = Mock()
self.image_lambda_function2.packagetype = IMAGE
self.image_lambda_function2.imageuri = "image2"
self.lambda_function_observer.watch(self.image_lambda_function2)
self.image_lambda_function3 = Mock()
self.image_lambda_function3.packagetype = IMAGE
self.image_lambda_function3.imageuri = "image2"
self.lambda_function_observer.watch(self.image_lambda_function3)
def test_one_lambda_function_code_path_got_changed(self):
self.lambda_function_observer._on_zip_change(["path1"])
self.on_change.assert_called_once_with([self.zip_lambda_function1])
def test_one_lambda_function_layer_code_path_got_changed(self):
self.lambda_function_observer._on_zip_change(["layer1_path2"])
self.on_change.assert_called_once_with([self.zip_lambda_function2])
def test_common_layer_code_path_got_changed(self):
self.lambda_function_observer._on_zip_change(["layer1_path1"])
self.on_change.assert_called_once_with(
[self.zip_lambda_function2, self.zip_lambda_function3])
def test_one_lambda_function_image_got_changed(self):
self.lambda_function_observer._on_image_change(["image1"])
self.on_change.assert_called_once_with([self.image_lambda_function1])
def test_common_image_got_changed(self):
self.lambda_function_observer._on_image_change(["image2"])
self.on_change.assert_called_once_with(
[self.image_lambda_function2, self.image_lambda_function3])
class LambdaFunctionObserver_unwatch(TestCase):
@patch("samcli.lib.utils.file_observer.FileObserver")
@patch("samcli.lib.utils.file_observer.ImageObserver")
def setUp(self, ImageObserverMock, FileObserverMock):
self.on_change = Mock()
self.image_observer_mock = Mock()
ImageObserverMock.return_value = self.image_observer_mock
self.file_observer_mock = Mock()
FileObserverMock.return_value = self.file_observer_mock
self.lambda_function_observer = LambdaFunctionObserver(self.on_change)
self.zip_lambda_function1 = Mock()
self.zip_lambda_function1.packagetype = ZIP
self.zip_lambda_function1.code_abs_path = "path1"
self.zip_lambda_function1.layers = []
self.lambda_function_observer.watch(self.zip_lambda_function1)
self.zip_lambda_function2 = Mock()
self.zip_lambda_function2.packagetype = ZIP
self.zip_lambda_function2.code_abs_path = "path2"
layer1_mock = Mock()
layer1_mock.codeuri = "layer1_path1"
layer2_mock = Mock()
layer2_mock.codeuri = "layer1_path2"
self.zip_lambda_function2.layers = [layer1_mock, layer2_mock]
self.lambda_function_observer.watch(self.zip_lambda_function2)
self.zip_lambda_function3 = Mock()
self.zip_lambda_function3.packagetype = ZIP
self.zip_lambda_function3.code_abs_path = "path3"
self.zip_lambda_function3.layers = [layer1_mock]
self.lambda_function_observer.watch(self.zip_lambda_function3)
self.image_lambda_function1 = Mock()
self.image_lambda_function1.packagetype = IMAGE
self.image_lambda_function1.imageuri = "image1"
self.lambda_function_observer.watch(self.image_lambda_function1)
self.image_lambda_function2 = Mock()
self.image_lambda_function2.packagetype = IMAGE
self.image_lambda_function2.imageuri = "image2"
self.lambda_function_observer.watch(self.image_lambda_function2)
self.image_lambda_function3 = Mock()
self.image_lambda_function3.packagetype = IMAGE
self.image_lambda_function3.imageuri = "image2"
self.lambda_function_observer.watch(self.image_lambda_function3)
def test_successfully_unwatch_last_zip_lambda_function(self):
self.lambda_function_observer.unwatch(self.zip_lambda_function1)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {
"path2": [self.zip_lambda_function2],
"path3": [self.zip_lambda_function3],
"layer1_path1":
[self.zip_lambda_function2, self.zip_lambda_function3],
"layer1_path2": [self.zip_lambda_function2],
},
IMAGE: {
"image1": [self.image_lambda_function1],
"image2":
[self.image_lambda_function2, self.image_lambda_function3],
},
},
)
self.file_observer_mock.unwatch.assert_called_with("path1")
def test_successfully_unwatch_zip_lambda_function_with_layers(self):
self.lambda_function_observer.unwatch(self.zip_lambda_function2)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {
"path1": [self.zip_lambda_function1],
"path3": [self.zip_lambda_function3],
"layer1_path1": [self.zip_lambda_function3],
},
IMAGE: {
"image1": [self.image_lambda_function1],
"image2":
[self.image_lambda_function2, self.image_lambda_function3],
},
},
)
self.assertEqual(
self.file_observer_mock.unwatch.call_args_list,
[
call("path2"),
call("layer1_path2"),
],
)
def test_successfully_unwatch_last_image_lambda_function(self):
self.lambda_function_observer.unwatch(self.image_lambda_function1)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {
"path1": [self.zip_lambda_function1],
"path2": [self.zip_lambda_function2],
"path3": [self.zip_lambda_function3],
"layer1_path1":
[self.zip_lambda_function2, self.zip_lambda_function3],
"layer1_path2": [self.zip_lambda_function2],
},
IMAGE: {
"image2":
[self.image_lambda_function2, self.image_lambda_function3]
},
},
)
self.image_observer_mock.unwatch.assert_called_with("image1")
def test_successfully_unwatch_non_last_image_lambda_function(self):
self.lambda_function_observer.unwatch(self.image_lambda_function2)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {
"path1": [self.zip_lambda_function1],
"path2": [self.zip_lambda_function2],
"path3": [self.zip_lambda_function3],
"layer1_path1":
[self.zip_lambda_function2, self.zip_lambda_function3],
"layer1_path2": [self.zip_lambda_function2],
},
IMAGE: {
"image1": [self.image_lambda_function1],
"image2": [self.image_lambda_function3]
},
},
)
self.image_observer_mock.unwatch.assert_not_called()
class LambdaFunctionObserver_watch(TestCase):
@patch("samcli.lib.utils.file_observer.FileObserver")
@patch("samcli.lib.utils.file_observer.ImageObserver")
def setUp(self, ImageObserverMock, FileObserverMock):
self.on_change = Mock()
self.image_observer_mock = Mock()
ImageObserverMock.return_value = self.image_observer_mock
self.file_observer_mock = Mock()
FileObserverMock.return_value = self.file_observer_mock
self.lambda_function_observer = LambdaFunctionObserver(self.on_change)
def test_watch_ZIP_lambda_function(self):
lambda_function = Mock()
lambda_function.packagetype = ZIP
lambda_function.code_abs_path = "path1"
lambda_function.layers = []
self.lambda_function_observer.watch(lambda_function)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {
"path1": [lambda_function]
},
IMAGE: {},
},
)
self.file_observer_mock.watch.assert_called_with("path1")
def test_watch_ZIP_lambda_function_with_layers(self):
lambda_function = Mock()
lambda_function.packagetype = ZIP
lambda_function.code_abs_path = "path1"
layer1_mock = Mock()
layer1_mock.codeuri = "layer1_path"
layer2_mock = Mock()
layer2_mock.codeuri = "layer2_path"
lambda_function.layers = [layer1_mock, layer2_mock]
self.lambda_function_observer.watch(lambda_function)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {
"path1": [lambda_function],
"layer1_path": [lambda_function],
"layer2_path": [lambda_function],
},
IMAGE: {},
},
)
self.assertEqual(
self.file_observer_mock.watch.call_args_list,
[
call("path1"),
call("layer1_path"),
call("layer2_path"),
],
)
def test_watch_IMAGE_lambda_function(self):
lambda_function = Mock()
lambda_function.packagetype = IMAGE
lambda_function.imageuri = "image1"
self.lambda_function_observer.watch(lambda_function)
self.assertEqual(
self.lambda_function_observer._observed_functions,
{
ZIP: {},
IMAGE: {
"image1": [lambda_function]
},
},
)
self.image_observer_mock.watch.assert_called_with("image1")
class WarmLambdaRuntime(LambdaRuntime):
"""
This class extends the LambdaRuntime class to add the Warm containers feature. This class handles the
warm containers life cycle.
"""
def __init__(self, container_manager, image_builder):
"""
Initialize the Local Lambda runtime
Parameters
----------
container_manager samcli.local.docker.manager.ContainerManager
Instance of the ContainerManager class that can run a local Docker container
image_builder samcli.local.docker.lambda_image.LambdaImage
Instance of the LambdaImage class that can create am image
warm_containers bool
Determines if the warm containers is enabled or not.
"""
self._containers = {}
self._observer = LambdaFunctionObserver(self._on_code_change)
super().__init__(container_manager, image_builder)
def create(self,
function_config,
debug_context=None,
container_host=None,
container_host_interface=None):
"""
Create a new Container for the passed function, then store it in a dictionary using the function name,
so it can be retrieved later and used in the other functions. Make sure to use the debug_context only
if the function_config.name equals debug_context.debug-function or the warm_containers option is disabled
Parameters
----------
function_config FunctionConfig
Configuration of the function to create a new Container for it.
debug_context DebugContext
Debugging context for the function (includes port, args, and path)
container_host string
Host of locally emulated Lambda container
container_host_interface string
Interface that Docker host binds ports to
Returns
-------
Container
the created container
"""
# reuse the cached container if it is created
container = self._containers.get(function_config.name, None)
if container and container.is_created():
LOG.info(
"Reuse the created warm container for Lambda function '%s'",
function_config.name)
return container
# debug_context should be used only if the function name is the one defined
# in debug-function option
if debug_context and debug_context.debug_function != function_config.name:
LOG.debug(
"Disable the debugging for Lambda Function %s, as the passed debug function is %s",
function_config.name,
debug_context.debug_function,
)
debug_context = None
container = super().create(function_config, debug_context,
container_host, container_host_interface)
self._containers[function_config.name] = container
self._observer.watch(function_config)
self._observer.start()
return container
def _on_invoke_done(self, container):
"""
Cleanup the created resources, just before the invoke function ends.
In warm containers, the running containers will be closed just before the end of te command execution,
so no action is done here
Parameters
----------
container: Container
The current running container
"""
def _configure_interrupt(self, function_name, timeout, container,
is_debugging):
"""
When a Lambda function is executing, we setup certain interrupt handlers to stop the execution.
Usually, we setup a function timeout interrupt to kill the container after timeout expires. If debugging though,
we don't enforce a timeout. But we setup a SIGINT interrupt to catch Ctrl+C and terminate the container.
Parameters
----------
function_name: str
Name of the function we are running
timeout: int
Timeout in seconds
container: samcli.local.docker.container.Container
Instance of a container to terminate
is_debugging: bool
Are we debugging?
Returns
-------
threading.Timer
Timer object, if we setup a timer. None otherwise
"""
def timer_handler():
# NOTE: This handler runs in a separate thread. So don't try to mutate any non-thread-safe data structures
LOG.info("Function '%s' timed out after %d seconds", function_name,
timeout)
def signal_handler(sig, frame):
# NOTE: This handler runs in a separate thread. So don't try to mutate any non-thread-safe data structures
LOG.info("Execution of function %s was interrupted", function_name)
if is_debugging:
LOG.debug("Setting up SIGTERM interrupt handler")
signal.signal(signal.SIGTERM, signal_handler)
return None
# Start a timer, we'll use this to abort the function if it runs beyond the specified timeout
LOG.debug("Starting a timer for %s seconds for function '%s'", timeout,
function_name)
timer = threading.Timer(timeout, timer_handler, ())
timer.start()
return timer
def clean_running_containers_and_related_resources(self):
"""
Clean the running containers, the decompressed code dirs, and stop the created observer
"""
LOG.debug("Terminating all running warm containers")
for function_name, container in self._containers.items():
LOG.debug(
"Terminate running warm container for Lambda Function '%s'",
function_name)
self._container_manager.stop(container)
self._clean_decompressed_paths()
self._observer.stop()
def _on_code_change(self, functions):
"""
Handles the lambda function code change event. it determines if there is a real change in the code
by comparing the checksum of the code path before and after the event.
Parameters
----------
functions: list [FunctionConfig]
the lambda functions that their source code or images got changed
"""
for function_config in functions:
function_name = function_config.name
resource = "source code" if function_config.packagetype == ZIP else f"{function_config.imageuri} image"
LOG.info(
"Lambda Function '%s' %s has been changed, terminate its warm container. "
"The new container will be created in lazy mode",
function_name,
resource,
)
container = self._containers.get(function_name, None)
if container:
self._container_manager.stop(container)
self._containers.pop(function_name, None)
self._observer.unwatch(function_config)