def _unpack(self):
try:
if os.path.isdir(self.get_agent_dir()):
shutil.rmtree(self.get_agent_dir())
zipfile.ZipFile(self.get_agent_pkg_path()).extractall(self.get_agent_dir())
except Exception as e:
fileutil.clean_ioerror(e,
paths=[self.get_agent_dir(), self.get_agent_pkg_path()])
msg = u"Exception unpacking Agent {0} from {1}: {2}".format(
self.name,
self.get_agent_pkg_path(),
ustr(e))
raise UpdateError(msg)
if not os.path.isdir(self.get_agent_dir()):
msg = u"Unpacking Agent {0} failed to create directory {1}".format(
self.name,
self.get_agent_dir())
raise UpdateError(msg)
logger.verbose(
u"Agent {0} unpacked successfully to {1}",
self.name,
self.get_agent_dir())
return
def _unpack(self):
try:
if os.path.isdir(self.get_agent_dir()):
shutil.rmtree(self.get_agent_dir())
zipfile.ZipFile(self.get_agent_pkg_path()).extractall(
self.get_agent_dir())
except Exception as e:
fileutil.clean_ioerror(
e, paths=[self.get_agent_dir(),
self.get_agent_pkg_path()])
msg = u"Exception unpacking Agent {0} from {1}: {2}".format(
self.name, self.get_agent_pkg_path(), ustr(e))
raise UpdateError(msg)
if not os.path.isdir(self.get_agent_dir()):
msg = u"Unpacking Agent {0} failed to create directory {1}".format(
self.name, self.get_agent_dir())
raise UpdateError(msg)
logger.verbose(u"Agent {0} unpacked successfully to {1}", self.name,
self.get_agent_dir())
return
def update_settings_file(self, settings_file, settings):
settings_file = os.path.join(self.get_conf_dir(), settings_file)
try:
fileutil.write_file(settings_file, settings)
except IOError as e:
fileutil.clean_ioerror(e, paths=[settings_file])
raise ExtensionError(u"Failed to update settings file", e)
def update_settings_file(self, settings_file, settings):
settings_file = os.path.join(self.get_conf_dir(), settings_file)
try:
fileutil.write_file(settings_file, settings)
except IOError as e:
fileutil.clean_ioerror(e,
paths=[settings_file])
raise ExtensionError(u"Failed to update settings file", e)
def test_clean_ioerror_handles_a_range_of_errors(self):
for err in fileutil.KNOWN_IOERRORS:
e = IOError() # pylint: disable=invalid-name
e.errno = err
d = tempfile.mkdtemp() # pylint: disable=invalid-name
fileutil.clean_ioerror(e, paths=[d])
self.assertFalse(os.path.isdir(d))
self.assertFalse(os.path.isfile(d))
def test_clean_ioerror_ignores_missing(self):
e = IOError()
e.errno = errno.ENOSPC
# Send no paths
fileutil.clean_ioerror(e)
# Send missing file(s) / directories
fileutil.clean_ioerror(e, paths=['/foo/not/here', None, '/bar/not/there'])
def test_clean_ioerror_handles_a_range_of_errors(self):
for err in fileutil.KNOWN_IOERRORS:
e = IOError()
e.errno = err
d = tempfile.mkdtemp()
fileutil.clean_ioerror(e, paths=[d])
self.assertFalse(os.path.isdir(d))
self.assertFalse(os.path.isfile(d))
def test_clean_ioerror_ignores_missing(self):
e = IOError()
e.errno = errno.ENOSPC
# Send no paths
fileutil.clean_ioerror(e)
# Send missing file(s) / directories
fileutil.clean_ioerror(e, paths=['/foo/not/here', None, '/bar/not/there'])
def set_handler_state(self, handler_state):
state_dir = self.get_conf_dir()
state_file = os.path.join(state_dir, "HandlerState")
try:
if not os.path.exists(state_dir):
fileutil.mkdir(state_dir, mode=0o700)
fileutil.write_file(state_file, handler_state)
except IOError as e:
fileutil.clean_ioerror(e, paths=[state_file])
self.logger.error("Failed to set state: {0}", e)
def test_clean_ioerror_removes_files(self):
fd, f = tempfile.mkstemp() # pylint: disable=invalid-name
os.close(fd)
fileutil.write_file(f, 'Not empty')
e = IOError() # pylint: disable=invalid-name
e.errno = errno.ENOSPC
fileutil.clean_ioerror(e, paths=[f])
self.assertFalse(os.path.isdir(f))
self.assertFalse(os.path.isfile(f))
def set_handler_state(self, handler_state):
state_dir = self.get_conf_dir()
state_file = os.path.join(state_dir, "HandlerState")
try:
if not os.path.exists(state_dir):
fileutil.mkdir(state_dir, mode=0o700)
fileutil.write_file(state_file, handler_state)
except IOError as e:
fileutil.clean_ioerror(e, paths=[state_file])
self.logger.error("Failed to set state: {0}", e)
def test_clean_ioerror_removes_files(self):
fd, f = tempfile.mkstemp()
os.close(fd)
fileutil.write_file(f, 'Not empty')
e = IOError()
e.errno = errno.ENOSPC
fileutil.clean_ioerror(e, paths=[f])
self.assertFalse(os.path.isdir(f))
self.assertFalse(os.path.isfile(f))
def test_clean_ioerror_removes_directories(self):
d1 = tempfile.mkdtemp() # pylint: disable=invalid-name
d2 = tempfile.mkdtemp() # pylint: disable=invalid-name
for n in ['foo', 'bar']: # pylint: disable=invalid-name
fileutil.write_file(os.path.join(d2, n), 'Not empty')
e = IOError() # pylint: disable=invalid-name
e.errno = errno.ENOSPC
fileutil.clean_ioerror(e, paths=[d1, d2])
self.assertFalse(os.path.isdir(d1))
self.assertFalse(os.path.isfile(d1))
self.assertFalse(os.path.isdir(d2))
self.assertFalse(os.path.isfile(d2))
def test_clean_ioerror_removes_directories(self):
d1 = tempfile.mkdtemp()
d2 = tempfile.mkdtemp()
for n in ['foo', 'bar']:
fileutil.write_file(os.path.join(d2, n), 'Not empty')
e = IOError()
e.errno = errno.ENOSPC
fileutil.clean_ioerror(e, paths=[d1, d2])
self.assertFalse(os.path.isdir(d1))
self.assertFalse(os.path.isfile(d1))
self.assertFalse(os.path.isdir(d2))
self.assertFalse(os.path.isfile(d2))
def create_handler_env(self):
env = [{
"name": self.ext_handler.name,
"version": HANDLER_ENVIRONMENT_VERSION,
"handlerEnvironment": {
"logFolder": self.get_log_dir(),
"configFolder": self.get_conf_dir(),
"statusFolder": self.get_status_dir(),
"heartbeatFile": self.get_heartbeat_file()
}
}]
try:
fileutil.write_file(self.get_env_file(), json.dumps(env))
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to save handler environment", e)
def set_handler_status(self, status="NotReady", message="", code=0):
state_dir = self.get_conf_dir()
handler_status = ExtHandlerStatus()
handler_status.name = self.ext_handler.name
handler_status.version = str(self.ext_handler.properties.version)
handler_status.message = message
handler_status.code = code
handler_status.status = status
status_file = os.path.join(state_dir, "HandlerStatus")
try:
fileutil.write_file(status_file,
json.dumps(get_properties(handler_status)))
except (IOError, ValueError, ProtocolError) as e:
fileutil.clean_ioerror(e, paths=[status_file])
self.logger.error("Failed to save handler status: {0}", e)
def create_handler_env(self):
env = [{
"name": self.ext_handler.name,
"version": HANDLER_ENVIRONMENT_VERSION,
"handlerEnvironment": {
"logFolder": self.get_log_dir(),
"configFolder": self.get_conf_dir(),
"statusFolder": self.get_status_dir(),
"heartbeatFile": self.get_heartbeat_file()
}
}]
try:
fileutil.write_file(self.get_env_file(), json.dumps(env))
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to save handler environment", e)
def set_handler_status(self, status="NotReady", message="", code=0):
state_dir = self.get_conf_dir()
handler_status = ExtHandlerStatus()
handler_status.name = self.ext_handler.name
handler_status.version = str(self.ext_handler.properties.version)
handler_status.message = message
handler_status.code = code
handler_status.status = status
status_file = os.path.join(state_dir, "HandlerStatus")
try:
handler_status_json = json.dumps(get_properties(handler_status))
if handler_status_json is not None:
fileutil.write_file(status_file, handler_status_json)
else:
self.logger.error("Failed to create JSON document of handler status for {0} version {1}".format(
self.ext_handler.name,
self.ext_handler.properties.version))
except (IOError, ValueError, ProtocolError) as e:
fileutil.clean_ioerror(e, paths=[status_file])
self.logger.error("Failed to save handler status: {0}, {1}", ustr(e), traceback.format_exc())
def set_handler_status(self, status="NotReady", message="", code=0):
state_dir = self.get_conf_dir()
handler_status = ExtHandlerStatus()
handler_status.name = self.ext_handler.name
handler_status.version = str(self.ext_handler.properties.version)
handler_status.message = message
handler_status.code = code
handler_status.status = status
status_file = os.path.join(state_dir, "HandlerStatus")
try:
handler_status_json = json.dumps(get_properties(handler_status))
if handler_status_json is not None:
fileutil.write_file(status_file, handler_status_json)
else:
self.logger.error("Failed to create JSON document of handler status for {0} version {1}".format(
self.ext_handler.name,
self.ext_handler.properties.version))
except (IOError, ValueError, ProtocolError) as e:
fileutil.clean_ioerror(e, paths=[status_file])
self.logger.error("Failed to save handler status: {0}, {1}", ustr(e), traceback.format_exc())
def test_clean_ioerror_ignores_unless_ioerror(self):
try:
d = tempfile.mkdtemp() # pylint: disable=invalid-name
fd, f = tempfile.mkstemp() # pylint: disable=invalid-name
os.close(fd)
fileutil.write_file(f, 'Not empty')
# Send non-IOError exception
e = Exception() # pylint: disable=invalid-name
fileutil.clean_ioerror(e, paths=[d, f])
self.assertTrue(os.path.isdir(d))
self.assertTrue(os.path.isfile(f))
# Send unrecognized IOError
e = IOError() # pylint: disable=invalid-name
e.errno = errno.EFAULT
self.assertFalse(e.errno in fileutil.KNOWN_IOERRORS)
fileutil.clean_ioerror(e, paths=[d, f])
self.assertTrue(os.path.isdir(d))
self.assertTrue(os.path.isfile(f))
finally:
shutil.rmtree(d)
os.remove(f)
def test_clean_ioerror_ignores_unless_ioerror(self):
try:
d = tempfile.mkdtemp()
fd, f = tempfile.mkstemp()
os.close(fd)
fileutil.write_file(f, 'Not empty')
# Send non-IOError exception
e = Exception()
fileutil.clean_ioerror(e, paths=[d, f])
self.assertTrue(os.path.isdir(d))
self.assertTrue(os.path.isfile(f))
# Send unrecognized IOError
e = IOError()
e.errno = errno.EFAULT
self.assertFalse(e.errno in fileutil.KNOWN_IOERRORS)
fileutil.clean_ioerror(e, paths=[d, f])
self.assertTrue(os.path.isdir(d))
self.assertTrue(os.path.isfile(f))
finally:
shutil.rmtree(d)
os.remove(f)
def download(self):
begin_utc = datetime.datetime.utcnow()
self.logger.verbose("Download extension package")
self.set_operation(WALAEventOperation.Download)
if self.pkg is None:
raise ExtensionError("No package uri found")
package = None
for uri in self.pkg.uris:
try:
package = self.protocol.download_ext_handler_pkg(uri.uri)
if package is not None:
break
except Exception as e:
logger.warn("Error while downloading extension: {0}", e)
if package is None:
raise ExtensionError("Failed to download extension")
self.logger.verbose("Unpack extension package")
self.pkg_file = os.path.join(conf.get_lib_dir(),
os.path.basename(uri.uri) + ".zip")
try:
fileutil.write_file(self.pkg_file, bytearray(package), asbin=True)
zipfile.ZipFile(self.pkg_file).extractall(self.get_base_dir())
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to write and unzip plugin", e)
#Add user execute permission to all files under the base dir
for file in fileutil.get_all_files(self.get_base_dir()):
fileutil.chmod(file, os.stat(file).st_mode | stat.S_IXUSR)
duration = elapsed_milliseconds(begin_utc)
self.report_event(message="Download succeeded", duration=duration)
self.logger.info("Initialize extension directory")
#Save HandlerManifest.json
man_file = fileutil.search_file(self.get_base_dir(),
'HandlerManifest.json')
if man_file is None:
raise ExtensionError("HandlerManifest.json not found")
try:
man = fileutil.read_file(man_file, remove_bom=True)
fileutil.write_file(self.get_manifest_file(), man)
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to save HandlerManifest.json", e)
#Create status and config dir
try:
status_dir = self.get_status_dir()
fileutil.mkdir(status_dir, mode=0o700)
seq_no, status_path = self.get_status_file_path()
if seq_no > -1:
now = datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")
status = {
"version": 1.0,
"timestampUTC": now,
"status": {
"name": self.ext_handler.name,
"operation": "Enabling Handler",
"status": "transitioning",
"code": 0
}
}
fileutil.write_file(json.dumps(status), status_path)
conf_dir = self.get_conf_dir()
fileutil.mkdir(conf_dir, mode=0o700)
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to create status or config dir", e)
#Save HandlerEnvironment.json
self.create_handler_env()
def download(self):
self.logger.verbose("Download extension package")
self.set_operation(WALAEventOperation.Download)
if self.pkg is None:
raise ExtensionError("No package uri found")
package = None
for uri in self.pkg.uris:
try:
package = self.protocol.download_ext_handler_pkg(uri.uri)
if package is not None:
break
except Exception as e:
logger.warn("Error while downloading extension: {0}", e)
if package is None:
raise ExtensionError("Failed to download extension")
self.logger.verbose("Unpack extension package")
self.pkg_file = os.path.join(conf.get_lib_dir(),
os.path.basename(uri.uri) + ".zip")
try:
fileutil.write_file(self.pkg_file, bytearray(package), asbin=True)
zipfile.ZipFile(self.pkg_file).extractall(self.get_base_dir())
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to write and unzip plugin", e)
#Add user execute permission to all files under the base dir
for file in fileutil.get_all_files(self.get_base_dir()):
fileutil.chmod(file, os.stat(file).st_mode | stat.S_IXUSR)
self.report_event(message="Download succeeded")
self.logger.info("Initialize extension directory")
#Save HandlerManifest.json
man_file = fileutil.search_file(self.get_base_dir(),
'HandlerManifest.json')
if man_file is None:
raise ExtensionError("HandlerManifest.json not found")
try:
man = fileutil.read_file(man_file, remove_bom=True)
fileutil.write_file(self.get_manifest_file(), man)
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to save HandlerManifest.json", e)
#Create status and config dir
try:
status_dir = self.get_status_dir()
fileutil.mkdir(status_dir, mode=0o700)
conf_dir = self.get_conf_dir()
fileutil.mkdir(conf_dir, mode=0o700)
except IOError as e:
fileutil.clean_ioerror(e,
paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to create status or config dir", e)
#Save HandlerEnvironment.json
self.create_handler_env()
def download(self):
begin_utc = datetime.datetime.utcnow()
self.logger.verbose("Download extension package")
self.set_operation(WALAEventOperation.Download)
if self.pkg is None:
raise ExtensionError("No package uri found")
uris_shuffled = self.pkg.uris
random.shuffle(uris_shuffled)
file_downloaded = False
for uri in uris_shuffled:
try:
destination = os.path.join(conf.get_lib_dir(), os.path.basename(uri.uri) + ".zip")
file_downloaded = self.protocol.download_ext_handler_pkg(uri.uri, destination)
if file_downloaded and os.path.exists(destination):
self.pkg_file = destination
break
except Exception as e:
logger.warn("Error while downloading extension: {0}", ustr(e))
if not file_downloaded:
raise ExtensionError("Failed to download extension", code=1001)
self.logger.verbose("Unzip extension package")
try:
zipfile.ZipFile(self.pkg_file).extractall(self.get_base_dir())
os.remove(self.pkg_file)
except IOError as e:
fileutil.clean_ioerror(e, paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to unzip extension package", e, code=1001)
# Add user execute permission to all files under the base dir
for file in fileutil.get_all_files(self.get_base_dir()):
fileutil.chmod(file, os.stat(file).st_mode | stat.S_IXUSR)
duration = elapsed_milliseconds(begin_utc)
self.report_event(message="Download succeeded", duration=duration)
self.logger.info("Initialize extension directory")
# Save HandlerManifest.json
man_file = fileutil.search_file(self.get_base_dir(), 'HandlerManifest.json')
if man_file is None:
raise ExtensionError("HandlerManifest.json not found")
try:
man = fileutil.read_file(man_file, remove_bom=True)
fileutil.write_file(self.get_manifest_file(), man)
except IOError as e:
fileutil.clean_ioerror(e, paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to save HandlerManifest.json", e)
# Create status and config dir
try:
status_dir = self.get_status_dir()
fileutil.mkdir(status_dir, mode=0o700)
seq_no, status_path = self.get_status_file_path()
if status_path is not None:
now = datetime.datetime.utcnow().strftime("%Y-%m-%dT%H:%M:%SZ")
status = {
"version": 1.0,
"timestampUTC": now,
"status": {
"name": self.ext_handler.name,
"operation": "Enabling Handler",
"status": "transitioning",
"code": 0
}
}
fileutil.write_file(status_path, json.dumps(status))
conf_dir = self.get_conf_dir()
fileutil.mkdir(conf_dir, mode=0o700)
except IOError as e:
fileutil.clean_ioerror(e, paths=[self.get_base_dir(), self.pkg_file])
raise ExtensionError(u"Failed to create status or config dir", e)
# Save HandlerEnvironment.json
self.create_handler_env()