module_copy_shell.py
Go to the documentation of this file.
"""
mbed SDK
Copyright (c) 2011-2015 ARM Limited
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.
Author: Przemyslaw Wirkus <Przemyslaw.Wirkus@arm.com>
"""
import os
from os.path import join, basename
from .host_test_plugins import HostTestPluginBase
class HostTestPluginCopyMethod_Shell(HostTestPluginBase):
# Plugin interface
name = 'HostTestPluginCopyMethod_Shell'
type = 'CopyMethod'
stable = True
capabilities = ['shell', 'cp', 'copy', 'xcopy']
required_parameters = ['image_path', 'destination_disk']
def __init__(self):
""" ctor
"""
HostTestPluginBase.__init__(self)
def setup(self, *args, **kwargs):
""" Configure plugin, this function should be called before plugin execute() method is used.
"""
return True
def execute(self, capability, *args, **kwargs):
"""! Executes capability by name
@param capability Capability name
@param args Additional arguments
@param kwargs Additional arguments
@details Each capability e.g. may directly just call some command line program or execute building pythonic function
@return Capability call return value
"""
if not kwargs['image_path']:
self.print_plugin_error("Error: image path not specified")
return False
if not kwargs['destination_disk']:
self.print_plugin_error("Error: destination disk not specified")
return False
# This optional parameter can be used if TargetID is provided (-t switch)
target_id = kwargs.get('target_id', None)
pooling_timeout = kwargs.get('polling_timeout', 60)
result = False
if self.check_parameters(capability, *args, **kwargs):
if kwargs['image_path'] and kwargs['destination_disk']:
image_path = os.path.normpath(kwargs['image_path'])
destination_disk = os.path.normpath(kwargs['destination_disk'])
# Wait for mount point to be ready
# if mount point changed according to target_id use new mount point
# available in result (_, destination_disk) of check_mount_point_ready
mount_res, destination_disk = self.check_mount_point_ready(destination_disk, target_id=target_id, timeout=pooling_timeout) # Blocking
if not mount_res:
return result # mount point is not ready return
# Prepare correct command line parameter values
image_base_name = basename(image_path)
destination_path = join(destination_disk, image_base_name)
if capability == 'shell':
if os.name == 'nt': capability = 'copy'
elif os.name == 'posix': capability = 'cp'
if capability == 'cp' or capability == 'copy' or capability == 'copy':
copy_method = capability
cmd = [copy_method, image_path, destination_path]
if os.name == 'posix':
result = self.run_command(cmd, shell=False)
if os.uname()[0] == 'Linux':
result = result and self.run_command(["sync", "-f", destination_path])
else:
result = result and self.run_command(["sync"])
else:
result = self.run_command(cmd)
return result
def load_plugin():
""" Returns plugin available in this module
"""
return HostTestPluginCopyMethod_Shell()
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase
Base class for all plugins used with host tests.
Definition: host_test_plugins.py:32
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.run_command
def run_command(self, cmd, shell=True)
Runs command from command line.
Definition: host_test_plugins.py:227
mbed_host_tests.host_tests_plugins.module_copy_shell.HostTestPluginCopyMethod_Shell.setup
def setup(self, args, kwargs)
Definition: module_copy_shell.py:38
mbed_host_tests.host_tests_plugins.module_copy_shell.load_plugin
def load_plugin()
Definition: module_copy_shell.py:95
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.check_parameters
def check_parameters(self, capability, args, kwargs)
This function should be ran each time we call execute() to check if none of the required parameters i...
Definition: host_test_plugins.py:211
mbed_host_tests.host_tests_plugins.module_copy_shell.HostTestPluginCopyMethod_Shell
Definition: module_copy_shell.py:25
mbed_host_tests.host_tests_plugins.module_copy_shell.HostTestPluginCopyMethod_Shell.__init__
def __init__(self)
Definition: module_copy_shell.py:33
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.print_plugin_error
def print_plugin_error(self, text)
Interface helper methods - overload only if you need to have custom behaviour.
Definition: host_test_plugins.py:93
mbed_host_tests.host_tests_plugins.host_test_plugins.HostTestPluginBase.check_mount_point_ready
def check_mount_point_ready(self, destination_disk, init_delay=0.2, loop_delay=0.25, target_id=None, timeout=60)
Waits until destination_disk is ready and can be accessed by e.g.
Definition: host_test_plugins.py:116
mbed_host_tests.host_tests_plugins.module_copy_shell.HostTestPluginCopyMethod_Shell.execute
def execute(self, capability, args, kwargs)
Executes capability by name.
Definition: module_copy_shell.py:43