-#!/usr/bin/env python
+#!/usr/bin/env python3
# Generates samba network traffic
#
# Copyright (C) Catalyst IT Ltd. 2017
def main():
- desc = ("Generates network traffic 'conversations' based on <summary-file>"
- " (which should be the output file produced by either traffic_learner"
- " or traffic_summary.pl). This traffic is sent to <dns-hostname>,"
+ desc = ("Generates network traffic 'conversations' based on a model generated"
+ " by script/traffic_learner. This traffic is sent to <dns-hostname>,"
" which is the full DNS hostname of the DC being tested.")
parser = optparse.OptionParser(
- "%prog [--help|options] <summary-file> <dns-hostname>",
+ "%prog [--help|options] <model-file> <dns-hostname>",
description=desc)
parser.add_option('--dns-rate', type='float', default=0,
help='fire extra DNS packets at this rate')
+ parser.add_option('--dns-query-file', dest="dns_query_file",
+ help='A file contains DNS query list')
parser.add_option('-B', '--badpassword-frequency',
type='float', default=0.0,
help='frequency of connections with bad passwords')
parser.add_option('-c', '--clean-up',
action="store_true",
help='Clean up the generated groups and user accounts')
- parser.add_option('--random-seed', type='int', default=0,
+ parser.add_option('--random-seed', type='int', default=None,
help='Use to keep randomness consistent across multiple runs')
-
+ parser.add_option('--stop-on-any-error',
+ action="store_true",
+ help='abort the whole thing if a child fails')
model_group = optparse.OptionGroup(parser, 'Traffic Model Options',
'These options alter the traffic '
- 'generated when the summary-file is a '
- 'traffic-model (produced by '
- 'traffic_learner)')
- model_group.add_option('-S', '--scale-traffic', type='float', default=1.0,
- help='Increase the number of conversations by '
- 'this factor')
- model_group.add_option('-D', '--duration', type='float', default=None,
+ 'generated by the model')
+ model_group.add_option('-S', '--scale-traffic', type='float',
+ help=('Increase the number of conversations by '
+ 'this factor (or use -T)'))
+ parser.add_option('-T', '--packets-per-second', type=float,
+ help=('attempt this many packets per second '
+ '(alternative to -S)'))
+ parser.add_option('--old-scale',
+ action="store_true",
+ help='emulate the old scale for traffic')
+ model_group.add_option('-D', '--duration', type='float', default=60.0,
help=('Run model for this long (approx). '
'Default 60s for models'))
+ model_group.add_option('--latency-timeout', type='float', default=None,
+ help=('Wait this long for last packet to finish'))
model_group.add_option('-r', '--replay-rate', type='float', default=1.0,
help='Replay the traffic faster by this factor')
+ model_group.add_option('--conversation-persistence', type='float',
+ default=0.0,
+ help=('chance (0 to 1) that a conversation waits '
+ 'when it would have died'))
model_group.add_option('--traffic-summary',
help=('Generate a traffic summary file and write '
'it here (- for stdout)'))
'the traffic')
user_gen_group.add_option('-n', '--number-of-users', type='int', default=0,
help='Total number of test users to create')
- user_gen_group.add_option('--number-of-groups', type='int', default=0,
+ user_gen_group.add_option('--number-of-groups', type='int', default=None,
help='Create this many groups')
user_gen_group.add_option('--average-groups-per-user',
type='int', default=0,
# First ensure we have reasonable arguments
if len(args) == 1:
- summary = None
+ model_file = None
host = args[0]
elif len(args) == 2:
- summary, host = args
+ model_file, host = args
else:
parser.print_usage()
return
traffic.clean_up_accounts(ldb, opts.instance_id)
exit(0)
- if summary:
- if not os.path.exists(summary):
- logger.error("Summary file %s doesn't exist" % summary)
+ if model_file:
+ if not os.path.exists(model_file):
+ logger.error("Model file %s doesn't exist" % model_file)
sys.exit(1)
- # the summary-file can be ommitted for --generate-users-only and
+ # the model-file can be ommitted for --generate-users-only and
# --cleanup-up, but it should be specified in all other cases
elif not opts.generate_users_only:
- logger.error("No summary-file specified to replay traffic from")
+ logger.error("No model file specified to replay traffic from")
sys.exit(1)
if not opts.fixed_password:
" for the users created as part of this test"))
sys.exit(1)
- if opts.random_seed:
+ if opts.random_seed is not None:
random.seed(opts.random_seed)
creds = credopts.get_credentials(lp)
logger.error("--group-memberships requires --number-of-groups")
sys.exit(1)
+ if opts.scale_traffic is not None and opts.packets_per_second is not None:
+ logger.error("--scale-traffic and --packets-per-second "
+ "are incompatible. Use one or the other.")
+ sys.exit(1)
+
+ if not opts.scale_traffic and not opts.packets_per_second:
+ logger.info("No packet rate specified. Using --scale-traffic=1.0")
+ opts.scale_traffic = 1.0
+
if opts.timing_data not in ('-', None):
try:
open(opts.timing_data, 'w').close()
open(opts.traffic_summary, 'w').close()
except IOError:
# exception info will be added to log automatically
+ if debuglevel > 0:
+ import traceback
+ traceback.print_exc()
logger.exception(("the supplied traffic summary destination "
"(%s) is not writable" % opts.traffic_summary))
sys.exit()
- duration = opts.duration
- if duration is None:
- duration = 60.0
+ if opts.old_scale:
+ # we used to use a silly calculation based on the number
+ # of conversations; now we use the number of packets and
+ # scale traffic accurately. To roughly compare with older
+ # numbers you use --old-scale which approximates as follows:
+ opts.scale_traffic *= 0.55
- # ingest the model or traffic summary
- if summary:
+ # ingest the model
+ if model_file and not opts.generate_users_only:
+ model = traffic.TrafficModel()
try:
- conversations, interval, duration, dns_counts = \
- traffic.ingest_summaries([summary])
-
- logger.info(("Using conversations from the traffic summary "
- "file specified"))
-
- # honour the specified duration if it's different to the
- # capture duration
- if opts.duration is not None:
- duration = opts.duration
-
- except ValueError as e:
- if not str(e).startswith('need more than'):
- raise
-
- model = traffic.TrafficModel()
-
- try:
- model.load(summary)
- except ValueError:
- logger.error(("Could not parse %s. The summary file "
- "should be the output from either the "
- "traffic_summary.pl or "
- "traffic_learner scripts.") % summary)
- sys.exit()
-
- logger.info(("Using the specified model file to "
- "generate conversations"))
+ model.load(model_file)
+ except ValueError:
+ if debuglevel > 0:
+ import traceback
+ traceback.print_exc()
+ logger.error(("Could not parse %s, which does not seem to be "
+ "a model generated by script/traffic_learner."
+ % model_file))
+ sys.exit(1)
- conversations = model.generate_conversations(opts.scale_traffic,
- duration,
- opts.replay_rate)
+ logger.info(("Using the specified model file to "
+ "generate conversations"))
+ if opts.scale_traffic:
+ packets_per_second = model.scale_to_packet_rate(opts.scale_traffic)
+ else:
+ packets_per_second = opts.packets_per_second
+
+ conversations = \
+ model.generate_conversation_sequences(
+ packets_per_second,
+ opts.duration,
+ opts.replay_rate,
+ opts.conversation_persistence)
else:
conversations = []
- if debuglevel > 5:
- for c in conversations:
- for p in c.packets:
- print(" ", p, file=sys.stderr)
-
- print('=' * 72, file=sys.stderr)
-
if opts.number_of_users and opts.number_of_users < len(conversations):
logger.error(("--number-of-users (%d) is less than the "
"number of conversations to replay (%d)"
sys.exit(1)
number_of_users = max(opts.number_of_users, len(conversations))
+
+ if opts.number_of_groups is None:
+ opts.number_of_groups = max(int(number_of_users / 10), 1)
+
max_memberships = number_of_users * opts.number_of_groups
if not opts.group_memberships and opts.average_groups_per_user:
opts.number_of_groups)))
sys.exit(1)
+ # if no groups were specified by the user, then make sure we create some
+ # group memberships (otherwise it's not really a fair test)
+ if not opts.group_memberships and not opts.average_groups_per_user:
+ opts.group_memberships = min(number_of_users * 5, max_memberships)
+
# Get an LDB connection.
try:
# if we're only adding users, then it's OK to pass a sam.ldb filepath
logger.info("Writing traffic summary")
summaries = []
- for c in conversations:
+ for c in traffic.seq_to_conversations(conversations):
summaries += c.replay_as_summary_lines()
summaries.sort()
exit(0)
- traffic.replay(conversations, host,
+ traffic.replay(conversations,
+ host,
lp=lp,
creds=creds,
accounts=accounts,
dns_rate=opts.dns_rate,
- duration=duration,
+ dns_query_file=opts.dns_query_file,
+ duration=opts.duration,
+ latency_timeout=opts.latency_timeout,
badpassword_frequency=opts.badpassword_frequency,
prefer_kerberos=opts.prefer_kerberos,
statsdir=statsdir,
base_dn=ldb.domain_dn(),
ou=traffic.ou_name(ldb, opts.instance_id),
tempdir=tempdir,
- domain_sid=ldb.get_domain_sid())
+ stop_on_any_error=opts.stop_on_any_error,
+ domain_sid=ldb.get_domain_sid(),
+ instance_id=opts.instance_id)
if opts.timing_data == '-':
timing_dest = sys.stdout
if not opts.preserve_tempdir:
logger.info("Removing temporary directory")
shutil.rmtree(tempdir)
-
+ else:
+ # delete the empty directories anyway. There are thousands of
+ # them and they're EMPTY.
+ for d in os.listdir(tempdir):
+ if d.startswith('conversation-'):
+ path = os.path.join(tempdir, d)
+ try:
+ os.rmdir(path)
+ except OSError as e:
+ logger.info("not removing %s (%s)" % (path, e))
main()