nfsadmin 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b6408e762bae666a4ac9a02272fee6dfc83f036
+  data.tar.gz: e5569e448ff209e9c1e52b9ca3e725a8041a5ea4
+SHA512:
+  metadata.gz: e96b2bcb0aedbd0c763390084c417bc80342a44faa97347bffc1492448e0292446c2495e65c4c09eda243215838e8f5d8baedefed2535765eb2e183c9c541d0f
+  data.tar.gz: 429a729e61a58f0b4731bd0019dfc484f74a3eea385c5c1a1cbba77649ae695bf385e88f7d8c30514f130fa55fffb730595bd5cbe69ccf0ffa563b2226b0d695

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+*.html
+.idea
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-gemset

@@ -0,0 +1 @@
+nfsadmin

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    nfsadmin (0.0.2)
+      gli (~> 2.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.4)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.5.2)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.14)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.1)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    gli (2.9.0)
+    json (1.8.1)
+    multi_json (1.9.2)
+    multi_test (0.1.1)
+    rake (10.2.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.5)
+  nfsadmin!
+  rake (~> 10.2)
+  rdoc (~> 4.1)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Siteminds B.V. - B.J.W. Schaap
+
+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/README.md

@@ -0,0 +1,41 @@
+nfsadmin
+========
+
+Nfsadmin is a Ruby Gem that allows for simple configuration of the NFS service and its exports.
+It consists of a library part that you can use in your own applications, and a CLI that allows 
+for using `nfsadmin` as a commandline tool.
+
+Library usage
+-------------
+
+Using the library is easy: just `require 'nfsadmin'` in your own Ruby code.
+
+CLI usage
+---------
+
+The `nfsadmin` commandline binary comes with the gem. Type `nfsadmin help` to see how it works.
+
+License
+-------
+
+The MIT License (MIT)
+
+Copyright (c) 2014 Siteminds B.V. - B.J.W. Schaap
+
+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/README.rdoc

@@ -0,0 +1,6 @@
+= nfsadmin
+
+Describe your project here
+
+:include:nfsadmin.rdoc
+

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'cucumber'
+require 'cucumber/rake/task'
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'Your application title'
+end
+
+spec = eval(File.read('nfsadmin.gemspec'))
+
+Gem::PackageTask.new(spec) do |pkg|
+end
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+
+task :default => [:test,:features]

data/bin/nfsadmin

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'nfsadmin'
+
+include GLI::App
+
+program_desc 'nfsadmin is a CLI to manage the NFS service and its exports'
+
+version Nfsadmin::VERSION
+
+flag [:c,:config], :default_value => '/etc/exports'
+
+desc 'The export command manages exported NFS shares'
+command :export do |c|
+
+  c.default_command :list
+
+  c.desc 'List all NFS exported shares on this server'
+  c.command :list do |list|
+    list.desc 'Define output type. Valid types are: text, json'
+    list.default_value 'text'
+    list.flag [:f, :format]
+    list.action do |global_options,options,args|
+      Nfsadmin::Tasks.list_shares(global_options[:c], options[:f])
+    end
+  end
+
+  c.desc 'Add a new NFS export to be shared on this server'
+  c.command :add do |add|
+    add.desc 'The location to be exported as NFS share'
+    add.flag [:l, :location]
+    add.desc 'The network address (networks and wildcards allowed)'
+    add.flag [:a, :address]
+    add.desc 'The NFS options for this share, e.g. rw,sync,no_root_squash,no_subtree_check'
+    add.flag [:o, :options]
+    add.action do |global_options,options,args|
+      Nfsadmin::Tasks.create_share(global_options[:c], options[:l], options[:a], options[:o])
+    end
+  end
+
+  c.desc 'Delete an NFS export from this server'
+  c.command [:rm,:delete] do |delete|
+    delete.action do |global_options,options,args|
+      Nfsadmin::Tasks.delete_share(global_options[:c], options[:l])
+    end
+  end
+
+  c.desc 'Get information about a specific share'
+  c.command [:get] do |get|
+    get.action do |global_options,options,args|
+      Nfsadmin::Tasks.get_share(global_options[:c], options[:l], options[:f])
+    end
+  end
+end
+
+desc 'The service command manages the NFS service'
+arg_name 'Describe arguments to service here'
+command :service do |c|
+
+  c.desc 'Return the status of the NFS service(s)'
+  c.command :status do |status|
+    status.action do
+      Nfsadmin::Tasks.show_status
+    end
+  end
+
+  c.desc 'Start the NFS service(s)'
+  c.command :start do |start|
+    start.action do
+      Nfsadmin::Tasks.start_service
+    end
+  end
+
+  c.desc 'Stop the NFS service(s)'
+  c.command :stop do |stop|
+    stop.action do
+      Nfsadmin::Tasks.stop_service
+    end
+  end
+
+  c.desc 'Restart the NFS service(s)'
+  c.command :start do |restart|
+    restart.action do
+      Nfsadmin::Tasks.restart_service
+    end
+  end
+
+  c.desc 'Reload the NFS exports configuration'
+  c.command :reload do |reload|
+    reload.action do
+      Nfsadmin::Tasks.reload_config
+    end
+  end
+
+  c.default_command :status
+end
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/features/nfsadmin.feature

@@ -0,0 +1,8 @@
+Feature: My bootstrapped app kinda works
+  In order to get going on coding my awesome app
+  I want to have aruba and cucumber setup
+  So I don't have to do it myself
+
+  Scenario: App just runs
+    When I get help for "nfsadmin"
+    Then the exit status should be 0

data/features/step_definitions/nfsadmin_steps.rb

@@ -0,0 +1,6 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+# Add more step definitions here

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/nfsadmin/tasks.rb

@@ -0,0 +1,152 @@
+require 'json'
+
+module Nfsadmin
+
+  class Tasks
+    def self.get_shares(exportsfile)
+      shares = []
+      location = ''
+      begin
+        file = File.open(exportsfile, 'r')
+      rescue
+        fail 'No exports configuration could be found'
+      end
+      file.readlines.each do |line|
+        share = {}
+        acl = []
+        parts = line.split
+        parts.each do |part|
+          entry = {}
+          if (Pathname.new(part)).absolute?
+            location = part
+          else
+            subparts = part.split('(')
+            entry[:address] = subparts[0]
+            entry[:options] = subparts[1].sub!(/\)/, '')
+            acl << entry
+          end
+        end
+        share[:location] = location
+        share[:acl] = acl
+        shares << share
+      end
+      file.close
+      return shares
+    end
+
+    def self.write_exports(exportsfile, exports)
+      begin
+        file = File.open(exportsfile, File::WRONLY|File::CREAT)
+        file.truncate(0)
+      rescue
+        fail "Could not write to exports configuration #{exportsfile}"
+      end
+      exports.each do |share|
+        file.print(share[:location] + '   ')
+        share[:acl].each do |acl|
+          file.print acl[:address].to_s + '(' + acl[:options].to_s + ')' + ' '
+        end
+        file.print "\n"
+      end
+      file.flush
+      file.close
+    end
+
+    def self.list_shares(exportsfile, output_type)
+      exports = get_shares(exportsfile)
+      if output_type.downcase == 'text'
+        # Output plain text
+        exports.each do |share|
+          printf('%-40s', share[:location])
+          share[:acl].each do |acl|
+            print acl[:address] + '(' + acl[:options] + ')' + ' '
+          end
+          print "\n"
+        end
+        STDOUT.flush
+      elsif output_type.downcase == 'json'
+        # Output JSON
+        puts JSON.generate({ :exports => exports })
+      else
+        fail "#{output_type} is an invalid output format. Must one of: text, json"
+      end
+    end
+
+    def self.create_share(exportsfile, location, address, options)
+      if location.nil?
+        fail 'Location must be specified'
+      end
+      if address.nil?
+        fail 'Address must be specified'
+      end
+      if options.nil?
+        fail 'Options must be specified'
+      end
+      share = { :location => location,
+                :acl => [{
+                    :address => address,
+                    :options => options
+                }]
+      }
+      shares = get_shares(exportsfile)
+      existingshare = shares.find { |s| s[:location] == location }
+      if existingshare.nil?
+        shares << share
+        write_exports(exportsfile, shares)
+      else
+        puts 'Share already exists. Use nfsadmin export modify to change it. Skipping'
+      end
+    end
+
+    def self.delete_share(exportsfile, location)
+      if location.nil?
+        fail 'Location must be specified with -l or --location='
+      end
+      shares = get_shares(exportsfile)
+      share = shares.find { |share| share[:location] == location }
+      shares.delete(share)
+      write_exports(exportsfile, shares)
+    end
+
+    def self.get_share(exportsfile, location, output_type)
+      if location.nil?
+        fail 'Location must be specified with -l or --location='
+      end
+      shares = get_shares(exportsfile)
+      share = shares.find { |share| share[:location] == location }
+      if output_type.downcase == 'text'
+        printf('%-40s', share[:location])
+        share[:acl].each do |acl|
+          print acl[:address] + '(' + acl[:options] + ')' + ' '
+        end
+        print "\n"
+        STDOUT.flush
+      elsif output_type.downcase == 'json'
+        puts JSON.generate(share)
+      else
+        fail "#{output_type} is an invalid output format. Must one of: text, json"
+      end
+    end
+
+    def self.show_status
+      `/usr/sbin/service nfs status`
+    end
+
+    def self.start_service
+      `/usr/sbin/service nfs start`
+    end
+
+    def self.stop_service
+      `/usr/sbin/service nfs stop`
+    end
+
+    def self.restart_service
+      `/usr/sbin/service nfd restart`
+    end
+
+    def self.reload_config
+      `/usr/sbin/service nfs reload`
+    end
+  end
+
+end

data/lib/nfsadmin/version.rb

@@ -0,0 +1,3 @@
+module Nfsadmin
+  VERSION = '0.0.2'
+end

data/lib/nfsadmin.rb

@@ -0,0 +1,2 @@
+require 'nfsadmin/version.rb'
+require 'nfsadmin/tasks.rb'

data/nfsadmin.gemspec

@@ -0,0 +1,29 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','nfsadmin','version.rb'])
+spec = Gem::Specification.new do |s|
+  s.name = 'nfsadmin'
+  s.version = Nfsadmin::VERSION
+  s.author = 'Bastiaan Schaap'
+  s.email = 'b.schaap@siteminds.nl'
+  s.homepage = 'https://github.com/bjwschaap/nfsadmin'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'This gem contains a library and CLI tool for managing the NFS service and exports'
+  s.description = <<eos
+                  This gem contains a library and CLI tool for managing the NFS service and exports. It depends on
+                  autofs to be installed, and the service NFS to be available. This is my first attempt at a
+                  RubyGem, and much still needs to be done. Only tested on Centos 6 at this time.
+eos
+  s.license = 'MIT'
+  s.files = `git ls-files`.split("\n")
+  s.require_paths << 'lib'
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README.rdoc','nfsadmin.rdoc']
+  s.rdoc_options << '--title' << 'nfsadmin' << '--main' << 'README.rdoc' << '-ri'
+  s.bindir = 'bin'
+  s.executables << 'nfsadmin'
+  s.required_ruby_version = '~> 2.0'
+  s.add_development_dependency('rake', '~> 10.2' )
+  s.add_development_dependency('rdoc', '~> 4.1')
+  s.add_development_dependency('aruba', '~> 0.5')
+  s.add_runtime_dependency('gli','~> 2.9')
+end

data/nfsadmin.rdoc

@@ -0,0 +1,5 @@
+= nfsadmin
+
+Generate this with
+    nfsadmin rdoc
+After you have described your command line interface

data/test/default_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class DefaultTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def teardown
+  end
+
+  def test_the_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'test/unit'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: nfsadmin
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bastiaan Schaap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: |2
+                    This gem contains a library and CLI tool for managing the NFS service and exports. It depends on
+                    autofs to be installed, and the service NFS to be available. This is my first attempt at a
+                    RubyGem, and much still needs to be done. Only tested on Centos 6 at this time.
+email: b.schaap@siteminds.nl
+executables:
+- nfsadmin
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- nfsadmin.rdoc
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- README.rdoc
+- Rakefile
+- bin/nfsadmin
+- features/nfsadmin.feature
+- features/step_definitions/nfsadmin_steps.rb
+- features/support/env.rb
+- lib/nfsadmin.rb
+- lib/nfsadmin/tasks.rb
+- lib/nfsadmin/version.rb
+- nfsadmin.gemspec
+- nfsadmin.rdoc
+- test/default_test.rb
+- test/test_helper.rb
+homepage: https://github.com/bjwschaap/nfsadmin
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--title"
+- nfsadmin
+- "--main"
+- README.rdoc
+- "-ri"
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: This gem contains a library and CLI tool for managing the NFS service and
+  exports
+test_files: []