DHCP plugin updates

Add tests, adapted from aii-core. Replace bare open() with
CAF::FileReader to make the tests work. Include some improvements which
accumulated on our side.

aii-core/src/main/perl/Shellfe.pm

@@ -43,6 +43,7 @@ use constant PROFILEINFO => 'profiles-info.xml';
 use constant NODHCP => 'nodhcp';
 use constant NONBP => 'nonbp';
 use constant NOOSINSTALL=> 'noosinstall';
+use constant DISCOVERY => '/system/aii/discovery';
 use constant OSINSTALL => '/system/aii/osinstall';
 use constant NBP => '/system/aii/nbp';
 use constant CDBURL => 'cdburl';
@@ -537,6 +538,10 @@ sub dhcp
 {
  my ($self, $node, $st, $cmd, $dhcpmgr) = @_;
 
+ # If the profile has a discovery plugin configured, then don't second-guess
+ # it - it may or may not be ISC DHCP
+ return if $st->{configuration}->elementExists (DISCOVERY);
+
  return unless $st->{configuration}->elementExists (DHCPPATH);
 
  my $mac;

aii-dhcp/src/main/pan/quattor/aii/dhcp/config.pan

@@ -2,24 +2,31 @@
 # ${developer-info}
 # ${author-info}
 # ${build-info}
-template quattor/aii/${project.artifactId}/config;
+template quattor/aii/dhcp/config;
 
-include 'quattor/aii/${project.artifactId}/schema';
+include 'quattor/aii/dhcp/schema';
 
-# TFTP server
-# This is optional. Only it is necessary if your TFTP server is running on
-# a different machine than the DHCP server
-#
-# "/system/aii/dhcp/options/tftpserver" = "tftp.mydomain.org"
-#
+bind "/system/aii/discovery/dhcp" = structure_dhcp_module_info;
+
+prefix "/system/aii/discovery/dhcp";
+
+@documentation{
+ Enable the plugin
+}
+"enabled" = true;
+
+bind "/system/aii/dhcp" = structure_dhcp_dhcp_info;
+
+prefix "/system/aii/dhcp";
+
+@documentation{
+ Override the TFT server for this node
+}
 variable AII_DHCP_TFTPSERVER ?= null;
-"/system/aii/dhcp/options/tftpserver" ?= AII_DHCP_TFTPSERVER;
-
-# Additional DHCP options (optional).
-# Warning: They will be added in the host declaration of dhcpd.conf file, so
-# do not forget the ';' at the end
-#
-#"/system/aii/dhcp/addoptions" = "options blu-blo-bli bla;";
-#
+"tftpserver" ?= AII_DHCP_TFTPSERVER;
+
+@documentation{
+ Additional options to include in the host definition
+}
 variable AII_DHCP_ADDOPTIONS ?= null;
-"/system/aii/dhcp/options/addoptions" ?= AII_DHCP_ADDOPTIONS;
+"options" ?= AII_DHCP_ADDOPTIONS;

aii-dhcp/src/main/pan/quattor/aii/dhcp/schema.pan

@@ -3,12 +3,21 @@
 # ${author-info}
 # ${build-info}
 
-unique template quattor/aii/${project.artifactId}/schema;
+unique template quattor/aii/dhcp/schema;
+
+type structure_dhcp_module_info = {
+ "enabled" ? boolean
+};
 
-# Information needed for creating the Kickstart file
 type structure_dhcp_dhcp_info = {
+ @{TFTP server to use for this node, instead of the host where AII runs}
  "tftpserver" ? string
+ @{Name of the file to boot}
+ "filename" ? string
+ @{
+ Custom options to include in the host definition. Note: if the type
+ of an option requires quoting, then the quotes must be included in
+ the value you specify in templates.
+ }
  "options" ? string{}
 };
-
-bind "/system/aii/${project.artifactId}" = structure_dhcp_dhcp_info;

aii-dhcp/src/main/perl/dhcp.pm

@@ -5,6 +5,7 @@ use Socket;
 use Exporter;
 use Sys::Hostname;
 use CAF::Lock qw (FORCE_IF_STALE);
+use CAF::FileReader;
 use CAF::FileWriter;
 use CAF::Process;
 
@@ -70,7 +71,7 @@ sub update_dhcp_config_file
  $nodes_regexp .= $node->{NAME} . '|' . $node->{FQDN} . '|';
  }
  $nodes_regexp =~ s/\|$//; # remove last '|'
- $nodes_regexp = '\\n\s*host\s+(' . $nodes_regexp . ')\s*\{[^}]*\}';
+ $nodes_regexp = '\\n\s*host\s+(' . $nodes_regexp . ')\s*(\{(?:[^{}]|(?2))*\})';
  $text =~ s/$nodes_regexp//gm;
 
  #
@@ -138,6 +139,11 @@ sub update_dhcp_config_file
  push @newnodes, "$indent\t next-server $node->{ST_IP_TFTP};";
  }
 
+ # DHCP filename option
+ if ($node->{FILENAME}) {
+ push @newnodes, "$indent\t filename \"$node->{FILENAME}\";";
+ }
+
  # additional options
  if ($node->{MORE_OPT}) {
  push @newnodes, "$indent\t $node->{MORE_OPT}";
@@ -255,14 +261,14 @@ sub update_dhcp_config {
  }
  $self->debug(3, "Locked dhcp configuration");
  $self->debug(3,"DHCP configuration file : $filename");
- if (!open(FILE, "< $filename")) {
+ my $fh = CAF::FileReader->new($filename, log => $self);
+ if ($EC->error()) {
  $self->error("dhcp: update configuration: ".
  "file access error $filename");
  return(1);
  }
- local $/ = undef;
- $text = <FILE>;
- close (FILE);
+ $text = "$fh";
+ $fh->close();
 
  #
  # Add/removal of nodes
@@ -272,18 +278,10 @@ sub update_dhcp_config {
  return(1);
  }
 
- #
- # Backup the old one
- #
- if (!rename ($filename, $filename . '.pre_aii')) {
- $self->error("dhcp: error creating backup copy $filename.pre_aii");
- return(1);
- }
-
  #
  # Write the new dhcp configuration file
  #
- my $file = CAF::FileWriter->open($filename, mode => 0664, log => $this_app);
+ my $file = CAF::FileWriter->new($filename, mode => 0664, log => $this_app, backup => '.pre_aii');
  $file->print($text);
  $file->close();
 
@@ -312,12 +310,24 @@ sub Configure
  }
  my $ip = $self->get_ip($bootable, $tree);
 
+ my $server_ip = gethostbyname(hostname());
+ $server_ip = inet_ntoa($server_ip) if defined($server_ip);
+ if (!defined($server_ip)) {
+ $self->error("aii-dhcp: failed to obtain own IP address");
+ return;
+ }
+
  my $opts = $config->getElement("/system/aii/dhcp")->getTree();
  my $tftpserver = "";
+ my $filename = "";
  my $additional = "";
  if ($opts->{tftpserver}) {
  $tftpserver = $opts->{tftpserver};
  }
+ if ($opts->{filename}) {
+ $filename = $opts->{filename};
+ $filename =~ s/BOOTSRVIP/$server_ip/;
+ }
  if ($opts->{options}) {
  foreach my $k (sort keys %{$opts->{options}}) {
  $additional .= "option $k $opts->{options}->{$k};\n";
@@ -331,6 +341,7 @@ sub Configure
  IP => unpack('N', Socket::inet_aton($ip)),
  MAC => $cards->{$bootable}->{hwaddr},
  ST_IP_TFTP => $tftpserver,
+ FILENAME => $filename,
  MORE_OPT => $additional,
  };
  if ($this_app->option('use_fqdn')) {
@@ -373,7 +384,7 @@ sub Unconfigure
  IP => $ip,
  };
  $self->update_dhcp_config([], [$nodeconfig]);
- return 0;
+ return 1;
 }
 
 1;