Merge pull request #131 from mbornoz/apt-preferences

apt::pin: handling all apt preferences properties

README.md

@@ -101,6 +101,16 @@ Adds an apt pin for a certain release.
     apt::pin { 'karmic-updates': priority => 700 }
     apt::pin { 'karmic-security': priority => 700 }
 
+Note you can also specifying more complex pins using distribution properties.
+
+    apt::pin { 'stable':
+      priority        => -10,
+      originator      => 'Debian',
+      release_version => '3.0',
+      component       => 'main',
+      label           => 'Debian'
+    }
+
 ###apt::ppa
 
 Adds a ppa repository using `add-apt-repository`.

manifests/pin.pp

@@ -7,10 +7,14 @@ define apt::pin(
   $order           = '',
   $packages        = '*',
   $priority        = 0,
-  $release    = '',
+  $release         = '', # a=
   $origin          = '',
-  $originator = '',
-  $version    = ''
+  $version         = '',
+  $codename        = '', # n=
+  $release_version = '', # v=
+  $component       = '', # c=
+  $originator      = '', # o=
+  $label           = ''  # l=
 ) {
 
   include apt::params
@@ -21,16 +25,37 @@ define apt::pin(
     fail('Only integers are allowed in the apt::pin order param')
   }
 
-  if $release != '' {
-    $pin = "release a=${release}"
-  } elsif $origin != '' {
-    $pin = "origin \"${origin}\""
-  } elsif $originator != '' {
-    $pin = "release o=${originator}"
-  } elsif $version != '' {
-    $pin = "version ${version}"
-  } else {
-    $pin = "release a=${name}"
+  $pin_release_array = [
+    $release,
+    $codename,
+    $release_version,
+    $component,
+    $originator,
+    $label] 
+  $pin_release = join($pin_release_array, '')
+
+  # Read the manpage 'apt_preferences(5)', especially the chapter
+  # 'Thea Effect of APT Preferences' to understand the following logic
+  # and the difference between specific and general form
+  if $packages != '*' { # specific form
+
+    if ( $pin_release != '' and ( $origin != '' or $version != '' )) or
+      ( $origin != '' and ( $pin_release != '' or $version != '' )) or
+      ( $version != '' and ( $pin_release != '' or $origin != '' )) {
+      fail('parameters release, origin, and version are mutually exclusive')
+    }
+
+  } else { # general form
+
+    if $version != '' {
+      fail('parameter version cannot be used in general form')
+    }
+
+    if ( $pin_release != '' and $origin != '' ) or
+      ( $origin != '' and $pin_release != '' ) {
+      fail('parmeters release and origin are mutually exclusive')
+    }
+
   }
 
   $path = $order ? {

spec/defines/pin_spec.rb

@@ -12,34 +12,77 @@ describe 'apt::pin', :type => :define do
     }
   end
 
-  [ {},
+  [ 
+    { :params  => {},
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: *\nPin: release a=my_pin\nPin-Priority: 0\n"
+    },
     {
+      :params => {
         :packages => 'apache', 
         :priority => '1'
       },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: apache\nPin: release a=my_pin\nPin-Priority: 1\n"
+    },
     {
+      :params => {
         :order    => 50, 
         :packages => 'apache', 
         :priority => '1'
       },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: apache\nPin: release a=my_pin\nPin-Priority: 1\n"
+    },
     {
+      :params => {
         :ensure   => 'absent',
         :packages => 'apache',
         :priority => '1'
       },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: apache\nPin: release a=my_pin\nPin-Priority: 1\n"
+    },
     {
+      :params => {
         :packages => 'apache',
         :priority => '1',
         :release  => 'my_newpin'
-    }
+      },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: apache\nPin: release a=my_newpin\nPin-Priority: 1\n"
+    },
+    {
+      :params => {
+        :packages => 'apache',
+        :priority => '1',
+        :version  => '2.2.16*'
+      },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: apache\nPin: version 2.2.16*\nPin-Priority: 1\n"
+    },
+    {
+      :params => {
+        :priority => '1',
+        :origin   => 'ftp.de.debian.org'
+      },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: *\nPin: origin \"ftp.de.debian.org\"\nPin-Priority: 1\n"
+    },
+    {
+      :params => {
+        :packages        => 'apache',
+        :priority        => '1',  
+        :release         => 'stable',
+        :codename        => 'wheezy',
+        :release_version => '3.0',
+        :component       => 'main',
+        :originator      => 'Debian',
+        :label           => 'Debian'
+      },
+      :content => "# my_pin\nExplanation: : my_pin\nPackage: apache\nPin: release a=stable, n=wheezy, v=3.0, c=main, o=Debian, l=Debian\nPin-Priority: 1\n"
+    },
   ].each do |param_set|
     describe "when #{param_set == {} ? "using default" : "specifying"} define parameters" do
       let :param_hash do
-        default_params.merge(param_set)
+        default_params.merge(param_set[:params])
       end
 
       let :params do
-        param_set
+        param_set[:params]
       end
 
       it { should include_class("apt::params") }
@@ -50,7 +93,7 @@ describe 'apt::pin', :type => :define do
           'owner'   => 'root',
           'group'   => 'root',
           'mode'    => '0644',
-          'content' => "# #{title}\nExplanation: : #{title}\nPackage: #{param_hash[:packages]}\nPin: release a=#{param_hash[:release] || title}\nPin-Priority: #{param_hash[:priority]}\n",
+          'content' => param_set[:content],
         })
       }
     end

templates/pin.pref.erb

@@ -1,3 +1,20 @@
+<%-
+@pin = "release a=#{@name}" # default value
+if @pin_release.length > 0
+  options = []
+  options.push("a=#{@release}") if @release.length > 0
+  options.push("n=#{@codename}") if @codename.length > 0
+  options.push("v=#{@release_version}") if @release_version.length > 0
+  options.push("c=#{@component}") if @component.length > 0
+  options.push("o=#{@originator}") if @originator.length > 0
+  options.push("l=#{@label}") if @label.length > 0
+  @pin = "release #{options.join(', ')}"
+elsif @version.length > 0
+  @pin = "version #{@version}"
+elsif @origin.length > 0
+  @pin = "origin \"#{@origin}\""
+end
+-%>
 # <%= @name %>
 Explanation: <%= @explanation %>
 Package: <%= @packages %>