/
helios_job_submit.pl
196 lines (146 loc) · 5.37 KB
/
helios_job_submit.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
#!/usr/bin/env perl
use 5.008;
use strict;
use warnings;
use Helios::Job;
use Helios::Config;
our $VERSION = '2.82';
# CHANGES:
# 2012-01-22: Minor changes to comments.
# [LH] 2013-08-04: Changed service instantiation to use new Helios::Config API.
# [LH] [2013-10-28]: Updated to use Helios::Config and new Helios::Job API.
# Replaced all try {} with eval {}. Added --verbose option to return jobid.
# [LH] [2013-11-01]: changed cmd line arg parsing so -v and -n work as well as
# --verbose and --no-validate
# [LH] [2013-11-24]: Added new --verbose and jobtype documentation to POD.
# Removed old code already commented out.
# [LH] [2014-02-28]: Changed shebang line to use env instead of /usr/bin/perl.
# [LH] [2014-09-19]: Changed validateParamsXML() to return undef if the job
# arguments do not validate. [RT98845]
=head1 NAME
helios_job_submit.pl - Submit a job to the Helios job processing system from the cmd line
=head1 SYNOPSIS
helios_job_submit.pl [--verbose] [--no-validate] I<jobclass> [I<jobargs>]
helios_job_submit.pl MyService "<job>params><myarg1>myvalue1</myarg1></params></job>"
helios_job_submit.pl --help
=head1 DESCRIPTION
Use helios_job_submit.pl to submit a job to the Helios job processing system
from the command line or a shell script. In the simplest form, 2 options are
required. The first parameter is the jobtype (usually the name of your
service), and the second is the XML string representing the job's arguments.
If the second parameter is not given, helios_job_submit.pl will read the job
argument string from STDIN. If the job submission is successful, the command
will exit with an exitstatus of 0. If unsuccessful, the command will exit
with a non-zero status and will print the error to STDERR.
In addition to the normal command options, there are 2 optional parameters
that can be specified. These must be specified I<before> the jobtype and
argument string:
=over 4
=item --verbose
If --verbose is specified, the jobid of the new job is returned via STDOUT.
Without --verbose, the jobid is not returned; this is a backward compatibility
measure because Helios pre-2.80 did not return a jobid.
=item --no-validate
By default, Helios job argument strings are specified with an XML-like syntax.
The helios_job_submit.pl command attempts to insure your job argument string
is well-formed XML by default, but this can slow down the job submission
process. Specifying the --no-validate option will turn off the validation step
and will speed up the submission process. Keep in mind your job argument
XML will not be validated before submission.
=back
=cut
our $DEBUG_MODE = 0;
if (defined($ENV{HELIOS_DEBUG}) && $ENV{HELIOS_DEBUG} == 1) {
$DEBUG_MODE = 1;
}
our $VALIDATE = 1;
# BEGIN CODE Copyright (C) 2013 by Logical Helion, LLC.
# [LH] [2013-10-28]: Added --verbose option.
our $OPT_VERBOSE = 0;
our @OPTS = @ARGV;
foreach (@OPTS) {
last if !/^-/;
# END CODE Copyright (C) 2013 by Logical Helion, LLC.
if ( lc($_) eq '--no-validate' || lc($_) eq '-n') {
shift @ARGV;
$VALIDATE = 0;
}
if ( lc($_) eq '--verbose' || lc($_ eq '-v')) {
shift @ARGV;
$OPT_VERBOSE = 1;
}
}
our $JOB_CLASS = shift @ARGV;
our $PARAMS = shift @ARGV;
our $DATABASES_INFO;
our $VERBOSE = 0;
# print help if asked
if ( !defined($JOB_CLASS) || ($JOB_CLASS eq '--help') || ($JOB_CLASS eq '-h') ) {
require Pod::Usage;
Pod::Usage::pod2usage(-verbose => 2, -exitstatus => 0);
}
# BEGIN CODE Copyright (C) 2013 by Logical Helion, LLC.
my $config = Helios::Config->parseConfig();
# END CODE Copyright (C) 2013 by Logical Helion, LLC.
# if we were passed a <params> wodge of XML on the command line,
# try to validate it
# if we DIDN'T get a <params> wodge,
# then we have to assume it's coming from STDIN.
# which probably means it's a metajob
if ( !defined($PARAMS) ) {
# read them in from STDIN
while (<>) {
chomp;
$PARAMS .= $_;
}
}
# test the args before we submit
if ($VALIDATE) { validateParamsXML($PARAMS) or exit(1); }
my $j = Helios::Job->new();
$j->setConfig($config);
$j->setJobType($JOB_CLASS);
$j->setArgString($PARAMS);
my $jobid = $j->submit();
if ($DEBUG_MODE) {
print "Job submit successful. JOBID: ",$jobid,"\n";
}
# BEGIN CODE Copyright (C) 2013 by Logical Helion, LLC.
if ($OPT_VERBOSE && !$DEBUG_MODE) {
print "Jobid: $jobid\n";
}
# END CODE Copyright (C) 2013 by Logical Helion, LLC.
=head1 SUBROUTINES
=head2 validateParamsXML($xml)
Given a wodge of parameter XML (wrapped by <job><params></params></job> tags),
validateParamsXML returns a true value if the XML is valid, and a false value
if it isn't.
=cut
sub validateParamsXML {
my $arg = shift;
# [LH] [2013-10-28]: Replaced all try {} with eval {}
my $valid = 0;
eval {
$arg = Helios::Job->parseArgXML($arg);
$valid = 1;
1;
} or do {
my $E = $@;
warn("Invalid job arguments: $arg (", $E->text(),")\n");
return undef;
};
return 1;
}
=head1 SEE ALSO
L<Helios>, L<Helios::Job>
=head1 AUTHOR
Andrew Johnson, E<lt>lajandy at cpan dotorgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2008-9 by CEB Toolbox, Inc.
Portions of this software, where noted, are Copyright (C) 2013 by
Logical Helion, LLC.
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.0 or,
at your option, any later version of Perl 5 you may have available.
=head1 WARRANTY
This software comes with no warranty of any kind.
=cut