# -*- coding: utf-8 -*- {{{
# vim: set fenc=utf-8 ft=python sw=4 ts=4 sts=4 et:
#
# Copyright 2019, Battelle Memorial Institute.
#
# 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.
#
# This material was prepared as an account of work sponsored by an agency of
# the United States Government. Neither the United States Government nor the
# United States Department of Energy, nor Battelle, nor any of their
# employees, nor any jurisdiction or organization that has cooperated in the
# development of these materials, makes any warranty, express or
# implied, or assumes any legal liability or responsibility for the accuracy,
# completeness, or usefulness or any information, apparatus, product,
# software, or process disclosed, or represents that its use would not infringe
# privately owned rights. Reference herein to any specific commercial product,
# process, or service by trade name, trademark, manufacturer, or otherwise
# does not necessarily constitute or imply its endorsement, recommendation, or
# favoring by the United States Government or any agency thereof, or
# Battelle Memorial Institute. The views and opinions of authors expressed
# herein do not necessarily state or reflect those of the
# United States Government or any agency thereof.
#
# PACIFIC NORTHWEST NATIONAL LABORATORY operated by
# BATTELLE for the UNITED STATES DEPARTMENT OF ENERGY
# under Contract DE-AC05-76RL01830
# }}}
""" Core package."""
import logging
import os
import psutil
import sys
from configparser import ConfigParser
from ..utils.frozendict import FrozenDict
from urllib.parse import urlparse
__version__ = '7.0'
_log = logging.getLogger(__name__)
[docs]def set_home(home=None):
""" Set the home directory with user and variables expanded.
If the home is sent in, it used.
Otherwise, the default value of '~/.volttron' is used.
"""
os.environ["VOLTTRON_HOME"] = home or get_home()
[docs]def get_home():
""" Return the home directory with user and variables expanded.
If the VOLTTRON_HOME environment variable is set, it used.
Otherwise, the default value of '~/.volttron' is used.
"""
vhome = os.path.abspath(
os.path.normpath(
os.path.expanduser(
os.path.expandvars(
os.environ.get('VOLTTRON_HOME', '~/.volttron')))))
if vhome.endswith('/'):
vhome = vhome[:-1]
if os.environ.get('VOLTTRON_HOME') is not None:
log = logging.getLogger('volttron')
log.warn("Removing / from the end of VOLTTRON_HOME")
os.environ['VOLTTRON_HOME'] = vhome
return vhome
[docs]def get_config_path() -> str:
"""
Returns the platforms main configuration file.
:return:
"""
return os.path.join(get_home(), "config")
[docs]def get_address():
"""Return the VIP address of the platform
If the VOLTTRON_VIP_ADDR environment variable is set, it used.
Otherwise, it is derived from get_home()."""
address = os.environ.get('VOLTTRON_VIP_ADDR')
if not address:
abstract = '@' if sys.platform.startswith('linux') else ''
address = 'ipc://%s%s/run/vip.socket' % (abstract, get_home())
return address
[docs]def get_volttron_root():
"""
Returns the root folder where the volttron code base resideds on disk.
:return: absolute path to root folder
"""
return os.path.dirname(
os.path.dirname(
os.path.dirname(
os.path.abspath(__file__)
)
)
)
[docs]def get_volttron_data():
root = get_volttron_root()
return os.path.join(root, "volttron_data")
[docs]def get_services_core(agent_dir=None):
root = get_volttron_root()
services_core = os.path.join(root, "services/core")
if not agent_dir:
return services_core
return os.path.join(services_core, agent_dir)
[docs]def get_ops(agent_dir=None):
root = get_volttron_root()
ops_dir = os.path.join(root, "services/ops")
if not agent_dir:
return ops_dir
return os.path.join(ops_dir, agent_dir)
[docs]def get_examples(agent_dir):
root = get_volttron_root()
examples_dir = os.path.join(root, "examples")
if not agent_dir:
return examples_dir
return os.path.join(examples_dir, agent_dir)
[docs]def is_instance_running(volttron_home=None):
from volttron.platform import jsonapi
if volttron_home is None:
volttron_home = get_home()
instance_file = os.path.expanduser("~/.volttron_instances")
if not os.path.isfile(instance_file):
return False
with open(instance_file, 'r') as fp:
jsonobj = jsonapi.loads(fp.read())
if volttron_home not in jsonobj:
return False
obj = jsonobj[volttron_home]
pid = obj.get('pid', None)
if not pid:
return False
return psutil.pid_exists(pid)
[docs]def is_rabbitmq_available():
rabbitmq_available = True
try:
import pika
rabbitmq_available = True
except ImportError:
os.environ['RABBITMQ_NOT_AVAILABLE'] = "True"
rabbitmq_available = False
return rabbitmq_available
__config__ = None
[docs]def build_vip_address_string(vip_root, serverkey, publickey, secretkey):
""" Build a full vip address string based upon the passed arguments
All arguments are required to be non-None in order for the string to be
created successfully.
:raises ValueError if one of the parameters is None.
"""
_log.debug("root: {}, serverkey: {}, publickey: {}, secretkey: {}".format(
vip_root, serverkey, publickey, secretkey))
parsed = urlparse(vip_root)
if parsed.scheme == 'tcp':
if not (serverkey and publickey and secretkey and vip_root):
raise ValueError("All parameters must be entered.")
root = "{}?serverkey={}&publickey={}&secretkey={}".format(
vip_root, serverkey, publickey, secretkey)
elif parsed.scheme == 'ipc':
root = vip_root
else:
raise ValueError('Invalid vip root specified!')
return root