[pve-devel] [PATCH pve-client] cleanup: use nested CLIHandler command definitions
Dietmar Maurer
dietmar at proxmox.com
Wed Jun 13 07:28:05 CEST 2018
Signed-off-by: Dietmar Maurer <dietmar at proxmox.com>
---
PVE/APIClient/Helpers.pm | 44 +++++++++-
pveclient | 208 ++++++++++++++++++++++++++++-------------------
2 files changed, 165 insertions(+), 87 deletions(-)
diff --git a/PVE/APIClient/Helpers.pm b/PVE/APIClient/Helpers.pm
index d6d1a17..b83829b 100644
--- a/PVE/APIClient/Helpers.pm
+++ b/PVE/APIClient/Helpers.pm
@@ -15,6 +15,13 @@ my $pve_api_path_hash;
my $pve_api_definition_fn = "/usr/share/pve-client/pve-api-definition.dat";
+my $method_map = {
+ create => 'POST',
+ set => 'PUT',
+ get => 'GET',
+ delete => 'DELETE',
+};
+
my $build_pve_api_path_hash;
$build_pve_api_path_hash = sub {
my ($tree) = @_;
@@ -131,16 +138,49 @@ sub complete_api_path {
$info = $pve_api_path_hash->{"/$dir"};
}
+ my $res = [];
if ($info) {
if (my $children = $info->{children}) {
foreach my $c (@$children) {
if ($c->{path} =~ m!\Q$dir/$rest!) {
- print "$c->{path}\n";
- print "$c->{path}/\n"if $c->{children};
+ push @$res, $c->{path};
+ push @$res, "$c->{path}/" if $c->{children};
}
}
}
}
+ return $res;
+}
+
+# test for command lines with api calls (or similar bash completion calls):
+# example1: pveclient api get remote1 /cluster
+sub extract_path_info {
+
+ my $info;
+
+ my $test_path_properties = sub {
+ my ($args) = @_;
+
+ return if scalar(@$args) < 5;
+ return if $args->[1] ne 'api';
+
+ my $path = $args->[4];
+ if (my $method = $method_map->{$args->[2]}) {
+ $info = lookup_api_method($path, $method, 1);
+ }
+ };
+
+ if (defined(my $cmd = $ARGV[0])) {
+ if ($cmd eq 'api') {
+ $test_path_properties->([$0, @ARGV]);
+ } elsif ($cmd eq 'bashcomplete') {
+ my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT});
+ my $args = PVE::Tools::split_args($cmdline);
+ $test_path_properties->($args);
+ }
+ }
+
+ return $info;
}
1;
diff --git a/pveclient b/pveclient
index f18dab9..70db84a 100755
--- a/pveclient
+++ b/pveclient
@@ -1,5 +1,7 @@
#!/usr/bin/perl
+package PVE::CLI::pveclient;
+
use strict;
use warnings;
use Cwd 'abs_path';
@@ -7,7 +9,7 @@ use lib '/usr/share/pve-client';
use lib '.';
use Data::Dumper;
-use PVE::JSONSchema;
+use PVE::JSONSchema qw(register_standard_option get_standard_option);
use PVE::CLIHandler;
use PVE::APIClient::LWP;
@@ -21,97 +23,21 @@ use PVE::APIClient::Commands::help;
use JSON;
sub call_method {
- my ($path, $method, $args) = @_;
+ my ($remote, $path, $method, $params) = @_;
die "missing API path\n" if !defined($path);
my $info = PVE::APIClient::Helpers::lookup_api_method($path, $method);
- my $param = PVE::JSONSchema::get_options($info->{parameters}, $args);
- print Dumper($param);
+ print Dumper($params);
die "implement me";
}
+use base qw(PVE::CLIHandler);
-my $cli_class_handlers = {
- list => 'PVE::APIClient::Commands::list',
- lxc => 'PVE::APIClient::Commands::lxc',
- remote => 'PVE::APIClient::Commands::remote',
- config => 'PVE::APIClient::Commands::config',
- help => 'PVE::APIClient::Commands::help',
-};
-
-my $cmd = shift;
-if (!defined($cmd)) {
- PVE::APIClient::Commands::help->help({});
- exit(-1);
-}
-
-my $method_map = {
- create => 'POST',
- set => 'PUT',
- get => 'GET',
- delete => 'DELETE',
-};
-
-if (my $method = $method_map->{$cmd}) {
- my $path;
- if (scalar(@ARGV) && $ARGV[0] !~ m/^\-/) {
- $path = shift @ARGV;
- }
- my $res = call_method($path, $method, \@ARGV);
- die "implement me";
-} elsif (my $class = $cli_class_handlers->{$cmd}) {
- $class->run_cli_handler();
-} elsif ($cmd eq 'bashcomplete') {
-
- exit(0) if !(defined($ENV{COMP_LINE}) && defined($ENV{COMP_POINT}));
-
- my $cmdlist = join('|', keys %$cli_class_handlers);
- if ($ENV{COMP_LINE} =~ m/^(.*pveclient\s+($cmdlist)\s+)(.*)$/) {
- my $cmd = $2;
- my $class = $cli_class_handlers->{$cmd} || die "internal error";
-
- if ($cmd eq 'list') { # simple commands
- $ENV{COMP_LINE} = "pveclient $3";
- $ENV{COMP_POINT} = length($ENV{COMP_LINE});
- @ARGV = ('bashcomplete', 'pveclient', $ARGV[1], $ARGV[2]);
- } else {
- $ENV{COMP_LINE} = "pveclient $3";
- $ENV{COMP_POINT} = length($ENV{COMP_LINE});
- @ARGV = ('bashcomplete', 'pveclient', $ARGV[1], $ARGV[2]);
- }
- $class->run_cli_handler();
-
- } else {
-
- my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT});
- my ($bash_command, $cur, $prev) = @ARGV;
- $cmdline =~ s/\Q$cur\E$//;
-
- my $args = PVE::Tools::split_args($cmdline);
-
- my @cmds = (keys %$method_map, keys %$cli_class_handlers);
- if (scalar(@$args) == 1) {
- foreach my $p (@cmds) {
- print "$p\n" if $p =~ m/^$cur/;
- }
- } elsif (scalar(@$args) == 2) {
- if (my $method = $method_map->{$args->[1]}) {
- PVE::APIClient::Helpers::complete_api_path($cur);
- }
- } elsif (scalar(@$args) >= 3) {
- my $path = $args->[2];
- if (my $method = $method_map->{$args->[1]}) {
- if (my $info = PVE::APIClient::Helpers::lookup_api_method($path, $method, 1)) {
- my $prop = $info->{parameters}->{properties};
- PVE::APIClient::Helpers::complete_api_call_options($method, $prop, $prev, $cur, $args);
- }
- }
- }
- }
+my $cmd = $ARGV[0];
-} elsif ($cmd eq 'packagedepends') {
+if ($cmd && $cmd eq 'packagedepends') {
# experimental code to print required perl packages
my $packages = {};
my $dir = Cwd::getcwd;
@@ -129,8 +55,120 @@ if (my $method = $method_map->{$cmd}) {
}
}
print join("\n", sort(keys %$packages)) . "\n";
-} else {
- PVE::APIClient::Commands::help->help({});
+
+ exit(0);
+}
+
+my $path_properties = {};
+my $path_returns = { type => 'null' };
+
+# dynamically update schema definition for direct API call
+# like: pveclient api <get|set|create|delete|help> <remote> <path>
+if (my $info = PVE::APIClient::Helpers::extract_path_info()) {
+ $path_properties = $info->{parameters}->{properties};
+ $path_returns = $info->{returns};
}
-exit(0);
+$path_properties->{remote} = get_standard_option('pveclient-remote-name');
+$path_properties->{api_path} = {
+ description => "API path.",
+ type => 'string',
+ completion => sub {
+ my ($cmd, $pname, $cur, $args) = @_;
+ return PVE::APIClient::Helpers::complete_api_path($cur);
+ },
+};
+
+__PACKAGE__->register_method ({
+ name => 'pveclient_get',
+ path => 'pveclient_get',
+ method => 'GET',
+ description => "call API GET on <path>.",
+ parameters => {
+ additionalProperties => 0,
+ properties => $path_properties,
+ },
+ returns => $path_returns,
+ code => sub {
+ my ($param) = @_;
+
+ my $path = PVE::Tools::extract_param($param, 'api_path');
+ my $remote = PVE::Tools::extract_param($param, 'remote');
+
+ return call_method($remote, $path, 'GET', $param);
+ }});
+
+__PACKAGE__->register_method ({
+ name => 'pveclient_set',
+ path => 'pveclient_set',
+ method => 'PUT',
+ description => "call API PUT on <path>.",
+ parameters => {
+ additionalProperties => 0,
+ properties => $path_properties,
+ },
+ returns => $path_returns,
+ code => sub {
+ my ($param) = @_;
+
+ print Dumper($param);
+
+ die "implement me";
+
+ }});
+
+__PACKAGE__->register_method ({
+ name => 'pveclient_create',
+ path => 'pveclient_create',
+ method => 'PUSH',
+ description => "call API PUSH on <path>.",
+ parameters => {
+ additionalProperties => 0,
+ properties => $path_properties,
+ },
+ returns => $path_returns,
+ code => sub {
+ my ($param) = @_;
+
+ print Dumper($param);
+
+ die "implement me";
+
+ }});
+
+__PACKAGE__->register_method ({
+ name => 'pveclient_delete',
+ path => 'pveclient_delete',
+ method => 'DELETE',
+ description => "call API DELETE on <path>.",
+ parameters => {
+ additionalProperties => 0,
+ properties => $path_properties,
+ },
+ returns => $path_returns,
+ code => sub {
+ my ($param) = @_;
+
+ print Dumper($param);
+
+ die "implement me";
+
+ }});
+
+
+our $cmddef = {
+ config => $PVE::APIClient::Commands::config::cmddef,
+ list => $PVE::APIClient::Commands::list::cmddef,
+ lxc => $PVE::APIClient::Commands::lxc::cmddef,
+ remote => $PVE::APIClient::Commands::remote::cmddef,
+
+ api => {
+ get => [ __PACKAGE__, 'pveclient_get', ['remote', 'api_path']],
+ set => [ __PACKAGE__, 'pveclient_set', ['remote', 'api_path']],
+ create => [ __PACKAGE__, 'pveclient_create', ['remote', 'api_path']],
+ delete => [ __PACKAGE__, 'pveclient_delete', ['remote', 'api_path']],
+ }
+};
+
+
+__PACKAGE__->run_cli_handler();
--
2.11.0
More information about the pve-devel
mailing list