[v1.0] Implement functions through library and custom resource (#5)

* move nfs-package name to a node attribute

* implement functions through library and custom resource

* revert back logging level for tests

* lint

* better handle convergance with existing resources

* fix test to expect exact number of calls

Author: mattlqx

README.md

@@ -2,7 +2,7 @@
 
 Cookbook to mount Elastic Filesystem endpoints in Amazon Web Services.
 
-Presently, you just configure global defaults (presently the recommended values from Amazon) and individual mounts through node attributes. In the future, a LWRP may be added.
+You just configure global defaults (presently the recommended values from Amazon) and individual mounts through node attributes. You also have the option of using the `mount_efs` resource within your own recipes.
 
 ## Requirements
 
@@ -103,6 +103,10 @@ Configure any desired mounts under `node['efs']['mounts']` and include `efs` in
 }
 ```
 
+### mount_efs
+
+This cookbook is implemented with a custom resource so you can use `mount_efs` in your cookbook recipes as well with the same available attributes as the `node['efs']['mounts']` structure.
+
 ## Contributing
 
 1. Fork the repository on Github

attributes/default.rb

@@ -5,3 +5,10 @@
 default['efs']['retrans'] = 2
 default['efs']['mounts'] = {}
 default['efs']['remove_unspecified_mounts'] = false
+
+default['efs']['nfs-package'] = case node['platform']
+                                when 'ubuntu', 'debian'
+                                  'nfs-common'
+                                when 'redhat'
+                                  'nfs-utils'
+                                end

libraries/efs.rb

@@ -0,0 +1,122 @@
+module EFS
+  # Class representing an Elastic Filesystem share/mount
+  class Mount
+    attr_reader :mount
+    attr_reader :fsid
+    attr_reader :region
+    attr_accessor :rsize
+    attr_accessor :wsize
+    attr_accessor :behavior
+    attr_accessor :timeout
+    attr_accessor :retrans
+    attr_accessor :extra_options
+
+    def initialize(mount, fsid, region)
+      raise 'Non-nil region required' if region.nil?
+
+      @mount = mount
+      @fsid = fsid
+      @region = region
+      @extra_options = ''
+    end
+
+    def options_from_line(line) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+      _linedevice, linemount, _fstype, options, _freq, _pass = line.split(/\s+/)
+      raise "Mount does not match #{mount}" if linemount != mount
+      options.split(',').each do |pair|
+        k, v = pair.split('=')
+        case k
+        when 'rsize'
+          @rsize = v
+        when 'wsize'
+          @wsize = v
+        when 'soft', 'hard'
+          @behavior = k
+        when 'timeo'
+          @timeout = v
+        when 'retrans'
+          @retrans = v
+        when 'nfsvers'
+          next
+        else
+          @extra_options += ',' unless @extra_options.empty?
+          @extra_options += k
+          @extra_options += "=#{v}" if v
+        end
+      end
+    end
+
+    def load_existing_options
+      options_from_line(existing_line) if existing_line
+    end
+
+    def standard_options
+      "nfsvers=4.1,rsize=#{@rsize},wsize=#{@wsize},#{@behavior},timeo=#{@timeout},retrans=#{@retrans}"
+    end
+
+    def options
+      @extra_options.empty? ? standard_options : standard_options + ',' + @extra_options
+    end
+
+    def device
+      "#{@fsid}.efs.#{@region}.amazonaws.com:/"
+    end
+
+    def exists?
+      !existing_line.nil?
+    end
+
+    def mounted?
+      !mtab_lines.empty?
+    end
+
+    def fstab_lines
+      file_include('/etc/fstab')
+    end
+
+    def mtab_lines
+      file_include('/etc/mtab')
+    end
+
+    def file_include(file)
+      lines = []
+      IO.readlines(file).each do |line|
+        lines << line.gsub(/\s+/, ' ').chomp if /\s#{mount}\s/ =~ line
+      end
+      lines
+    end
+
+    def existing_line
+      (existing_lines - other_mounts).first
+    end
+
+    def existing_lines
+      return fstab_lines unless fstab_lines.empty?
+      mtab_lines
+    end
+
+    # Returns fstab lines with the same mount point but different devices
+    def other_mounts
+      others = []
+      fstab_lines.each do |line|
+        localdevice, localmount, _fstype, _options, _freq, _pass = line.split(/\s+/)
+        others << line if localmount == mount && localdevice != device
+      end
+      others
+    end
+
+    def self.remove_unspecified_mounts(mounts, run_context) # rubocop:disable Metrics/AbcSize
+      IO.readlines('/etc/fstab').each do |line|
+        device, mount, _fstype, _options, _freq, _pass = line.split(/\s+/)
+        next unless mount && device.match(/fs-[a-f0-9]{8}\.efs\.[a-z]{2}-[a-z]+-\d\.amazonaws\.com/)
+        next if mounts.key?(mount) && mounts[mount]['device'] == device
+
+        m = Chef::Resource::Mount.new(mount, run_context)
+        m.device = device
+        m.action = :nothing
+        m.run_action(:disable)
+        m.run_action(:umount) unless mounts.key?(mount)
+      end
+    end
+  end
+end

libraries/remove_unspecified_mounts.rb

@@ -4,7 +4,7 @@
 license          'MIT'
 description      'Installs/Configures Amazon Elastic Filesystem mounts'
 long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
-version          '0.1.4'
+version          '1.0.0'
 
 source_url 'https://github.com/mattlqx/cookbook-efs' if respond_to?(:source_url)
 issues_url 'https://github.com/mattlqx/cookbook-efs/issues' if respond_to?(:issues_url)

metadata.rb

@@ -5,44 +5,19 @@
 # Copyright 2017, Matt Kulka
 #
 
-case node['platform']
-when 'ubuntu', 'debian'
-  package 'nfs-common'
-when 'redhat'
-  package 'nfs-utils'
-end
+package node['efs']['nfs-package']
 
 node['efs']['mounts'].each do |mount_point, attribs|
-  attribs = attribs.to_hash
-  attribs['rsize'] ||= node['efs']['rsize']
-  attribs['wsize'] ||= node['efs']['wsize']
-  attribs['behavior'] ||= node['efs']['behavior']
-  attribs['timeout'] ||= node['efs']['timeout']
-  attribs['retrans'] ||= node['efs']['retrans']
-  attribs['options'] ||= "nfsvers=4.1,rsize=#{attribs['rsize']},wsize=#{attribs['wsize']}," \
-    "#{attribs['behavior']},timeo=#{attribs['timeout']},retrans=#{attribs['retrans']}"
-
-  begin
-    region = attribs.fetch('region', nil) || node['ec2']['placement_availability_zone'][0..-2]
-  rescue NoMethodError
-    raise "No region specified for mount #{mount_point} and this doesn\'t appear to be an EC2 instance."
-  end
-
-  raise "Mount #{mount_point} has an invalid fsid." unless attribs['fsid'] =~ /fs-[a-f0-9]{8}/
-
-  directory mount_point
-
-  mount mount_point do
-    fstype 'nfs4'
-    device attribs['fsid'] + '.efs.' + region + '.amazonaws.com:/'
+  mount_efs mount_point do
+    fsid attribs['fsid']
     options attribs['options']
-    action %i[enable mount]
+    action :mount
   end
 end
 
 ruby_block 'remove unspecified efs mounts' do
   only_if { node['efs']['remove_unspecified_mounts'] }
   block do
-    remove_unspecified_mounts(node['efs']['mounts'], run_context)
+    EFS::Mount.remove_unspecified_mounts(node['efs']['mounts'], run_context)
   end
 end

recipes/default.rb

@@ -0,0 +1,91 @@
+resource_name :mount_efs
+
+default_action :mount
+
+property :mount_point, String, name_property: true, desired_state: false
+property :fsid, String, desired_state: false, regex: [/fs-[a-f0-9]{8}/], required: true
+property :region, String, desired_state: false
+property :rsize, Integer, default: node['efs']['rsize'], desired_state: false,
+                          coerce: proc { |m| m.is_a?(String) ? m.to_i : m }
+property :wsize, Integer, default: node['efs']['wsize'], desired_state: false,
+                          coerce: proc { |m| m.is_a?(String) ? m.to_i : m }
+property :behavior, String, default: node['efs']['behavior'], desired_state: false
+property :timeout, Integer, default: node['efs']['timeout'], desired_state: false,
+                            coerce: proc { |m| m.is_a?(String) ? m.to_i : m }
+property :retrans, Integer, default: node['efs']['retrans'], desired_state: false,
+                            coerce: proc { |m| m.is_a?(String) ? m.to_i : m }
+property :options, String, desired_state: false
+
+load_current_value do |new_resource|
+  @mount = EFS::Mount.new(new_resource.mount_point, new_resource.fsid, region_value)
+  if @mount.exists?
+    @mount.load_existing_options
+  else
+    current_value_does_not_exist!
+  end
+
+  region region_value
+  rsize @mount.rsize unless @mount.rsize.nil?
+  wsize @mount.wsize unless @mount.wsize.nil?
+  behavior @mount.behavior unless @mount.behavior.nil?
+  timeout @mount.timeout unless @mount.timeout.nil?
+  retrans @mount.retrans unless @mount.retrans.nil?
+  options @mount.extra_options unless @mount.extra_options.nil?
+end
+
+def region_value
+  begin
+    region ||= node['ec2']['placement_availability_zone'][0..-2]
+  rescue NoMethodError
+    raise "No region specified for mount #{mount_point} and this doesn\'t appear to be an EC2 instance."
+  end
+  region
+end
+
+def new_object # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+  mount = EFS::Mount.new(mount_point, fsid, region_value)
+  mount.rsize = rsize unless rsize.nil?
+  mount.wsize = wsize unless wsize.nil?
+  mount.behavior = behavior unless behavior.nil?
+  mount.timeout = timeout unless timeout.nil?
+  mount.retrans = retrans unless retrans.nil?
+  mount.extra_options = options unless options.nil?
+  mount
+end
+
+action :mount do
+  mount = new_object
+
+  converge_if_changed :mount_point do
+    directory new_resource.mount_point
+  end
+
+  converge_if_changed do
+    mount.other_mounts.each do |line|
+      localdevice, localmount, _fstype, _options, _freq, _pass = line.split(/\s+/)
+      mount "#{localmount} #{localdevice} unmount" do
+        device localdevice
+        mount_point localmount
+        action %i[disable umount]
+      end
+    end
+
+    mount new_resource.mount_point do
+      fstype 'nfs4'
+      device mount.device
+      options mount.options
+      action %i[enable mount]
+    end
+  end
+end
+
+action :umount do
+  mount = new_object
+
+  mount new_resource.mount_point do
+    fstype 'nfs4'
+    device mount.device
+    options mount.options
+    action %i[disable umount]
+  end
+end