chef-ruby-lvm-attrib 0.3.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1 @@
+Please refer to the Chef Community Code of Conduct at https://www.chef.io/code-of-conduct/

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+Please refer to https://github.com/chef/chef/blob/master/CONTRIBUTING.md

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "chefstyle"
+  gem "rake"
+end

data/README.md

@@ -0,0 +1,74 @@
+# chef-ruby-lvm-attrib
+
+[![Gem Version](https://badge.fury.io/rb/chef-ruby-lvm-attrib.svg)](https://badge.fury.io/rb/chef-ruby-lvm-attrib)
+
+This is a list of attributes for lvm objects. They are generated from the source code and broken down by version. See ADDING ATTRIBUTES below to contribute.
+
+At their core these files exist to determine which arguments to pass lvs/vgs/pvs and the subsequent type conversions.
+
+Currently this is split from the main ruby-lvm gem since these files require updating to follow LVM2 releases.
+
+## Usage
+
+```ruby
+  require 'lvm/attributes'
+
+  attributes = Attributes.load("2.0.36", "vgs.yaml")
+```
+
+## Requirements
+
+- None
+
+## Installation
+
+```bash
+sudo gem install chef-ruby-lvm-attrib
+```
+
+## Updating for new LVM releases
+
+To add attributes:
+
+Use `update-lvm.sh` script to add new version. Find the interested LVM2 tag from [LVM2 Repository](https://sourceware.org/git/?p=lvm2.git).
+
+- Fork this repository
+- `git clone your-forked-repo`
+- `cd your-forked-repo`
+- `./update-lvm.sh v2_02_155`
+
+The script will add `lib/lvm/attributes/LVM_VERSION` where `LVM_VERSION` being something like `2.02.86(2)` or `2.02.98(2)`.
+
+If the script will not error, it will create new branch and commit `Added LVM_VERSION attributes`.
+
+In case of error, see missing attribute type note below.
+
+If all is well, publish the changes and make Pull Request from GitHub web:
+
+- `git push origin mybranch`
+- Submit PR to this repository.
+
+### Missing Attribute Type:
+
+If you get an error like the below:
+
+```
+Oops, missing type conversion data of column 'discards' use by 'SEGS' which says its going to return a 'discards'
+Figure out the missing type and rerun.
+```
+
+- Look in `path/to/lvm-source/lib/report/columns.h` for the column name in the 7th field.
+- If the 3rd field is NUM, type will be Integer. If 3rd field is STR, type will be String.
+- Add the information to `bin/generate_field_data` in the TYPE_CONVERSION_MAP and try running again
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2008 Matthew Kent, Bravenet Web Services Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+task default: :style
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  desc "Run Chefstyle tests"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed."
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.3

data/bin/generate_field_data

@@ -0,0 +1,239 @@
+#!/usr/bin/env ruby
+
+# Build yaml files which provide arguments passed to {lv,pv,vg}s and subsequent
+# type conversions.
+#
+# ./generate_field_data ~/LVM2.2.02.38
+
+require "fileutils"
+require "yaml"
+
+VERSION_FILE = "/VERSION".freeze
+COLUMNS_FILE = "/lib/report/columns.h".freeze
+
+debug = false
+
+TYPE_CONVERSION_MAP = {
+  # Only types we can really trust
+  "uint32" => "Integer",
+  "int32" => "Integer",
+  # These were determined by reading the code, they invoke _(u)int32_disp right away
+  "pvmdas" => "Integer",
+  "vgmdas" => "Integer",
+  "lvcount" => "Integer",
+  "lvsegcount" => "Integer",
+  "segstartpe" => "Integer",
+  # listed to return STR?
+  "lvkmaj" => "Integer",
+  "lvkmin" => "Integer",
+  "snpercent" => "Float",
+  "copypercent" => "Float",
+  # size32/64, these do unit formatting unless overridden on command line. We
+  # typically want them in bytes so we can convert them to Integers safely
+  "size32" => "Integer",
+  "size64" => "Integer",
+  # These types return size32/size64 as well
+  "lvkreadahead" => "Integer",
+  "pvsize" => "Integer",
+  "devsize" => "Integer",
+  "originsize" => "Integer",
+  "pvfree" => "Integer",
+  "pvused" => "Integer",
+  "pvmdafree" => "Integer",
+  "pvmdasize" => "Integer",
+  "vgsize" => "Integer",
+  "vgfree" => "Integer",
+  "vgmda_free" => "Integer",
+  "chunksize" => "Integer",
+  "segstart" => "Integer",
+  "segsize" => "Integer",
+  "snapcount" => "Integer",
+  "vgmdafree" => "Integer",
+  "vgmdasize" => "Integer",
+  "pvextvsn" => "Integer",
+  "vgmissingpvcount" => "Integer",
+  # Weird one, can be "auto" or size32
+  "lvreadahead" => "String",
+  "lvmetadatasize" => "Integer",
+  "datapercent" => "Float",
+  "metadatapercent" => "Float",
+  "pvmdasused" => "Integer",
+  "vgmdasused" => "Integer",
+  "vgmdacopies" => "Integer",
+  "thincount" => "Integer",
+  "thinid" => "Integer",
+  "discards" => "Integer",
+  "thinzero" => "Integer",
+  "transactionid" => "Integer",
+  "raidmismatchcount" => "Integer",
+  "raidwritebehind" => "Integer",
+  "raidminrecoveryrate" => "Integer",
+  "raidmaxrecoveryrate" => "Integer",
+  "segsizepe" => "Integer",
+  # New fields for caching
+  "cache_total_blocks" => "Integer",
+  "cache_used_blocks" => "Integer",
+  "cache_dirty_blocks" => "Integer",
+  "cache_read_hits" => "Integer",
+  "cache_read_misses" => "Integer",
+  "cache_write_hits" => "Integer",
+  "cache_write_misses" => "Integer",
+
+  # 2.02.169+
+  "lv_size" => "Integer",
+  "kernelmetadataformat" => "Integer",
+  "seg_stripes" => "Integer",
+  "seg_data_stripes" => "Integer",
+  "seg_reshape_len" => "Integer",
+  "seg_reshape_len_le" => "Integer",
+  "seg_data_copies" => "Integer",
+  "seg_data_offset" => "Integer",
+  "seg_new_data_offset" => "Integer",
+  "seg_parity_chunks" => "Integer",
+  "cachemetadataformat" => "Integer",
+
+  # these seems to be integers
+  "vdo_used_size" => "Integer",
+  "vdo_saving_percent" => "Integer",
+  "writecache_total_blocks" => "Integer",
+  "writecache_free_blocks" => "Integer",
+  "writecache_writeback_blocks" => "Integer",
+  "writecache_error" => "Integer",
+  "vdo_minimum_io_size" => "Integer",
+  "vdo_block_map_cache_size" => "Integer",
+  "vdo_block_map_era_length" => "Integer",
+  "vdo_index_memory_size" => "Integer",
+  "vdo_slab_size" => "Integer",
+  "vdo_ack_threads" => "Integer",
+  "vdo_bio_threads" => "Integer",
+  "vdo_bio_rotation" => "Integer",
+  "vdo_cpu_threads" => "Integer",
+  "vdo_hash_zone_threads" => "Integer",
+  "vdo_logical_threads" => "Integer",
+  "vdo_physical_threads" => "Integer",
+  "vdo_max_discard" => "Integer",
+  "vdo_header_size" => "Integer",
+}.freeze
+
+lvm_source = ARGV[0]
+
+version = File.readlines(lvm_source + VERSION_FILE)[0].split(/-git|\s+/)[0]
+
+lvs     = []
+lvssegs = []
+pvs     = []
+pvssegs = []
+vgs     = []
+File.readlines(lvm_source + COLUMNS_FILE).each do |line|
+  # eg: FIELD(LVS, lv, STR, "LV UUID", lvid.id[1], 38, uuid, "lv_uuid", "Unique identifier")
+  next unless line =~ /^FIELD\((.*)\)$/
+
+  fields = $1.split(", ")
+  fields.each { |f| f.gsub!(/^"/, ""); f.gsub!(/"$/, "") }
+  p fields if debug
+  app = fields[0]
+  general_type = fields[2]
+  specific_type = fields[6]
+  column        = fields[7]
+  method        = fields[7].dup
+  description   = fields[8]
+  p app, general_type, specific_type, column, method, description if debug
+
+  if %w{NUM SIZ}.include?(general_type)
+    attribute_type = TYPE_CONVERSION_MAP[specific_type]
+    if attribute_type.nil?
+      puts "Oops, missing type conversion data of column '#{specific_type}' use by '#{app}' which says its going to return a '#{specific_type}'"
+      puts "Figure out the missing type and rerun."
+      exit 1
+    end
+  else
+    attribute_type = "String"
+  end
+
+  # our shorter nicer method names, according to the man page these can be
+  # dropped when passing column names as arguments as well, but i found a few
+  # with issues (seg_start).
+  case app
+  when "LVS", "LVSINFOSTATUS", "LVSSTATUS"
+    method.sub!(/^lv_/, "")
+  when "SEGS"
+    method.sub!(/^seg_/, "")
+  when "LABEL"
+    method.sub!(/^pv_/, "")
+  when "PVS"
+    method.sub!(/^pv_/, "")
+  when "PVSEGS"
+    method.sub!(/^pvseg_/, "")
+  when "VGS"
+    method.sub!(/^vg_/, "")
+  end
+
+  attribute = {
+    method: method,
+    column: column,
+    type_hint: attribute_type,
+    description: description,
+  }
+
+  case app
+  when "LVS", "LVSINFOSTATUS", "LVSSTATUS"
+    lvs << attribute
+  when "SEGS"
+    lvssegs << attribute
+  when "LABEL"
+    pvs << attribute
+  when "PVS"
+    pvs << attribute
+  when "PVSEGS"
+    pvssegs << attribute
+  when "VGS"
+    vgs << attribute
+  end
+end
+
+# we use vg_uuid as our crossover attribute that links vg->lv and vg->pv
+attribute = { method: "vg_uuid",
+              column: "vg_uuid",
+              type_hint: "String",
+              description: "For VolumeGroup to LogicalVolume relationship." }
+lvs << attribute
+attribute = { method: "vg_uuid",
+              column: "vg_uuid",
+              type_hint: "String",
+              description: "For VolumeGroup to PhysicalVolume relationship." }
+pvs << attribute
+
+# and we link lv->lvsegment, pv->pvsegment
+attribute = { method: "lv_uuid",
+              column: "lv_uuid",
+              type_hint: "String",
+              description: "For LogicalVolume to LogicalVolumeSegment relationship." }
+lvssegs << attribute
+attribute = { method: "pv_uuid",
+              column: "pv_uuid",
+              type_hint: "String",
+              description: "For PhysicalVolume to PhysicalVolumeSegment relationship." }
+pvssegs << attribute
+
+lvs.sort!     { |x, y| x[:column] <=> y[:column] }
+lvssegs.sort! { |x, y| x[:column] <=> y[:column] }
+pvs.sort!     { |x, y| x[:column] <=> y[:column] }
+pvssegs.sort! { |x, y| x[:column] <=> y[:column] }
+vgs.sort!     { |x, y| x[:column] <=> y[:column] }
+
+attributes_dir = "lib/lvm/attributes/#{version}"
+FileUtils.mkdir(attributes_dir)
+
+disclaimer = <<~GO
+  # These are column to object attribute mappings
+  # generated by #{$0} based on
+  # #{lvm_source}/lib/report/columns.h
+GO
+
+File.open("#{attributes_dir}/lvs.yaml", "w")    { |f| f.write(disclaimer); f.write(lvs.to_yaml) }
+File.open("#{attributes_dir}/lvsseg.yaml", "w") { |f| f.write(disclaimer); f.write(lvssegs.to_yaml) }
+File.open("#{attributes_dir}/pvs.yaml", "w")    { |f| f.write(disclaimer); f.write(pvs.to_yaml) }
+File.open("#{attributes_dir}/pvsseg.yaml", "w") { |f| f.write(disclaimer); f.write(pvssegs.to_yaml) }
+File.open("#{attributes_dir}/vgs.yaml", "w")    { |f| f.write(disclaimer); f.write(vgs.to_yaml) }
+
+puts "Done."

data/chef-ruby-lvm-attrib.gemspec

@@ -0,0 +1,18 @@
+$:.unshift(File.expand_path("../lib/", __FILE__))
+require "lvm/attributes"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chef Software"]
+  gem.email         = ["oss@chef.io"]
+  gem.description   = "A list of attributes for LVM objects"
+  gem.license       = "MIT"
+  gem.summary       = "A list of attributes for LVM objects"
+  gem.homepage      = "https://github.com/chef/chef-ruby-lvm-attrib"
+  gem.executables   = ["generate_field_data"]
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "chef-ruby-lvm-attrib"
+  gem.require_paths = ["lib"]
+  gem.version       = LVM::Attributes::VERSION
+end

data/lib/lvm/attributes.rb

@@ -0,0 +1,29 @@
+require "yaml"
+
+module LVM
+  module Attributes
+    VERSION = "0.3.3".freeze
+
+    def load(version, name)
+      cwd = File.dirname(__FILE__)
+
+      # was going to be symlinks, but rubygems didn't seem to want to package
+      # them
+      if version == "2.02.28"
+        version = "2.02.27"
+      elsif ((31..39).map { |x| "2.02.#{x}" }).include?(version)
+        version = "2.02.30"
+      end
+
+      file = File.join(cwd, "attributes", version, name)
+
+      begin
+        YAML.load_file(file)
+      rescue Errno::ENOENT => e
+        raise ArgumentError.new("Unable to load lvm attributes [#{name}] for version [#{version}]. " \
+          "The version/object may not be supported or you may need to upgrade the chef-ruby-lvm-attrib gem. Error [#{e.message}]")
+      end
+    end
+    module_function :load
+  end # module Attributes
+end # module LVM

data/lib/lvm/attributes/2.02.100(2)/lvs.yaml

@@ -0,0 +1,156 @@
+# These are column to object attribute mappings
+# generated by ./bin/generate_field_data based on
+# lvm2/lib/report/columns.h
+---
+- :method: convert_lv
+  :column: convert_lv
+  :type_hint: String
+  :description: For lvconvert
+- :method: copy_percent
+  :column: copy_percent
+  :type_hint: Float
+  :description: For RAID
+- :method: data_lv
+  :column: data_lv
+  :type_hint: String
+  :description: For thin pools
+- :method: data_percent
+  :column: data_percent
+  :type_hint: Float
+  :description: For snapshot and thin pools and volumes
+- :method: active
+  :column: lv_active
+  :type_hint: String
+  :description: Active state of the LV.
+- :method: attr
+  :column: lv_attr
+  :type_hint: String
+  :description: Various attributes - see man page.
+- :method: host
+  :column: lv_host
+  :type_hint: String
+  :description: Creation host of the LV
+- :method: kernel_major
+  :column: lv_kernel_major
+  :type_hint: String
+  :description: Currently assigned major number or -1 if LV is not active.
+- :method: kernel_minor
+  :column: lv_kernel_minor
+  :type_hint: String
+  :description: Currently assigned minor number or -1 if LV is not active.
+- :method: kernel_read_ahead
+  :column: lv_kernel_read_ahead
+  :type_hint: Integer
+  :description: Currently-in-use read ahead setting in current units.
+- :method: major
+  :column: lv_major
+  :type_hint: Integer
+  :description: Persistent major number or -1 if not persistent.
+- :method: metadata_size
+  :column: lv_metadata_size
+  :type_hint: Integer
+  :description: For thin pools
+- :method: minor
+  :column: lv_minor
+  :type_hint: Integer
+  :description: Persistent minor number or -1 if not persistent.
+- :method: modules
+  :column: lv_modules
+  :type_hint: String
+  :description: Kernel device-mapper modules required for this LV.
+- :method: name
+  :column: lv_name
+  :type_hint: String
+  :description: Name.  LVs created for internal use are enclosed in brackets.
+- :method: path
+  :column: lv_path
+  :type_hint: String
+  :description: Full pathname for LV.
+- :method: profile
+  :column: lv_profile
+  :type_hint: String
+  :description: Configuration profile attached to this LV.
+- :method: read_ahead
+  :column: lv_read_ahead
+  :type_hint: String
+  :description: Read ahead setting in current units.
+- :method: size
+  :column: lv_size
+  :type_hint: Integer
+  :description: Size of LV in current units.
+- :method: tags
+  :column: lv_tags
+  :type_hint: String
+  :description: Tags
+- :method: time
+  :column: lv_time
+  :type_hint: String
+  :description: Creation time of the LV
+- :method: uuid
+  :column: lv_uuid
+  :type_hint: String
+  :description: Unique identifier.
+- :method: metadata_lv
+  :column: metadata_lv
+  :type_hint: String
+  :description: For thin pools
+- :method: metadata_percent
+  :column: metadata_percent
+  :type_hint: Float
+  :description: For thin pools
+- :method: mirror_log
+  :column: mirror_log
+  :type_hint: String
+  :description: For mirrors
+- :method: move_pv
+  :column: move_pv
+  :type_hint: String
+  :description: For pvmove
+- :method: origin
+  :column: origin
+  :type_hint: String
+  :description: For snapshots
+- :method: origin_size
+  :column: origin_size
+  :type_hint: Integer
+  :description: For snapshots
+- :method: pool_lv
+  :column: pool_lv
+  :type_hint: String
+  :description: For thin volumes
+- :method: raid_max_recovery_rate
+  :column: raid_max_recovery_rate
+  :type_hint: Integer
+  :description: For RAID1
+- :method: raid_min_recovery_rate
+  :column: raid_min_recovery_rate
+  :type_hint: Integer
+  :description: For RAID1
+- :method: raid_mismatch_count
+  :column: raid_mismatch_count
+  :type_hint: Integer
+  :description: For RAID
+- :method: raid_sync_action
+  :column: raid_sync_action
+  :type_hint: String
+  :description: For RAID
+- :method: raid_write_behind
+  :column: raid_write_behind
+  :type_hint: Integer
+  :description: For RAID1
+- :method: seg_count
+  :column: seg_count
+  :type_hint: Integer
+  :description: Number of segments in LV.
+- :method: snap_percent
+  :column: snap_percent
+  :type_hint: Float
+  :description: For snapshots
+- :method: sync_percent
+  :column: sync_percent
+  :type_hint: Float
+  :description: For RAID
+- :method: vg_uuid
+  :column: vg_uuid
+  :type_hint: String
+  :description: For VolumeGroup to LogicalVolume relationship.