Merge pull request #215 from dylanratcliffe/add_facts

Add facts, functions, tasks, plans

Author: pmcmaw

.gitignore

@@ -3,4 +3,5 @@
 Gemfile.lock
 .bundle/
 .fixtures/modules
-.fixtures/manifests
+.fixtures/manifests
+spec/fixtures

README.md

@@ -287,6 +287,40 @@ parameters documented above also apply to AIX systems.
 * range (Parameter) - Sets the inter-physical volume allocation policy. AIX only
 * type (Parameter) - Configures the logical volume type. AIX only
 
+## Functions
+
+`lvm::bytes_to_size`: Converts a number of bytes to a size format that LVM can understand e.g. `lvm::bytes_to_size(214748364800)` would return `200g`
+
+`lvm::size_to_bytes`: Converts an LVM size to bytes, the opposite of `lvm::bytes_to_size`.
+
+## Tasks
+
+Documented in the ["Tasks" tab](https://forge.puppet.com/puppetlabs/lvm/tasks) on the forge
+
+## Plans
+
+### `lvm::expand`
+
+Executes common tasks for expanding mounts, this can include:
+
+* Creating PVs
+* Adding PVs to VG
+* Extending LV
+* Extending filesystem
+
+**Parameters:**
+
+`server`: *String* The target for the plan
+
+`volume_group`: *String* The volume group to which the logical volume belongs
+
+`logical_volume`: *String* The logical volume which is to be expanded
+
+`additional_size`: *String* How much size to add to the LV. This should be specified in LVM format i.e. "200m" or "2.5g"
+
+`disks`: *Array[String]* Any physical disks that should be added to the volume group as part of the expand process
+
+`resize_fs`: *Boolean* Whether or not to resize the filesystem
 
 ## Limitations
 

Rakefile

@@ -4,16 +4,5 @@ require 'puppet-lint/tasks/puppet-lint'
 PuppetLint.configuration.send('disable_80chars')
 PuppetLint.configuration.relative = true
 PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "pkg/**/*.pp"]
+PuppetSyntax.exclude_paths = ["plans/**/*.pp"]
 
-desc 'Run puppet in noop mode and check for syntax errors.'
-task :validate do
-  Dir['manifests/**/*.pp'].each do |manifest|
-    sh "puppet parser validate --noop #{manifest}"
-  end
-  Dir['spec/**/*.rb','lib/**/*.rb'].each do |ruby_file|
-    sh "ruby -c #{ruby_file}" unless ruby_file =~ /spec\/fixtures/
-  end
-  Dir['templates/**/*.erb'].each do |template|
-    sh "erb -P -x -T '-' #{template} | ruby -c"
-  end
-end

functions/bytes_to_size.pp

@@ -0,0 +1,25 @@
+function lvm::bytes_to_size (
+  Numeric $size,
+) {
+  $units = {
+    'k' => 1024,
+    'm' => 1048576,
+    'g' => 1073741824,
+    't' => 1099511627776,
+    'p' => 1.12589991e15,
+    'e' => 1.1529215e18,
+  }
+  $remaining_units = $units.filter |$name, $number| {
+    # Run all the calculation and return only units that are greater than one
+    $size_as_unit = $size / $number
+    $size_as_unit >= 1
+  }
+
+  # Use the last unit
+  $largest_unit = $remaining_units.keys[-1]
+
+  $value = ($size / $units[$largest_unit])
+
+  # # Return the string
+  "${value}${largest_unit}"
+}

functions/size_to_bytes.pp

@@ -0,0 +1,22 @@
+function lvm::size_to_bytes (
+  String $size,
+) {
+  $units = {
+    'K' => 1024,
+    'M' => 1048576,
+    'G' => 1073741824,
+    'T' => 1099511627776,
+    'P' => 1.12589991e15,
+    'E' => 1.1529215e18,
+  }
+  # Check if the size is valid and if so, extract the units
+  if $size =~ /^([0-9]+(\.[0-9]+)?)([KMGTPEkmgtpe])/ {
+    $unit   = String($3, '%u') # Store the units in uppercase
+    $number = Float($1)       # Store the number as a float
+
+    # Multiply the number by the units to get bytes
+    $number * $units[$unit]
+  } else {
+    fail("${size} is not a valid LVM size")
+  }
+}

lib/facter/logical_volumes.rb

@@ -0,0 +1,32 @@
+Facter.add(:logical_volumes) do
+  # Fact should be confined to only linux servers that have the lvs command
+  confine do
+    Facter.value('kernel') == 'Linux' &&
+    Facter::Core::Execution.which('lvs')
+  end
+
+  setcode do
+    # Require the helper methods to reduce duplication
+    require 'puppet_x/lvm/output'
+
+    # List columns here that can be passed to the lvs -o command. Dont't
+    # include things in here that might be bland as we currently can't deal
+    # with them
+    columns = [
+      'lv_uuid',
+      'lv_name',
+      'lv_full_name',
+      'lv_path',
+      'lv_dm_path',
+      'lv_attr',
+      'lv_layout',
+      'lv_role',
+      'lv_active',
+      'lv_size',
+      'lv_permissions',
+    ]
+
+    output = Facter::Core::Execution.exec("lvs -o #{columns.join(',')}  --noheading --nosuffix")
+    Puppet_X::LVM::Output.parse('lv_name', columns, output)
+  end
+end

lib/facter/lvm_support.rb

@@ -15,9 +15,8 @@
 Facter.add('lvm_vgs') do
   confine :lvm_support => true
 
-  if Facter.value(:lvm_support)
-    vgs = Facter::Core::Execution.execute('vgs -o name --noheadings 2>/dev/null', timeout: 30)
-  end
+  vgs = Facter::Core::Execution.execute('vgs -o name --noheadings 2>/dev/null', timeout: 30)
+
   if vgs.nil?
     setcode { 0 }
   else
@@ -48,9 +47,8 @@
 Facter.add('lvm_pvs') do
   confine :lvm_support => true
 
-  if Facter.value(:lvm_support)
-    pvs = Facter::Core::Execution.execute('pvs -o name --noheadings 2>/dev/null', timeout: 30)
-  end
+  pvs = Facter::Core::Execution.execute('pvs -o name --noheadings 2>/dev/null', timeout: 30)
+
   if pvs.nil?
     setcode { 0 }
   else

lib/facter/physical_volumes.rb

@@ -0,0 +1,35 @@
+Facter.add(:physical_volumes) do
+  # Fact should be confined to only linux servers that have the lvs command
+  confine do
+    Facter.value('kernel') == 'Linux' &&
+    Facter::Core::Execution.which('pvs')
+  end
+
+  setcode do
+    # Require the helper methods to reduce duplication
+    require 'puppet_x/lvm/output'
+
+    # List columns here that can be passed to the lvs -o command. Dont't
+    # include things in here that might be bland as we currently can't deal
+    # with them
+    columns = [
+      'pv_uuid',
+      'dev_size',
+      'pv_name',
+      'pe_start',
+      'pv_size',
+      'pv_free',
+      'pv_used',
+      'pv_attr',
+      'pv_pe_count',
+      'pv_pe_alloc_count',
+      'pv_mda_count',
+      'pv_mda_used_count',
+      'pv_ba_start',
+      'pv_ba_size',
+    ]
+
+    output = Facter::Core::Execution.exec("pvs -o #{columns.join(',')}  --noheading --nosuffix")
+    Puppet_X::LVM::Output.parse('pv_name', columns, output)
+  end
+end

lib/facter/volume_groups.rb

@@ -0,0 +1,28 @@
+Facter.add(:volume_groups) do
+  # Fact should be confined to only linux servers that have the lvs command
+  confine do
+    Facter.value('kernel') == 'Linux' &&
+    Facter::Core::Execution.which('vgs')
+  end
+
+  setcode do
+    # Require the helper methods to reduce duplication
+    require 'puppet_x/lvm/output'
+
+    # List columns here that can be passed to the lvs -o command. Dont't
+    # include things in here that might be bland as we currently can't deal
+    # with them
+    columns = [
+      'vg_uuid',
+      'vg_name',
+      'vg_attr',
+      'vg_permissions',
+      'vg_allocation_policy',
+      'vg_size',
+      'vg_free',
+    ]
+
+    output = Facter::Core::Execution.exec("vgs -o #{columns.join(',')}  --noheading --nosuffix")
+    Puppet_X::LVM::Output.parse('vg_name', columns, output)
+  end
+end

lib/puppet/provider/logical_volume/lvm.rb

@@ -23,7 +23,10 @@
     def self.instances
       get_logical_volumes.collect do |logical_volumes_line|
         logical_volumes_properties = get_logical_volume_properties(logical_volumes_line)
-        new(logical_volumes_properties)
+        instance = new(logical_volumes_properties)
+        # Save the volume group in the provider so the type can find it
+        instance.volume_group = logical_volumes_properties[:volume_group]
+        instance
       end
     end
 
@@ -46,13 +49,21 @@ def self.get_logical_volume_properties(logical_volumes_line)
       output_array = logical_volumes_line.gsub(/\s+/m, ' ').strip.split(" ")
 
       # Assign properties based on headers
-      # Just doing name for now...
-      logical_volumes_properties[:ensure]     = :present
-      logical_volumes_properties[:name]       = output_array[0]
+      logical_volumes_properties[:ensure]       = :present
+      logical_volumes_properties[:name]         = output_array[0]
+      logical_volumes_properties[:volume_group] = output_array[1]
 
       logical_volumes_properties
     end
 
+    # Just assume that the volume group is correct, we don't support changing
+    # it anyway.
+    attr_writer :volume_group
+
+    def volume_group
+        @resource ? @resource[:volume_group] : @volume_group
+    end
+
     def create
         args = []
 
@@ -148,12 +159,23 @@ def destroy
     end
 
     def exists?
-        lvs(@resource[:volume_group]) =~ lvs_pattern
+        begin
+            lvs(@resource[:volume_group]) =~ /#{@resource[:name]}/
+        rescue Puppet::ExecutionFailure
+            # lvs fails if we give it an empty volume group name, as would
+            # happen if we were running `puppet resource`. This should be
+            # interpreted as "The resource does not exist"
+            nil
+        end
     end
 
     def size
         if @resource[:size] =~ /^\d+\.?\d{0,2}([KMGTPE])/i
             unit = $1.downcase
+        else
+            # If we are getting the size initially we don't know what the
+            # units will be, default to GB
+            unit = 'g'
         end
 
         raw = lvs('--noheading', '--unit', unit, path)
@@ -303,9 +325,6 @@ def mirrorlog=( new_mirror_log_location )
         end
     end
 
-
-
-
     private
 
     def lvs_pattern