arif/xcat-core
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

started the table api calls

Browse Source
This commit is contained in:
Bruce Potter 2014-03-16 19:54:00 -04:00
parent 7f63cf564c
commit 3eaf383163
2 changed files with 164 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

199
xCAT-server/xCAT-wsapi/restapi.pl
View File

@ -12,6 +12,7 @@ use IO::Socket::SSL;
use lib "/opt/xcat/lib/perl";
use xCAT::Table;
#bmp: you need more comments in most of the file, especially in the handler routines
#URIdef{node|network}->{allnode|nodeattr}
@ -412,8 +413,34 @@ my %URIdef = (
},
},
#### definition for database resources
database => {
#### definition for database/table resources
table => {
table_nodes_allattr => {
desc => "[URI:/table/{table}/{noderange}] - The table resource",
matcher => '^\/table\/[^\/]*\/[^\/]*$',
GET => {
desc => "Get all the attibutes for noderange {noderange} of the table {table}.",
cmd => "getNodesAttribs",
fhandler => \&tablehdl,
outhdler => \&tableout,
},
PUT => {
desc => "Change the attibutes for the table {table}.",
cmd => "chdef",
fhandler => \&defhdl,
#outhdler => \&defout,
},
POST => {
desc => "Create the table {table}. DataBody: {attr1:v1,att2:v2...}.",
cmd => "mkdef",
fhandler => \&defhdl,
},
DELETE => {
desc => "Remove the table {table}.",
cmd => "rmdef",
fhandler => \&defhdl,
},
},
},
);
@ -472,10 +499,10 @@ my $q = CGI->new;
my $pathInfo = $q->path_info; # the resource specification, i.e. everything in the url after xcatws
#my $requestType = $ENV{'REQUEST_METHOD'};
my $requestType = $q->request_method(); # GET, PUT, POST, PATCH, DELETE
my $queryString = $ENV{'QUERY_STRING'}; #todo: remove this when not used any more
#my $queryString = $ENV{'QUERY_STRING'}; #todo: remove this when not used any more
#my $userAgent = $ENV{'HTTP_USER_AGENT'}; # curl, etc.
my $userAgent = $q->user_agent(); # the client program: curl, etc.
my %queryhash; # the queryString will get put into this
#my %queryhash; # the queryString will get put into this
my @path = split(/\//, $pathInfo);
#shift(@path); # get rid of the initial /
#my $resource = $path[0];
@ -514,7 +541,9 @@ if ($ARGV[0] eq "-h") {
}
my $JSON; # global ptr to the json object. Its set by loadJSON()
if (isPut() || isPost()) { loadJSON(); } # need to do this early, so we can fetch the params
#if (isPut() || isPost()) {
loadJSON(); # need to do this early, so we can fetch the params
#}
# the input parameters from both the url and put/post data will combined and then
# separated into the general params (not specific to the api call) and params specific to the call
@ -533,27 +562,27 @@ $format = $generalparams->{format} if (defined ($generalparams->{format}));
$pathInfo =~ s/\/$//;
# Get the payload format from the end of URI
if ($pathInfo =~ /\.json$/) {
$format = "json";
$pathInfo =~ s/\.json$//;
} elsif ($pathInfo =~ /\.json.pretty$/) {
$format = "json";
$pretty = 1;
$pathInfo =~ s/\.json.pretty$//;
} elsif ($pathInfo =~ /\.xml$/) {
$format = "xml";
$pathInfo =~ s/\.xml$//;
} elsif ($pathInfo =~ /\.html$/) {
$format = "html";
$pathInfo =~ s/\.html$//;
}
#if ($pathInfo =~ /\.json$/) {
# $format = "json";
# $pathInfo =~ s/\.json$//;
#} elsif ($pathInfo =~ /\.json.pretty$/) {
# $format = "json";
# $pretty = 1;
# $pathInfo =~ s/\.json.pretty$//;
#} elsif ($pathInfo =~ /\.xml$/) {
# $format = "xml";
# $pathInfo =~ s/\.xml$//;
#} elsif ($pathInfo =~ /\.html$/) {
# $format = "html";
# $pathInfo =~ s/\.html$//;
#}
if (!exists $formatters{$format}) {
error("The format '$format' is not supported",$STATUS_BAD_REQUEST);
}
#if (!exists $formatters{$format}) {
# error("The format '$format' is not supported",$STATUS_BAD_REQUEST);
#}
if ($format eq 'json') {
loadJSON(); # in case it was not loaded before
# loadJSON(); # in case it was not loaded before
if ($generalparams->{pretty}) { $JSON->indent(1); }
}
@ -568,6 +597,7 @@ $XML::Simple::PREFERRED_PARSER = 'XML::Parser';
# Match the first layer of resource URI
my $uriLayer1;
#bmp: why can't you just split on "/" like xcatws.cgi did?
# Get all the layers in the URI
my @layers;
my $portion = index($pathInfo, '/');
@ -596,24 +626,26 @@ if ($#layers < 0) {
}
# set the user and password to access xcatd
#todo: replace with using certificates or an api key
$request->{becomeuser}->[0]->{username}->[0] = $ENV{userName} if (defined($ENV{userName}));
$request->{becomeuser}->[0]->{username}->[0] = $generalparams->{userName} if (defined($generalparams->{userName}));
$request->{becomeuser}->[0]->{password}->[0] = $ENV{password} if (defined($ENV{password}));
$request->{becomeuser}->[0]->{password}->[0] = $generalparams->{password} if (defined($generalparams->{password}));
# find and invoke the correct handler and output handler functions
my $outputdata;
my $handled;
if (defined ($URIdef{$uriLayer1})) {
# Make sure the resource has been defined
foreach my $res (keys %{$URIdef{$uriLayer1}}) {
my $matcher = $URIdef{$uriLayer1}->{$res}->{matcher};
#bmp: if you use m|$matcher| here instead then you won't need to escape all of the /'s ?
if ($pathInfo =~ /$matcher/) {
# matched to a resource
if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{fhandler})) {
if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{fhandler})) { #bmp: if there isn't a handler, shouldn't we error out?
my $params;
unless (defined ($URIdef{$uriLayer1}->{$res}->{$requestType})) {
addPageContent("request method '$requestType' is not supported on resource '$pathInfo'");
sendResponseMsg($STATUS_NOT_ALLOWED);
unless (defined ($URIdef{$uriLayer1}->{$res}->{$requestType})) { #bmp: how can this not be defined if we got here?
error("request method '$requestType' is not supported on resource '$pathInfo'",$STATUS_NOT_ALLOWED);
}
$params->{'cmd'} = $URIdef{$uriLayer1}->{$res}->{$requestType}->{cmd} if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{cmd}));
$params->{'outputhdler'} = $URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler} if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler}));
@ -626,7 +658,7 @@ if (defined ($URIdef{$uriLayer1})) {
$outputdata = $URIdef{$uriLayer1}->{$res}->{$requestType}->{fhandler}->($params);
# Filter the output data from the response
$outputdata = filterData ($outputdata);
# Resture the output data
# Restructure the output data
if (defined ($URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler})) {
$outputdata = $URIdef{$uriLayer1}->{$res}->{$requestType}->{outhdler}->($outputdata, $params);
} else {
@ -642,20 +674,14 @@ if (defined ($URIdef{$uriLayer1})) {
}
}
} else {
addPageContent("Unspported resource.");
sendResponseMsg($STATUS_NOT_FOUND);
error("Unspported resource.",$STATUS_NOT_FOUND);
}
unless ($handled) {
addPageContent("Unspported resource.");
sendResponseMsg($STATUS_NOT_FOUND);
error("Unspported resource1.",$STATUS_NOT_FOUND);
}
# all output has been added into the global varibale pageContent, call the response funcion
#if (exists $data->[0]->{info} && $data->[0]->{info}->[0] =~ /Could not find an object/) {
# sendResponseMsg($STATUS_NOT_FOUND);
@ -801,6 +827,8 @@ sub defout_1 {
return \@output;
}
# invoke one of the def cmds
sub defhdl {
my $params = shift;
@ -861,8 +889,7 @@ sub actionhdl {
#my @v = keys(%$paramhash);
push @args, $paramhash->{'action'};
} else {
addPageContent("Missed Action.");
sendResponseMsg($STATUS_NOT_FOUND);
error("Missed Action.",$STATUS_NOT_FOUND);
}
}
@ -873,6 +900,44 @@ sub actionhdl {
return $responses;
}
# get all attrs of 1 table for a noderange
sub tablehdl {
my $params = shift;
my @args;
my @urilayers = @{$params->{'layers'}};
# set the command name
$request->{command} = $params->{'cmd'};
# the uri is /table/<tablename>/<noderange>
if (defined($urilayers[1])) { $request->{table} = $urilayers[1]; }
if (defined($urilayers[2])) { $request->{noderange} = $urilayers[2]; }
# attr=ALL means get all non-blank attributes
$request->{attr} = 'ALL';
my $req = genRequest();
my $responses = sendRequest($req, 1);
return $responses;
}
# parse the output of all attrs of 1 table for a noderange
sub tableout {
my $data = shift;
my $json;
# each element is a hash with 1 key called "node" that has a 1 element array that has the node hash
foreach my $d (@$data) {
my $jsonnode = $d->{node};
debug(Dumper($d)); debug (Dumper($jsonnode));
if (!defined($jsonnode)) { error('improperly formatted output from xcatd', $STATUS_TEAPOT); }
push @$json, $jsonnode;
}
addPageContent($JSON->encode($json));
}
sub displayUsage {
foreach my $group (keys %URIdef) {
print "Resource Group: $group\n";
@ -897,16 +962,11 @@ sub displayUsage {
# Format the output data the way the user requested. All data wrapping and writing is funneled through here.
# This will call one of the other wrap*() functions.
# This handles and removes serverdone and error tags in the perl data structure that is from the xml that xcatd returned
#bmp: is there a way to avoid make a copy of the whole response? For big output that could be time consuming.
# For the error tag, you don't have to bother copying the response, because you are going to exit anyway.
# Maybe this function could just verify there is a serverdone and handle any error, and then
# let the output handler ignore the serverdone tag?
sub filterData {
my $data = shift;
my $errorInformation = '';
@ -914,8 +974,8 @@ sub filterData {
my $outputdata;
#trim the serverdone message off
foreach (@{$data}) {
if (defined ($_->{serverdone}) || defined($_->{error})) {
if (defined ($_->{serverdone}) && defined($_->{error})) {
if (exists($_->{serverdone}) || defined($_->{error})) {
if (exists($_->{serverdone}) && defined($_->{error})) {
$errorInformation = $_->{error}->[0];
addPageContent($q->p($errorInformation));
if (($errorInformation =~ /Permission denied/) || ($errorInformation =~ /Authentication failure/)) {
@ -954,6 +1014,7 @@ sub wrapJson {
}
#bmp: this isn't used anymore, just here for reference, right?
# structure the json output for node resource api calls
sub wrapJsonNodes {
# this is an array of responses from xcatd. Often all the output comes back in 1 response, but not always.
@ -1114,6 +1175,7 @@ sub genRequest {
# The response returned to the caller of this function has already been converted from xml to perl structure.
sub sendRequest {
my $request = shift;
my $noarray = shift; # optional arg to not set ForceArray on the XMLin() call
my $sitetab;
my $retries = 0;
@ -1173,9 +1235,12 @@ sub sendRequest {
#addPageContent("DEBUG: response from xcatd: " . $response . "\n");
}
$response =~ s/\e/xxxxESCxxxx/g;
debug("response xml=$response");
#print "responseXML is ".$response;
$rsp = XML::Simple::XMLin($response, SuppressEmpty => undef, ForceArray => 1);
#bmp: i added the $noarray option because for the table output it saved me processing if everything
# wasn't forced into arrays. Consider if that could save you processing on other api calls too.
$rsp = XML::Simple::XMLin($response, SuppressEmpty => undef, ForceArray => (!$noarray));
debug(Dumper($rsp));
#add ESC back
foreach my $key (keys %$rsp) {
@ -1192,7 +1257,7 @@ sub sendRequest {
$response = '';
push(@$fullResponse, $rsp);
if ($rsp->{serverdone}) {
if (exists($rsp->{serverdone})) {
$cleanexit = 1;
last;
}
@ -1210,7 +1275,7 @@ sub sendRequest {
# Put input parameters from both $q->url_param and put/post data (if it exists) into generalparams and paramhash for all to use
sub fetchParameters {
my @generalparamlist = qw(userName password format pretty debug);
my @generalparamlist = qw(userName password pretty debug);
# 1st check for put/post data and put that in the hash
my $pdata;
if (isPut()) { $pdata = $q->param('PUTDATA'); }
@ -1261,14 +1326,15 @@ sub loadJSON {
}
# add a error msg to the output in the correct format and end this request
#todo: replace all addPageContent/sendResponseMsg pairs to call this function instead
sub error {
my ($msg, $errorcode) = @_;
my $severity = 'error';
my $m;
if ($format eq 'xml') { $m = "<$severity>$msg</$severity>\n"; }
elsif ($format eq 'json') { $m = qq({"$severity":"$msg"}\n); }
else { $m = "<p>$severity: $msg</p>\n"; }
#if ($format eq 'xml') { $m = "<$severity>$msg</$severity>\n"; }
#elsif ($format eq 'json') {
$m = qq({"$severity":"$msg"}\n);
#}
#else { $m = "<p>$severity: $msg</p>\n"; }
addPageContent($m);
sendResponseMsg($errorcode);
}
@ -1290,7 +1356,7 @@ sub displaydebugmsg {
addPageContent($q->p("DEBUG: generalparams:". Dumper($generalparams)));
addPageContent($q->p("DEBUG: paramhash:". Dumper($paramhash)));
addPageContent($q->p("DEBUG: q->request_method: $requestType\n"));
addPageContent($q->p("DEBUG: q->user_agent: $userAgent\n"));
#addPageContent($q->p("DEBUG: q->user_agent: $userAgent\n"));
addPageContent($q->p("DEBUG: pathInfo: $pathInfo\n"));
#addPageContent($q->p("DEBUG: path " . Dumper(@path) . "\n"));
#foreach (keys(%ENV)) { addPageContent($q->p("DEBUG: ENV{$_}: $ENV{$_}\n")); }
@ -1302,3 +1368,18 @@ sub displaydebugmsg {
sendResponseMsg($STATUS_OK); # this will also exit
}
}
# push flags (options) onto the xcatd request. Arguments: request args array, flags array.
# Format of flags array: <urlparam-name> <xdsh-cli-flag> <if-there-is-associated-value>
# Use this function for cmds with a lot of flags like xdcp and xdsh
sub pushFlags {
my ($args, $flags) = @_;
foreach my $f (@$flags) {
my ($key, $flag, $arg) = @$f;
if (defined($paramhash->{$key})) {
push @$args, $flag;
if ($arg) { push @$args, $paramhash->{$key}; }
}
}
}

45
xCAT-server/xCAT-wsapi/xcatws-test.sh
View File

@ -42,80 +42,83 @@ function chkrc
#todo: add a test case for every api call that is documented
set -x
# clean up from last time
curl -# -X DELETE -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw" >/dev/null; echo ''
curl -# -X DELETE -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw" >/dev/null; echo ''
# create test nodes
curl -# -X POST -k "https://127.0.0.1/xcatws/nodes/wstest1-wstest2?userName=$user&password=$pw&$format" $ctype --data '{"groups":"wstest","netboot":"xnba"}' \
curl -# -X POST -k "https://127.0.0.1/xcatws/node/wstest1-wstest2?userName=$user&password=$pw&$format" $ctype --data '{"groups":"wstest","netboot":"xnba"}' \
| grep -q '2 object definitions have been created'; chkrc
# list all nodes and make sure they are in the list
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node?userName=$user&password=$pw&$format" \
| pcregrep -qM '"wstest1",\n\s*"wstest2"'; chkrc
# list all node's group and netboot attributes
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes?userName=$user&password=$pw&field=groups&field=netboot" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node?userName=$user&password=$pw&field=groups&field=netboot" \
| grep -qE '"nodename":"wstest1".*"groups":"wstest"'; chkrc
# list all attributes of all nodes
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes?userName=$user&password=$pw&field=ALL" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node?userName=$user&password=$pw&field=ALL" \
| grep -qE '"nodename":"wstest1".*"groups":"wstest"'; chkrc
# list the noderange and make sure they are in the list
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw&$format" \
| pcregrep -qM '"wstest1",\n\s*"wstest2"'; chkrc
# list all node's group and netboot attributes
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw&field=groups&field=netboot" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw&field=groups&field=netboot" \
| grep -qE '"nodename":"wstest1".*"groups":"wstest"'; chkrc
# list all attributes of all nodes
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw&field=ALL" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw&field=ALL" \
| grep -qE '"nodename":"wstest1".*"groups":"wstest"'; chkrc
# change some attributes
curl -# -X PUT -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw&$format" $ctype --data '{"room":"222","netboot":"pxe"}' \
curl -# -X PUT -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw&$format" $ctype --data '{"room":"222","netboot":"pxe"}' \
| grep -q '2 object definitions have been created or modified'; chkrc
# verify they got the new values
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw&field=room&field=netboot" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw&field=room&field=netboot" \
| grep -qE '"nodename":"wstest1".*"room":"222"'; chkrc
# delete the nodes
curl -# -X DELETE -k "https://127.0.0.1/xcatws/nodes/wstest?userName=$user&password=$pw&$format" \
curl -# -X DELETE -k "https://127.0.0.1/xcatws/node/wstest?userName=$user&password=$pw&$format" \
| grep -q '2 object definitions have been removed'; chkrc
# list all nodes and make sure they are not in the list
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node?userName=$user&password=$pw&$format" \
| pcregrep -qM '"wstest1",\n\s*"wstest2"'; chkrc not
# list the power state of the noderange
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/$nr/power?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/$nr/power?userName=$user&password=$pw&$format" \
| grep -q '"power":"on"'; chkrc
# list the nodestat state of the noderange
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/$nr/status?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/$nr/status?userName=$user&password=$pw&$format" \
| grep -q '":"sshd"'; chkrc
# list the node inventory of the noderange
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/$nr/inventory?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/$nr/inventory?userName=$user&password=$pw&$format" \
| grep -q '"Board manufacturer":"IBM"'; chkrc
# list the node vitals of the noderange
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/$nr/vitals?userName=$user&password=$pw&$format" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/$nr/vitals?userName=$user&password=$pw&$format" \
| grep -q '"Cooling Fault":"false"'; chkrc
# list the node energy settings of the noderange
curl -# -X GET -k "https://127.0.0.1/xcatws/nodes/$nr/energy?userName=$user&password=$pw&$format&field=cappingstatus&field=cappingmaxmin" \
curl -# -X GET -k "https://127.0.0.1/xcatws/node/$nr/energy?userName=$user&password=$pw&$format&field=cappingstatus&field=cappingmaxmin" \
| grep -q '"cappingstatus":"off"'; chkrc
# run a cmd on the noderange
curl -# -X POST -k "https://127.0.0.1/xcatws/nodes/$nr/dsh?userName=$user&password=$pw&$format" $ctype --data '{"command":"pwd"}' \
curl -# -X POST -k "https://127.0.0.1/xcatws/node/$nr/dsh?userName=$user&password=$pw&$format" $ctype --data '{"command":"pwd"}' \
| grep -q '"/root"'; chkrc
# copy a file to the noderange
curl -# -X POST -k "https://127.0.0.1/xcatws/nodes/$nr/dcp?userName=$user&password=$pw&$format" $ctype --data '{"source":"/root/.bashrc","target":"/tmp/"}' \
curl -# -X POST -k "https://127.0.0.1/xcatws/node/$nr/dcp?userName=$user&password=$pw&$format" $ctype --data '{"source":"/root/.bashrc","target":"/tmp/"}' \
| grep -q '"errorcode":"0"'; chkrc
# test the table calls
#curl -# -X GET -k "https://127.0.0.1/xcatws/table/nodelist/test001?userName=$user&password=$pw&$format"
exit
@ -128,5 +131,5 @@ exit
#curl -X GET -k "https://127.0.0.1/xcatws/images/bp-netboot?userName=$user&password=$pw&$format&field=osvers"
#todo: remove when these test cases are in xcatws-test.pl
#./xcatws-test.pl -u "https://127.0.0.1/xcatws/nodes/test001?userName=$user&password=$pw" -m GET
#./xcatws-test.pl -u "https://127.0.0.1/xcatws/nodes/test001?userName=$user&password=$pw" -m PUT "nodepos.room=foo"
#./xcatws-test.pl -u "https://127.0.0.1/xcatws/node/test001?userName=$user&password=$pw" -m GET
#./xcatws-test.pl -u "https://127.0.0.1/xcatws/node/test001?userName=$user&password=$pw" -m PUT "nodepos.room=foo"