# == Define: iface::bond
#
# Resource to define a bonding interface configuration stanza within
# interfaces(5).
#
# == Parameters
#
# [*ifname*] => *(namevar)* - string
#   Name of the interface to be configured.
#
# [*method*] - string
#   Configuration method to be used.
#
# [*auto*] - bool
#   Sets the interface on automatic setup on startup. This is affected by
#   ifup -a and ifdown -a commands.
#
# [*allows*] - array
#   Adds an allow- entry to the interface stanza.
#
# [*family*] - string
#   Address family. Currently, only inet family is supported. Support for
#   inet6 is comming soon.
#
# [*order*] - int
#   Order of the entry to be created in /etc/network/interfaces. Innate
#   odering is preset with default value of 10 for loopback and 20 for dhcp
#   and static stanzas. The order attribute of the resource is added to the
#   default value.
#
# [*hwaddress*] - string
#   The MAC address of the interface. This value is validated as standard
#   IEEE MAC address of 6 bytes, written hexadecimal, delimited with
#   colons (:) or dashes (-).
#
# [*hostname*] - string
#   The hostname to be submitted with dhcp requests.
#
# [*leasetime*] - int
#   The requested leasetime of dhcp leases.
#
# [*vendor*] - string
#   The vendor id to be submitted with dhcp requests.
#
# [*client*] - string
#  The client id to be submitted with dhcp requests.
#
# [*metric*] - int
#  Routing metric for routes added resolved on this interface.
#
# [*address*] - string
#  IP address formatted as dotted-quad for IPv4.
#
# [*netmask*] - string
#  Netmask as dotted-quad or CIDR prefix length.
#
# [*broadcast*] - string
#  Broadcast address as dotted-quad or + or -.
#
# [*gateway*] - string
#  Default route to be brought up with this interface.
#
# [*pointopoint*] - stirng
#  Address of the ppp endpoint as dotted-quad.
#
# [*mtu*] - int
#  Size of the maximum transportable unit over this interface.
#
# [*scope*] - string
#  Scope of address validity. Values allowed are global, link or host.
#
# [*pre_ups*] - array
#  Array of commands to be run prior to bringing this interface up.
#
# [*ups*] - array
#  Array of commands to be run after bringing this interface up.
#
# [*downs*] - array
#  Array of commands to be run prior to bringing this interface down.
#
# [*post_downs*] - array
#  Array of commands to be run after bringing this interface down.
#
# [*aux_ops_*] - hash
#  Hash of key-value pairs with auxiliary options for this interface.
#  To be used by other debnet types only.
#
# [*aux_ops*] - hash
#  Hash of key-value pairs with auxiliary options for this interface.
#  To be used by other debnet types only.
#
# [*tx_queue*] - int
#  Feature helper for setting tx queue on the interface.
#
# [*routes*] - hash
#  Feature helper for setting static routes via the interface.
#
# [*dns_nameserver*] - array
#  Feature helper to add a list of nameservers to be configures via resolvconf
#  while the interface is set up.
#
# [*dns_search*] - array
#  Feature helper to add a list of domain names as dns search via resolvconf
#  while the interface is set up.
#
# === Authors
#
# Tibor Repasi
#
# === Copyright
#
# Copyright 2015 Tibor Repasi
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
define debnet::iface::bond(
  $method,
  $ifname = $title,
  $auto = true,
  $allows = [],
  $family = 'inet',
  $order = 0,

  # bond options
  $ports = [],
  $mode = 'active-backup',
  $miimon = 100,
  $use_carrier = true,
  $updelay = undef,
  $downdelay = undef,

  # options for multiple methods
  $metric = undef,
  $hwaddress = undef,

  # options for method dhcp
  $hostname = undef,
  $leasetime = undef,
  $vendor = undef,
  $client = undef,

  # options for method static
  $address = undef,
  $netmask = undef,
  $broadcast = undef,
  $gateway = undef,
  $pointopoint = undef,
  $mtu = undef,
  $scope = undef,

  # up and down commands
  $pre_ups = [],
  $ups = [],
  $downs = [],
  $post_downs = [],

  # auxiliary options
  $aux_ops_master = {},
  $aux_ops_slaves = {},

  # feature-helpers
  $tx_queue = undef,
  $routes = {},
  $dns_nameservers = undef,
  $dns_search = undef,
) {
  include debnet

  if !defined(Package[$debnet::params::ifenslave_pkg]) {
    package { $debnet::params::ifenslave_pkg:
      ensure => 'installed',
    }
  }

  validate_array($ports)
  if size($ports) == 0 {
    fail('Bonding needs at least one port to be declared!')
  }
  # lint:ignore:80chars
  validate_re($mode,
    '^balance\-rr$|^active\-backup$|^balance\-xor$|^broadcast$|^802\.3ad$|^balance\-tlb$|^balance\-alb$')
  # lint:endignore
  if is_string($miimon) {
    validate_re($miimon, '^\d+$')
  } else {
    validate_integer($miimon)
  }
  $bondopts0 = {
      'bond-slaves'  => 'none',
      'bond-primary' => $ports[1],
      'bond-mode'    => $mode,
      'bond-miimon'  => $miimon,
    }

  validate_bool($use_carrier)
  if $updelay {
    if is_string($updelay) {
      validate_re($updelay, '^\d+$')
    } else {
      validate_integer($updelay)
    }
    $bondopts1 = {'bond-updelay' => $updelay}
  } else {
    $bondopts1 = {}
  }

  if $downdelay {
    if is_string($downdelay) {
      validate_re($downdelay, '^\d+$')
    } else {
      validate_integer($downdelay)
    }
    $bondopts2 = {'bond-downdelay' => $downdelay}
  } else {
    $bondopts2 = {}
  }

  debnet::iface { $ports:
    method     => 'manual',
    auto       => $auto,
    allows     => $allows,
    family     => $family,
    order      => 50 + $order,
    mtu        => $mtu,
    pre_ups    => $pre_ups,
    ups        => $ups,
    downs      => $downs,
    post_downs => $post_downs,
    aux_ops    => merge(
      $aux_ops_slaves,
      {
        'bond-master'  => $ifname,
        'bond-mode'    => $mode,
        'bond-primary' => $ports[1],
      }
    ),
    tx_queue   => $tx_queue,
  }

  debnet::iface { $ifname:
    method          => $method,
    auto            => $auto,
    allows          => $allows,
    family          => $family,
    order           => 60 + $order,
    metric          => $metric,
    hwaddress       => $hwaddress,
    hostname        => $hostname,
    leasetime       => $leasetime,
    vendor          => $vendor,
    client          => $client,
    address         => $address,
    netmask         => $netmask,
    broadcast       => $broadcast,
    gateway         => $gateway,
    pointopoint     => $pointopoint,
    mtu             => $mtu,
    scope           => $scope,
    pre_ups         => $pre_ups,
    ups             => $ups,
    downs           => $downs,
    post_downs      => $post_downs,
    aux_ops         => merge(
      $aux_ops_master,
      $bondopts0,
      $bondopts1,
      $bondopts2
    ),
    tx_queue        => $tx_queue,
    routes          => $routes,
    dns_nameservers => $dns_nameservers,
    dns_search      => $dns_search,
  }
}