Skip to content

Commit

Permalink
Merge pull request #154 from tofu-rocketry/release-3.2.0
Browse files Browse the repository at this point in the history 
Release 3.2.0 to master
  • Loading branch information
@tofu-rocketry
tofu-rocketry authored Mar 18, 2021
2 parents b0cc13b + 4bdafb4 commit bb2f026
Show file tree
Hide file tree
Showing 10 changed files with 409 additions and 412 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
Changelog for ssm
=================
* Thu Mar 18 2021 Adrian Coveney <[email protected]> - 3.2.0-1
- Added logging of what certificate DNs/subjects are being used to facilitate
troubleshooting.
- Added stomp.py as .deb package dependency to avoid broken installations.
- Refactored code to enable simpler external calls and better testing.

* Wed Dec 16 2020 Adrian Coveney <[email protected]> - 3.1.1-1
- Changed logging to reduce how verbose the logging of a 3rd-party module is.

Expand Down
8 changes: 7 additions & 1 deletion apel-ssm.spec
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
%endif

Name: apel-ssm
Version: 3.1.1
Version: 3.2.0
%define releasenumber 1
Release: %{releasenumber}%{?dist}
Summary: Secure stomp messenger
Expand Down Expand Up @@ -100,6 +100,12 @@ rm -rf $RPM_BUILD_ROOT
%doc %_defaultdocdir/%{name}

%changelog
* Thu Mar 18 2021 Adrian Coveney <[email protected]> - 3.2.0-1
- Added logging of what certificate DNs/subjects are being used to facilitate
troubleshooting.
- Added stomp.py as .deb package dependency to avoid broken installations.
- Refactored code to enable simpler external calls and better testing.

* Wed Dec 16 2020 Adrian Coveney <[email protected]> - 3.1.1-1
- Changed logging to reduce how verbose the logging of a 3rd-party module is.

Expand Down
228 changes: 8 additions & 220 deletions bin/receiver.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,60 +18,19 @@

from __future__ import print_function

from ssm.brokers import StompBrokerGetter, STOMP_SERVICE, STOMP_SSL_SERVICE
from ssm.ssm2 import Ssm2, Ssm2Exception
from ssm import __version__, set_up_logging, LOG_BREAK
import ssm.agents
from ssm import __version__, LOG_BREAK

from stomp.exception import NotConnectedException
try:
from argo_ams_library import AmsConnectionException
except ImportError:
# ImportError is raised when Ssm2 initialised if AMS is requested but lib
# not installed.
AmsConnectionException = None

import time
import logging.config
import ldap
import logging
import os
import sys
from optparse import OptionParser
from daemon import DaemonContext

try:
import ConfigParser
except ImportError:
import configparser as ConfigParser

# How often (in seconds) to read the list of valid DNs.
REFRESH_DNS = 600
log = None


def get_dns(dn_file):
"""Retrieve a list of DNs from a file."""
dns = []
f = None
try:
f = open(dn_file, 'r')
lines = f.readlines()
for line in lines:
if line.isspace() or line.strip().startswith('#'):
continue
elif line.strip().startswith('/'):
dns.append(line.strip())
else:
log.warn('DN in incorrect format: %s', line)
finally:
if f is not None:
f.close()
# If no valid DNs, SSM cannot receive any messages.
if len(dns) == 0:
raise Ssm2Exception('No valid DNs found in %s. SSM will not start' % dn_file)

log.debug('%s DNs found.', len(dns))
return dns


def main():
"""Set up connection, and listen for messages."""
Expand All @@ -97,192 +56,21 @@ def main():
print('Cannot start SSM. Pidfile %s already exists.' % pidfile)
sys.exit(1)

# set up logging
try:
if os.path.exists(options.log_config):
logging.config.fileConfig(options.log_config)
else:
set_up_logging(cp.get('logging', 'logfile'),
cp.get('logging', 'level'),
cp.getboolean('logging', 'console'))
except (ConfigParser.Error, ValueError, IOError) as err:
print('Error configuring logging: %s' % err)
print('SSM will exit.')
sys.exit(1)
ssm.agents.logging_helper(cp, options.log_config)

global log
log = logging.getLogger('ssmreceive')

log.info(LOG_BREAK)
log.info('Starting receiving SSM version %s.%s.%s.', *__version__)

# Determine the protocol for the SSM to use.
try:
protocol = cp.get('receiver', 'protocol')

except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
# If the newer configuration setting 'protocol' is not set, use 'STOMP'
# for backwards compatability.
protocol = Ssm2.STOMP_MESSAGING
log.debug("No option set for 'protocol'. Defaulting to %s.", protocol)
protocol = ssm.agents.get_protocol(cp, log)

log.info('Setting up SSM with protocol: %s', protocol)

if protocol == Ssm2.STOMP_MESSAGING:
# Set defaults for AMS variables that Ssm2 constructor requires below.
project = None
token = ''

use_ssl = cp.getboolean('broker', 'use_ssl')
if use_ssl:
service = STOMP_SSL_SERVICE
else:
service = STOMP_SERVICE

# If we can't get a broker to connect to, we have to give up.
try:
bg = StompBrokerGetter(cp.get('broker', 'bdii'))
brokers = bg.get_broker_hosts_and_ports(service, cp.get('broker',
'network'))
except ConfigParser.NoOptionError as e:
try:
host = cp.get('broker', 'host')
port = cp.get('broker', 'port')
brokers = [(host, int(port))]
except ConfigParser.NoOptionError:
log.error('Options incorrectly supplied for either single '
'broker or broker network. '
'Please check configuration')
log.error('System will exit.')
log.info(LOG_BREAK)
sys.exit(1)
except ldap.SERVER_DOWN as e:
log.error('Could not connect to LDAP server: %s', e)
log.error('System will exit.')
log.info(LOG_BREAK)
sys.exit(1)

elif protocol == Ssm2.AMS_MESSAGING:
# Then we are setting up an SSM to connect to a AMS.

# 'use_ssl' isn't checked when using AMS (SSL is always used), but it
# is needed for the call to the Ssm2 constructor below.
use_ssl = None
try:
# We only need a hostname, not a port
host = cp.get('broker', 'host')
# Use brokers variable so subsequent code is not dependant on
# the exact destination type.
brokers = [host]

except ConfigParser.NoOptionError:
log.error('The host must be specified when connecting to AMS, '
'please check your configuration')
log.error('System will exit.')
log.info(LOG_BREAK)
print('SSM failed to start. See log file for details.')
sys.exit(1)

# Attempt to configure AMS specific variables.
try:
token = cp.get('messaging', 'token')
project = cp.get('messaging', 'ams_project')

except (ConfigParser.Error, ValueError, IOError) as err:
# A token and project are needed to successfully receive from an
# AMS instance, so log and then exit on an error.
log.error('Error configuring AMS values: %s', err)
log.error('SSM will exit.')
print('SSM failed to start. See log file for details.')
sys.exit(1)
brokers, project, token = ssm.agents.get_ssm_args(protocol, cp, log)

if len(brokers) == 0:
log.error('No brokers available.')
log.error('System will exit.')
log.info(LOG_BREAK)
sys.exit(1)

log.info('The SSM will run as a daemon.')

# We need to preserve the file descriptor for any log files.
rootlog = logging.getLogger()
log_files = [x.stream for x in rootlog.handlers]
dc = DaemonContext(files_preserve=log_files)

try:
ssm = Ssm2(brokers,
cp.get('messaging', 'path'),
cert=cp.get('certificates', 'certificate'),
key=cp.get('certificates', 'key'),
listen=cp.get('messaging', 'destination'),
use_ssl=use_ssl,
capath=cp.get('certificates', 'capath'),
check_crls=cp.getboolean('certificates', 'check_crls'),
pidfile=pidfile,
protocol=protocol,
project=project,
token=token)

log.info('Fetching valid DNs.')
dns = get_dns(options.dn_file)
ssm.set_dns(dns)

except Exception as e:
log.fatal('Failed to initialise SSM: %s', e)
log.info(LOG_BREAK)
sys.exit(1)

try:
# Note: because we need to be compatible with python 2.4, we can't use
# with dc:
# here - we need to call the open() and close() methods
# manually.
dc.open()
ssm.startup()
i = 0
# The message listening loop.
while True:
try:
time.sleep(0.1)
if protocol == Ssm2.AMS_MESSAGING:
# We need to pull down messages as part of
# this loop when using AMS.
ssm.pull_msg_ams()

if i % (REFRESH_DNS * 10) == 0:
log.info('Refreshing valid DNs and then sending ping.')
dns = get_dns(options.dn_file)
ssm.set_dns(dns)

if protocol == Ssm2.STOMP_MESSAGING:
ssm.send_ping()

except (NotConnectedException, AmsConnectionException) as error:
log.warn('Connection lost.')
log.debug(error)
ssm.shutdown()
dc.close()
log.info("Waiting for 10 minutes before restarting...")
time.sleep(10 * 60)
log.info('Restarting SSM.')
dc.open()
ssm.startup()

i += 1

except SystemExit as e:
log.info('Received the shutdown signal: %s', e)
ssm.shutdown()
dc.close()
except Exception as e:
log.error('Unexpected exception: %s', e)
log.error('Exception type: %s', e.__class__)
log.error('The SSM will exit.')
ssm.shutdown()
dc.close()

log.info('Receiving SSM has shut down.')
log.info(LOG_BREAK)
ssm.agents.run_receiver(protocol, brokers, project, token,
cp, log, options.dn_file)


if __name__ == '__main__':
Expand Down
Loading

0 comments on commit bb2f026

Please sign in to comment.